Using CA Service Virtualization › Installation and Configuration › DDLs for Major Databases › EclipseLink Properties for Schema

EclipseLink Properties for Schema

You can define the EclipseLink JPA persistence unit properties in a persistence.xml file to configure schema generation.

eclipselink.ddl-generation

Specifies the Data Definition Language (DDL) generation action to use for your JPA entities. To specify the DDL generation target, see eclipselink.ddl-generation.output-mode.

Values:

You can use the following values in a persistence.xml file:

• none: EclipseLink does not generate a DDL; no schema is generated.
• create-tables: EclipseLink tries to execute a CREATE TABLE SQL command for each table. When you issue a CREATE TABLE SQL command for an existing table, EclipseLink follows the default behavior of your specific database and JDBC driver combination. In most cases, an exception is thrown, the table is not created, and EclipseLink continues with the next statement.
• drop-and-create-tables – EclipseLink tries to DROP all tables, then CREATE all tables. If EclipseLink encounters issues, it follows the default behavior of your specific database and JDBC driver combination. EclipseLink then continues with the next statement.

The following values are valid for the org.eclipse.persistence.config.PersistenceUnitProperties:

• NONE
• CREATE_ONLY
• DROP_AND_CREATE

If you use persistence in a Java SE environment and you want to create the DDL files without creating tables, define a Java system property INTERACT_WITH_DB and set the value to false.

Default: One of the following:

• None
• PersistenceUnitProperties.NONE

Example:

persistence.xml file<property value="create-tables"/>Example: property Mapimport org.eclipse.persistence.config.PersistenceUnitProperties;propertiesMap.put(PersistenceUnitProperties.DDL_GENERATION, PersistenceUnitProperties.CREATE_ONLY);

eclipselink.application-location

Specifies where EclipseLink writes generated DDL files. Files are written if you set eclipselink.ddl-generation to anything other than none.

Value: A file specification to a directory in which you have write access. The file specification can be relative to your current working directory or absolute. If it does not end in a file separator, EclipseLink appends one that is valid for your operating system.

Default: One of the following:

"."+File.separator

or

<tt>PersistenceUnitProperties.DEFAULT_APP_LOCATION</tt>

Example:

persistence.xml file<property value="C:\ddl\"/>Example: property Mapimport org.eclipse.persistence.config.PersistenceUnitProperties;propertiesMap.put(PersistenceUnitProperties.APP_LOCATION, "C:\ddl\");

eclipselink.create-ddl-jdbc-file-name

Specifies the file name of the DDL file that EclipseLink generates containing SQL statements to create tables for JPA entities. This file is written to the location specified by eclipselink.application-location when eclipselink.ddl-generation is set to create-tables or drop-and-create-tables.

Values: A file name valid for your operating system. Optionally, if the concatenation of eclipselink.application-location with eclipselink.create-ddl-jdbc-file-name is a valid file specification for your operating system, you can prefix the file name with a file path.

Default: One of the following:

• createDDL.jdbc

or

• PersistenceUnitProperties.DEFAULT_CREATE_JDBC_FILE_NAME

Example:

persistence.xml file<property value="create.sql"/> Example: property Mapimport org.eclipse.persistence.config.PersistenceUnitProperties;propertiesMap.put(PersistenceUnitProperties.CREATE_JDBC_DDL_FILE, "create.sql");

eclipselink.drop-ddl-jdbc-file-name

Specifies the file name of the DDL file that EclipseLink generates containing the SQL statements to drop tables for JPA entities. This file is written to the location specified by eclipselink.application-location when eclipselink.ddl-generation is set to drop-and-create-tables.

Values: A file name valid for your operating system. Optionally, if the concatenation of eclipselink.application-location with eclipselink.drop-ddl-jdbc-file-name is a valid file specification for your operating system, you can prefix the file name with a file path.

Default: One of the following:

• dropDDL.jdbc

or

• PersistenceUnitProperties.DEFAULT_DROP_JDBC_FILE_NAME

Example:

persistence.xml file<property value="drop.sql"/>Example: property Mapimport org.eclipse.persistence.config.PersistenceUnitProperties;propertiesMap.put(PersistenceUnitProperties.DROP_JDBC_DDL_FILE, "drop.sql");

eclipselink.ddl-generation.output-mode

Defines the DDL generation target.

Values:

The valid values for the use in the persistence.xml file are:

both:

• Generate the SQL files and execute them on the database.

  If eclipselink.ddl-generation is set to "create-tables," eclipselink.create-ddl-jdbc-file-name is written to eclipselink.application-location and then executes on the database.

  If eclipselink.ddl-generation is set to "drop-and-create-tables," both eclipselink.create-ddl-jdbc-file-name and eclipselink.drop-ddl-jdbc-file-name are written to eclipselink.application-location. Both SQL files execute on the database.

database:

• Execute SQL on the database only (do not generate the SQL files).

sql-script:

• Generate the SQL files only (do not execute them on the database).

  If eclipselink.ddl-generation is set to "create-tables," then eclipselink.create-ddl-jdbc-file-name is written to eclipselink.application-location. The command does not execute on the database.

  If eclipselink.ddl-generation is set to "drop-and-create-tables," both eclipselink.create-ddl-jdbc-file-name and eclipselink.drop-ddl-jdbc-file-name are written to eclipselink.application-location. Neither is executed on the database. The following values are valid for the org.eclipse.persistence.config.PersistenceUnitProperties:

  • DDL_BOTH_GENERATION – see both.
  • DDL_DATABASE_GENERATION – see the database.
  • DDL_SQL_SCRIPT_GENERATION – see sql-script.

Default: The default for Container or Java EE mode is {{database}},

Example:

persistence.xml file<property value="database"/>Example: property Mapimport org.eclipse.persistence.config.PersistenceUnitProperties;propertiesMap.put(PersistenceUnitProperties.DDL_GENERATION_MODE, PersistenceUnitProperties.DDL_DATABASE_GENERATION);

Note: Override this setting by containers with specific EclipseLink support. See your container documentation for details. Bootstrap or Java SE mode: both or PersistenceUnitProperties.DDL_BOTH_GENERATION.