public interface DatabaseStructure extends ExportableProducer
Encapsulates definition of the underlying data structure backing a sequence-style generator.
Modifier and Type | Method and Description |
---|---|
AccessCallback |
buildCallback(SharedSessionContractImplementor session)
A callback to be able to get the next value from the underlying
structure as needed.
|
int |
getIncrementSize()
The configured increment size
|
int |
getInitialValue()
The configured initial value
|
String |
getName()
The name of the database structure (table or sequence).
|
int |
getTimesAccessed()
How many times has this structure been accessed through this reference?
|
boolean |
isPhysicalSequence()
Is the structure physically a sequence?
|
void |
prepare(Optimizer optimizer)
Prepare this structure for use.
|
String[] |
sqlCreateStrings(Dialect dialect)
Commands needed to create the underlying structures.
|
String[] |
sqlDropStrings(Dialect dialect)
Commands needed to drop the underlying structures.
|
registerExportables
String getName()
The name of the database structure (table or sequence).
int getTimesAccessed()
How many times has this structure been accessed through this reference?
int getInitialValue()
The configured initial value
int getIncrementSize()
The configured increment size
AccessCallback buildCallback(SharedSessionContractImplementor session)
A callback to be able to get the next value from the underlying structure as needed.
session
- The session.void prepare(Optimizer optimizer)
Prepare this structure for use. Called sometime after instantiation, but before first use.
optimizer
- The optimizer being applied to the generator.String[] sqlCreateStrings(Dialect dialect)
Commands needed to create the underlying structures.
dialect
- The database dialect being used.String[] sqlDropStrings(Dialect dialect)
Commands needed to drop the underlying structures.
dialect
- The database dialect being used.boolean isPhysicalSequence()
Is the structure physically a sequence?
true
if the actual database structure is a sequence; false
otherwise.Copyright © 2001-2018 Red Hat, Inc. All Rights Reserved.