org.jooq.meta.xml.XMLDatabase Maven / Gradle / Ivy
/*
* 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
*
* https://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.
*
* Other licenses:
* -----------------------------------------------------------------------------
* Commercial licenses for this work are available. These replace the above
* Apache-2.0 license and offer limited warranties, support, maintenance, and
* commercial database integrations.
*
* For more information, please visit: https://www.jooq.org/legal/licensing
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*/
package org.jooq.meta.xml;
import static java.lang.Boolean.FALSE;
import static java.util.Arrays.asList;
import static org.jooq.impl.DSL.name;
import static org.jooq.tools.StringUtils.defaultIfBlank;
import static org.jooq.tools.StringUtils.defaultIfNull;
import static org.jooq.tools.StringUtils.isBlank;
import static org.jooq.util.xml.jaxb.TableConstraintType.PRIMARY_KEY;
import static org.jooq.util.xml.jaxb.TableConstraintType.UNIQUE;
import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.io.Reader;
import java.io.StringReader;
import java.io.StringWriter;
import java.io.UnsupportedEncodingException;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.SortedSet;
import java.util.TreeSet;
import javax.xml.stream.XMLInputFactory;
import javax.xml.stream.XMLStreamException;
import javax.xml.stream.XMLStreamReader;
import javax.xml.transform.Transformer;
import javax.xml.transform.TransformerException;
import javax.xml.transform.TransformerFactory;
import javax.xml.transform.stream.StreamResult;
import javax.xml.transform.stream.StreamSource;
import org.jooq.Constants;
import org.jooq.DSLContext;
import org.jooq.FilePattern;
import org.jooq.FilePattern.Sort;
import org.jooq.Name;
import org.jooq.SQLDialect;
import org.jooq.SortOrder;
import org.jooq.TableOptions.TableType;
// ...
// ...
// ...
import org.jooq.exception.IOException;
import org.jooq.impl.DSL;
import org.jooq.meta.AbstractDatabase;
import org.jooq.meta.AbstractIndexDefinition;
import org.jooq.meta.ArrayDefinition;
import org.jooq.meta.CatalogDefinition;
import org.jooq.meta.ColumnDefinition;
import org.jooq.meta.DataTypeDefinition;
import org.jooq.meta.DefaultCheckConstraintDefinition;
import org.jooq.meta.DefaultDataTypeDefinition;
import org.jooq.meta.DefaultIndexColumnDefinition;
import org.jooq.meta.DefaultRelations;
import org.jooq.meta.DefaultSequenceDefinition;
// ...
import org.jooq.meta.DomainDefinition;
import org.jooq.meta.EnumDefinition;
import org.jooq.meta.IndexColumnDefinition;
import org.jooq.meta.IndexDefinition;
import org.jooq.meta.PackageDefinition;
import org.jooq.meta.RoutineDefinition;
import org.jooq.meta.SchemaDefinition;
import org.jooq.meta.SequenceDefinition;
import org.jooq.meta.TableDefinition;
// ...
import org.jooq.meta.UDTDefinition;
import org.jooq.meta.XMLSchemaCollectionDefinition;
import org.jooq.tools.JooqLogger;
import org.jooq.tools.StringUtils;
import org.jooq.tools.jdbc.JDBCUtils;
import org.jooq.util.jaxb.tools.MiniJAXB;
import org.jooq.util.xml.jaxb.CheckConstraint;
import org.jooq.util.xml.jaxb.Index;
import org.jooq.util.xml.jaxb.IndexColumnUsage;
import org.jooq.util.xml.jaxb.InformationSchema;
import org.jooq.util.xml.jaxb.KeyColumnUsage;
import org.jooq.util.xml.jaxb.ReferentialConstraint;
import org.jooq.util.xml.jaxb.Routine;
import org.jooq.util.xml.jaxb.Schema;
import org.jooq.util.xml.jaxb.Sequence;
import org.jooq.util.xml.jaxb.Table;
import org.jooq.util.xml.jaxb.TableConstraint;
import org.jooq.util.xml.jaxb.TableConstraintType;
import org.jooq.util.xml.jaxb.Trigger;
import org.jooq.util.xml.jaxb.TriggerActionOrientation;
import org.jooq.util.xml.jaxb.View;
/**
* The XML Database.
*
* @author Lukas Eder
*/
public class XMLDatabase extends AbstractDatabase {
private static final JooqLogger log = JooqLogger.getLogger(XMLDatabase.class);
InformationSchema info;
private InformationSchema info() {
if (info == null) {
// [#8118] Regardless of failure, prevent NPEs from subsequent calls
info = new InformationSchema();
// [#8115] Support old property name style for backwards compatibility reasons
final String xml = getProperties().getProperty("xmlFiles",
getProperties().getProperty("xmlFile",
getProperties().getProperty("xml-file")
)
);
final String xsl = getProperties().getProperty("xslFile",
getProperties().getProperty("xsl-file")
);
final String sort = getProperties().getProperty("sort", "semantic").toLowerCase();
if (xml == null)
throw new RuntimeException("Must provide an xmlFile property");
try {
new FilePattern()
.basedir(new File(getBasedir()))
.pattern(xml)
.sort(Sort.of(sort))
.load(source -> {
String content;
Reader reader = null;
try {
if (StringUtils.isBlank(xsl)) {
// [#7414] Default to reading UTF-8
content = source.readString();
// [#7414] Alternatively, read the encoding from the XML file
try {
XMLStreamReader xmlReader = XMLInputFactory.newInstance().createXMLStreamReader(new StringReader(content));
String encoding = xmlReader.getCharacterEncodingScheme();
// Returned encoding can be null in the presence of a BOM
// See https://stackoverflow.com/a/27147259/521799
if (encoding != null && !"UTF-8".equals(encoding))
content = new String(content.getBytes("UTF-8"), encoding);
}
catch (XMLStreamException e1) {
log.warn("Could not open XML Stream: " + e1.getMessage());
}
catch (UnsupportedEncodingException e2) {
log.warn("Unsupported encoding: " + e2.getMessage());
}
}
else {
InputStream xslIs = null;
try {
log.info("Using XSL file", xsl);
xslIs = XMLDatabase.class.getResourceAsStream(xsl);
if (xslIs == null)
xslIs = new FileInputStream(xsl);
StringWriter writer = new StringWriter();
TransformerFactory factory = TransformerFactory.newInstance();
Transformer transformer = factory.newTransformer(new StreamSource(xslIs));
transformer.transform(new StreamSource(reader), new StreamResult(writer));
content = writer.getBuffer().toString();
}
catch (java.io.IOException e3) {
throw new IOException("Error while loading XSL file", e3);
}
catch (TransformerException e4) {
throw new RuntimeException("Error while transforming XML file " + xml + " with XSL file " + xsl, e4);
}
finally {
JDBCUtils.safeClose(xslIs);
}
}
}
finally {
JDBCUtils.safeClose(reader);
}
// TODO [#1201] Add better error handling here
content = content.replaceAll(
"<(\\w+:)?information_schema xmlns(:\\w+)?=\"http://www.jooq.org/xsd/jooq-meta-\\d+\\.\\d+\\.\\d+.xsd\">",
"<$1information_schema xmlns$2=\"" + Constants.NS_META + "\">");
content = content.replace(
"",
"");
info = MiniJAXB.append(info, MiniJAXB.unmarshal(content, InformationSchema.class));
});
}
catch (Exception e) {
throw new RuntimeException("Error while opening files " + xml + " or " + xsl, e);
}
}
return info;
}
@Override
protected DSLContext create0() {
SQLDialect dialect = SQLDialect.DEFAULT;
try {
dialect = SQLDialect.valueOf(getProperties().getProperty("dialect"));
}
catch (Exception ignore) {}
// [#6493] Data types are better discovered from the family, not the dialect. This affects the XMLDatabase,
// for instance. Other databases are currently not affected by the family / dialect distinction
return DSL.using(dialect.family());
}
@Override
protected List getIndexes0() throws SQLException {
List result = new ArrayList<>();
final Map> indexColumnUsage = new HashMap<>();
for (IndexColumnUsage ic : info().getIndexColumnUsages()) {
Name name = name(ic.getIndexCatalog(), ic.getIndexSchema(), ic.getTableName(), ic.getIndexName());
SortedSet list = indexColumnUsage.computeIfAbsent(name, k -> new TreeSet<>((o1, o2) -> {
int r = 0;
r = defaultIfNull(o1.getIndexCatalog(), "").compareTo(defaultIfNull(o2.getIndexCatalog(), ""));
if (r != 0)
return r;
r = defaultIfNull(o1.getIndexSchema(), "").compareTo(defaultIfNull(o2.getIndexSchema(), ""));
if (r != 0)
return r;
r = defaultIfNull(o1.getTableName(), "").compareTo(defaultIfNull(o2.getTableName(), ""));
if (r != 0)
return r;
r = defaultIfNull(o1.getIndexName(), "").compareTo(defaultIfNull(o2.getIndexName(), ""));
if (r != 0)
return r;
return Integer.compare(o1.getOrdinalPosition(), o2.getOrdinalPosition());
}));
list.add(ic);
}
indexLoop:
for (Index i : info().getIndexes()) {
if (getInputSchemata().contains(i.getTableSchema())) {
final SchemaDefinition schema = getSchema(i.getTableSchema());
final TableDefinition table = getTable(schema, i.getTableName());
if (table == null)
continue indexLoop;
final Name name = name(i.getIndexCatalog(), i.getIndexSchema(), i.getTableName(), i.getIndexName());
IndexDefinition index = new AbstractIndexDefinition(schema, i.getIndexName(), table, Boolean.TRUE.equals(i.isIsUnique()), i.getComment()) {
private final List indexColumns;
{
indexColumns = new ArrayList<>();
SortedSet list = indexColumnUsage.get(name);
if (list != null)
for (IndexColumnUsage ic : list) {
ColumnDefinition column = table.getColumn(ic.getColumnName());
if (column != null)
indexColumns.add(new DefaultIndexColumnDefinition(
this,
column,
Boolean.TRUE.equals(ic.isIsDescending()) ? SortOrder.DESC : SortOrder.ASC,
ic.getOrdinalPosition()
));
else
log.error(String.format("Column %s not found in table %s.", ic.getColumnName(), table));
}
else
log.error(String.format("No columns found for index %s.", name));
}
@Override
protected List getIndexColumns0() {
return indexColumns;
}
};
result.add(index);
}
}
return result;
}
@Override
protected void loadPrimaryKeys(DefaultRelations relations) {
for (KeyColumnUsage usage : keyColumnUsage(PRIMARY_KEY)) {
SchemaDefinition schema = getSchema(usage.getConstraintSchema());
String key = usage.getConstraintName();
String tableName = usage.getTableName();
String columnName = usage.getColumnName();
TableConstraint tc = tableConstraint(usage.getConstraintCatalog(), usage.getConstraintSchema(), usage.getConstraintName());
TableDefinition table = getTable(schema, tableName);
if (table != null)
relations.addPrimaryKey(key, table, table.getColumn(columnName), tc != null && !FALSE.equals(tc.isEnforced()));
}
}
@Override
protected void loadUniqueKeys(DefaultRelations relations) {
for (KeyColumnUsage usage : keyColumnUsage(UNIQUE)) {
SchemaDefinition schema = getSchema(usage.getConstraintSchema());
String key = usage.getConstraintName();
String tableName = usage.getTableName();
String columnName = usage.getColumnName();
TableConstraint tc = tableConstraint(usage.getConstraintCatalog(), usage.getConstraintSchema(), usage.getConstraintName());
TableDefinition table = getTable(schema, tableName);
if (table != null)
relations.addUniqueKey(key, table, table.getColumn(columnName), tc != null && !FALSE.equals(tc.isEnforced()));
}
}
private List keyColumnUsage(TableConstraintType constraintType) {
List result = new ArrayList<>();
for (TableConstraint constraint : info().getTableConstraints())
if (constraintType == constraint.getConstraintType()
&& getInputSchemata().contains(constraint.getConstraintSchema()))
for (KeyColumnUsage usage : info().getKeyColumnUsages())
if ( StringUtils.equals(defaultIfNull(constraint.getConstraintCatalog(), ""), defaultIfNull(usage.getConstraintCatalog(), ""))
&& StringUtils.equals(defaultIfNull(constraint.getConstraintSchema(), ""), defaultIfNull(usage.getConstraintSchema(), ""))
&& StringUtils.equals(defaultIfNull(constraint.getConstraintName(), ""), defaultIfNull(usage.getConstraintName(), "")))
result.add(usage);
result.sort((o1, o2) -> {
int r = 0;
r = defaultIfNull(o1.getConstraintCatalog(), "").compareTo(defaultIfNull(o2.getConstraintCatalog(), ""));
if (r != 0)
return r;
r = defaultIfNull(o1.getConstraintSchema(), "").compareTo(defaultIfNull(o2.getConstraintSchema(), ""));
if (r != 0)
return r;
r = defaultIfNull(o1.getConstraintName(), "").compareTo(defaultIfNull(o2.getConstraintName(), ""));
if (r != 0)
return r;
return Integer.compare(o1.getOrdinalPosition(), o2.getOrdinalPosition());
});
return result;
}
@Override
protected void loadForeignKeys(DefaultRelations relations) {
for (ReferentialConstraint fk : info().getReferentialConstraints()) {
if (getInputSchemata().contains(fk.getConstraintSchema())) {
for (KeyColumnUsage usage : info().getKeyColumnUsages()) {
if ( StringUtils.equals(defaultIfNull(fk.getConstraintCatalog(), ""), defaultIfNull(usage.getConstraintCatalog(), ""))
&& StringUtils.equals(defaultIfNull(fk.getConstraintSchema(), ""), defaultIfNull(usage.getConstraintSchema(), ""))
&& StringUtils.equals(defaultIfNull(fk.getConstraintName(), ""), defaultIfNull(usage.getConstraintName(), ""))) {
SchemaDefinition foreignKeySchema = getSchema(fk.getConstraintSchema());
SchemaDefinition uniqueKeySchema = getSchema(fk.getUniqueConstraintSchema());
String foreignKey = usage.getConstraintName();
String foreignKeyTableName = usage.getTableName();
String foreignKeyColumn = usage.getColumnName();
String uniqueKey = fk.getUniqueConstraintName();
TableConstraint fktc = tableConstraint(fk.getConstraintCatalog(), fk.getConstraintSchema(), fk.getConstraintName());
TableConstraint uktc = tableConstraint(fk.getUniqueConstraintCatalog(), fk.getUniqueConstraintSchema(), fk.getUniqueConstraintName());
if (fktc != null && uktc != null) {
TableDefinition foreignKeyTable = getTable(foreignKeySchema, foreignKeyTableName);
TableDefinition uniqueKeyTable = getTable(uniqueKeySchema, uktc.getTableName());
if (foreignKeyTable != null && uniqueKeyTable != null)
relations.addForeignKey(
foreignKey,
foreignKeyTable,
foreignKeyTable.getColumn(foreignKeyColumn),
uniqueKey,
uniqueKeyTable,
usage.getPositionInUniqueConstraint(),
!FALSE.equals(fktc.isEnforced())
);
}
}
}
}
}
}
private TableConstraint tableConstraint(String constraintCatalog, String constraintSchema, String constraintName) {
for (TableConstraint uk : info().getTableConstraints())
if ( StringUtils.equals(defaultIfNull(constraintCatalog, ""), defaultIfNull(uk.getConstraintCatalog(), ""))
&& StringUtils.equals(defaultIfNull(constraintSchema, ""), defaultIfNull(uk.getConstraintSchema(), ""))
&& StringUtils.equals(defaultIfNull(constraintName, ""), defaultIfNull(uk.getConstraintName(), "")))
return uk;
return null;
}
@Override
protected void loadCheckConstraints(DefaultRelations r) {
constraintLoop:
for (CheckConstraint check : info().getCheckConstraints()) {
if (!getInputSchemata().contains(check.getConstraintSchema()))
continue constraintLoop;
SchemaDefinition schema = getSchema(check.getConstraintSchema());
if (schema == null)
continue constraintLoop;
TableConstraint tc = tableConstraint(check.getConstraintCatalog(), check.getConstraintSchema(), check.getConstraintName());
if (tc == null)
continue constraintLoop;
TableDefinition table = getTable(schema, tc.getTableName());
if (table == null)
continue constraintLoop;
r.addCheckConstraint(table, new DefaultCheckConstraintDefinition(
schema,
table,
check.getConstraintName(),
check.getCheckClause(),
!FALSE.equals(tc.isEnforced())
));
}
}
@Override
protected List getCatalogs0() throws SQLException {
List result = new ArrayList<>();
result.add(new CatalogDefinition(this, "", ""));
return result;
}
@Override
protected List getSchemata0() {
List result = new ArrayList<>();
for (Schema schema : info().getSchemata()) {
String schemaName = schema.getSchemaName();
result.add(new SchemaDefinition(this, StringUtils.defaultIfNull(schemaName, ""), schema.getComment()));
}
return result;
}
@Override
protected List getSequences0() {
List result = new ArrayList<>();
for (Sequence sequence : info().getSequences()) {
if (getInputSchemata().contains(sequence.getSequenceSchema())) {
SchemaDefinition schema = getSchema(sequence.getSequenceSchema());
DataTypeDefinition type = new DefaultDataTypeDefinition(
this,
schema,
sequence.getDataType(),
sequence.getCharacterMaximumLength(),
sequence.getNumericPrecision(),
sequence.getNumericScale(),
false,
(String) null
);
result.add(new DefaultSequenceDefinition(
schema,
sequence.getSequenceName(),
type,
sequence.getComment(),
sequence.getStartValue(),
sequence.getIncrement(),
sequence.getMinimumValue(),
sequence.getMaximumValue(),
Boolean.TRUE.equals(sequence.isCycleOption()),
sequence.getCache()));
}
}
return result;
}
@Override
protected List getTables0() {
List result = new ArrayList<>();
for (Table table : info().getTables()) {
if (getInputSchemata().contains(table.getTableSchema())) {
SchemaDefinition schema = getSchema(table.getTableSchema());
TableType tableType;
switch (table.getTableType()) {
case GLOBAL_TEMPORARY: tableType = TableType.TEMPORARY; break;
case VIEW: tableType = TableType.VIEW; break;
case MATERIALIZED_VIEW:tableType = TableType.MATERIALIZED_VIEW; break;
case BASE_TABLE:
default: tableType = TableType.TABLE; break;
}
String source = null;
if (tableType == TableType.VIEW || tableType == TableType.MATERIALIZED_VIEW) {
viewLoop:
for (View view : info().getViews()) {
if (StringUtils.equals(defaultIfNull(table.getTableCatalog(), ""), defaultIfNull(view.getTableCatalog(), "")) &&
StringUtils.equals(defaultIfNull(table.getTableSchema(), ""), defaultIfNull(view.getTableSchema(), "")) &&
StringUtils.equals(defaultIfNull(table.getTableName(), ""), defaultIfNull(view.getTableName(), ""))) {
source = view.getViewDefinition();
break viewLoop;
}
}
}
result.add(new XMLTableDefinition(schema, info(), table, table.getComment(), tableType, source));
}
}
return result;
}
@Override
protected List getEnums0() {
List result = new ArrayList<>();
return result;
}
@Override
protected List getDomains0() throws SQLException {
List result = new ArrayList<>();
return result;
}
@Override
protected List getXMLSchemaCollections0() throws SQLException {
List result = new ArrayList<>();
return result;
}
@Override
protected List getUDTs0() {
List result = new ArrayList<>();
return result;
}
@Override
protected List getArrays0() {
List result = new ArrayList<>();
return result;
}
@Override
protected List getRoutines0() {
List result = new ArrayList<>();
for (Routine routine : info().getRoutines()) {
if (isBlank(routine.getSpecificPackage()) && isBlank(routine.getRoutinePackage())) {
String schemaName = defaultIfBlank(routine.getSpecificSchema(), routine.getRoutineSchema());
if (getInputSchemata().contains(schemaName)) {
SchemaDefinition schema = getSchema(schemaName);
result.add(new XMLRoutineDefinition(schema, null, info(), routine, routine.getComment()));
}
}
}
return result;
}
@Override
protected List getPackages0() {
List result = new ArrayList<>();
Set packages = new HashSet<>();
for (Routine routine : info().getRoutines()) {
String schemaName = defaultIfBlank(routine.getSpecificSchema(), routine.getRoutineSchema());
if (getInputSchemata().contains(schemaName)) {
SchemaDefinition schema = getSchema(schemaName);
String packageName = defaultIfBlank(routine.getSpecificPackage(), routine.getRoutinePackage());
if (!isBlank(packageName) && packages.add(packageName)) {
result.add(new XMLPackageDefinition(schema, info(), packageName));
}
}
}
return result;
}
static int unbox(Integer i) {
return i == null ? 0 : i.intValue();
}
static long unbox(Long l) {
return l == null ? 0L : l.longValue();
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy