Class DefaultTemporalTableSupport

java.lang.Object

org.hibernate.dialect.temporal.DefaultTemporalTableSupport

All Implemented Interfaces:

TemporalTableSupport

Direct Known Subclasses:

DB2TemporalTableSupport, MySQLTemporalTableSupport, OracleTemporalTableSupport, PostgreSQLTemporalTableSupport, SQLServerTemporalTableSupport

public class DefaultTemporalTableSupport
extends Object
implements TemporalTableSupport

Constructor Summary

Constructors

Constructor	Description
DefaultTemporalTableSupport(Dialect dialect)

Method Summary

Modifier and Type	Method	Description
void	addTemporalTableAuxiliaryObjects(TemporalTableStrategy strategy, Table table, Database database, boolean partitioned, String currentPartitionName, String historyPartitionName)	Register any auxiliary database objects required for the given temporary table and strategy.
boolean	createTemporalTableCheckConstraint(TemporalTableStrategy strategy)	Should we create a check constraint to enforce effectivity constraints? (That starting timestamps precede ending timestamps.) This is typically not needed for native temporal tables.
String	getAsOfOperator(TemporalTableStrategy strategy)	The operator used to specify a temporal instant for querying historical data.
TemporalTableStrategy	getDefaultTemporalTableStrategy()	The recommended temporal table strategy for this dialect.
String	getExtraTemporalTableDeclarations(TemporalTableStrategy strategy, String rowStartColumn, String rowEndColumn, boolean partitioned)	Any extra declarations required as part of the create table statement for a temporal table.
int	getTemporalColumnPrecision()	The column precision to use for effectivity columns of native temporal tables when the precision is not explicitly specified.
int	getTemporalColumnType()	The column type to use for effectivity columns of temporal tables.
String	getTemporalExclusionColumnOption()	Column options for a native implementation of exclusion from temporal versioning.
String	getTemporalTableOptions(TemporalTableStrategy strategy, String rowEndColumnName, boolean partitioned, String currentPartitionName, String historyPartitionName)	Table options to use for temporal tables, used to specify system versioning or table partitioning.
boolean	supportsNativeTemporalTables()	Does this dialect natively support SQL 2011-style temporal tables?
boolean	supportsTemporalTablePartitioning()	Do we support partitioning temporal tables in this dialect?
boolean	suppressesTemporalTablePrimaryKeys(boolean partitioned)	Do we need to suppress creation of the primary key constraint on a temporal table?
boolean	useAsOfOperator(TemporalTableStrategy strategy)	Should be use the for system_time as of operator when querying temporal tables? We usually only use it for querying native temporal tables at a historical instant, but in Oracle we use it all the time.
boolean	useTemporalRestriction(LoadQueryInfluencers influencers)	Should we use temporal restrictions on the row start and row end columns when querying temporal tables? We usually use them unless we are using native temporal tables, but on Oracle we never use them.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

DefaultTemporalTableSupport

public DefaultTemporalTableSupport(Dialect dialect)

Method Details

supportsNativeTemporalTables

public boolean supportsNativeTemporalTables()

Description copied from interface: TemporalTableSupport

Does this dialect natively support SQL 2011-style temporal tables?

Specified by:

supportsNativeTemporalTables in interface TemporalTableSupport

See Also:

• TemporalTableStrategy.NATIVE

getTemporalColumnType

public int getTemporalColumnType()

Description copied from interface: TemporalTableSupport

The column type to use for effectivity columns of temporal tables. The default implementation returns TIMESTAMP.

Specified by:

getTemporalColumnType in interface TemporalTableSupport

getTemporalColumnPrecision

public int getTemporalColumnPrecision()

Description copied from interface: TemporalTableSupport

The column precision to use for effectivity columns of native temporal tables when the precision is not explicitly specified. The default implementation returns the default timestamp precision for this dialect.

Specified by:

getTemporalColumnPrecision in interface TemporalTableSupport

See Also:

• Temporal.secondPrecision()

getTemporalTableOptions

public String getTemporalTableOptions(TemporalTableStrategy strategy,
 String rowEndColumnName,
 boolean partitioned,
 String currentPartitionName,
 String historyPartitionName)

Description copied from interface: TemporalTableSupport

Table options to use for temporal tables, used to specify system versioning or table partitioning.

Specified by:

getTemporalTableOptions in interface TemporalTableSupport

Parameters:

strategy - The temporal table strategy

rowEndColumnName - The name of the row end column specified via Temporal.rowEnd()

partitioned - Is partitioning requested

currentPartitionName - The current partition name, if specified

historyPartitionName - The history partition name, if specified

Returns:

The options, or null if there are no options

suppressesTemporalTablePrimaryKeys

public boolean suppressesTemporalTablePrimaryKeys(boolean partitioned)

Description copied from interface: TemporalTableSupport

Do we need to suppress creation of the primary key constraint on a temporal table?

Specified by:

suppressesTemporalTablePrimaryKeys in interface TemporalTableSupport

Parameters:

partitioned - Is partitioning requested

supportsTemporalTablePartitioning

public boolean supportsTemporalTablePartitioning()

Description copied from interface: TemporalTableSupport

Do we support partitioning temporal tables in this dialect?

Specified by:

supportsTemporalTablePartitioning in interface TemporalTableSupport

See Also:

• Temporal.HistoryPartitioning

addTemporalTableAuxiliaryObjects

public void addTemporalTableAuxiliaryObjects(TemporalTableStrategy strategy,
 Table table,
 Database database,
 boolean partitioned,
 String currentPartitionName,
 String historyPartitionName)

Description copied from interface: TemporalTableSupport

Register any auxiliary database objects required for the given temporary table and strategy. Used to create history tables or table partitions.

Specified by:

addTemporalTableAuxiliaryObjects in interface TemporalTableSupport

Parameters:

strategy - The temporal table strategy

table - A temporal table

database - The database to register with

partitioned - Is partitioning requested

currentPartitionName - The current partition name, if specified

historyPartitionName - The history partition name, if specified

getExtraTemporalTableDeclarations

public String getExtraTemporalTableDeclarations(TemporalTableStrategy strategy,
 String rowStartColumn,
 String rowEndColumn,
 boolean partitioned)

Description copied from interface: TemporalTableSupport

Any extra declarations required as part of the create table statement for a temporal table. These declarations, unlike the options come inside the parentheses, along with the column and constraint definitions. Examples include the period for system_time clause, the Db2 transaction start id column, the MySQL partitioning column, and so on.

Specified by:

getExtraTemporalTableDeclarations in interface TemporalTableSupport

Parameters:

strategy - The temporal table strategy

partitioned - Is partitioning requested

createTemporalTableCheckConstraint

public boolean createTemporalTableCheckConstraint(TemporalTableStrategy strategy)

Description copied from interface: TemporalTableSupport

Should we create a check constraint to enforce effectivity constraints? (That starting timestamps precede ending timestamps.) This is typically not needed for native temporal tables.

Specified by:

createTemporalTableCheckConstraint in interface TemporalTableSupport

getAsOfOperator

public String getAsOfOperator(TemporalTableStrategy strategy)

Description copied from interface: TemporalTableSupport

The operator used to specify a temporal instant for querying historical data. Usually for system_time as of. This is usually used together with native temporal tables, but in Oracle we use it all the time.

Specified by:

getAsOfOperator in interface TemporalTableSupport

useAsOfOperator

public boolean useAsOfOperator(TemporalTableStrategy strategy)

Description copied from interface: TemporalTableSupport

Should be use the for system_time as of operator when querying temporal tables? We usually only use it for querying native temporal tables at a historical instant, but in Oracle we use it all the time.

Specified by:

useAsOfOperator in interface TemporalTableSupport

Parameters:

strategy - The strategy

useTemporalRestriction

public boolean useTemporalRestriction(LoadQueryInfluencers influencers)

Description copied from interface: TemporalTableSupport

Should we use temporal restrictions on the row start and row end columns when querying temporal tables? We usually use them unless we are using native temporal tables, but on Oracle we never use them.

Specified by:

useTemporalRestriction in interface TemporalTableSupport

Parameters:

influencers - The LoadQueryInfluencers

getTemporalExclusionColumnOption

public String getTemporalExclusionColumnOption()

Description copied from interface: TemporalTableSupport

Column options for a native implementation of exclusion from temporal versioning.

Specified by:

getTemporalExclusionColumnOption in interface TemporalTableSupport

getDefaultTemporalTableStrategy

public TemporalTableStrategy getDefaultTemporalTableStrategy()

Description copied from interface: TemporalTableSupport

The recommended temporal table strategy for this dialect.

Specified by:

getDefaultTemporalTableStrategy in interface TemporalTableSupport

See Also:

• TemporalTableStrategy.AUTO