The DDL Generator has a number of different options which may be set. Some of them are specified at the command line while others need to be configured through a property file. Most of the options are located in global properties file org/castor/ddlgen/ddlgen.properties, but there are also some options that are specific for one database engine. These DB-specific properties can be found at org/castor/ddlgen/engine/<database>/<database>.properties.

The DDL Generator supports generation of SQL scripts for the following database engines:

Please find below the complete list of parameters that can be set on the Castor source generator.

Alternatively to specifying the file property, it is possible to work with a nested <FileSet> element or with the dir property.

Below is an example of how to use this task from within an Ant target definition named 'castor:ddl:src':

<target name="castor:ddl:src" depends="init"
           description="Generate a DDL script from a JDO mapping file.">

  <taskdef name="castor-ddlgen"
           classname="org.castor.anttask.CastorDDLGenTask"
           classpathref="castor.class.path" />
  <mkdir dir="generated" />
  <castor-ddlgen file="src/main/resources/mapping.xml"
                 ddlFileName="target/generated/ddl/mapping.sql"
                 databaseEngine="mysql"/>
</target>
		

The following JDBC types are not supported by Castor yet.

At startup, the DDL Generator first evaluates the command line options. Next it loads the global properties on the command line if specified, otherwise the default properties included with the DDL Generator. There are two important properties loaded at startup:

The last step at startup is to read the specific configuration of the database engine being used. A custom configuration can be provided on the command line to override the default.

Please find below a list of global properties to control various advanced options of the DDL Generator.

#
# generator classes of supported database engines
#
org.castor.ddlgen.Generators=\
  org.castor.ddlgen.engine.db2.Db2Generator,\
  org.castor.ddlgen.engine.derby.DerbyGenerator,\
  org.castor.ddlgen.engine.hsql.HsqlGenerator,\
  org.castor.ddlgen.engine.mssql.MssqlGenerator,\
  org.castor.ddlgen.engine.mysql.MysqlGenerator,\
  org.castor.ddlgen.engine.oracle.OracleGenerator,\
  org.castor.ddlgen.engine.pointbase.PointBaseGenerator,\
  org.castor.ddlgen.engine.postgresql.PostgresqlGenerator,\
  org.castor.ddlgen.engine.sapdb.SapdbGenerator,\
  org.castor.ddlgen.engine.sybase.SybaseGenerator
			

drop A if exist
create A(IDA int);
alter table A add primary key (IDA)

drop B if exist
create B(IDB int);
alter table B add primary key (IDB)
			

drop A if exist
drop B if exist

create A(IDA int);
create B(IDB int);

alter table A add primary key (IDA)
alter table B add primary key (IDB)
			

Below you can find a list of specific properties to control various advanced options of the DDL Generator.

#
# key generator factory classes of supported database engines
#
org.castor.ddlgen.KeyGeneratorFactories=\
  org.castor.ddlgen.keygenerator.HighLowKeyGeneratorFactory,\
  org.castor.ddlgen.keygenerator.MaxKeyGeneratorFactory,\
  org.castor.ddlgen.keygenerator.UUIDKeyGeneratorFactory,\
  org.castor.ddlgen.engine.oracle.OracleSequenceKeyGeneratorFactory
				

#
# trigger template
#
org.castor.ddlgen.TriggerTemplate=\
CREATE TRIGGER <trigger_name>
  BEFORE INSERT OR UPDATE ON <table_name>
  FOR EACH ROW
  DECLARE
    iCounter <table_name>.<pk_name>%TYPE;
    cannot_change_counter EXCEPTION;
  BEGIN
    IF INSERTING THEN
      Select <sequence_name>.NEXTVAL INTO iCounter FROM Dual;
      :new.<pk_name> := iCounter;
    END IF;

    IF UPDATING THEN
      IF NOT (:new.<pk_name> = :old.<pk_name>) THEN
        RAISE cannot_change_counter;
      END IF;
    END IF;

EXCEPTION
  WHEN cannot_change_counter THEN
    raise_application_error(-20000, 'Cannot Change Counter Value');
END;