The Torque Database Schema Reference attempts to explain what the different elements and attributes are when defining your own database schema. In addition I will attempt to explain what attributes mean what in the different databases currently supported.

Some of the following examples are taken from the project-schema.xml document in the src/conf/torque/schema.

Element: database

The database element and its relevant attributes. <database name="MY_DATABASE" defaultIdMethod="idBroker" package="com.myapp.om" baseClass="com.myapp.om.BaseClass" basePeer="com.myapp.om.BasePeer"> <table name="SIMPLE"> <!-- table info goes here --> </table> </database> The database element has 8 attributes associated with it, they are: name The name of the database being referenced defaultIdMethod How will the primary keys be created, defaults to "none" defaultJavaType Default type of columns in the database (object or primitive, defaults to primitive) package Used for OM Peer generation baseClass Used for OM generation basePeer Used for OM Peer generation defaultJavaNamingMethod Indicates how a schema table or column name is mapped to a Java class or method name respectively heavyIndexing ? (true or false, defaults to false) The database element can contain the following elements: table 1 or more

Attribute: defaultIdMethod

By defining this attribute at the database level it applies the defaultIdMethod to those tables which do not have an idMethod attribute defined. The attribute defaultIdMethod has 5 possible values, they are: idbroker This allows turbine to generate the IDs through its IDBroker Service native Turbine will determine how the database will auto-generate IDs autoincrement deprecated, please use native sequence deprecated, please use native none Typically used if you do not want IDs generated

Attribute: defaultJavaNamingMethod

This attribute determines how table or column names, from the name attribute of the table or column element, are converted to a Java class or method name respectively when creating the OM Java objects. defaultJavaNamingMethod can contain 3 different values: nochange Indicates no change is performed. underscore Underscores are removed, First letter is capitalized, first letter after an underscore is capitalized, the rest of the letters are converted to lowercase. javaname Same as underscore, but no letters are converted to lowercase.

Attribute: package

The base package in which this database will generate the Object Models associated with it. This overrides the targetPackage property in the Torque build.properties file.

Attribute: baseClass

The base class to use when generating the Object Model. This class does not have to extend org.apache.turbine.om.BaseObject.

Attribute: basePeer

The base peer to use when generating the Object Model Peers. Unlike baseClass, basePeer should extend BasePeer at some point in the chain, i.e it needs to be the superclass.

Element: table

The table element and its relevant attributes <table name="MY_TABLE" javaName="table" idMethod="idbroker" skipSql="false" baseClass="com.myapp.om.table.BaseClass" basePeer="com.myapp.om.table.BasePeer" javaNamingMethod="underscore" description="Table for Torque tests"> <!-- column information here --> </table> The table element has 13 attributes associated with it, they are: name The name of the table being referenced javaName How this table will be referenced in Java idMethod How will the primary keys be created, defaults to "null" skipSql Whether or not to skip SQL generation for this reference abstract Whether or not to generate the class as Abstract or not baseClass Used for OM Peer generation basePeer Used for OM Peer generation alias The table alias interface ? javaNamingMethod Specifies how the name attribute is converted to the Java class name of the corresponding OM object. This attribute overrides the defaultJavaNamingMethod attribute of the database element heavyIndexing ? (true or false) description Used for doc generation The table element can contain the following elements: column 1 or more foreign-key 0 or more index 0 or more unique 0 or more id-method-parameter 0 or more

Attribute: javaName

This is the Java class name to use when generating the Table or column. If this is missing the Java name is generated in the following manner: Underscores are removed, first letter and first letter after each underscore is uppercased, all other letters are lowercased. So YOUR_TABLE_NAME would become YourTableName.

Element: column

The column element and its relevant attributes <column name="MY_COLUMN" javaName="Column" primaryKey="true" required="true" size="4" type="VARCHAR" javaNamingMethod="underscore"> <!-- inheritance info if necessary --> </column> The column element has 13 attributes associated with it, they are: name The name of the column being referenced javaName How this column will be referred to in Java primaryKey Is this a primary key or not (true or false, defaults to false) required Whether a value is required in this field (true or false, defaults to false) type What type of column is it? Covered below, defaults to VARCHAR javaType The type of the column in Java (object or primitive) size How many characters or digits can be stored? default Default value to insert into field if it is missing. autoIncrement Whether or not to auto-increment this field (true or false, defaults to false) inheritance ? (single or false, defaults to false) inputValidator ? javaNamingMethod Specifies how the name attribute is converted to the Java class name of the corresponding OM object. This attribute overrides the defaultJavaNamingMethod attribute of the database element description Used for doc generation The column element can contain the following elements: inheritance 0 or more

Element: inheritance

The inheritance element and its relevant attributes <inheritance key="key" class="classname" extends="mybase"/> The inheritance element has 3 attributes associated with it, they are: key ? class ? extends ? The inheritance element can not contain other elements.

Element: foreign-key

The foreign-key element and its relevant attributes <foreign-key foreignTable="MY_TABLE" name="MY_TABLE_FK" onUpdate="none" onDelete="none"> <!-- reference info --> </foreign-key> The foreign-key element has 4 attributes associated with it, they are: foreignTable The name of the table being referenced name The name of the foreign key onUpdate The action to take when the referenced value in foreignTable is updated onDelete The action to take when the referenced value in foreignTable is deleted The foreign-key element can contain the following elements: reference 1 or more

Element: reference

The reference element and its relevant attributes <reference local="FK_TABLE_ID" foreign="PK_COLUMN_ID"/> The reference element has 2 attributes associated with it, they are: local The local reference foreign The foreign key reference The reference element can not contain other elements.

Element: index

The index element and its relevant attributes <index name="MY_INDEX"> <!-- index-column info --> </index> The index element has 1 attribute associated with it, it is: name The name of the index The index element can contain the following elements: index-column 1 or more

Element: index-column

The index-column element and its relevant attributes <index-column name="INDEX_COLUMN"/> The index-column element has 2 attributes associated with it, they are: name The name of the indexed column size ? The index-column element can not contain other elements.

Element: unique

The unique element and its relevant attributes <unique name="MY_UNIQUE"> <!-- unique-column info --> </unique> The unique element has 1 attribute associated with it, it is: name The name of the unique constraint The unique element can contain the following elements: unique-column 1 or more

Element: unique-column

The unique-column element and its relevant attributes <index-column name="UNIQUE_COLUMN"/> The unique-column element has 1 attribute associated with it, it is: name The name of the unique column The unique-column element can not contain other elements.