org.jooq.util.AbstractDatabase Maven / Gradle / Ivy
/**
* Copyright (c) 2009-2014, Data Geekery GmbH (http://www.datageekery.com)
* All rights reserved.
*
* This work is dual-licensed
* - under the Apache Software License 2.0 (the "ASL")
* - under the jOOQ License and Maintenance Agreement (the "jOOQ License")
* =============================================================================
* You may choose which license applies to you:
*
* - If you're using this work with Open Source databases, you may choose
* either ASL or jOOQ License.
* - If you're using this work with at least one commercial database, you must
* choose jOOQ License
*
* For more information, please visit http://www.jooq.org/licenses
*
* Apache Software License 2.0:
* -----------------------------------------------------------------------------
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* jOOQ License and Maintenance Agreement:
* -----------------------------------------------------------------------------
* Data Geekery grants the Customer the non-exclusive, timely limited and
* non-transferable license to install and use the Software under the terms of
* the jOOQ License and Maintenance Agreement.
*
* This library is distributed with a LIMITED WARRANTY. See the jOOQ License
* and Maintenance Agreement for more details: http://www.jooq.org/licensing
*/
package org.jooq.util;
import static org.jooq.impl.DSL.falseCondition;
import java.io.IOException;
import java.io.StringReader;
import java.math.BigInteger;
import java.sql.Connection;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import org.jooq.DSLContext;
import org.jooq.SQLDialect;
import org.jooq.Table;
import org.jooq.exception.DataAccessException;
import org.jooq.impl.SQLDataType;
import org.jooq.tools.JooqLogger;
import org.jooq.tools.StringUtils;
import org.jooq.tools.csv.CSVReader;
import org.jooq.util.jaxb.CustomType;
import org.jooq.util.jaxb.EnumType;
import org.jooq.util.jaxb.ForcedType;
import org.jooq.util.jaxb.Schema;
// ...
/**
* A base implementation for all types of databases.
*
* @author Lukas Eder
*/
public abstract class AbstractDatabase implements Database {
private static final JooqLogger log = JooqLogger.getLogger(AbstractDatabase.class);
// -------------------------------------------------------------------------
// Configuration elements
// -------------------------------------------------------------------------
private SQLDialect dialect;
private Connection connection;
private DSLContext create;
private String[] excludes;
private String[] includes;
private boolean includeExcludeColumns;
private String[] recordVersionFields;
private String[] recordTimestampFields;
private boolean supportsUnsignedTypes;
private boolean dateAsTimestamp;
private List configuredSchemata;
private List configuredCustomTypes;
private List configuredEnumTypes;
private List configuredForcedTypes;
// -------------------------------------------------------------------------
// Loaded definitions
// -------------------------------------------------------------------------
private List inputSchemata;
private List schemata;
private List sequences;
private List identities;
private List uniqueKeys;
private List foreignKeys;
private List checkConstraints;
private List tables;
private List enums;
private List udts;
private List arrays;
private List routines;
private List packages;
private Relations relations;
private transient Map> sequencesBySchema;
private transient Map> identitiesBySchema;
private transient Map> uniqueKeysBySchema;
private transient Map> foreignKeysBySchema;
private transient Map> checkConstraintsBySchema;
private transient Map> tablesBySchema;
@SuppressWarnings("unused")
private transient Map> enumsBySchema;
private transient Map> udtsBySchema;
private transient Map> arraysBySchema;
private transient Map> routinesBySchema;
private transient Map> packagesBySchema;
// Other caches
private final Map, Boolean> exists;
protected AbstractDatabase() {
exists = new HashMap, Boolean>();
}
@Override
public final SQLDialect getDialect() {
if (dialect == null) {
dialect = create().configuration().dialect();
}
return dialect;
}
@Override
public final void setConnection(Connection connection) {
this.connection = connection;
}
@Override
public final Connection getConnection() {
return connection;
}
@Override
public final DSLContext create() {
if (create == null) {
create = create0();
}
return create;
}
@Override
public final boolean exists(Table table) {
Boolean result = exists.get(table);
if (result == null) {
try {
create().selectOne().from(table).where(falseCondition()).fetch();
result = true;
}
catch (DataAccessException e) {
result = false;
}
exists.put(table, result);
}
return result;
}
@Override
public final List getSchemata() {
if (schemata == null) {
schemata = new ArrayList();
try {
schemata = getSchemata0();
}
catch (SQLException e) {
log.error("Could not load schemata", e);
}
Iterator it = schemata.iterator();
while (it.hasNext()) {
if (!getInputSchemata().contains(it.next().getName())) {
it.remove();
}
}
if (schemata.isEmpty()) {
log.warn(
"No schemata were loaded",
"Please check your connection settings, and whether your database (and your database version!) is really supported by jOOQ. Also, check the case-sensitivity in your configured getInputSchemata() {
if (inputSchemata == null) {
inputSchemata = new ArrayList();
// [#1312] Allow for ommitting inputSchema configuration. Generate
// All schemata instead
if (configuredSchemata.size() == 1 && StringUtils.isBlank(configuredSchemata.get(0).getInputSchema())) {
try {
for (SchemaDefinition schema : getSchemata0()) {
inputSchemata.add(schema.getName());
}
}
catch (SQLException e) {
log.error("Could not load schemata", e);
}
}
else {
for (Schema schema : configuredSchemata) {
/* [pro] xx
xx xxxxxxx xxxxxxx xxxxxx xxx xxxxxxxxxxxxxxxx xxxxxx xxxxxx
xx xxxxx xxxxxxxxxx xxxxxxxxxxxxxxx x
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
x
xxxx
xx [/pro] */
{
inputSchemata.add(schema.getInputSchema());
}
}
}
}
return inputSchemata;
}
@Override
@Deprecated
public String getOutputSchema(String inputSchema) {
for (Schema schema : configuredSchemata) {
if (inputSchema.equals(schema.getInputSchema())) {
return schema.getOutputSchema();
}
}
return inputSchema;
}
@Override
public final void setConfiguredSchemata(List schemata) {
this.configuredSchemata = schemata;
}
@Override
public final void setExcludes(String[] excludes) {
this.excludes = excludes;
}
@Override
public final String[] getExcludes() {
return excludes;
}
@Override
public final void setIncludes(String[] includes) {
this.includes = includes;
}
@Override
public final String[] getIncludes() {
return includes;
}
@Override
public final void setIncludeExcludeColumns(boolean includeExcludeColumns) {
this.includeExcludeColumns = includeExcludeColumns;
}
@Override
public final boolean getIncludeExcludeColumns() {
return includeExcludeColumns;
}
@Override
public void setRecordVersionFields(String[] recordVersionFields) {
this.recordVersionFields = recordVersionFields;
}
@Override
public String[] getRecordVersionFields() {
return recordVersionFields;
}
@Override
public void setRecordTimestampFields(String[] recordTimestampFields) {
this.recordTimestampFields = recordTimestampFields;
}
@Override
public String[] getRecordTimestampFields() {
return recordTimestampFields;
}
@Override
public final void setConfiguredEnumTypes(List configuredEnumTypes) {
this.configuredEnumTypes = configuredEnumTypes;
}
@Override
public final List getConfiguredEnumTypes() {
return configuredEnumTypes;
}
@Override
public final void setConfiguredCustomTypes(List configuredCustomTypes) {
this.configuredCustomTypes = configuredCustomTypes;
}
@Override
public final List getConfiguredCustomTypes() {
return configuredCustomTypes;
}
@Override
public final CustomType getConfiguredCustomType(String name) {
for (CustomType type : configuredCustomTypes) {
if (type.getName().equals(name)) {
return type;
}
}
return null;
}
@Override
public final void setConfiguredForcedTypes(List configuredForcedTypes) {
this.configuredForcedTypes = configuredForcedTypes;
}
@Override
public final List getConfiguredForcedTypes() {
return configuredForcedTypes;
}
@Override
public final void setSupportsUnsignedTypes(boolean supportsUnsignedTypes) {
this.supportsUnsignedTypes = supportsUnsignedTypes;
}
@Override
public final boolean supportsUnsignedTypes() {
return supportsUnsignedTypes;
}
@Override
public final void setDateAsTimestamp(boolean dateAsTimestamp) {
this.dateAsTimestamp = dateAsTimestamp;
}
@Override
public final boolean dateAsTimestamp() {
return dateAsTimestamp;
}
@Override
public final List getSequences(SchemaDefinition schema) {
if (sequences == null) {
sequences = new ArrayList();
try {
List s = getSequences0();
sequences = filterExcludeInclude(s);
log.info("Sequences fetched", fetchedSize(s, sequences));
} catch (Exception e) {
log.error("Error while fetching sequences", e);
}
}
if (sequencesBySchema == null) {
sequencesBySchema = new LinkedHashMap>();
}
return filterSchema(sequences, schema, sequencesBySchema);
}
@Override
public final List getIdentities(SchemaDefinition schema) {
if (identities == null) {
identities = new ArrayList();
for (SchemaDefinition s : getSchemata()) {
for (TableDefinition table : getTables(s)) {
IdentityDefinition identity = table.getIdentity();
if (identity != null) {
identities.add(identity);
}
}
}
}
if (identitiesBySchema == null) {
identitiesBySchema = new LinkedHashMap>();
}
return filterSchema(identities, schema, identitiesBySchema);
}
@Override
public final List getUniqueKeys(SchemaDefinition schema) {
if (uniqueKeys == null) {
uniqueKeys = new ArrayList();
for (SchemaDefinition s : getSchemata()) {
for (TableDefinition table : getTables(s)) {
for (UniqueKeyDefinition uniqueKey : table.getUniqueKeys()) {
uniqueKeys.add(uniqueKey);
}
}
}
}
if (uniqueKeysBySchema == null) {
uniqueKeysBySchema = new LinkedHashMap>();
}
return filterSchema(uniqueKeys, schema, uniqueKeysBySchema);
}
@Override
public final List getForeignKeys(SchemaDefinition schema) {
if (foreignKeys == null) {
foreignKeys = new ArrayList();
for (SchemaDefinition s : getSchemata()) {
for (TableDefinition table : getTables(s)) {
for (ForeignKeyDefinition foreignKey : table.getForeignKeys()) {
foreignKeys.add(foreignKey);
}
}
}
}
if (foreignKeysBySchema == null) {
foreignKeysBySchema = new LinkedHashMap>();
}
return filterSchema(foreignKeys, schema, foreignKeysBySchema);
}
@Override
public final List getCheckConstraints(SchemaDefinition schema) {
if (checkConstraints == null) {
checkConstraints = new ArrayList();
for (SchemaDefinition s : getSchemata()) {
for (TableDefinition table : getTables(s)) {
for (CheckConstraintDefinition checkConstraint : table.getCheckConstraints()) {
checkConstraints.add(checkConstraint);
}
}
}
}
if (checkConstraintsBySchema == null) {
checkConstraintsBySchema = new LinkedHashMap>();
}
return filterSchema(checkConstraints, schema, checkConstraintsBySchema);
}
@Override
public final List getTables(SchemaDefinition schema) {
if (tables == null) {
tables = new ArrayList();
try {
List t = getTables0();
tables = filterExcludeInclude(t);
log.info("Tables fetched", fetchedSize(t, tables));
} catch (Exception e) {
log.error("Error while fetching tables", e);
}
}
if (tablesBySchema == null) {
tablesBySchema = new LinkedHashMap>();
}
return filterSchema(tables, schema, tablesBySchema);
}
@Override
public final TableDefinition getTable(SchemaDefinition schema, String name) {
return getTable(schema, name, false);
}
@Override
public final TableDefinition getTable(SchemaDefinition schema, String name, boolean ignoreCase) {
return getDefinition(getTables(schema), name, ignoreCase);
}
@Override
public final List getEnums(SchemaDefinition schema) {
if (enums == null) {
enums = new ArrayList();
try {
List e = getEnums0();
enums = filterExcludeInclude(e);
enums.addAll(getConfiguredEnums());
log.info("Enums fetched", fetchedSize(e, enums));
} catch (Exception e) {
log.error("Error while fetching enums", e);
}
}
return enums;
}
private final List getConfiguredEnums() {
List result = new ArrayList();
for (EnumType enumType : configuredEnumTypes) {
String name = enumType.getName();
DefaultEnumDefinition e = new DefaultEnumDefinition(getSchemata().get(0), name, null, true);
String literals = enumType.getLiterals();
try {
@SuppressWarnings("resource")
CSVReader reader = new CSVReader(new StringReader(literals));
e.addLiterals(reader.readNext());
} catch (IOException ignore) {}
result.add(e);
}
return result;
}
@Override
public final ForcedType getConfiguredForcedType(Definition definition) {
return getConfiguredForcedType(definition, null);
}
@Override
public final ForcedType getConfiguredForcedType(Definition definition, DataTypeDefinition definedType) {
for (ForcedType forcedType : getConfiguredForcedTypes()) {
String expression = forcedType.getExpression();
if (forcedType.getExpressions() != null) {
expression = forcedType.getExpressions();
log.warn("DEPRECATED", "The getArrays(SchemaDefinition schema) {
if (arrays == null) {
arrays = new ArrayList();
try {
List a = getArrays0();
arrays = filterExcludeInclude(a);
log.info("ARRAYs fetched", fetchedSize(a, arrays));
} catch (Exception e) {
log.error("Error while fetching ARRAYS", e);
}
}
if (arraysBySchema == null) {
arraysBySchema = new LinkedHashMap>();
}
return filterSchema(arrays, schema, arraysBySchema);
}
@Override
public final ArrayDefinition getArray(SchemaDefinition schema, String name) {
return getArray(schema, name, false);
}
@Override
public final ArrayDefinition getArray(SchemaDefinition schema, String name, boolean ignoreCase) {
return getDefinition(getArrays(schema), name, ignoreCase);
}
@Override
public final List getUDTs(SchemaDefinition schema) {
if (udts == null) {
udts = new ArrayList();
try {
List u = getUDTs0();
udts = filterExcludeInclude(u);
log.info("UDTs fetched", fetchedSize(u, udts));
} catch (Exception e) {
log.error("Error while fetching udts", e);
}
}
if (udtsBySchema == null) {
udtsBySchema = new LinkedHashMap>();
}
return filterSchema(udts, schema, udtsBySchema);
}
@Override
public final UDTDefinition getUDT(SchemaDefinition schema, String name) {
return getUDT(schema, name, false);
}
@Override
public final UDTDefinition getUDT(SchemaDefinition schema, String name, boolean ignoreCase) {
return getDefinition(getUDTs(schema), name, ignoreCase);
}
@Override
public final Relations getRelations() {
if (relations == null) {
try {
relations = getRelations0();
} catch (Exception e) {
log.error("Error while fetching relations", e);
relations = new DefaultRelations();
}
}
return relations;
}
@Override
public final List getRoutines(SchemaDefinition schema) {
if (routines == null) {
routines = new ArrayList();
try {
List r = getRoutines0();
routines = filterExcludeInclude(r);
log.info("Routines fetched", fetchedSize(r, routines));
} catch (Exception e) {
log.error("Error while fetching functions", e);
}
}
if (routinesBySchema == null) {
routinesBySchema = new LinkedHashMap>();
}
return filterSchema(routines, schema, routinesBySchema);
}
@Override
public final List getPackages(SchemaDefinition schema) {
if (packages == null) {
packages = new ArrayList();
try {
List p = getPackages0();
packages = filterExcludeInclude(p);
log.info("Packages fetched", fetchedSize(p, packages));
} catch (Exception e) {
log.error("Error while fetching packages", e);
}
}
if (packagesBySchema == null) {
packagesBySchema = new LinkedHashMap>();
}
return filterSchema(packages, schema, packagesBySchema);
}
static final D getDefinition(List definitions, String name, boolean ignoreCase) {
for (D definition : definitions) {
if ((ignoreCase && definition.getName().equalsIgnoreCase(name)) ||
(!ignoreCase && definition.getName().equals(name))) {
return definition;
}
}
return null;
}
private final List filterSchema(List definitions, SchemaDefinition schema, Map> cache) {
List result = cache.get(schema);
if (result == null) {
result = filterSchema(definitions, schema);
cache.put(schema, result);
}
return result;
}
private final List filterSchema(List definitions, SchemaDefinition schema) {
if (schema == null) {
return definitions;
}
else {
List result = new ArrayList();
for (T definition : definitions) {
if (definition.getSchema().equals(schema)) {
result.add(definition);
}
}
return result;
}
}
private final List filterExcludeInclude(List definitions) {
return filterExcludeInclude(definitions, excludes, includes);
}
static final List filterExcludeInclude(List definitions, String[] excludes, String[] includes) {
List result = new ArrayList();
definitionsLoop: for (T definition : definitions) {
for (String exclude : excludes) {
if (exclude != null &&
(definition.getName().matches(exclude.trim()) ||
definition.getQualifiedName().matches(exclude.trim()))) {
continue definitionsLoop;
}
}
for (String include : includes) {
if (include != null &&
(definition.getName().matches(include.trim()) ||
definition.getQualifiedName().matches(include.trim()))) {
result.add(definition);
continue definitionsLoop;
}
}
}
return result;
}
/**
* Retrieve ALL relations from the database.
*/
protected final Relations getRelations0() {
DefaultRelations result = new DefaultRelations();
try {
loadPrimaryKeys(result);
}
catch (Exception e) {
log.error("Error while fetching primary keys", e);
}
try {
loadUniqueKeys(result);
}
catch (Exception e) {
log.error("Error while fetching unique keys", e);
}
try {
loadForeignKeys(result);
}
catch (Exception e) {
log.error("Error while fetching foreign keys", e);
}
try {
loadCheckConstraints(result);
}
catch (Exception e) {
log.error("Error while fetching check constraints", e);
}
return result;
}
@Override
public final boolean isArrayType(String dataType) {
switch (getDialect()) {
case POSTGRES:
case H2:
return "ARRAY".equals(dataType);
case HSQLDB:
return dataType.endsWith("ARRAY");
}
return false;
}
static final String fetchedSize(List fetched, List included) {
return fetched.size() + " (" + included.size() + " included, " + (fetched.size() - included.size()) + " excluded)";
}
/**
* Create a new Factory
*/
protected abstract DSLContext create0();
/**
* Retrieve primary keys and store them to relations
*/
protected abstract void loadPrimaryKeys(DefaultRelations r) throws SQLException;
/**
* Retrieve non-primary unique keys and store them to relations
*/
protected abstract void loadUniqueKeys(DefaultRelations r) throws SQLException;
/**
* Retrieve foreign keys and store them to relations. Unique keys are
* already loaded.
*/
protected abstract void loadForeignKeys(DefaultRelations r) throws SQLException;
/**
* Retrieve CHECK constraints and store them to relations.
*/
protected abstract void loadCheckConstraints(DefaultRelations r) throws SQLException;
/**
* Retrieve ALL schemata from the database. This will be filtered in
* {@link #getSchemata()}
*/
protected abstract List getSchemata0() throws SQLException;
/**
* Retrieve ALL sequences from the database. This will be filtered in
* {@link #getTables(SchemaDefinition)}
*/
protected abstract List getSequences0() throws SQLException;
/**
* Retrieve ALL tables from the database. This will be filtered in
* {@link #getTables(SchemaDefinition)}
*/
protected abstract List getTables0() throws SQLException;
/**
* Retrieve ALL stored routines (functions and procedures) from the
* database. This will be filtered in {@link #getRoutines(SchemaDefinition)}
*/
protected abstract List getRoutines0() throws SQLException;
/**
* Retrieve ALL packages from the database. This will be filtered in
* {@link #getPackages(SchemaDefinition)}
*/
protected abstract List getPackages0() throws SQLException;
/**
* Retrieve ALL enum UDTs from the database. This will be filtered in
* {@link #getEnums(SchemaDefinition)}
*/
protected abstract List getEnums0() throws SQLException;
/**
* Retrieve ALL UDTs from the database. This will be filtered in
* {@link #getEnums(SchemaDefinition)}
*/
protected abstract List getUDTs0() throws SQLException;
/**
* Retrieve ALL ARRAYs from the database. This will be filtered in
* {@link #getArrays(SchemaDefinition)}
*/
protected abstract List getArrays0() throws SQLException;
/**
* Get the data type considering a known max value
*/
protected final DataTypeDefinition getDataTypeForMAX_VAL(SchemaDefinition schema, BigInteger value) {
DataTypeDefinition type;
if (BigInteger.valueOf(Byte.MAX_VALUE).compareTo(value) >= 0) {
type = new DefaultDataTypeDefinition(this, schema, SQLDataType.NUMERIC.getTypeName(), 0, 2, 0, false, false);
}
else if (BigInteger.valueOf(Short.MAX_VALUE).compareTo(value) >= 0) {
type = new DefaultDataTypeDefinition(this, schema, SQLDataType.NUMERIC.getTypeName(), 0, 4, 0, false, false);
}
else if (BigInteger.valueOf(Integer.MAX_VALUE).compareTo(value) >= 0) {
type = new DefaultDataTypeDefinition(this, schema, SQLDataType.NUMERIC.getTypeName(), 0, 9, 0, false, false);
}
else if (BigInteger.valueOf(Long.MAX_VALUE).compareTo(value) >= 0) {
type = new DefaultDataTypeDefinition(this, schema, SQLDataType.NUMERIC.getTypeName(), 0, 18, 0, false, false);
}
else {
type = new DefaultDataTypeDefinition(this, schema, SQLDataType.NUMERIC.getTypeName(), 0, 38, 0, false, false);
}
return type;
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy