Skip to content

Commit 9db9d6a

Browse files
committed
Add generator DTD to public site
1 parent f4f956c commit 9db9d6a

File tree

1 file changed

+214
-0
lines changed

1 file changed

+214
-0
lines changed

dtd/mybatis-generator-config_1_0.dtd

Lines changed: 214 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,214 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
3+
<!--
4+
Licensed under the Apache License, Version 2.0 (the "License");
5+
you may not use this file except in compliance with the License.
6+
You may obtain a copy of the License at
7+
8+
http://www.apache.org/licenses/LICENSE-2.0
9+
10+
Unless required by applicable law or agreed to in writing, software
11+
distributed under the License is distributed on an "AS IS" BASIS,
12+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
See the License for the specific language governing permissions and
14+
limitations under the License.
15+
-->
16+
17+
<!--
18+
This DTD defines the structure of the MyBatis generator configuration file.
19+
Configuration files should declare the DOCTYPE as follows:
20+
21+
<!DOCTYPE generatorConfiguration PUBLIC
22+
"-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
23+
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
24+
25+
Please see the documentation included with MyBatis generator for details on each option
26+
in the DTD. You may also view documentation on-line here:
27+
28+
http://mybatis.org/docs/generator
29+
30+
-->
31+
32+
<!--
33+
The generatorConfiguration element is the root element for configurations.
34+
-->
35+
<!ELEMENT generatorConfiguration (properties?, classPathEntry*, context+)>
36+
37+
<!--
38+
The properties element is used to define a standard Java properties file
39+
that contains placeholders for use in the remainder of the configuration
40+
file.
41+
-->
42+
<!ELEMENT properties EMPTY>
43+
<!ATTLIST properties
44+
resource CDATA #IMPLIED
45+
url CDATA #IMPLIED>
46+
47+
<!--
48+
The context element is used to describe a context for generating files, and the source
49+
tables.
50+
-->
51+
<!ELEMENT context (property*, plugin*, commentGenerator?, jdbcConnection, javaTypeResolver?,
52+
javaModelGenerator, sqlMapGenerator?, javaClientGenerator?, table+)>
53+
<!ATTLIST context id ID #REQUIRED
54+
defaultModelType CDATA #IMPLIED
55+
targetRuntime CDATA #IMPLIED
56+
introspectedColumnImpl CDATA #IMPLIED>
57+
58+
<!--
59+
The jdbcConnection element is used to describe the JDBC connection that the generator
60+
will use to introspect the database.
61+
-->
62+
<!ELEMENT jdbcConnection (property*)>
63+
<!ATTLIST jdbcConnection
64+
driverClass CDATA #REQUIRED
65+
connectionURL CDATA #REQUIRED
66+
userId CDATA #IMPLIED
67+
password CDATA #IMPLIED>
68+
69+
<!--
70+
The classPathEntry element is used to add the JDBC driver to the run-time classpath.
71+
Repeat this element as often as needed to add elements to the classpath.
72+
-->
73+
<!ELEMENT classPathEntry EMPTY>
74+
<!ATTLIST classPathEntry
75+
location CDATA #REQUIRED>
76+
77+
<!--
78+
The property element is used to add custom properties to many of the generator's
79+
configuration elements. See each element for example properties.
80+
Repeat this element as often as needed to add as many properties as necessary
81+
to the configuration element.
82+
-->
83+
<!ELEMENT property EMPTY>
84+
<!ATTLIST property
85+
name CDATA #REQUIRED
86+
value CDATA #REQUIRED>
87+
88+
<!--
89+
The plugin element is used to define a plugin.
90+
-->
91+
<!ELEMENT plugin (property*)>
92+
<!ATTLIST plugin
93+
type CDATA #REQUIRED>
94+
95+
<!--
96+
The javaModelGenerator element is used to define properties of the Java Model Generator.
97+
The Java Model Generator builds primary key classes, record classes, and Query by Example
98+
indicator classes.
99+
-->
100+
<!ELEMENT javaModelGenerator (property*)>
101+
<!ATTLIST javaModelGenerator
102+
targetPackage CDATA #REQUIRED
103+
targetProject CDATA #REQUIRED>
104+
105+
<!--
106+
The javaTypeResolver element is used to define properties of the Java Type Resolver.
107+
The Java Type Resolver is used to calculate Java types from database column information.
108+
The default Java Type Resolver attempts to make JDBC DECIMAL and NUMERIC types easier
109+
to use by substituting Integral types if possible (Long, Integer, Short, etc.)
110+
-->
111+
<!ELEMENT javaTypeResolver (property*)>
112+
<!ATTLIST javaTypeResolver
113+
type CDATA #IMPLIED>
114+
115+
<!--
116+
The sqlMapGenerator element is used to define properties of the SQL Map Generator.
117+
The SQL Map Generator builds an XML file for each table that conforms to iBATIS'
118+
SqlMap DTD.
119+
-->
120+
<!ELEMENT sqlMapGenerator (property*)>
121+
<!ATTLIST sqlMapGenerator
122+
targetPackage CDATA #REQUIRED
123+
targetProject CDATA #REQUIRED>
124+
125+
<!--
126+
The javaClientGenerator element is used to define properties of the Java client Generator.
127+
The Java Client Generator builds Java interface and implementation classes
128+
(as required) for each table.
129+
If this element is missing, then the generator will not build Java Client classes.
130+
-->
131+
<!ELEMENT javaClientGenerator (property*)>
132+
<!ATTLIST javaClientGenerator
133+
type CDATA #REQUIRED
134+
targetPackage CDATA #REQUIRED
135+
targetProject CDATA #REQUIRED
136+
implementationPackage CDATA #IMPLIED>
137+
138+
<!--
139+
The table element is used to specify a database table that will be the source information
140+
for a set of generated objects.
141+
-->
142+
<!ELEMENT table (property*, generatedKey?, columnRenamingRule?, (columnOverride | ignoreColumn)*) >
143+
<!ATTLIST table
144+
catalog CDATA #IMPLIED
145+
schema CDATA #IMPLIED
146+
tableName CDATA #REQUIRED
147+
alias CDATA #IMPLIED
148+
domainObjectName CDATA #IMPLIED
149+
enableInsert CDATA #IMPLIED
150+
enableSelectByPrimaryKey CDATA #IMPLIED
151+
enableSelectByExample CDATA #IMPLIED
152+
enableUpdateByPrimaryKey CDATA #IMPLIED
153+
enableDeleteByPrimaryKey CDATA #IMPLIED
154+
enableDeleteByExample CDATA #IMPLIED
155+
enableCountByExample CDATA #IMPLIED
156+
enableUpdateByExample CDATA #IMPLIED
157+
selectByPrimaryKeyQueryId CDATA #IMPLIED
158+
selectByExampleQueryId CDATA #IMPLIED
159+
modelType CDATA #IMPLIED
160+
escapeWildcards CDATA #IMPLIED
161+
delimitIdentifiers CDATA #IMPLIED
162+
delimitAllColumns CDATA #IMPLIED>
163+
164+
<!--
165+
The columnOverride element is used to change certain attributes of the column
166+
from their default values.
167+
-->
168+
<!ELEMENT columnOverride (property*)>
169+
<!ATTLIST columnOverride
170+
column CDATA #REQUIRED
171+
property CDATA #IMPLIED
172+
javaType CDATA #IMPLIED
173+
jdbcType CDATA #IMPLIED
174+
typeHandler CDATA #IMPLIED
175+
delimitedColumnName CDATA #IMPLIED>
176+
177+
<!--
178+
The ignoreColumn element is used to identify a column that should be ignored.
179+
No generated SQL will refer to the column, and no property will be generated
180+
for the column in the model objects.
181+
-->
182+
<!ELEMENT ignoreColumn EMPTY>
183+
<!ATTLIST ignoreColumn
184+
column CDATA #REQUIRED
185+
delimitedColumnName CDATA #IMPLIED>
186+
187+
<!--
188+
The generatedKey element is used to identify a column in the table whose value
189+
is calculated - either from a sequence (or some other query), or as an identity column.
190+
-->
191+
<!ELEMENT generatedKey EMPTY>
192+
<!ATTLIST generatedKey
193+
column CDATA #REQUIRED
194+
sqlStatement CDATA #REQUIRED
195+
identity CDATA #IMPLIED
196+
type CDATA #IMPLIED>
197+
198+
<!--
199+
The columnRenamingRule element is used to specify a rule for renaming
200+
columns before the corresponding property name is calculated
201+
-->
202+
<!ELEMENT columnRenamingRule EMPTY>
203+
<!ATTLIST columnRenamingRule
204+
searchString CDATA #REQUIRED
205+
replaceString CDATA #IMPLIED>
206+
207+
<!--
208+
The commentGenerator element is used to define properties of the Comment Generator.
209+
The Comment Generator adds comments to generated elements.
210+
-->
211+
<!ELEMENT commentGenerator (property*)>
212+
<!ATTLIST commentGenerator
213+
type CDATA #IMPLIED>
214+

0 commit comments

Comments
 (0)