Top Description Inners Methods
org.hibernate.boot.model.relational

public Interface AuxiliaryDatabaseObject

extends Exportable, Serializable
Known Direct Implementers
org.hibernate.boot.model.relational.AbstractAuxiliaryDatabaseObject
Imports
java.io.Serializable, org.hibernate.dialect.Dialect
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.
Author
Steve Ebersole

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static interface
AuxiliaryDatabaseObject.Expandable

Additional, optional interface for AuxiliaryDatabaseObject that want to allow expansion of allowable dialects via mapping.

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

True if this database object does apply to the given dialect.
appliesToDialect(Dialect
The dialect to check against.
dialect)

Does this database object apply to the given dialect?

public boolean

Returns:

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

Defines a simple precedence.

public default String[]

Returns:

the SQL strings for creating the database object.
sqlCreateStrings(SqlStringGenerationContext
A context to help generate the SQL creation strings
context)

Gets the SQL strings for creating the database object.

public default String[]

Returns:

the SQL strings for creating the database object.
sqlCreateStrings(Dialect
The dialect for which to generate the SQL creation strings
dialect)

Deprecated Hibernate ORM may never call this method, and implementations cannot properly handle default catalogs/schemas.
Gets the SQL strings for creating the database object.
public default String[]

Returns:

the SQL strings for dropping the database object.
sqlDropStrings(SqlStringGenerationContext
A context to help generate the SQL drop strings
context)

Gets the SQL strings for dropping the database object.

public default String[]

Returns:

the SQL strings for dropping the database object.
sqlDropStrings(Dialect
The dialect for which to generate the SQL drop strings
dialect)

Deprecated Hibernate ORM may never call this method, and implementations cannot properly handle default catalogs/schemas.
Gets the SQL strings for dropping the database object.
Inherited from org.hibernate.boot.model.relational.Exportable:
getExportIdentifier

Method Detail

appliesToDialectback to summary
public boolean appliesToDialect(Dialect dialect)

Does this database object apply to the given dialect?

Parameters
dialect:Dialect

The dialect to check against.

Returns:boolean

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

beforeTablesOnCreationback to summary
public 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:boolean

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

sqlCreateStringsback to summary
public default String[] sqlCreateStrings(SqlStringGenerationContext context)

Gets the SQL strings for creating the database object.

Parameters
context:SqlStringGenerationContext

A context to help generate the SQL creation strings

Returns:String[]

the SQL strings for creating the database object.

sqlCreateStringsback to summary
public default 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:Dialect

The dialect for which to generate the SQL creation strings

Returns:String[]

the SQL strings for creating the database object.

Annotations
@Deprecated
sqlDropStringsback to summary
public default String[] sqlDropStrings(SqlStringGenerationContext context)

Gets the SQL strings for dropping the database object.

Parameters
context:SqlStringGenerationContext

A context to help generate the SQL drop strings

Returns:String[]

the SQL strings for dropping the database object.

sqlDropStringsback to summary
public default 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:Dialect

The dialect for which to generate the SQL drop strings

Returns:String[]

the SQL strings for dropping the database object.

Annotations
@Deprecated
org.hibernate.boot.model.relational back to summary

public Interface AuxiliaryDatabaseObject.Expandable

Known Direct Implementers
org.hibernate.boot.model.relational.AbstractAuxiliaryDatabaseObject
Additional, optional interface for AuxiliaryDatabaseObject that want to allow expansion of allowable dialects via mapping.

Method Summary

Modifier and TypeMethod and Description
public void
addDialectScope(String dialectName)

Method Detail

addDialectScopeback to summary
public void addDialectScope(String dialectName)