Apache Derby Tools 10.17.1.0 · org.apache.derby.impl.tools.optional.ForeignDBViews

Modifier and Type	Field and Description
private static final String[]	SAFE_DROP_SQLSTATES
private static final int	XML_TYPE

Access	Constructor and Description
public	ForeignDBViews() 0-arg constructor required by the OptionalTool contract

Method Summary

Modifier and Type	Method and Description
private void	createDerbySchema(Connection derbyConn, String derbySchemaName) Create a Derby schema if it does not already exist.
private String	delimitedID(String text)
private String	dotSeparatedSchemaName(String rawName) Turn a Derby schema name into a schema name suitable for use in a dot-separated object name.
private void	dropDerbySchema(Connection derbyConn, String derbySchemaName) Drop a Derby schema.
private void	dropObject(Connection conn, String schemaName, String objectName, String objectType, boolean restrict) Drop a schema object.
private void	executeDDL(Connection conn, String text)
private Connection	getDerbyConnection()
private String	getDerbySchemaName(String schemaPrefix, String foreignSchemaName) Get the name of the local Derby schema corresponding to a foreign schema name.
private Connection	getForeignConnection(String connectionURL)
private ResultSet	getForeignTables(DatabaseMetaData foreignDBMD) Get a cursor through the user tables in the foreign database.
public void	loadTool(String... configurationParameters) Implements org.apache.derby.iapi.sql.dictionary.OptionalTool.loadTool. Creates a local Derby schema for every foreign schema which contains a user table.
private String	mapType(int jdbcType, int precision, int scale, String foreignTypeName) Get the type of an external database's column as a Derby type name.
private String	precisionAndScale(int precision, int scale) Build a precision and scale designator.
private String	precisionToLength(int precision) Turns precision into a length designator.
private PreparedStatement	prepareStatement(Connection conn, String text)
private void	registerForeignTable(DatabaseMetaData foreignDBMD, String foreignSchemaName, String foreignTableName, String foreignConnectionURL, String schemaPrefix, Connection derbyConn)
private String	stringLiteral(String text)
public void	unloadTool(String... configurationParameters) Implements org.apache.derby.iapi.sql.dictionary.OptionalTool.unloadTool. Removes the schemas, table functions, and views created by loadTool().
private SQLException	wrap(String errorMessage)

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

SAFE_DROP_SQLSTATES	back to summary
private static final String[] SAFE_DROP_SQLSTATES

XML_TYPE	back to summary
private static final int XML_TYPE

ForeignDBViews	back to summary
public ForeignDBViews() 0-arg constructor required by the OptionalTool contract

Method Detail

createDerbySchema	back to summary
private void createDerbySchema(Connection derbyConn, String derbySchemaName) throws SQLException Create a Derby schema if it does not already exist.

delimitedID	back to summary
private String delimitedID(String text)

dotSeparatedSchemaName	back to summary
private String dotSeparatedSchemaName(String rawName) Turn a Derby schema name into a schema name suitable for use in a dot-separated object name.

dropDerbySchema	back to summary
private void dropDerbySchema(Connection derbyConn, String derbySchemaName) throws SQLException Drop a Derby schema.

dropObject	back to summary
private void dropObject(Connection conn, String schemaName, String objectName, String objectType, boolean restrict) throws SQLException Drop a schema object. If the object does not exist, silently swallow the error.

executeDDL	back to summary
private void executeDDL(Connection conn, String text) throws SQLException

getDerbyConnection	back to summary
private Connection getDerbyConnection() throws SQLException

getDerbySchemaName	back to summary
private String getDerbySchemaName(String schemaPrefix, String foreignSchemaName) Get the name of the local Derby schema corresponding to a foreign schema name. Returns null if the default (current) schema is to be used.

getForeignConnection	back to summary
private Connection getForeignConnection(String connectionURL) throws SQLException

getForeignTables	back to summary
private ResultSet getForeignTables(DatabaseMetaData foreignDBMD) throws SQLException Get a cursor through the user tables in the foreign database.

loadTool	back to summary
public void loadTool(String... configurationParameters) throws SQLException Implements org.apache.derby.iapi.sql.dictionary.OptionalTool.loadTool. Creates a local Derby schema for every foreign schema which contains a user table. Then creates a table function and convenience view for every user table found in the foreign database. The parameters to this method are: foreignConnectionURL (required) - URL to connect to the foreign database schemaPrefix (optional) - If not specified, then the local Derby schema which is created has the same name as the foreign schema. Otherwise, this prefix is prepended to the names of the local Derby schemas which are created.

loadTool

back to summary

public void loadTool(String... configurationParameters) throws SQLException

Implements org.apache.derby.iapi.sql.dictionary.OptionalTool.loadTool.

Creates a local Derby schema for every foreign schema which contains a user table. Then creates a table function and convenience view for every user table found in the foreign database. The parameters to this method are:

foreignConnectionURL (required) - URL to connect to the foreign database
schemaPrefix (optional) - If not specified, then the local Derby schema which is created has the same name as the foreign schema. Otherwise, this prefix is prepended to the names of the local Derby schemas which are created.

mapType	back to summary
private String mapType(int jdbcType, int precision, int scale, String foreignTypeName) throws SQLException Get the type of an external database's column as a Derby type name.

precisionAndScale	back to summary
private String precisionAndScale(int precision, int scale) Build a precision and scale designator.

precisionToLength	back to summary
private String precisionToLength(int precision) Turns precision into a length designator.

prepareStatement	back to summary
private PreparedStatement prepareStatement(Connection conn, String text) throws SQLException

registerForeignTable	back to summary
private void registerForeignTable(DatabaseMetaData foreignDBMD, String foreignSchemaName, String foreignTableName, String foreignConnectionURL, String schemaPrefix, Connection derbyConn) throws SQLException

stringLiteral	back to summary
private String stringLiteral(String text)

unloadTool	back to summary
public void unloadTool(String... configurationParameters) throws SQLException Implements org.apache.derby.iapi.sql.dictionary.OptionalTool.unloadTool. Removes the schemas, table functions, and views created by loadTool(). connectionURL (required) - URL to connect to the foreign database schemaPrefix (optional) - See loadTool() for more information on this argument.

unloadTool

back to summary

public void unloadTool(String... configurationParameters) throws SQLException

Implements org.apache.derby.iapi.sql.dictionary.OptionalTool.unloadTool.

Removes the schemas, table functions, and views created by loadTool().

connectionURL (required) - URL to connect to the foreign database
schemaPrefix (optional) - See loadTool() for more information on this argument.

wrap	back to summary
private SQLException wrap(String errorMessage)

public Class ForeignDBViews

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail