package org.jumpmind.db.platform.interbase;
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you 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.
*/
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.sql.Statement;
import java.sql.Types;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.commons.collections.map.ListOrderedMap;
import org.jumpmind.db.model.Column;
import org.jumpmind.db.model.ForeignKey;
import org.jumpmind.db.model.IIndex;
import org.jumpmind.db.model.Table;
import org.jumpmind.db.model.TypeMap;
import org.jumpmind.db.platform.AbstractJdbcDdlReader;
import org.jumpmind.db.platform.DatabaseMetaDataWrapper;
import org.jumpmind.db.platform.IDatabasePlatform;
/*
* The Jdbc Model Reader for Interbase.
*/
public class InterbaseDdlReader extends AbstractJdbcDdlReader {
public InterbaseDdlReader(IDatabasePlatform platform) {
super(platform);
setDefaultCatalogPattern(null);
setDefaultSchemaPattern(null);
setDefaultTablePattern("%");
setDefaultColumnPattern("%");
}
@Override
protected Table readTable(Connection connection, DatabaseMetaDataWrapper metaData,
Map<String, Object> values) throws SQLException {
Table table = super.readTable(connection, metaData, values);
if (table != null) {
determineExtraColumnInfo(connection, table);
determineAutoIncrementColumns(connection, table);
adjustColumns(table);
}
return table;
}
protected Column readColumn(DatabaseMetaDataWrapper metaData, Map<String, Object> values)
throws SQLException {
Column column = super.readColumn(metaData, values);
if (column.getMappedTypeCode() == Types.VARCHAR) {
int size = Integer.parseInt(column.getSize());
if (size >= InterbaseDdlBuilder.SWITCH_TO_LONGVARCHAR_SIZE) {
column.setMappedTypeCode(Types.LONGVARCHAR);
}
}
return column;
}
@Override
protected Collection<Column> readColumns(DatabaseMetaDataWrapper metaData, String tableName)
throws SQLException {
ResultSet columnData = null;
try {
List<Column> columns = new ArrayList<Column>();
if (getPlatform().getDdlBuilder().isDelimitedIdentifierModeOn()) {
// Jaybird has a problem when delimited identifiers are used as
// it is not able to find the columns for the table
// So we have to filter manually below
columnData = metaData.getColumns(getDefaultTablePattern(),
getDefaultColumnPattern());
while (columnData.next()) {
Map<String, Object> values = readMetaData(columnData, getColumnsForColumn());
if (tableName.equals(values.get("TABLE_NAME"))) {
columns.add(readColumn(metaData, values));
}
}
} else {
columnData = metaData.getColumns(tableName, getDefaultColumnPattern());
while (columnData.next()) {
Map<String, Object> values = readMetaData(columnData, getColumnsForColumn());
columns.add(readColumn(metaData, values));
}
}
return columns;
} finally {
if (columnData != null) {
columnData.close();
}
}
}
/*
* Helper method that determines extra column info from the system tables:
* default value, precision, scale.
*
* @param table The table
*/
protected void determineExtraColumnInfo(Connection connection, Table table) throws SQLException {
StringBuffer query = new StringBuffer();
query.append("SELECT a.RDB$FIELD_NAME, a.RDB$DEFAULT_SOURCE, b.RDB$FIELD_PRECISION, b.RDB$FIELD_SCALE,");
query.append(" b.RDB$FIELD_TYPE, b.RDB$FIELD_SUB_TYPE FROM RDB$RELATION_FIELDS a, RDB$FIELDS b");
query.append(" WHERE a.RDB$RELATION_NAME=? AND a.RDB$FIELD_SOURCE=b.RDB$FIELD_NAME");
PreparedStatement prepStmt = connection.prepareStatement(query.toString());
try {
prepStmt.setString(1, getPlatform().getDdlBuilder().isDelimitedIdentifierModeOn() ? table.getName()
: table.getName().toUpperCase());
ResultSet rs = prepStmt.executeQuery();
while (rs.next()) {
String columnName = rs.getString(1).trim();
Column column = table.findColumn(columnName, getPlatform().getDdlBuilder()
.isDelimitedIdentifierModeOn());
if (column != null) {
byte[] defaultBytes = rs.getBytes(2);
String defaultValue = defaultBytes != null ? new String(defaultBytes) : null;
if (!rs.wasNull() && (defaultValue != null)) {
defaultValue = defaultValue.trim();
if (defaultValue.startsWith("DEFAULT ")) {
defaultValue = defaultValue.substring("DEFAULT ".length());
}
column.setDefaultValue(defaultValue);
}
short precision = rs.getShort(3);
boolean precisionSpecified = !rs.wasNull();
short scale = rs.getShort(4);
boolean scaleSpecified = !rs.wasNull();
if (precisionSpecified) {
// for some reason, Interbase stores the negative scale
column.setSizeAndScale(precision, scaleSpecified ? -scale : 0);
}
short dbType = rs.getShort(5);
short blobSubType = rs.getShort(6);
// CLOBs are returned by the driver as VARCHAR
if (!rs.wasNull() && (dbType == 261) && (blobSubType == 1)) {
column.setMappedTypeCode(Types.CLOB);
}
}
}
rs.close();
} finally {
prepStmt.close();
}
}
/*
* Helper method that determines the auto increment status using Interbase's
* system tables.
*
* @param table The table
*/
protected void determineAutoIncrementColumns(Connection connection, Table table)
throws SQLException {
// Since for long table and column names, the generator name will be
// shortened
// we have to determine for each column whether there is a generator for
// it
InterbaseDdlBuilder builder = (InterbaseDdlBuilder) getPlatform().getDdlBuilder();
Column[] columns = table.getColumns();
HashMap<String, Column> names = new HashMap<String, Column>();
String name;
for (int idx = 0; idx < columns.length; idx++) {
name = builder.getGeneratorName(table, columns[idx]);
if (!getPlatform().getDdlBuilder().isDelimitedIdentifierModeOn()) {
name = name.toUpperCase();
}
names.put(name, columns[idx]);
}
Statement stmt = connection.createStatement();
try {
ResultSet rs = stmt.executeQuery("SELECT RDB$GENERATOR_NAME FROM RDB$GENERATORS");
while (rs.next()) {
String generatorName = rs.getString(1).trim();
Column column = (Column) names.get(generatorName);
if (column != null) {
column.setAutoIncrement(true);
}
}
rs.close();
} finally {
stmt.close();
}
}
/*
* Adjusts the columns in the table by fixing types and default values.
*
* @param table The table
*/
protected void adjustColumns(Table table) {
Column[] columns = table.getColumns();
for (int idx = 0; idx < columns.length; idx++) {
if (columns[idx].getMappedTypeCode() == Types.FLOAT) {
columns[idx].setMappedTypeCode(Types.REAL);
} else if ((columns[idx].getMappedTypeCode() == Types.NUMERIC)
|| (columns[idx].getMappedTypeCode() == Types.DECIMAL)) {
if ((columns[idx].getMappedTypeCode() == Types.NUMERIC)
&& (columns[idx].getSizeAsInt() == 18) && (columns[idx].getScale() == 0)) {
columns[idx].setMappedTypeCode(Types.BIGINT);
}
} else if (TypeMap.isTextType(columns[idx].getMappedTypeCode())) {
columns[idx].setDefaultValue(unescape(columns[idx].getDefaultValue(), "'", "''"));
}
}
}
@Override
protected Collection<String> readPrimaryKeyNames(DatabaseMetaDataWrapper metaData,
String tableName) throws SQLException {
List<String> pks = new ArrayList<String>();
ResultSet pkData = null;
try {
if (getPlatform().getDdlBuilder().isDelimitedIdentifierModeOn()) {
// Jaybird has a problem when delimited identifiers are used as
// it is not able to find the primary key info for the table
// So we have to filter manually below
pkData = metaData.getPrimaryKeys(getDefaultTablePattern());
while (pkData.next()) {
Map<String, Object> values = readMetaData(pkData, getColumnsForPK());
if (tableName.equals(values.get("TABLE_NAME"))) {
pks.add(readPrimaryKeyName(metaData, values));
}
}
} else {
pkData = metaData.getPrimaryKeys(tableName);
while (pkData.next()) {
Map<String, Object> values = readMetaData(pkData, getColumnsForPK());
pks.add(readPrimaryKeyName(metaData, values));
}
}
} finally {
if (pkData != null) {
pkData.close();
}
}
return pks;
}
@Override
protected Collection<IIndex> readIndices(Connection connection, DatabaseMetaDataWrapper metaData,
String tableName) throws SQLException {
// Jaybird is not able to read indices when delimited identifiers are
// turned on,
// so we gather the data manually using Firebird's system tables
@SuppressWarnings("unchecked")
Map<String, IIndex> indices = new ListOrderedMap();
StringBuilder query = new StringBuilder();
query.append("SELECT a.RDB$INDEX_NAME, b.RDB$RELATION_NAME, b.RDB$UNIQUE_FLAG, ");
query.append(" a.RDB$FIELD_POSITION, a.RDB$FIELD_NAME ");
query.append(" FROM RDB$INDEX_SEGMENTS a, RDB$INDICES b ");
query.append(" WHERE a.RDB$INDEX_NAME=b.RDB$INDEX_NAME AND b.RDB$RELATION_NAME = ?");
PreparedStatement stmt = connection.prepareStatement(query.toString());
ResultSet indexData = null;
stmt.setString(1,
getPlatform().getDdlBuilder().isDelimitedIdentifierModeOn() ? tableName : tableName.toUpperCase());
try {
indexData = stmt.executeQuery();
while (indexData.next()) {
Map<String,Object> values = new HashMap<String, Object>();
values.put("INDEX_NAME", indexData.getString(1).trim());
values.put("TABLE_NAME", indexData.getString(2).trim());
values.put("NON_UNIQUE", !indexData.getBoolean(3));
values.put("ORDINAL_POSITION", indexData.getShort(4));
values.put("COLUMN_NAME", indexData.getString(5).trim());
values.put("INDEX_TYPE", 3);
readIndex(metaData, values, indices);
}
} finally {
if (indexData != null) {
indexData.close();
}
}
return indices.values();
}
@Override
protected Collection<ForeignKey> readForeignKeys(Connection connection, DatabaseMetaDataWrapper metaData,
String tableName) throws SQLException {
@SuppressWarnings("unchecked")
Map<String,ForeignKey> fks = new ListOrderedMap();
ResultSet fkData = null;
try {
if (getPlatform().getDdlBuilder().isDelimitedIdentifierModeOn()) {
// Jaybird has a problem when delimited identifiers are used as
// it is not able to find the foreign key info for the table
// So we have to filter manually below
fkData = metaData.getForeignKeys(getDefaultTablePattern());
while (fkData.next()) {
Map<String,Object> values = readMetaData(fkData, getColumnsForFK());
if (tableName.equals(values.get("FKTABLE_NAME"))) {
readForeignKey(metaData, values, fks);
}
}
} else {
fkData = metaData.getForeignKeys(tableName);
while (fkData.next()) {
Map<String,Object> values = readMetaData(fkData, getColumnsForFK());
readForeignKey(metaData, values, fks);
}
}
} finally {
if (fkData != null) {
fkData.close();
}
}
return fks.values();
}
protected boolean isInternalPrimaryKeyIndex(Connection connection,
DatabaseMetaDataWrapper metaData, Table table, IIndex index) throws SQLException {
InterbaseDdlBuilder builder = (InterbaseDdlBuilder) getPlatform().getDdlBuilder();
String tableName = builder.getTableName(table.getName());
String indexName = builder.getIndexName(index);
StringBuffer query = new StringBuffer();
query.append("SELECT RDB$CONSTRAINT_NAME FROM RDB$RELATION_CONSTRAINTS where RDB$RELATION_NAME=? AND RDB$CONSTRAINT_TYPE=? AND RDB$INDEX_NAME=?");
PreparedStatement stmt = connection.prepareStatement(query.toString());
try {
stmt.setString(
1,
getPlatform().getDdlBuilder().isDelimitedIdentifierModeOn() ? tableName : tableName
.toUpperCase());
stmt.setString(2, "PRIMARY KEY");
stmt.setString(3, indexName);
ResultSet resultSet = stmt.executeQuery();
return resultSet.next();
} finally {
if (stmt != null) {
stmt.close();
}
}
}
protected boolean isInternalForeignKeyIndex(Connection connection,
DatabaseMetaDataWrapper metaData, Table table, ForeignKey fk, IIndex index)
throws SQLException {
InterbaseDdlBuilder builder = (InterbaseDdlBuilder) getPlatform().getDdlBuilder();
String tableName = builder.getTableName(table.getName());
String indexName = builder.getIndexName(index);
String fkName = builder.getForeignKeyName(table, fk);
StringBuffer query = new StringBuffer();
query.append("SELECT RDB$CONSTRAINT_NAME FROM RDB$RELATION_CONSTRAINTS where RDB$RELATION_NAME=? AND RDB$CONSTRAINT_TYPE=? AND RDB$CONSTRAINT_NAME=? AND RDB$INDEX_NAME=?");
PreparedStatement stmt = connection.prepareStatement(query.toString());
try {
stmt.setString(
1,
getPlatform().getDdlBuilder().isDelimitedIdentifierModeOn() ? tableName : tableName
.toUpperCase());
stmt.setString(2, "FOREIGN KEY");
stmt.setString(3, fkName);
stmt.setString(4, indexName);
ResultSet resultSet = stmt.executeQuery();
return resultSet.next();
} finally {
if (stmt != null) {
stmt.close();
}
}
}
@Override
protected String getTableNamePattern(String tableName) {
return String.format("\"%s\"", tableName);
}
}