public interface DatabaseStructure extends ExportableProducer
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.
|
default void |
configure(Optimizer optimizer)
Configures this structure with the given arguments.
|
default String[] |
getAllSqlForTests()
Deprecated.
Exposed for tests only.
|
int |
getIncrementSize()
The configured increment size
|
int |
getInitialValue()
The configured initial value
|
QualifiedName |
getPhysicalName()
The physical name of the database structure (table or sequence).
|
int |
getTimesAccessed()
How many times has this structure been accessed through this reference?
|
default void |
initialize(SqlStringGenerationContext context)
Initializes this structure, in particular pre-generates SQL as necessary.
|
boolean |
isPhysicalSequence()
Is the structure physically a sequence?
|
default void |
prepare(Optimizer optimizer)
Deprecated.
Use
configure(Optimizer) instead. |
void |
registerExportables(Database database)
Register database objects involved in this structure, e.g.
|
QualifiedName getPhysicalName()
Only available after registerExportables(Database)
has been called.
int getTimesAccessed()
int getInitialValue()
int getIncrementSize()
AccessCallback buildCallback(SharedSessionContractImplementor session)
session
- The session.@Deprecated default void prepare(Optimizer optimizer)
configure(Optimizer)
instead.optimizer
- The optimizer being applied to the generator.default void configure(Optimizer optimizer)
Called just after instantiation, before initialize(SqlStringGenerationContext)
optimizer
- The optimizer being applied to the generator.void registerExportables(Database database)
This method is called just once, after configure(Optimizer)
,
but before initialize(SqlStringGenerationContext)
.
registerExportables
in interface ExportableProducer
database
- The database instancedefault void initialize(SqlStringGenerationContext context)
This method is called just once, after registerExportables(Database)
,
before first use.
context
- A context to help generate SQL stringsboolean isPhysicalSequence()
true
if the actual database structure is a sequence; false
otherwise.@Deprecated default String[] getAllSqlForTests()
Copyright © 2001-2021 Red Hat, Inc. All Rights Reserved.