Interface Persistence.SchemaManagementProperties

All Known Implementing Classes:

PersistenceConfiguration

Enclosing class:

Persistence

public static interface Persistence.SchemaManagementProperties

Properties used to control the schema management tooling.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
static final String	SCHEMAGEN_CONNECTION	Supplies a JDBC Connection to use for executing schema management actions on the database.
static final String	SCHEMAGEN_CREATE_SCHEMAS	Specifies whether the persistence provider creates database schemas in addition to creating database objects such as tables, sequences, constraints, and so on.
static final String	SCHEMAGEN_CREATE_SCRIPT_SOURCE	An application-provided SQL script to be executed when the schema is created.
static final String	SCHEMAGEN_CREATE_SOURCE	The source of artifacts to be created.
static final String	SCHEMAGEN_CREATE_TARGET	The provider-generated SQL script which creates the schema when "jakarta.persistence.schema-generation.scripts.action" is set.
static final String	SCHEMAGEN_DATABASE_ACTION	The action to be performed against the database.
static final String	SCHEMAGEN_DROP_SCRIPT_SOURCE	An application-provided SQL script to be executed when the schema is dropped.
static final String	SCHEMAGEN_DROP_SOURCE	The source of artifacts to be dropped.
static final String	SCHEMAGEN_DROP_TARGET	The provider-generated SQL script which drops the schema when "jakarta.persistence.schema-generation.scripts.action" is set.
static final String	SCHEMAGEN_LOAD_SCRIPT_SOURCE	An application-provided SQL script to be executed after the schema is created, typically used for loading data.
static final String	SCHEMAGEN_SCRIPTS_ACTION	The action to be generated as a SQL script.

Field Details

SCHEMAGEN_DATABASE_ACTION

static final String SCHEMAGEN_DATABASE_ACTION

The action to be performed against the database.

Standard actions are: none, create, drop, drop-and-create, validate, populate.

See Also:

• SchemaManagementAction
• PersistenceConfiguration.schemaManagementDatabaseAction(SchemaManagementAction)
• Constant Field Values

SCHEMAGEN_SCRIPTS_ACTION

static final String SCHEMAGEN_SCRIPTS_ACTION

The action to be generated as a SQL script.

The script is generated in the location specified by "jakarta.persistence.schema-generation.scripts.create-target" or "jakarta.persistence.schema-generation.scripts.drop-target".

Standard actions are: none, create, drop, drop-and-create.

See Also:

• SchemaManagementAction
• PersistenceConfiguration.schemaManagementScriptsAction(SchemaManagementAction)
• Constant Field Values

SCHEMAGEN_CREATE_SOURCE

static final String SCHEMAGEN_CREATE_SOURCE

The source of artifacts to be created.

Standard sources are: metadata, script, metadata-then-script, script-then-metadata.

The location of the script source is specified by "jakarta.persistence.schema-generation.create-script-source".

See Also:

• Constant Field Values

SCHEMAGEN_DROP_SOURCE

static final String SCHEMAGEN_DROP_SOURCE

The source of artifacts to be dropped.

Standard sources are: metadata, script, metadata-then-script, script-then-metadata.

The location of the script source is specified by "jakarta.persistence.schema-generation.drop-script-source".

See Also:

• Constant Field Values

SCHEMAGEN_CREATE_SCRIPT_SOURCE

static final String SCHEMAGEN_CREATE_SCRIPT_SOURCE

An application-provided SQL script to be executed when the schema is created.

An instance of Reader or a string specifying the file URL of the DDL script.

See Also:

• Constant Field Values

SCHEMAGEN_DROP_SCRIPT_SOURCE

static final String SCHEMAGEN_DROP_SCRIPT_SOURCE

An application-provided SQL script to be executed when the schema is dropped.

An instance of Reader or a string specifying the file URL of the DDL script.

See Also:

• Constant Field Values

SCHEMAGEN_LOAD_SCRIPT_SOURCE

static final String SCHEMAGEN_LOAD_SCRIPT_SOURCE

An application-provided SQL script to be executed after the schema is created, typically used for loading data.

An instance of Reader or a string specifying the file URL of the DML script.

See Also:

• Constant Field Values

SCHEMAGEN_CREATE_TARGET

static final String SCHEMAGEN_CREATE_TARGET

The provider-generated SQL script which creates the schema when "jakarta.persistence.schema-generation.scripts.action" is set.

An instance of Writer or a string specifying the file URL of the DDL script.

See Also:

• Constant Field Values

SCHEMAGEN_DROP_TARGET

static final String SCHEMAGEN_DROP_TARGET

The provider-generated SQL script which drops the schema when "jakarta.persistence.schema-generation.scripts.action" is set.

An instance of Writer or a string specifying the file URL of the DDL script.

See Also:

• Constant Field Values

SCHEMAGEN_CREATE_SCHEMAS

static final String SCHEMAGEN_CREATE_SCHEMAS

Specifies whether the persistence provider creates database schemas in addition to creating database objects such as tables, sequences, constraints, and so on. The value true specifies that the persistence provider creates schemas in the database or generates DDL containing CREATE SCHEMA commands.

If this property is not supplied, the provider does not create database schemas.

Since:

4.0

See Also:

• Constant Field Values

SCHEMAGEN_CONNECTION

static final String SCHEMAGEN_CONNECTION

Supplies a JDBC Connection to use for executing schema management actions on the database. If not specified, the persistence provider uses the DataSource configured for use by the persistence unit to obtain a JDBC connection.

Since:

4.0

See Also:

• Constant Field Values