org.datanucleus.store.rdbms.schema
Class RDBMSSchemaHandler

java.lang.Object
  org.datanucleus.store.rdbms.schema.RDBMSSchemaHandler

All Implemented Interfaces:

org.datanucleus.store.schema.StoreSchemaHandler

public class RDBMSSchemaHandler
extends Object
implements org.datanucleus.store.schema.StoreSchemaHandler

Handler for RDBMS schema information. Provides access to the following types of schema data

• types : type information for the datastore columns
• tables : hierarchy of schema-tables-columns.
• foreign-keys : FK info for a table
• primary-keys : PK info for a table
• indices : Indices info for a table
• columns : Columns info for a table

Field Summary

protected long	COLUMN_INFO_EXPIRATION_MS Time within which column info is valid (millisecs).
protected static org.datanucleus.util.Localiser	LOCALISER Localiser for messages.
protected Map<String,org.datanucleus.store.schema.StoreSchemaData>	schemaDataByName Map of schema data, keyed by its symbolic name where the data is cached.
protected RDBMSStoreManager	storeMgr

Constructor Summary

RDBMSSchemaHandler(RDBMSStoreManager storeMgr)

Method Summary

void	clear() Method to clear out any cached schema information.
void	createSchema(Object connection, String schemaName) Method to create the schema with the supplied name.
void	deleteSchema(Object connection, String schemaName) Method to delete the schema with the supplied name.
protected RDBMSColumnInfo	getRDBMSColumnInfoForColumn(Connection conn, Table table, String columnName) Convenience method to get the column info from the datastore for the column in the specified table.
protected RDBMSSchemaInfo	getRDBMSSchemaInfoForCatalogSchema(Connection conn, String catalog, String schema) Convenience method to retrieve schema information for all tables in the specified catalog/schema.
protected RDBMSTableFKInfo	getRDBMSTableFKInfoForTable(Connection conn, String catalogName, String schemaName, String tableName) Convenience method to get the ForeignKey info for the specified table from the datastore.
protected RDBMSTableFKInfo	getRDBMSTableFKInfoForTable(Connection conn, Table table) Convenience method to get the ForeignKey info for the specified table from the datastore.
protected RDBMSTableIndexInfo	getRDBMSTableIndexInfoForTable(Connection conn, String catalogName, String schemaName, String tableName) Convenience method to get the index info for the catalog+schema+tableName in the datastore.
protected RDBMSTableIndexInfo	getRDBMSTableIndexInfoForTable(Connection conn, Table table) Convenience method to get the index info for the specified table from the datastore.
protected RDBMSTableInfo	getRDBMSTableInfoForTable(Connection conn, String catalogName, String schemaName, String tableName) Convenience method to get the column info for the catalog+schema+tableName in the datastore.
protected RDBMSTableInfo	getRDBMSTableInfoForTable(Connection conn, Table table) Convenience method to get the column info for the specified table from the datastore.
protected RDBMSTablePKInfo	getRDBMSTablePKInfoForTable(Connection conn, String catalogName, String schemaName, String tableName) Convenience method to get the PrimaryKey info for the specified table from the datastore.
protected RDBMSTablePKInfo	getRDBMSTablePKInfoForTable(Connection conn, Table table) Convenience method to get the PrimaryKey info for the specified table from the datastore.
protected RDBMSTypesInfo	getRDBMSTypesInfo(Connection conn) Convenience method to read and cache the types information for this datastore.
org.datanucleus.store.schema.StoreSchemaData	getSchemaData(Object connection, String name, Object[] values) Accessor for schema data store under the provided name and defined by the specified values.
org.datanucleus.store.StoreManager	getStoreManager() Accessor for the StoreManager we handle the schema for.
String	getTableType(Connection conn, Table table) Returns the type of a database table/view in the datastore.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOCALISER

protected static final org.datanucleus.util.Localiser LOCALISER

Localiser for messages.

COLUMN_INFO_EXPIRATION_MS

protected final long COLUMN_INFO_EXPIRATION_MS

Time within which column info is valid (millisecs). Set to 5 mins.

See Also:

Constant Field Values

storeMgr

protected final RDBMSStoreManager storeMgr

schemaDataByName

protected Map<String,org.datanucleus.store.schema.StoreSchemaData> schemaDataByName

Map of schema data, keyed by its symbolic name where the data is cached. Can be "types", "tables" etc. The "tables" cached here are "known tables" and not just all tables for the catalog/schema.

Constructor Detail

RDBMSSchemaHandler

public RDBMSSchemaHandler(RDBMSStoreManager storeMgr)

Method Detail

clear

public void clear()

Method to clear out any cached schema information.

Specified by:

clear in interface org.datanucleus.store.schema.StoreSchemaHandler

createSchema

public void createSchema(Object connection,
                         String schemaName)

Method to create the schema with the supplied name.

Specified by:

createSchema in interface org.datanucleus.store.schema.StoreSchemaHandler

Parameters:

connection - Connection to the datastore

schemaName - Name of the schema

deleteSchema

public void deleteSchema(Object connection,
                         String schemaName)

Method to delete the schema with the supplied name.

Specified by:

deleteSchema in interface org.datanucleus.store.schema.StoreSchemaHandler

Parameters:

connection - Connection to the datastore

schemaName - Name of the schema

getSchemaData

public org.datanucleus.store.schema.StoreSchemaData getSchemaData(Object connection,
                                                                  String name,
                                                                  Object[] values)

Accessor for schema data store under the provided name and defined by the specified values. When there are no "values" the following are supported usages:-

• types : return the JDBC/SQL types for the datastore. Returns an RDBMSTypesInfo which contains the JDBCTypeInfo, which in turn contains the SQLTypeInfo. Types information is loaded on the first call and is cached thereafter.
• tables : return all currently loaded tables, with their columns. Returns an RDBMSSchemaInfo. When a table has been loaded for more than a period of time and is requested again we discard the cached info and go to the datastore in case it has been updated.

When there is only one "value" the following are supported usages:-

• foreign-keys : return all foreign keys for a Table, where the Table is passed in. Returns an RDBMSTableFKInfo
• primary-keys : return all primary keys for a Table, where the Table is passed in. Returns an RDBMSTablePFKInfo
• indices : return all indices for a Table, where the Table is passed in. Returns an RDBMSTableIndexInfo
• columns : return all columns for a Table, where the Table is passed in. Returns an RDBMSTableInfo.

When there are two "values" the following are supported usages:-

• columns : return column info for the supplied Table and column name. Returns an RDBMSTableInfo.
• tables : return table information for the supplied catalog and schema names. Returns an RDBMSSchemaInfo

When there are 3 "values" the following are supported usages:-

• foreign-keys : return all foreign keys for a Table, where the catalog+schema+table is passed in. Returns an RDBMSTableFKInfo
• primary-keys : return all primary keys for a Table, where the catalog+schema+table is passed in. Returns an RDBMSTablePFKInfo
• indices : return all indices for a Table, where the catalog+schema+table is passed in. Returns an RDBMSTableIndexInfo
• columns : return all columns for a Table, where the catalog+schema+table is passed in. Returns an RDBMSTableInfo.

Specified by:

getSchemaData in interface org.datanucleus.store.schema.StoreSchemaHandler

Parameters:

connection - Connection to the datastore

name - Name of the schema component to return.

values - Value(s) to use as qualifier(s) for selecting the schema component

Returns:

Schema data definition for this name

getStoreManager

public org.datanucleus.store.StoreManager getStoreManager()

Accessor for the StoreManager we handle the schema for.

Specified by:

getStoreManager in interface org.datanucleus.store.schema.StoreSchemaHandler

Returns:

Store Manager.

getTableType

public String getTableType(Connection conn,
                           Table table)
                    throws SQLException

Returns the type of a database table/view in the datastore. Uses DatabaseMetaData.getTables() to extract this information.

Parameters:

conn - Connection to the database.

table - The table/view

Returns:

The table type (consistent with the return from DatabaseMetaData.getTables())

Throws:

org.datanucleus.exceptions.NucleusDataStoreException - if an error occurs obtaining the information

SQLException

getRDBMSTypesInfo

protected RDBMSTypesInfo getRDBMSTypesInfo(Connection conn)

Convenience method to read and cache the types information for this datastore.

Parameters:

conn - Connection to the datastore

Returns:

The RDBMSTypesInfo

getRDBMSTableFKInfoForTable

protected RDBMSTableFKInfo getRDBMSTableFKInfoForTable(Connection conn,
                                                       Table table)

Convenience method to get the ForeignKey info for the specified table from the datastore.

Parameters:

conn - Connection to use

table - The table

Returns:

The foreign key info

getRDBMSTableFKInfoForTable

protected RDBMSTableFKInfo getRDBMSTableFKInfoForTable(Connection conn,
                                                       String catalogName,
                                                       String schemaName,
                                                       String tableName)

Convenience method to get the ForeignKey info for the specified table from the datastore.

Parameters:

conn - Connection to use

catalogName - Catalog

schemaName - Schema

tableName - Name of the table

Returns:

The foreign key info

getRDBMSTablePKInfoForTable

protected RDBMSTablePKInfo getRDBMSTablePKInfoForTable(Connection conn,
                                                       Table table)

Convenience method to get the PrimaryKey info for the specified table from the datastore.

Parameters:

conn - Connection to use

table - The table

Returns:

The primary key info

getRDBMSTablePKInfoForTable

protected RDBMSTablePKInfo getRDBMSTablePKInfoForTable(Connection conn,
                                                       String catalogName,
                                                       String schemaName,
                                                       String tableName)

Convenience method to get the PrimaryKey info for the specified table from the datastore.

Parameters:

conn - Connection to use

catalogName - Catalog

schemaName - Schema

tableName - Name of the table

Returns:

The primary key info

getRDBMSTableIndexInfoForTable

protected RDBMSTableIndexInfo getRDBMSTableIndexInfoForTable(Connection conn,
                                                             Table table)

Convenience method to get the index info for the specified table from the datastore. Returns ALL indexes regardless of whether unique or not.

Parameters:

conn - Connection to use

table - The table

Returns:

The index info

getRDBMSTableIndexInfoForTable

protected RDBMSTableIndexInfo getRDBMSTableIndexInfoForTable(Connection conn,
                                                             String catalogName,
                                                             String schemaName,
                                                             String tableName)

Convenience method to get the index info for the catalog+schema+tableName in the datastore. Returns ALL indexes regardless of whether unique or not.

Parameters:

conn - Connection to use

catalogName - Catalog

schemaName - Schema

tableName - Name of the table

Returns:

The index info

getRDBMSSchemaInfoForCatalogSchema

protected RDBMSSchemaInfo getRDBMSSchemaInfoForCatalogSchema(Connection conn,
                                                             String catalog,
                                                             String schema)

Convenience method to retrieve schema information for all tables in the specified catalog/schema.

Parameters:

conn - Connection

catalog - Catalog

schema - Schema

Returns:

Schema information

getRDBMSTableInfoForTable

protected RDBMSTableInfo getRDBMSTableInfoForTable(Connection conn,
                                                   Table table)

Convenience method to get the column info for the specified table from the datastore.

Parameters:

conn - Connection to use

table - The table

Returns:

The table info containing the columns

getRDBMSTableInfoForTable

protected RDBMSTableInfo getRDBMSTableInfoForTable(Connection conn,
                                                   String catalogName,
                                                   String schemaName,
                                                   String tableName)

Convenience method to get the column info for the catalog+schema+tableName in the datastore.

Parameters:

conn - Connection to use

catalogName - Catalog

schemaName - Schema

tableName - Name of the table

Returns:

The table info containing the columns

getRDBMSColumnInfoForColumn

protected RDBMSColumnInfo getRDBMSColumnInfoForColumn(Connection conn,
                                                      Table table,
                                                      String columnName)

Convenience method to get the column info from the datastore for the column in the specified table.

Parameters:

conn - Connection to use

table - The table

columnName - Name of the column

Returns:

The column info for the table+column