public abstract class AbstractDatabase extends Object implements Database
Database.Filter| Modifier | Constructor and Description |
|---|---|
protected |
AbstractDatabase() |
| Modifier and Type | Method and Description |
|---|---|
void |
addFilter(Database.Filter filter)
[#3488] Add an additional filter to the database that is applied in
addition to include / exclude.
|
DSLContext |
create()
Create the factory for this database.
|
protected abstract DSLContext |
create0()
Create a new Factory
|
boolean |
dateAsTimestamp()
Whether DATE columns should be treated as TIMESTAMP columns.
|
boolean |
exists(Table<?> table)
Check for the existence of a table in the dictionary views.
|
protected static String |
fetchedSize(List<?> fetched,
List<?> included) |
<T extends Definition> |
filterExcludeInclude(List<T> definitions)
Filter a list of definitions according to the exclude / include / and filter settings of this database.
|
protected <T extends Definition> |
filterExcludeInclude(List<T> definitions,
String[] e,
String[] i,
List<Database.Filter> f) |
protected <T extends Definition> |
filterSchema(List<T> definitions,
SchemaDefinition schema) |
protected <T extends Definition> |
filterSchema(List<T> definitions,
SchemaDefinition schema,
Map<SchemaDefinition,List<T>> cache) |
ArrayDefinition |
getArray(SchemaDefinition schema,
String name)
Get a ARRAY defined in this database by name.
|
ArrayDefinition |
getArray(SchemaDefinition schema,
String name,
boolean ignoreCase)
Get a ARRAY defined in this database by name.
|
List<ArrayDefinition> |
getArrays(SchemaDefinition schema)
The Arrays defined in this database.
|
protected abstract List<ArrayDefinition> |
getArrays0()
Retrieve ALL ARRAYs from the database.
|
List<CheckConstraintDefinition> |
getCheckConstraints(SchemaDefinition schema)
The check constraints contained in this database.
|
CustomType |
getConfiguredCustomType(String typeName)
Get a specific configured custom type by its name.
|
List<CustomType> |
getConfiguredCustomTypes()
Database objects matching any of these field names will be generated as
custom types.
|
List<EnumType> |
getConfiguredEnumTypes()
Database objects matching any of these field names will be generated as
enum types.
|
ForcedType |
getConfiguredForcedType(Definition definition)
Get the configured forced type object for any given
Definition,
or null if no ForcedType matches the definition. |
ForcedType |
getConfiguredForcedType(Definition definition,
DataTypeDefinition definedType)
Get the configured forced type object for any given
Definition,
or null if no ForcedType matches the definition. |
List<ForcedType> |
getConfiguredForcedTypes()
Database objects matching any of these field names will be generated as
forced types.
|
Connection |
getConnection()
The database connection.
|
protected DataTypeDefinition |
getDataTypeForMAX_VAL(SchemaDefinition schema,
BigInteger value)
Get the data type considering a known max value
|
protected static <D extends Definition> |
getDefinition(List<D> definitions,
String name,
boolean ignoreCase) |
SQLDialect |
getDialect()
Get the dialect for this database.
|
EnumDefinition |
getEnum(SchemaDefinition schema,
String name)
Get an enum UDT defined in this database by name.
|
EnumDefinition |
getEnum(SchemaDefinition schema,
String name,
boolean ignoreCase)
Get an enum UDT defined in this database by name.
|
List<EnumDefinition> |
getEnums(SchemaDefinition schema)
The enum UDTs defined in this database.
|
protected abstract List<EnumDefinition> |
getEnums0()
Retrieve ALL enum UDTs from the database.
|
String[] |
getExcludes()
Database objects matching any of these regular expressions will not be
generated.
|
List<Database.Filter> |
getFilters()
[#3488] The filters that are applied in addition to include / exclude.
|
List<ForeignKeyDefinition> |
getForeignKeys(SchemaDefinition schema)
The foreign keys contained in this database.
|
List<IdentityDefinition> |
getIdentities(SchemaDefinition schema)
The identities contained in this database.
|
boolean |
getIncludeExcludeColumns()
Indicate whether include / exclude regular expression shall also match
database columns.
|
String[] |
getIncludes()
Only database objects matching any of these regular expressions will be
generated.
|
List<String> |
getInputSchemata()
The input schemata are the schemata that jooq-meta is reading data from.
|
String |
getOutputSchema(String inputSchema)
Deprecated.
|
String[] |
getOverridePrimaryKeys()
Unique keys matching these regular expressions will be considered as
primary keys in generated code.
|
List<PackageDefinition> |
getPackages(SchemaDefinition schema)
The packages contained in this database.
|
protected abstract List<PackageDefinition> |
getPackages0()
Retrieve ALL packages from the database.
|
Properties |
getProperties() |
String[] |
getRecordTimestampFields()
Table columns matching these regular expressions will be considered as
record timestamp fields in generated code.
|
String[] |
getRecordVersionFields()
Table columns matching these regular expressions will be considered as
record version fields in generated code.
|
List<RegexFlag> |
getRegexFlags()
The regular expression flags that should be applied when using regular expressions.
|
Relations |
getRelations()
Retrieve the schema's primary key / foreign key relations.
|
protected Relations |
getRelations0()
Retrieve ALL relations from the database.
|
List<RoutineDefinition> |
getRoutines(SchemaDefinition schema)
The stored routines (procedures and functions) contained in this
database.
|
protected abstract List<RoutineDefinition> |
getRoutines0()
Retrieve ALL stored routines (functions and procedures) from the
database.
|
SchemaDefinition |
getSchema(String inputName)
Get a schema defined in this database by name.
|
List<SchemaDefinition> |
getSchemata()
The schemata generated from this database.
|
protected abstract List<SchemaDefinition> |
getSchemata0()
Retrieve ALL schemata from the database.
|
SchemaVersionProvider |
getSchemaVersionProvider() |
List<SequenceDefinition> |
getSequences(SchemaDefinition schema)
The sequences contained in this database.
|
protected abstract List<SequenceDefinition> |
getSequences0()
Retrieve ALL sequences from the database.
|
String[] |
getSyntheticPrimaryKeys()
Columns matching these regular expressions will be considered as members
of synthetic primary keys in generated code.
|
TableDefinition |
getTable(SchemaDefinition schema,
String name)
Get a table in this database by name.
|
TableDefinition |
getTable(SchemaDefinition schema,
String name,
boolean ignoreCase)
Get a table in this database by name.
|
List<TableDefinition> |
getTables(SchemaDefinition schema)
The tables contained in this database.
|
protected abstract List<TableDefinition> |
getTables0()
Retrieve ALL tables from the database.
|
UDTDefinition |
getUDT(SchemaDefinition schema,
String name)
Get a UDT defined in this database by name.
|
UDTDefinition |
getUDT(SchemaDefinition schema,
String name,
boolean ignoreCase)
Get a UDT defined in this database by name.
|
List<UDTDefinition> |
getUDTs(SchemaDefinition schema)
The UDTs defined in this database.
|
protected abstract List<UDTDefinition> |
getUDTs0()
Retrieve ALL UDTs from the database.
|
List<UniqueKeyDefinition> |
getUniqueKeys(SchemaDefinition schema)
The unique keys contained in this database.
|
boolean |
ignoreProcedureReturnValues()
Whether this database should ignore procedure return values.
|
boolean |
includeRelations()
[#3559] Whether relations (i.e. constraints) should be included in this database.
|
boolean |
isArrayType(String dataType)
Check whether a type is an array type.
|
protected abstract void |
loadCheckConstraints(DefaultRelations r)
Retrieve
CHECK constraints and store them to relations. |
protected abstract void |
loadForeignKeys(DefaultRelations r)
Retrieve foreign keys and store them to relations.
|
protected abstract void |
loadPrimaryKeys(DefaultRelations r)
Retrieve primary keys and store them to relations
|
protected abstract void |
loadUniqueKeys(DefaultRelations r)
Retrieve non-primary unique keys and store them to relations
|
void |
setConfiguredCustomTypes(List<CustomType> configuredCustomTypes)
Database objects matching any of these field names will be generated as
custom types.
|
void |
setConfiguredEnumTypes(List<EnumType> configuredEnumTypes)
Database objects matching any of these field names will be generated as
enum types.
|
void |
setConfiguredForcedTypes(List<ForcedType> configuredForcedTypes)
Database objects matching any of these field names will be generated as
forced types.
|
void |
setConfiguredSchemata(List<Schema> schemata)
The input and output schemata.
|
void |
setConnection(Connection connection)
Initialise a connection to this database.
|
void |
setDateAsTimestamp(boolean dateAsTimestamp)
Whether DATE columns should be treated as TIMESTAMP columns.
|
void |
setExcludes(String[] excludes)
Database objects matching any of these regular expressions will not be
generated.
|
void |
setIgnoreProcedureReturnValues(boolean ignoreProcedureReturnValues)
Whether this database should ignore procedure return values.
|
void |
setIncludeExcludeColumns(boolean includeExcludeColumns)
Indicate whether include / exclude regular expression shall also match
database columns.
|
void |
setIncludeRelations(boolean includeRelations)
[#3559] Whether relations (i.e. constraints) should be included in this database.
|
void |
setIncludes(String[] includes)
Only database objects matching any of these regular expressions will be
generated.
|
void |
setOverridePrimaryKeys(String[] overridePrimaryKeys)
Unique keys matching these regular expressions will be considered as
primary keys in generated code.
|
void |
setProperties(Properties properties)
Database properties.
|
void |
setRecordTimestampFields(String[] recordTimestampFields)
Table columns matching these regular expressions will be considered as
record timestamp fields in generated code.
|
void |
setRecordVersionFields(String[] recordVersionFields)
Table columns matching these regular expressions will be considered as
record version fields in generated code.
|
void |
setRegexFlags(List<RegexFlag> regexFlags)
The regular expression flags that should be applied when using regular expressions.
|
void |
setSchemaVersionProvider(SchemaVersionProvider schemaVersionProvider) |
void |
setSupportsUnsignedTypes(boolean supportsUnsignedTypes)
Whether this database supports unsigned types.
|
void |
setSyntheticPrimaryKeys(String[] syntheticPrimaryKeys)
Columns matching these regular expressions will be considered as members
of synthetic primary keys in generated code.
|
boolean |
supportsUnsignedTypes()
Whether this database supports unsigned types.
|
public final SQLDialect getDialect()
DatabasegetDialect in interface Databasepublic final void setConnection(Connection connection)
DatabasesetConnection in interface Databasepublic final Connection getConnection()
DatabasegetConnection in interface Databasepublic final DSLContext create()
Databasepublic final boolean exists(Table<?> table)
Databasepublic final List<SchemaDefinition> getSchemata()
DatabasegetSchemata in interface Databasepublic final SchemaDefinition getSchema(String inputName)
Databasepublic final List<String> getInputSchemata()
DatabasegetInputSchemata in interface Database@Deprecated public String getOutputSchema(String inputSchema)
DatabasegetOutputSchema in interface Databasepublic final void setConfiguredSchemata(List<Schema> schemata)
DatabasesetConfiguredSchemata in interface Databasepublic final void setProperties(Properties properties)
DatabasesetProperties in interface Databasepublic final Properties getProperties()
public final List<Database.Filter> getFilters()
DatabasegetFilters in interface Databasepublic final void addFilter(Database.Filter filter)
Databasepublic final void setExcludes(String[] excludes)
DatabasesetExcludes in interface Databasepublic final String[] getExcludes()
DatabasegetExcludes in interface Databasepublic final void setIncludes(String[] includes)
DatabasesetIncludes in interface Databasepublic final String[] getIncludes()
DatabasegetIncludes in interface Databasepublic final void setIncludeExcludeColumns(boolean includeExcludeColumns)
DatabasesetIncludeExcludeColumns in interface Databasepublic final boolean getIncludeExcludeColumns()
DatabasegetIncludeExcludeColumns in interface Databasepublic final void setRegexFlags(List<RegexFlag> regexFlags)
DatabasesetRegexFlags in interface Databasepublic final List<RegexFlag> getRegexFlags()
DatabasegetRegexFlags in interface Databasepublic void setRecordVersionFields(String[] recordVersionFields)
DatabasesetRecordVersionFields in interface Databasepublic String[] getRecordVersionFields()
DatabasegetRecordVersionFields in interface Databasepublic void setRecordTimestampFields(String[] recordTimestampFields)
DatabasesetRecordTimestampFields in interface Databasepublic String[] getRecordTimestampFields()
DatabasegetRecordTimestampFields in interface Databasepublic void setSyntheticPrimaryKeys(String[] syntheticPrimaryKeys)
DatabasesetSyntheticPrimaryKeys in interface Databasepublic String[] getSyntheticPrimaryKeys()
DatabasegetSyntheticPrimaryKeys in interface Databasepublic void setOverridePrimaryKeys(String[] overridePrimaryKeys)
DatabasesetOverridePrimaryKeys in interface Databasepublic String[] getOverridePrimaryKeys()
DatabasegetOverridePrimaryKeys in interface Databasepublic final void setConfiguredEnumTypes(List<EnumType> configuredEnumTypes)
DatabasesetConfiguredEnumTypes in interface Databasepublic final List<EnumType> getConfiguredEnumTypes()
DatabasegetConfiguredEnumTypes in interface Databasepublic final void setConfiguredCustomTypes(List<CustomType> configuredCustomTypes)
DatabasesetConfiguredCustomTypes in interface Databasepublic final List<CustomType> getConfiguredCustomTypes()
DatabasegetConfiguredCustomTypes in interface Databasepublic final CustomType getConfiguredCustomType(String typeName)
DatabasegetConfiguredCustomType in interface Databasepublic final void setConfiguredForcedTypes(List<ForcedType> configuredForcedTypes)
DatabasesetConfiguredForcedTypes in interface Databasepublic final List<ForcedType> getConfiguredForcedTypes()
DatabasegetConfiguredForcedTypes in interface Databasepublic final SchemaVersionProvider getSchemaVersionProvider()
getSchemaVersionProvider in interface Databasepublic final void setSchemaVersionProvider(SchemaVersionProvider schemaVersionProvider)
setSchemaVersionProvider in interface Databasepublic final void setSupportsUnsignedTypes(boolean supportsUnsignedTypes)
DatabasesetSupportsUnsignedTypes in interface Databasepublic final boolean supportsUnsignedTypes()
DatabasesupportsUnsignedTypes in interface Databasepublic final void setIgnoreProcedureReturnValues(boolean ignoreProcedureReturnValues)
DatabasesetIgnoreProcedureReturnValues in interface Databasepublic final boolean ignoreProcedureReturnValues()
DatabaseignoreProcedureReturnValues in interface Databasepublic final void setDateAsTimestamp(boolean dateAsTimestamp)
DatabasesetDateAsTimestamp in interface Databasepublic final boolean dateAsTimestamp()
DatabasedateAsTimestamp in interface Databasepublic final void setIncludeRelations(boolean includeRelations)
DatabasesetIncludeRelations in interface Databasepublic final boolean includeRelations()
DatabaseincludeRelations in interface Databasepublic final List<SequenceDefinition> getSequences(SchemaDefinition schema)
DatabasegetSequences in interface Databasepublic final List<IdentityDefinition> getIdentities(SchemaDefinition schema)
DatabasegetIdentities in interface Databasepublic final List<UniqueKeyDefinition> getUniqueKeys(SchemaDefinition schema)
DatabasegetUniqueKeys in interface Databasepublic final List<ForeignKeyDefinition> getForeignKeys(SchemaDefinition schema)
DatabasegetForeignKeys in interface Databasepublic final List<CheckConstraintDefinition> getCheckConstraints(SchemaDefinition schema)
DatabasegetCheckConstraints in interface Databasepublic final List<TableDefinition> getTables(SchemaDefinition schema)
Databasepublic final TableDefinition getTable(SchemaDefinition schema, String name)
Databasepublic final TableDefinition getTable(SchemaDefinition schema, String name, boolean ignoreCase)
Databasepublic final List<EnumDefinition> getEnums(SchemaDefinition schema)
Databasepublic final ForcedType getConfiguredForcedType(Definition definition)
DatabaseDefinition,
or null if no ForcedType matches the definition.getConfiguredForcedType in interface Databasepublic final ForcedType getConfiguredForcedType(Definition definition, DataTypeDefinition definedType)
DatabaseDefinition,
or null if no ForcedType matches the definition.getConfiguredForcedType in interface Databasepublic final EnumDefinition getEnum(SchemaDefinition schema, String name)
Databasepublic final EnumDefinition getEnum(SchemaDefinition schema, String name, boolean ignoreCase)
Databasepublic final List<ArrayDefinition> getArrays(SchemaDefinition schema)
Databasepublic final ArrayDefinition getArray(SchemaDefinition schema, String name)
Databasepublic final ArrayDefinition getArray(SchemaDefinition schema, String name, boolean ignoreCase)
Databasepublic final List<UDTDefinition> getUDTs(SchemaDefinition schema)
Databasepublic final UDTDefinition getUDT(SchemaDefinition schema, String name)
Databasepublic final UDTDefinition getUDT(SchemaDefinition schema, String name, boolean ignoreCase)
Databasepublic final Relations getRelations()
DatabasegetRelations in interface Databasepublic final List<RoutineDefinition> getRoutines(SchemaDefinition schema)
DatabasegetRoutines in interface Databasepublic final List<PackageDefinition> getPackages(SchemaDefinition schema)
DatabasegetPackages in interface Databaseprotected static final <D extends Definition> D getDefinition(List<D> definitions, String name, boolean ignoreCase)
protected final <T extends Definition> List<T> filterSchema(List<T> definitions, SchemaDefinition schema, Map<SchemaDefinition,List<T>> cache)
protected final <T extends Definition> List<T> filterSchema(List<T> definitions, SchemaDefinition schema)
public final <T extends Definition> List<T> filterExcludeInclude(List<T> definitions)
DatabasefilterExcludeInclude in interface Databaseprotected final <T extends Definition> List<T> filterExcludeInclude(List<T> definitions, String[] e, String[] i, List<Database.Filter> f)
protected final Relations getRelations0()
public final boolean isArrayType(String dataType)
DatabaseisArrayType in interface Databaseprotected abstract DSLContext create0()
protected abstract void loadPrimaryKeys(DefaultRelations r) throws SQLException
SQLExceptionprotected abstract void loadUniqueKeys(DefaultRelations r) throws SQLException
SQLExceptionprotected abstract void loadForeignKeys(DefaultRelations r) throws SQLException
SQLExceptionprotected abstract void loadCheckConstraints(DefaultRelations r) throws SQLException
CHECK constraints and store them to relations.SQLExceptionprotected abstract List<SchemaDefinition> getSchemata0() throws SQLException
getSchemata()SQLExceptionprotected abstract List<SequenceDefinition> getSequences0() throws SQLException
getTables(SchemaDefinition)SQLExceptionprotected abstract List<TableDefinition> getTables0() throws SQLException
getTables(SchemaDefinition)SQLExceptionprotected abstract List<RoutineDefinition> getRoutines0() throws SQLException
getRoutines(SchemaDefinition)SQLExceptionprotected abstract List<PackageDefinition> getPackages0() throws SQLException
getPackages(SchemaDefinition)SQLExceptionprotected abstract List<EnumDefinition> getEnums0() throws SQLException
getEnums(SchemaDefinition)SQLExceptionprotected abstract List<UDTDefinition> getUDTs0() throws SQLException
getEnums(SchemaDefinition)SQLExceptionprotected abstract List<ArrayDefinition> getArrays0() throws SQLException
getArrays(SchemaDefinition)SQLExceptionprotected final DataTypeDefinition getDataTypeForMAX_VAL(SchemaDefinition schema, BigInteger value)
Copyright © 2015. All Rights Reserved.