Package org.hibernate.boot.model.relational

Interface AuxiliaryDatabaseObject

All Superinterfaces:

Exportable, java.io.Serializable

All Known Implementing Classes:

AbstractAuxiliaryDatabaseObject, NamedAuxiliaryDatabaseObject, SimpleAuxiliaryDatabaseObject

public interface AuxiliaryDatabaseObject
extends Exportable, java.io.Serializable

Auxiliary database objects (i.e., triggers, stored procedures, etc) defined in the mappings. Allows Hibernate to manage their lifecycle as part of creating/dropping the schema.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	AuxiliaryDatabaseObject.Expandable	Additional, optional interface for AuxiliaryDatabaseObject that want to allow expansion of allowable dialects via mapping.

Method Summary

Modifier and Type	Method	Description
boolean	appliesToDialect(Dialect dialect)	Does this database object apply to the given dialect?
boolean	beforeTablesOnCreation()	Defines a simple precedence.
default java.lang.String[]	sqlCreateStrings(SqlStringGenerationContext context)	Gets the SQL strings for creating the database object.
default java.lang.String[]	sqlCreateStrings(Dialect dialect)	Deprecated. Hibernate ORM may never call this method, and implementations cannot properly handle default catalogs/schemas.
default java.lang.String[]	sqlDropStrings(SqlStringGenerationContext context)	Gets the SQL strings for dropping the database object.
default java.lang.String[]	sqlDropStrings(Dialect dialect)	Deprecated. Hibernate ORM may never call this method, and implementations cannot properly handle default catalogs/schemas.

Methods inherited from interface org.hibernate.boot.model.relational.Exportable

getExportIdentifier

Method Detail

appliesToDialect

boolean appliesToDialect(Dialect dialect)

Does this database object apply to the given dialect?

Parameters:

dialect - The dialect to check against.

Returns:

True if this database object does apply to the given dialect.

beforeTablesOnCreation

boolean beforeTablesOnCreation()

Defines a simple precedence. Should creation of this auxiliary object happen before creation of tables? If true, the auxiliary object creation will happen after any explicit schema creations but before table/sequence creations; if false, the auxiliary object creation will happen after explicit schema creations and after table/sequence creations. This precedence is automatically inverted for dropping.

Returns:

true indicates this object should be created before tables; false indicates it should be created after.

sqlCreateStrings

default java.lang.String[] sqlCreateStrings(SqlStringGenerationContext context)

Gets the SQL strings for creating the database object.

Parameters:

context - A context to help generate the SQL creation strings

Returns:

the SQL strings for creating the database object.

sqlCreateStrings

@Deprecated
default java.lang.String[] sqlCreateStrings(Dialect dialect)

Deprecated.

Hibernate ORM may never call this method, and implementations cannot properly handle default catalogs/schemas. Call/implement sqlCreateStrings(SqlStringGenerationContext) instead.

Gets the SQL strings for creating the database object.

Parameters:

dialect - The dialect for which to generate the SQL creation strings

Returns:

the SQL strings for creating the database object.

sqlDropStrings

default java.lang.String[] sqlDropStrings(SqlStringGenerationContext context)

Gets the SQL strings for dropping the database object.

Parameters:

context - A context to help generate the SQL drop strings

Returns:

the SQL strings for dropping the database object.

sqlDropStrings

@Deprecated
default java.lang.String[] sqlDropStrings(Dialect dialect)

Deprecated.

Hibernate ORM may never call this method, and implementations cannot properly handle default catalogs/schemas. Call/implement sqlDropStrings(SqlStringGenerationContext) instead.

Gets the SQL strings for dropping the database object.

Parameters:

dialect - The dialect for which to generate the SQL drop strings

Returns:

the SQL strings for dropping the database object.