org.apache.metamodel.jdbc

Class JdbcDataContext

java.lang.Object

org.apache.metamodel.AbstractDataContext

org.apache.metamodel.jdbc.JdbcDataContext

All Implemented Interfaces:

DataContext, UpdateableDataContext

public class JdbcDataContext
extends AbstractDataContext
implements UpdateableDataContext

DataContextStrategy to use for JDBC-compliant databases

Field Summary

Fields

Modifier and Type	Field and Description
static ColumnType	COLUMN_TYPE_BLOB_AS_BYTES
static ColumnType	COLUMN_TYPE_CLOB_AS_STRING
static String	DATABASE_PRODUCT_DB2
static String	DATABASE_PRODUCT_DB2_PREFIX
static String	DATABASE_PRODUCT_H2
static String	DATABASE_PRODUCT_HIVE
static String	DATABASE_PRODUCT_HSQLDB
static String	DATABASE_PRODUCT_MYSQL
static String	DATABASE_PRODUCT_ORACLE
static String	DATABASE_PRODUCT_POSTGRESQL
static String	DATABASE_PRODUCT_SQLSERVER
static String	SYSTEM_PROPERTY_BATCH_UPDATES
static String	SYSTEM_PROPERTY_COMPILED_QUERY_POOL_MAX_SIZE
static String	SYSTEM_PROPERTY_COMPILED_QUERY_POOL_MIN_EVICTABLE_IDLE_TIME_MILLIS
static String	SYSTEM_PROPERTY_COMPILED_QUERY_POOL_TIME_BETWEEN_EVICTION_RUNS_MILLIS
static String	SYSTEM_PROPERTY_CONVERT_LOBS

Constructor Summary

Constructors

Constructor and Description
JdbcDataContext(Connection connection) Creates the strategy based on a Connection
JdbcDataContext(Connection connection, TableType[] tableTypes, String catalogName) Creates the strategy based on a Connection, some table types and an optional catalogName
JdbcDataContext(DataSource dataSource) Creates the strategy based on a DataSource
JdbcDataContext(DataSource dataSource, TableType[] tableTypes, String catalogName) Creates the strategy based on a data source, some table types and an optional catalogName

Method Summary

Methods

Modifier and Type	Method and Description
void	close(Connection connection, ResultSet rs, Statement st) Quietly closes any of the parameterized JDBC objects
CompiledQuery	compileQuery(Query query) Compiles a query, preparing it for reuse.
DataSet	executeQuery(CompiledQuery compiledQuery, Object... values) Executes a compiled query with given values as parameters.
DataSet	executeQuery(Query query) Executes a query against the DataContext.
void	executeUpdate(UpdateScript update) Submits an UpdateScript for execution on the DataContext.
String	getCatalogName()
String[]	getCatalogNames() Convenience method to get the available catalogNames using this connection.
Connection	getConnection() Gets an appropriate connection object to use - either a dedicated connection or a new connection from the datasource object.
String	getDefaultSchemaName() Gets the name of the default schema.
Object	getDelegate() Gets the delegate from the JDBC API (ie.
org.apache.metamodel.jdbc.FetchSizeCalculator	getFetchSizeCalculator()
String	getIdentifierQuoteString()
IQueryRewriter	getQueryRewriter()
protected Schema	getSchemaByNameInternal(String name) Gets a specific schema from the non-abstract implementation.
protected String[]	getSchemaNamesInternal() Gets schema names from the non-abstract implementation.
TableType[]	getTableTypes()
protected boolean	isDefaultAutoCommit()
protected boolean	isQualifiedPathDelim(char c)
protected boolean	isSingleConnection()
JdbcDataContext	setQueryRewriter(IQueryRewriter queryRewriter)

Methods inherited from class org.apache.metamodel.AbstractDataContext

executeQuery, getColumnByQualifiedLabel, getDefaultSchema, getSchemaByName, getSchemaNames, getSchemas, getTableByQualifiedLabel, onSchemaCacheRefreshed, parseQuery, query, refreshSchemas

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.metamodel.DataContext

executeQuery, getColumnByQualifiedLabel, getDefaultSchema, getSchemaByName, getSchemaNames, getSchemas, getTableByQualifiedLabel, parseQuery, query, refreshSchemas

Field Detail

SYSTEM_PROPERTY_BATCH_UPDATES

public static final String SYSTEM_PROPERTY_BATCH_UPDATES

See Also:

Constant Field Values

SYSTEM_PROPERTY_CONVERT_LOBS

public static final String SYSTEM_PROPERTY_CONVERT_LOBS

See Also:

Constant Field Values

SYSTEM_PROPERTY_COMPILED_QUERY_POOL_MAX_SIZE

public static final String SYSTEM_PROPERTY_COMPILED_QUERY_POOL_MAX_SIZE

See Also:

Constant Field Values

SYSTEM_PROPERTY_COMPILED_QUERY_POOL_MIN_EVICTABLE_IDLE_TIME_MILLIS

public static final String SYSTEM_PROPERTY_COMPILED_QUERY_POOL_MIN_EVICTABLE_IDLE_TIME_MILLIS

See Also:

Constant Field Values

SYSTEM_PROPERTY_COMPILED_QUERY_POOL_TIME_BETWEEN_EVICTION_RUNS_MILLIS

public static final String SYSTEM_PROPERTY_COMPILED_QUERY_POOL_TIME_BETWEEN_EVICTION_RUNS_MILLIS

See Also:

Constant Field Values

DATABASE_PRODUCT_POSTGRESQL

public static final String DATABASE_PRODUCT_POSTGRESQL

See Also:

Constant Field Values

DATABASE_PRODUCT_MYSQL

public static final String DATABASE_PRODUCT_MYSQL

See Also:

Constant Field Values

DATABASE_PRODUCT_HSQLDB

public static final String DATABASE_PRODUCT_HSQLDB

See Also:

Constant Field Values

DATABASE_PRODUCT_H2

public static final String DATABASE_PRODUCT_H2

See Also:

Constant Field Values

DATABASE_PRODUCT_SQLSERVER

public static final String DATABASE_PRODUCT_SQLSERVER

See Also:

Constant Field Values

DATABASE_PRODUCT_DB2

public static final String DATABASE_PRODUCT_DB2

See Also:

Constant Field Values

DATABASE_PRODUCT_DB2_PREFIX

public static final String DATABASE_PRODUCT_DB2_PREFIX

See Also:

Constant Field Values

DATABASE_PRODUCT_ORACLE

public static final String DATABASE_PRODUCT_ORACLE

See Also:

Constant Field Values

DATABASE_PRODUCT_HIVE

public static final String DATABASE_PRODUCT_HIVE

See Also:

Constant Field Values

COLUMN_TYPE_CLOB_AS_STRING

public static final ColumnType COLUMN_TYPE_CLOB_AS_STRING

COLUMN_TYPE_BLOB_AS_BYTES

public static final ColumnType COLUMN_TYPE_BLOB_AS_BYTES

Constructor Detail

JdbcDataContext

public JdbcDataContext(DataSource dataSource,
               TableType[] tableTypes,
               String catalogName)

Creates the strategy based on a data source, some table types and an optional catalogName

Parameters:

dataSource - the datasource objcet to use for making connections

tableTypes - the types of tables to include

catalogName - a catalog name to use, can be null

JdbcDataContext

public JdbcDataContext(Connection connection,
               TableType[] tableTypes,
               String catalogName)

Creates the strategy based on a Connection, some table types and an optional catalogName

Parameters:

connection - the database connection

tableTypes - the types of tables to include

catalogName - a catalog name to use, can be null

JdbcDataContext

public JdbcDataContext(Connection connection)

Creates the strategy based on a Connection

Parameters:

connection - the database connection

JdbcDataContext

public JdbcDataContext(DataSource dataSource)

Creates the strategy based on a DataSource

Parameters:

dataSource - the data source

Method Detail

compileQuery

public CompiledQuery compileQuery(Query query)

Description copied from interface: DataContext

Compiles a query, preparing it for reuse. Often times compiled queries have a performance improvement when executed, but at the cost of a preparation time penalty. Therefore it is adviced to use compiled queries when the same query is to be fired multiple times. Compiled queries can contain QueryParameters as operands in the WHERE clause, making it possible to reuse the same query with different parameter values.

Specified by:

compileQuery in interface DataContext

Overrides:

compileQuery in class AbstractDataContext

Parameters:

query - the query object to execute, possibly holding one or more QueryParameters.

Returns:

the CompiledQuery after preparing the query

See Also:

CompiledQuery, QueryParameter

executeQuery

public DataSet executeQuery(CompiledQuery compiledQuery,
                   Object... values)

Description copied from interface: DataContext

Executes a compiled query with given values as parameters.

Specified by:

executeQuery in interface DataContext

Overrides:

executeQuery in class AbstractDataContext

Parameters:

compiledQuery - the compiledQuery object to execute

values - the values for parameters in the CompiledQuery.

Returns:

the DataSet produced from executing the query.

executeQuery

public DataSet executeQuery(Query query)
                     throws MetaModelException

Description copied from interface: DataContext

Executes a query against the DataContext.

Specified by:

executeQuery in interface DataContext

Parameters:

query - the query object to execute

Returns:

the DataSet produced from executing the query

Throws:

MetaModelException - if the specified query does not make sense or cannot be executed because of restraints on the type of datastore.

close

public void close(Connection connection,
         ResultSet rs,
         Statement st)

Quietly closes any of the parameterized JDBC objects

Parameters:

connection -

rs -

st -

getCatalogNames

public String[] getCatalogNames()

Convenience method to get the available catalogNames using this connection.

Returns:

a String-array with the names of the available catalogs.

getDelegate

public Object getDelegate()

Gets the delegate from the JDBC API (ie. Connection or DataSource) that is being used to perform database interactions.

Returns:

either a DataSource or a Connection, depending on the configuration of the DataContext.

getConnection

public Connection getConnection()

Gets an appropriate connection object to use - either a dedicated connection or a new connection from the datasource object. Hint: Use the close(Connection, ResultSet, Statement) method to close the connection (and any ResultSet or Statements involved).

getDefaultSchemaName

public String getDefaultSchemaName()

Description copied from class: AbstractDataContext

Gets the name of the default schema.

Specified by:

getDefaultSchemaName in class AbstractDataContext

Returns:

the default schema name.

setQueryRewriter

public JdbcDataContext setQueryRewriter(IQueryRewriter queryRewriter)

getQueryRewriter

public IQueryRewriter getQueryRewriter()

getIdentifierQuoteString

public String getIdentifierQuoteString()

getSchemaNamesInternal

protected String[] getSchemaNamesInternal()

Description copied from class: AbstractDataContext

Gets schema names from the non-abstract implementation. These schema names will be cached except if the AbstractDataContext.refreshSchemas() method is called.

Specified by:

getSchemaNamesInternal in class AbstractDataContext

Returns:

an array of schema names.

getSchemaByNameInternal

protected Schema getSchemaByNameInternal(String name)

Description copied from class: AbstractDataContext

Gets a specific schema from the non-abstract implementation. This schema object will be cached except if the AbstractDataContext.refreshSchemas() method is called.

Specified by:

getSchemaByNameInternal in class AbstractDataContext

Parameters:

name - the name of the schema to get

Returns:

a schema object representing the named schema, or null if no such schema exists.

getFetchSizeCalculator

public org.apache.metamodel.jdbc.FetchSizeCalculator getFetchSizeCalculator()

executeUpdate

public void executeUpdate(UpdateScript update)

Description copied from interface: UpdateableDataContext

Submits an UpdateScript for execution on the DataContext. Since implementations of the DataContext vary quite a lot, there is no golden rule as to how an update script will be executed. But the implementors should strive towards handling an UpdateScript as a single transactional change to the data store.

Specified by:

executeUpdate in interface UpdateableDataContext

Parameters:

update - the update script to execute

isSingleConnection

protected boolean isSingleConnection()

isDefaultAutoCommit

protected boolean isDefaultAutoCommit()

isQualifiedPathDelim

protected boolean isQualifiedPathDelim(char c)

Overrides:

isQualifiedPathDelim in class AbstractDataContext

getTableTypes

public TableType[] getTableTypes()

getCatalogName

public String getCatalogName()