org.dbtools.xml.dbschema.xsd Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of dbtools-gen Show documentation
Show all versions of dbtools-gen Show documentation
DBTools ORM Class Generator.
Optional comment
Database Table
Database specific table parameters
Table column/field
Name of field/column in the database table. Should not contain spaces and can be named many ways (myField, MY_FIELD, MyField, etc)
Number of decimal spaces to be used by the database (below the . in a number). This is also refered to as scale or precision in some databases.
Order by Field (currently not supported in Sqlite)
Foreign Key type (only ENUM currently supported in Sqlite)
Enumerations should be comma separated ("HOME,OFFICE,OTHER").
Enumeration usage (Use 1. OR 2. (not both)):
1. For foreign key enum: foreignKeyType="ENUM" then be sure the table for this has the enumerations attribute
Then set the default by using the field attribute enumerationDefault="MYDEFAULT"
2. For local enum: enumerations="UNKNOWN,YES,NO" enumerationDefault="UNKNOWN"
Fetch type (not supported in SQLite)
Field cannot be null (enforced both in database and code)
This field should be unique (can be used in combination with other fields being unique)
JDBC datatype
Enable indexing on this field
Field default value (both Table field AND Object variable)
Primary Key field ONLY. Auto increment Primary Key value
Primary Key field ONLY. Initial auto increment value (for sequences, use sequencerStartValue)
Primary Key field indicator
Used by Java generator to auto-update time-stamp of this field. This field should be a TIMESTAMP jdbcType. (Currently NOT supported by JPA generator)
Foreign Key table name
Foreign Key field/column name
Used by database generation. Size of VARCHAR or Size specifies the number of digits above the decimal in float types (FLOAT, DECIMAL, etc). Use "decimals" to specify the number of digits below the decimal point.
Enumerations should be comma separated with no spaces (Example "HOME,OFFICE,OTHER"). In the Java code, the datatype for this field/variable is replaced with an internal enum that will be created using the name of this field/variable.
Classname of the a user defined enum (Example: com.mycompany.LocationType). DO NOT use this field if using ForeignKeyType="ENUM".
Default value for Enumeration. Only use the name of the enumeration value. (Example: "HOME" (Do NOT put "LocationType.HOME")). If this is NOT specified, then the first enumeration value is used.
Primary Key field ONLY: Sequencer name
Primary Key field ONLY: Sequencer start value (default 0)
Override variable name
Sqlite ONLY. Flag to indicate field should use COLLATE for ORDER BY
Table unique constraints (This type of unique is currently only supports Sqlite)
Name of table. Should not contain spaces and can be named many ways (myTable, MY_TABLE, MyTable, etc)
Table enumerations should be comma separated example:("HOME,OFFICE,OTHER"). Be sure to set the field attribute foreignKeyType="ENUM"
Override class name
Apply notNull="true" on ALL fields. (Instead of placing notNull="true" individual fields)
Table should be read-only. Object generator will not include Insert/Update/Delete methods in Manager.
Database View
Name of field/column in the database table. Should not contain spaces and can be named many ways (myField, MY_FIELD, MyField, etc)
Number of decimal spaces to be used by the database (below the . in a number). This is also referred to as scale or precision in some databases.
Foreign Key type (only ENUM currently supported in Sqlite)
Enumerations should be comma separated ("HOME,OFFICE,OTHER").
Enumeration usage (Use 1. OR 2. (not both)):
1. For foreign key enum: foreignKeyType="ENUM" then be sure the table for this has the enumerations attribute
Then set the default by using the field attribute enumerationDefault="MYDEFAULT"
2. For local enum: enumerations="UNKNOWN,YES,NO" enumerationDefault="UNKNOWN"
Field cannot be null (enforced both in database and code)
JDBC datatype
Field default value (both Table field AND Object variable)
Primary Key ID field indicator
Foreign Key table name
Foreign Key field/column name
Used by database generation. Size of VARCHAR or Size specifies the number of digits above the decimal in float types (FLOAT, DECIMAL, etc). Use "decimals" to specify the number of digits below the decimal point.
Classname of the a user defined enum (Example: com.mycompany.LocationType). DO NOT use this field if using ForeignKeyType="ENUM".
Default value for Enumeration. Only use the name of the enumeration value. (Example: "HOME" (Do NOT put "LocationType.HOME")). If this is NOT specified, then the first enumeration value is used.
Override variable name
Sqlite ONLY. Flag to indicate field should use COLLATE for ORDER BY
Name of view. Should not contain spaces and can be named many ways (myView, MY_VIEW, MyView, etc)
Override class name
Apply notNull="true" on ALL fields. (Instead of placing notNull="true" individual fields)
Object generator will not include Insert/Update/Detele methods in Manager.
Database Query, defined in code. Used to create object mapping to custom database queries
Name of field/column in the database table. Should not contain spaces and can be named many ways (myField, MY_FIELD, MyField, etc)
Number of decimal spaces to be used by the database (below the . in a number). This is also referred to as scale or precision in some databases.
Foreign Key type (only ENUM currently supported in Sqlite)
Enumerations should be comma separated ("HOME,OFFICE,OTHER").
Enumeration usage (Use 1. OR 2. (not both)):
1. For foreign key enum: foreignKeyType="ENUM" then be sure the table for this has the enumerations attribute
Then set the default by using the field attribute enumerationDefault="MYDEFAULT"
2. For local enum: enumerations="UNKNOWN,YES,NO" enumerationDefault="UNKNOWN"
Field cannot be null (enforced both in database and code)
JDBC datatype
Field default value (both Table field AND Object variable)
Primary Key ID field indicator
Foreign Key table name
Foreign Key field/column name
Used by database generation. Size of VARCHAR or Size specifies the number of digits above the decimal in float types (FLOAT, DECIMAL, etc). Use "decimals" to specify the number of digits below the decimal point.
Classname of the a user defined enum (Example: com.mycompany.LocationType). DO NOT use this field if using ForeignKeyType="ENUM".
Default value for Enumeration. Only use the name of the enumeration value. (Example: "HOME" (Do NOT put "LocationType.HOME")). If this is NOT specified, then the first enumeration value is used.
Name of query. Should not contain spaces and can be named many ways (myQuery, MY_QUERY, MyQuery, etc)
Override class name
Apply notNull="true" on ALL fields. (Instead of placing notNull="true" individual fields)
Object generator will not include Insert/Update/Detele methods in Manager.
Path to SQL script file that is appended to bottom of created full DDL
Name of database. Used in package name, file name, key in database map
Apply notNull="true" to all Table/View/Query fields
Apply readOnly="true" to all Tables, Views, Queries