org.apache.calcite.avatica.jdbc

Class JdbcMeta

java.lang.Object

org.apache.calcite.avatica.jdbc.JdbcMeta

All Implemented Interfaces:

Meta

public class JdbcMeta
extends Object
implements Meta

Implementation of Meta upon an existing JDBC data source.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JdbcMeta.ConnectionCacheSettings Configurable connection cache settings.
static class	JdbcMeta.StatementCacheSettings Configurable statement cache settings.

Nested classes/interfaces inherited from interface org.apache.calcite.avatica.Meta

Meta.ConnectionHandle, Meta.ConnectionProperties, Meta.CursorFactory, Meta.DatabaseProperty, Meta.ExecuteResult, Meta.Factory, Meta.Frame, Meta.MetaResultSet, Meta.Pat, Meta.PrepareCallback, Meta.Signature, Meta.StatementHandle, Meta.Style

Constructor Summary

Constructors

Constructor and Description
JdbcMeta(String url)
JdbcMeta(String url, Properties info)
JdbcMeta(String url, String user, String password)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	apply(Connection conn, Meta.ConnectionProperties connProps)
void	closeConnection(Meta.ConnectionHandle ch)
void	closeStatement(Meta.StatementHandle h)
protected static List<ColumnMetaData>	columns(ResultSetMetaData metaData) Convert from JDBC metadata to Avatica columns.
Meta.ConnectionProperties	connectionSync(Meta.ConnectionHandle ch, Meta.ConnectionProperties connProps)
Iterable<Object>	createIterable(Meta.StatementHandle handle, Meta.Signature signature, List<TypedValue> parameterValues, Meta.Frame firstFrame)
Meta.StatementHandle	createStatement(Meta.ConnectionHandle ch)
Meta.Frame	fetch(Meta.StatementHandle h, List<TypedValue> parameterValues, long offset, int fetchMaxRowCount)
Meta.MetaResultSet	getAttributes(String catalog, Meta.Pat schemaPattern, Meta.Pat typeNamePattern, Meta.Pat attributeNamePattern)
Meta.MetaResultSet	getBestRowIdentifier(String catalog, String schema, String table, int scope, boolean nullable)
Meta.MetaResultSet	getCatalogs()
Meta.MetaResultSet	getClientInfoProperties()
Meta.MetaResultSet	getColumnPrivileges(String catalog, String schema, String table, Meta.Pat columnNamePattern)
Meta.MetaResultSet	getColumns(String catalog, Meta.Pat schemaPattern, Meta.Pat tableNamePattern, Meta.Pat columnNamePattern)
protected Connection	getConnection(String id)
Meta.MetaResultSet	getCrossReference(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable)
Map<Meta.DatabaseProperty,Object>	getDatabaseProperties()
Meta.MetaResultSet	getExportedKeys(String catalog, String schema, String table)
Meta.MetaResultSet	getFunctionColumns(String catalog, Meta.Pat schemaPattern, Meta.Pat functionNamePattern, Meta.Pat columnNamePattern)
Meta.MetaResultSet	getFunctions(String catalog, Meta.Pat schemaPattern, Meta.Pat functionNamePattern)
Meta.MetaResultSet	getImportedKeys(String catalog, String schema, String table)
Meta.MetaResultSet	getIndexInfo(String catalog, String schema, String table, boolean unique, boolean approximate)
Meta.MetaResultSet	getPrimaryKeys(String catalog, String schema, String table)
Meta.MetaResultSet	getProcedureColumns(String catalog, Meta.Pat schemaPattern, Meta.Pat procedureNamePattern, Meta.Pat columnNamePattern)
Meta.MetaResultSet	getProcedures(String catalog, Meta.Pat schemaPattern, Meta.Pat procedureNamePattern)
Meta.MetaResultSet	getPseudoColumns(String catalog, Meta.Pat schemaPattern, Meta.Pat tableNamePattern, Meta.Pat columnNamePattern)
Meta.MetaResultSet	getSchemas(String catalog, Meta.Pat schemaPattern)
Meta.MetaResultSet	getSuperTables(String catalog, Meta.Pat schemaPattern, Meta.Pat tableNamePattern)
Meta.MetaResultSet	getSuperTypes(String catalog, Meta.Pat schemaPattern, Meta.Pat typeNamePattern)
Meta.MetaResultSet	getTablePrivileges(String catalog, Meta.Pat schemaPattern, Meta.Pat tableNamePattern)
Meta.MetaResultSet	getTables(String catalog, Meta.Pat schemaPattern, Meta.Pat tableNamePattern, List<String> typeList)
Meta.MetaResultSet	getTableTypes()
Meta.MetaResultSet	getTypeInfo()
Meta.MetaResultSet	getUDTs(String catalog, Meta.Pat schemaPattern, Meta.Pat typeNamePattern, int[] types)
Meta.MetaResultSet	getVersionColumns(String catalog, String schema, String table)
protected static List<AvaticaParameter>	parameters(ParameterMetaData metaData) Converts from JDBC metadata to AvaticaParameters
Meta.StatementHandle	prepare(Meta.ConnectionHandle ch, String sql, long maxRowCount)
Meta.ExecuteResult	prepareAndExecute(Meta.StatementHandle h, String sql, long maxRowCount, Meta.PrepareCallback callback)
protected static Meta.Signature	signature(ResultSetMetaData metaData)
protected static Meta.Signature	signature(ResultSetMetaData metaData, ParameterMetaData parameterMetaData, String sql)

Methods inherited from class java.lang.Object

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

Constructor Detail

JdbcMeta

public JdbcMeta(String url)
         throws SQLException

Parameters:

url - a database url of the form jdbc:subprotocol:subname

Throws:

SQLException

JdbcMeta

public JdbcMeta(String url,
        String user,
        String password)
         throws SQLException

Parameters:

url - a database url of the form jdbc:subprotocol:subname

user - the database user on whose behalf the connection is being made

password - the user's password

Throws:

SQLException

JdbcMeta

public JdbcMeta(String url,
        Properties info)
         throws SQLException

Parameters:

url - a database url of the form jdbc:subprotocol:subname

info - a list of arbitrary string tag/value pairs as connection arguments; normally at least a "user" and "password" property should be included

Throws:

SQLException

Method Detail

columns

protected static List<ColumnMetaData> columns(ResultSetMetaData metaData)
                                       throws SQLException

Convert from JDBC metadata to Avatica columns.

Throws:

SQLException

parameters

protected static List<AvaticaParameter> parameters(ParameterMetaData metaData)
                                            throws SQLException

Converts from JDBC metadata to AvaticaParameters

Throws:

SQLException

signature

protected static Meta.Signature signature(ResultSetMetaData metaData,
                       ParameterMetaData parameterMetaData,
                       String sql)
                                   throws SQLException

Throws:

SQLException

signature

protected static Meta.Signature signature(ResultSetMetaData metaData)
                                   throws SQLException

Throws:

SQLException

getDatabaseProperties

public Map<Meta.DatabaseProperty,Object> getDatabaseProperties()

Specified by:

getDatabaseProperties in interface Meta

getTables

public Meta.MetaResultSet getTables(String catalog,
                           Meta.Pat schemaPattern,
                           Meta.Pat tableNamePattern,
                           List<String> typeList)

Specified by:

getTables in interface Meta

getColumns

public Meta.MetaResultSet getColumns(String catalog,
                            Meta.Pat schemaPattern,
                            Meta.Pat tableNamePattern,
                            Meta.Pat columnNamePattern)

Specified by:

getColumns in interface Meta

getSchemas

public Meta.MetaResultSet getSchemas(String catalog,
                            Meta.Pat schemaPattern)

Specified by:

getSchemas in interface Meta

getCatalogs

public Meta.MetaResultSet getCatalogs()

Specified by:

getCatalogs in interface Meta

getTableTypes

public Meta.MetaResultSet getTableTypes()

Specified by:

getTableTypes in interface Meta

getProcedures

public Meta.MetaResultSet getProcedures(String catalog,
                               Meta.Pat schemaPattern,
                               Meta.Pat procedureNamePattern)

Specified by:

getProcedures in interface Meta

getProcedureColumns

public Meta.MetaResultSet getProcedureColumns(String catalog,
                                     Meta.Pat schemaPattern,
                                     Meta.Pat procedureNamePattern,
                                     Meta.Pat columnNamePattern)

Specified by:

getProcedureColumns in interface Meta

getColumnPrivileges

public Meta.MetaResultSet getColumnPrivileges(String catalog,
                                     String schema,
                                     String table,
                                     Meta.Pat columnNamePattern)

Specified by:

getColumnPrivileges in interface Meta

getTablePrivileges

public Meta.MetaResultSet getTablePrivileges(String catalog,
                                    Meta.Pat schemaPattern,
                                    Meta.Pat tableNamePattern)

Specified by:

getTablePrivileges in interface Meta

getBestRowIdentifier

public Meta.MetaResultSet getBestRowIdentifier(String catalog,
                                      String schema,
                                      String table,
                                      int scope,
                                      boolean nullable)

Specified by:

getBestRowIdentifier in interface Meta

getVersionColumns

public Meta.MetaResultSet getVersionColumns(String catalog,
                                   String schema,
                                   String table)

Specified by:

getVersionColumns in interface Meta

getPrimaryKeys

public Meta.MetaResultSet getPrimaryKeys(String catalog,
                                String schema,
                                String table)

Specified by:

getPrimaryKeys in interface Meta

getImportedKeys

public Meta.MetaResultSet getImportedKeys(String catalog,
                                 String schema,
                                 String table)

Specified by:

getImportedKeys in interface Meta

getExportedKeys

public Meta.MetaResultSet getExportedKeys(String catalog,
                                 String schema,
                                 String table)

Specified by:

getExportedKeys in interface Meta

getCrossReference

public Meta.MetaResultSet getCrossReference(String parentCatalog,
                                   String parentSchema,
                                   String parentTable,
                                   String foreignCatalog,
                                   String foreignSchema,
                                   String foreignTable)

Specified by:

getCrossReference in interface Meta

getTypeInfo

public Meta.MetaResultSet getTypeInfo()

Specified by:

getTypeInfo in interface Meta

getIndexInfo

public Meta.MetaResultSet getIndexInfo(String catalog,
                              String schema,
                              String table,
                              boolean unique,
                              boolean approximate)

Specified by:

getIndexInfo in interface Meta

getUDTs

public Meta.MetaResultSet getUDTs(String catalog,
                         Meta.Pat schemaPattern,
                         Meta.Pat typeNamePattern,
                         int[] types)

Specified by:

getUDTs in interface Meta

getSuperTypes

public Meta.MetaResultSet getSuperTypes(String catalog,
                               Meta.Pat schemaPattern,
                               Meta.Pat typeNamePattern)

Specified by:

getSuperTypes in interface Meta

getSuperTables

public Meta.MetaResultSet getSuperTables(String catalog,
                                Meta.Pat schemaPattern,
                                Meta.Pat tableNamePattern)

Specified by:

getSuperTables in interface Meta

getAttributes

public Meta.MetaResultSet getAttributes(String catalog,
                               Meta.Pat schemaPattern,
                               Meta.Pat typeNamePattern,
                               Meta.Pat attributeNamePattern)

Specified by:

getAttributes in interface Meta

getClientInfoProperties

public Meta.MetaResultSet getClientInfoProperties()

Specified by:

getClientInfoProperties in interface Meta

getFunctions

public Meta.MetaResultSet getFunctions(String catalog,
                              Meta.Pat schemaPattern,
                              Meta.Pat functionNamePattern)

Specified by:

getFunctions in interface Meta

getFunctionColumns

public Meta.MetaResultSet getFunctionColumns(String catalog,
                                    Meta.Pat schemaPattern,
                                    Meta.Pat functionNamePattern,
                                    Meta.Pat columnNamePattern)

Specified by:

getFunctionColumns in interface Meta

getPseudoColumns

public Meta.MetaResultSet getPseudoColumns(String catalog,
                                  Meta.Pat schemaPattern,
                                  Meta.Pat tableNamePattern,
                                  Meta.Pat columnNamePattern)

Specified by:

getPseudoColumns in interface Meta

createIterable

public Iterable<Object> createIterable(Meta.StatementHandle handle,
                              Meta.Signature signature,
                              List<TypedValue> parameterValues,
                              Meta.Frame firstFrame)

Specified by:

createIterable in interface Meta

getConnection

protected Connection getConnection(String id)
                            throws SQLException

Throws:

SQLException

createStatement

public Meta.StatementHandle createStatement(Meta.ConnectionHandle ch)

Specified by:

createStatement in interface Meta

closeStatement

public void closeStatement(Meta.StatementHandle h)

Specified by:

closeStatement in interface Meta

closeConnection

public void closeConnection(Meta.ConnectionHandle ch)

Specified by:

closeConnection in interface Meta

apply

protected void apply(Connection conn,
         Meta.ConnectionProperties connProps)
              throws SQLException

Throws:

SQLException

connectionSync

public Meta.ConnectionProperties connectionSync(Meta.ConnectionHandle ch,
                                       Meta.ConnectionProperties connProps)

Specified by:

connectionSync in interface Meta

prepare

public Meta.StatementHandle prepare(Meta.ConnectionHandle ch,
                           String sql,
                           long maxRowCount)

Specified by:

prepare in interface Meta

prepareAndExecute

public Meta.ExecuteResult prepareAndExecute(Meta.StatementHandle h,
                                   String sql,
                                   long maxRowCount,
                                   Meta.PrepareCallback callback)

Specified by:

prepareAndExecute in interface Meta

fetch

public Meta.Frame fetch(Meta.StatementHandle h,
               List<TypedValue> parameterValues,
               long offset,
               int fetchMaxRowCount)

Specified by:

fetch in interface Meta