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

[#6213] Document XMLGenerator

Browse Source
This commit is contained in:
lukaseder 2017-06-09 13:51:39 +02:00
parent b845bc361d
commit 546907765a
2 changed files with 98 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
jOOQ-manual/src/main/resources/org/jooq/web/manual-3.10.xml
View File

@ -17904,6 +17904,55 @@ CREATE TABLE book_to_book_store (
</html></content>
</section>
<section id="xmlgenerator">
<title>Generating XML</title>
<content><html>
<p>
By default the code generator produces Java files for use with the jOOQ API as documented throughout this manual. In some cases, however, it may be desireable to generate other meta data formats, such as an XML document. This can be done with the <code>XMLGenerator</code>.
</p>
<p>
The format produced by the <code>XMLGenerator</code> is the same as the one consumed by the <reference id="codegen-xml" title="XMLDatabase"/>, which can read such XML content to produce Java code. It is specified in the <a href="http://www.jooq.org/xsd/jooq-meta-{meta-xsd-version}.xsd">http://www.jooq.org/xsd/jooq-meta-{meta-xsd-version}.xsd</a> schema. Essentially, this schema is an XML representation of the SQL standard <code>INFORMATION_SCHEMA</code>, as implemented by databases like H2, HSQLDB, MySQL, PostgreSQL, or SQL Server.
</p>
<p>
In order to use the <code>XMLGenerator</code>, simply place the following class reference into your code generation configuration:
</p>
<p>
<strong>XML configuration (standalone and Maven)</strong>
</p>
</html><xml><![CDATA[<configuration>
<generator>
<name>org.jooq.util.XMLGenerator</name>
</generator>
...
</configuration>]]></xml><html>
<p>
<strong>Programmatic configuration</strong>
</p>
</html><java><![CDATA[configuration.withGenerator(new Generator()
.withName("org.jooq.util.XMLGenerator"));]]></java><html>
<p>
<strong>Gradle configuration</strong>
</p>
</html><java><![CDATA[configuration {
generator {
name = 'org.jooq.util.XMLGenerator'
}
}]]></java><html>
<p>
This configuration does not interfere with most of the remaining code generation configuration, e.g. you can still specify the JDBC connection or the generation output target as usual.
</p>
</html></content>
</section>
<section id="codegen-maven">
<title>Running the code generator with Maven</title>
<content><html>

49
jOOQ-manual/src/main/resources/org/jooq/web/manual-3.9.xml
View File

@ -17494,6 +17494,55 @@ public class Book {
</html></content>
</section>
<section id="xmlgenerator">
<title>Generating XML</title>
<content><html>
<p>
By default the code generator produces Java files for use with the jOOQ API as documented throughout this manual. In some cases, however, it may be desireable to generate other meta data formats, such as an XML document. This can be done with the <code>XMLGenerator</code>.
</p>
<p>
The format produced by the <code>XMLGenerator</code> is the same as the one consumed by the <reference id="codegen-xml" title="XMLDatabase"/>, which can read such XML content to produce Java code. It is specified in the <a href="http://www.jooq.org/xsd/jooq-meta-{meta-xsd-version}.xsd">http://www.jooq.org/xsd/jooq-meta-{meta-xsd-version}.xsd</a> schema. Essentially, this schema is an XML representation of the SQL standard <code>INFORMATION_SCHEMA</code>, as implemented by databases like H2, HSQLDB, MySQL, PostgreSQL, or SQL Server.
</p>
<p>
In order to use the <code>XMLGenerator</code>, simply place the following class reference into your code generation configuration:
</p>
<p>
<strong>XML configuration (standalone and Maven)</strong>
</p>
</html><xml><![CDATA[<configuration>
<generator>
<name>org.jooq.util.XMLGenerator</name>
</generator>
...
</configuration>]]></xml><html>
<p>
<strong>Programmatic configuration</strong>
</p>
</html><java><![CDATA[configuration.withGenerator(new Generator()
.withName("org.jooq.util.XMLGenerator"));]]></java><html>
<p>
<strong>Gradle configuration</strong>
</p>
</html><java><![CDATA[configuration {
generator {
name = 'org.jooq.util.XMLGenerator'
}
}]]></java><html>
<p>
This configuration does not interfere with most of the remaining code generation configuration, e.g. you can still specify the JDBC connection or the generation output target as usual.
</p>
</html></content>
</section>
<section id="codegen-maven">
<title>Running the code generator with Maven</title>
<content><html>