github/jooq
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[#1674] Export data types with Result.formatXML() and

Browse Source 
Result.formatJSON() exports - Documented changes in manual and Javadoc
This commit is contained in:
Lukas Eder 2012-09-05 18:16:20 +02:00
parent c02ab72d7b
commit e7dbb66881
2 changed files with 20 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
jOOQ-website/src/main/resources/manual-2.6.xml
View File

@ -6160,11 +6160,11 @@ String xml = create.selectFrom(BOOK).fetch().formatXML();</java>
The above query will result in an XML document looking like the following one:
</p>
<xml><![CDATA[<result xmlns="http://www.jooq.org/xsd/jooq-export-1.6.2.xsd">
<xml><![CDATA[<result xmlns="http://www.jooq.org/xsd/jooq-export-2.6.0.xsd">
<fields>
<field name="ID"/>
<field name="AUTHOR_ID"/>
<field name="TITLE"/>
<field name="ID" type="INTEGER"/>
<field name="AUTHOR_ID" type="INTEGER"/>
<field name="TITLE" type="VARCHAR"/>
</fields>
<records>
<record>
@ -6234,8 +6234,16 @@ String json = create.selectFrom(BOOK).fetch().formatJSON();</java>
The above query will result in a JSON document looking like the following one:
</p>
<text>{fields:["ID","AUTHOR_ID","TITLE"],
records:[[1,1,"1984"],[2,1,"Animal Farm"]]}</text>
<text>{"fields":[{"name":"field-1","type":"type-1"},
{"name":"field-2","type":"type-2"},
...,
{"name":"field-n","type":"type-n"}],
"records":[[value-1-1,value-1-2,...,value-1-n],
[value-2-1,value-2-2,...,value-2-n]]}</text>
<p>
Note: This format has changed in jOOQ 2.6.0
</p>
</content>
</section>

9
jOOQ/src/main/java/org/jooq/Result.java
View File

@ -1754,7 +1754,10 @@ public interface Result<R extends Record> extends FieldProvider, List<R>, Attach
/**
* Get a simple formatted representation of this result as a JSON array of
* array. The format is the following: <code><pre>
* {"fields":["field-1","field-2",...,"field-n"],
* {"fields":[{"name":"field-1","type":"type-1"},
* {"name":"field-2","type":"type-2"},
* ...,
* {"name":"field-n","type":"type-n"}],
* "records":[[value-1-1,value-1-2,...,value-1-n],
* [value-2-1,value-2-2,...,value-2-n]]}
* </pre></code>
@ -1767,7 +1770,7 @@ public interface Result<R extends Record> extends FieldProvider, List<R>, Attach
* Get this result formatted as XML
*
* @see <a
* href="http://www.jooq.org/xsd/jooq-export-1.6.2.xsd">http://www.jooq.org/xsd/jooq-export-1.6.2.xsd</a>
* href="http://www.jooq.org/xsd/jooq-export-2.6.0.xsd">http://www.jooq.org/xsd/jooq-export-2.6.0.xsd</a>
*/
String formatXML();
@ -1784,7 +1787,7 @@ public interface Result<R extends Record> extends FieldProvider, List<R>, Attach
*
* @see #formatXML()
* @see <a
* href="http://www.jooq.org/xsd/jooq-export-1.6.2.xsd">http://www.jooq.org/xsd/jooq-export-1.6.2.xsd</a>
* href="http://www.jooq.org/xsd/jooq-export-2.6.0.xsd">http://www.jooq.org/xsd/jooq-export-2.6.0.xsd</a>
*/
Document intoXML();