org.apache.calcite.avatica

Interface Meta

All Known Implementing Classes:

MetaImpl

public interface Meta

Command handler for getting various metadata. Should be implemented by each driver.

Also holds other abstract methods that are not related to metadata that each provider must implement. This is not ideal.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Meta.ConnectionHandle Connection handle.
static interface	Meta.ConnectionProperties A pojo containing various client-settable Connection properties.
static class	Meta.CursorFactory Information necessary to convert an Iterable into a Cursor.
static class	Meta.ExecuteResult Response from execute.
static interface	Meta.Factory Factory to create instances of Meta.
static class	Meta.Frame A collection of rows.
static class	Meta.MetaResultSet Meta data from which a result set can be constructed.
static class	Meta.Pat Wrapper to remind API calls that a parameter is a pattern (allows '%' and '_' wildcards, per the JDBC spec) rather than a string to be matched exactly.
static interface	Meta.PrepareCallback API to put a result set into a statement, being careful to enforce thread-safety and not to overwrite existing open result sets.
static class	Meta.Signature Result of preparing a statement.
static class	Meta.StatementHandle Statement handle.
static class	Meta.Style How logical fields are represented in the objects returned by the iterator.

Method Summary

Methods

Modifier and Type	Method and Description
void	closeConnection(Meta.ConnectionHandle ch) Close a connection
void	closeStatement(Meta.StatementHandle h) Close a statement.
Meta.ConnectionProperties	connectionSync(Meta.ConnectionHandle ch, Meta.ConnectionProperties connProps) Sync client and server view of connection properties.
Iterable<Object>	createIterable(Meta.StatementHandle handle, Meta.Signature signature, List<Object> parameterValues, Meta.Frame firstFrame) Creates an iterable for a result set.
Meta.StatementHandle	createStatement(Meta.ConnectionHandle ch) Called during the creation of a statement to allocate a new handle.
Meta.Frame	fetch(Meta.StatementHandle h, List<Object> parameterValues, int offset, int fetchMaxRowCount) Returns a frame of rows.
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)
Meta.MetaResultSet	getCrossReference(String parentCatalog, String parentSchema, String parentTable, String foreignCatalog, String foreignSchema, String foreignTable)
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)
String	getNumericFunctions()
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)
String	getSqlKeywords()
String	getStringFunctions()
Meta.MetaResultSet	getSuperTables(String catalog, Meta.Pat schemaPattern, Meta.Pat tableNamePattern)
Meta.MetaResultSet	getSuperTypes(String catalog, Meta.Pat schemaPattern, Meta.Pat typeNamePattern)
String	getSystemFunctions()
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()
String	getTimeDateFunctions()
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)
Meta.StatementHandle	prepare(Meta.ConnectionHandle ch, String sql, int maxRowCount) Prepares a statement.
Meta.ExecuteResult	prepareAndExecute(Meta.ConnectionHandle ch, String sql, int maxRowCount, Meta.PrepareCallback callback) Prepares and executes a statement.

Method Detail

getSqlKeywords

String getSqlKeywords()

getNumericFunctions

String getNumericFunctions()

getStringFunctions

String getStringFunctions()

getSystemFunctions

String getSystemFunctions()

getTimeDateFunctions

String getTimeDateFunctions()

getTables

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

getColumns

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

getSchemas

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

getCatalogs

Meta.MetaResultSet getCatalogs()

getTableTypes

Meta.MetaResultSet getTableTypes()

getProcedures

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

getProcedureColumns

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

getColumnPrivileges

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

getTablePrivileges

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

getBestRowIdentifier

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

getVersionColumns

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

getPrimaryKeys

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

getImportedKeys

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

getExportedKeys

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

getCrossReference

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

getTypeInfo

Meta.MetaResultSet getTypeInfo()

getIndexInfo

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

getUDTs

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

getSuperTypes

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

getSuperTables

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

getAttributes

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

getClientInfoProperties

Meta.MetaResultSet getClientInfoProperties()

getFunctions

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

getFunctionColumns

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

getPseudoColumns

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

createIterable

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

Creates an iterable for a result set.

The default implementation just returns iterable, which it requires to be not null; derived classes may instead choose to execute the relational expression in signature.

prepare

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

Prepares a statement.

Parameters:

ch - Connection handle

sql - SQL query

maxRowCount - Negative for no limit (different meaning than JDBC)

Returns:

Signature of prepared statement

prepareAndExecute

Meta.ExecuteResult prepareAndExecute(Meta.ConnectionHandle ch,
                                   String sql,
                                   int maxRowCount,
                                   Meta.PrepareCallback callback)

Prepares and executes a statement.

Parameters:

ch - Connection handle

sql - SQL query

maxRowCount - Negative for no limit (different meaning than JDBC)

callback - Callback to lock, clear and assign cursor

Returns:

Result containing statement ID, and if a query, a result set and first frame of data

fetch

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

Returns a frame of rows.

The frame describes whether there may be another frame. If there is not another frame, the current iteration is done when we have finished the rows in the this frame.

The default implementation always returns null.

Parameters:

h - Statement handle

parameterValues - A list of parameter values, if statement is to be executed; otherwise null

offset - Zero-based offset of first row in the requested frame

fetchMaxRowCount - Maximum number of rows to return; negative means no limit

Returns:

Frame, or null if there are no more

createStatement

Meta.StatementHandle createStatement(Meta.ConnectionHandle ch)

Called during the creation of a statement to allocate a new handle.

Parameters:

ch - Connection handle

closeStatement

void closeStatement(Meta.StatementHandle h)

Close a statement.

closeConnection

void closeConnection(Meta.ConnectionHandle ch)

Close a connection

connectionSync

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

Sync client and server view of connection properties.

Note: this interface is considered "experimental" and may undergo further changes as this functionality is extended to other aspects of state management for Connection, Statement, and ResultSet.