Package io.trino.plugin.jdbc

Interface JdbcClient

All Known Implementing Classes:

BaseJdbcClient, CachingJdbcClient, ForwardingJdbcClient, StatisticsAwareJdbcClient

public interface JdbcClient

Method Summary

Modifier and Type	Method	Description
default void	abortReadConnection(Connection connection, ResultSet resultSet)
void	addColumn(ConnectorSession session, JdbcTableHandle handle, ColumnMetadata column)
JdbcOutputTableHandle	beginCreateTable(ConnectorSession session, ConnectorTableMetadata tableMetadata)
JdbcOutputTableHandle	beginInsertTable(ConnectorSession session, JdbcTableHandle tableHandle, List<JdbcColumnHandle> columns)
String	buildInsertSql(JdbcOutputTableHandle handle, List<WriteFunction> columnWriters)
CallableStatement	buildProcedure(ConnectorSession session, Connection connection, JdbcSplit split, JdbcProcedureHandle procedureHandle)
PreparedStatement	buildSql(ConnectorSession session, Connection connection, JdbcSplit split, JdbcTableHandle table, List<JdbcColumnHandle> columns)
void	commitCreateTable(ConnectorSession session, JdbcOutputTableHandle handle, Set<Long> pageSinkIds)
default Optional<ParameterizedExpression>	convertPredicate(ConnectorSession session, ConnectorExpression expression, Map<String,ColumnHandle> assignments)
void	createSchema(ConnectorSession session, String schemaName)
void	createTable(ConnectorSession session, ConnectorTableMetadata tableMetadata)
OptionalLong	delete(ConnectorSession session, JdbcTableHandle handle)
void	dropColumn(ConnectorSession session, JdbcTableHandle handle, JdbcColumnHandle column)
void	dropSchema(ConnectorSession session, String schemaName)
void	dropTable(ConnectorSession session, JdbcTableHandle jdbcTableHandle)
void	finishInsertTable(ConnectorSession session, JdbcOutputTableHandle handle, Set<Long> pageSinkIds)
List<JdbcColumnHandle>	getColumns(ConnectorSession session, JdbcTableHandle tableHandle)
Connection	getConnection(ConnectorSession session, JdbcOutputTableHandle handle)
Connection	getConnection(ConnectorSession session, JdbcSplit split, JdbcProcedureHandle procedureHandle)
Connection	getConnection(ConnectorSession session, JdbcSplit split, JdbcTableHandle tableHandle)
PreparedStatement	getPreparedStatement(Connection connection, String sql, Optional<Integer> columnCount)
JdbcProcedureHandle	getProcedureHandle(ConnectorSession session, JdbcProcedureHandle.ProcedureQuery procedureQuery)
Set<String>	getSchemaNames(ConnectorSession session)
ConnectorSplitSource	getSplits(ConnectorSession session, JdbcProcedureHandle procedureHandle)
ConnectorSplitSource	getSplits(ConnectorSession session, JdbcTableHandle tableHandle)
default Optional<SystemTable>	getSystemTable(ConnectorSession session, SchemaTableName tableName)
default Optional<String>	getTableComment(ResultSet resultSet)
JdbcTableHandle	getTableHandle(ConnectorSession session, PreparedQuery preparedQuery)
Optional<JdbcTableHandle>	getTableHandle(ConnectorSession session, SchemaTableName schemaTableName)
List<SchemaTableName>	getTableNames(ConnectorSession session, Optional<String> schema)
Map<String,Object>	getTableProperties(ConnectorSession session, JdbcTableHandle tableHandle)
default Optional<TableScanRedirectApplicationResult>	getTableScanRedirection(ConnectorSession session, JdbcTableHandle tableHandle)
default TableStatistics	getTableStatistics(ConnectorSession session, JdbcTableHandle handle)
TableStatistics	getTableStatistics(ConnectorSession session, JdbcTableHandle handle, TupleDomain<ColumnHandle> tupleDomain)	Deprecated. Use getTableStatistics(ConnectorSession, JdbcTableHandle)
default Optional<JdbcExpression>	implementAggregation(ConnectorSession session, AggregateFunction aggregate, Map<String,ColumnHandle> assignments)
Optional<PreparedQuery>	implementJoin(ConnectorSession session, JoinType joinType, PreparedQuery leftSource, PreparedQuery rightSource, List<JdbcJoinCondition> joinConditions, Map<JdbcColumnHandle,String> rightAssignments, Map<JdbcColumnHandle,String> leftAssignments, JoinStatistics statistics)
boolean	isLimitGuaranteed(ConnectorSession session)
boolean	isTopNGuaranteed(ConnectorSession session)	Reports whether result cardinality and ordering is guaranteed when supportsTopN(ConnectorSession, JdbcTableHandle, List) returns true.
PreparedQuery	prepareQuery(ConnectorSession session, JdbcTableHandle table, Optional<List<List<JdbcColumnHandle>>> groupingSets, List<JdbcColumnHandle> columns, Map<String,ParameterizedExpression> columnExpressions)
String	quoted(RemoteTableName remoteTableName)
String	quoted(String name)
void	renameColumn(ConnectorSession session, JdbcTableHandle handle, JdbcColumnHandle jdbcColumn, String newColumnName)
void	renameSchema(ConnectorSession session, String schemaName, String newSchemaName)
void	renameTable(ConnectorSession session, JdbcTableHandle handle, SchemaTableName newTableName)
void	rollbackCreateTable(ConnectorSession session, JdbcOutputTableHandle handle)
default boolean	schemaExists(ConnectorSession session, String schema)
default void	setColumnComment(ConnectorSession session, JdbcTableHandle handle, JdbcColumnHandle column, Optional<String> comment)
void	setColumnType(ConnectorSession session, JdbcTableHandle handle, JdbcColumnHandle column, Type type)
default void	setTableComment(ConnectorSession session, JdbcTableHandle handle, Optional<String> comment)
default void	setTableProperties(ConnectorSession session, JdbcTableHandle handle, Map<String,Optional<Object>> properties)
default boolean	supportsAggregationPushdown(ConnectorSession session, JdbcTableHandle table, List<AggregateFunction> aggregates, Map<String,ColumnHandle> assignments, List<List<ColumnHandle>> groupingSets)
boolean	supportsLimit()
boolean	supportsRetries()
boolean	supportsTopN(ConnectorSession session, JdbcTableHandle handle, List<JdbcSortItem> sortOrder)
Optional<ColumnMapping>	toColumnMapping(ConnectorSession session, Connection connection, JdbcTypeHandle typeHandle)
List<ColumnMapping>	toColumnMappings(ConnectorSession session, List<JdbcTypeHandle> typeHandles)	Bulk variant of toColumnMapping(ConnectorSession, Connection, JdbcTypeHandle).
WriteMapping	toWriteMapping(ConnectorSession session, Type type)
void	truncateTable(ConnectorSession session, JdbcTableHandle handle)

Method Details

schemaExists

default boolean schemaExists(ConnectorSession session,
 String schema)

getSchemaNames

Set<String> getSchemaNames(ConnectorSession session)

getTableNames

List<SchemaTableName> getTableNames(ConnectorSession session,
 Optional<String> schema)

getTableHandle

Optional<JdbcTableHandle> getTableHandle(ConnectorSession session,
 SchemaTableName schemaTableName)

getTableHandle

JdbcTableHandle getTableHandle(ConnectorSession session,
 PreparedQuery preparedQuery)

getProcedureHandle

JdbcProcedureHandle getProcedureHandle(ConnectorSession session,
 JdbcProcedureHandle.ProcedureQuery procedureQuery)

getColumns

List<JdbcColumnHandle> getColumns(ConnectorSession session,
 JdbcTableHandle tableHandle)

toColumnMapping

Optional<ColumnMapping> toColumnMapping(ConnectorSession session,
 Connection connection,
 JdbcTypeHandle typeHandle)

toColumnMappings

List<ColumnMapping> toColumnMappings(ConnectorSession session,
 List<JdbcTypeHandle> typeHandles)

Bulk variant of toColumnMapping(ConnectorSession, Connection, JdbcTypeHandle).

toWriteMapping

WriteMapping toWriteMapping(ConnectorSession session,
 Type type)

supportsAggregationPushdown

default boolean supportsAggregationPushdown(ConnectorSession session,
 JdbcTableHandle table,
 List<AggregateFunction> aggregates,
 Map<String,ColumnHandle> assignments,
 List<List<ColumnHandle>> groupingSets)

implementAggregation

default Optional<JdbcExpression> implementAggregation(ConnectorSession session,
 AggregateFunction aggregate,
 Map<String,ColumnHandle> assignments)

convertPredicate

default Optional<ParameterizedExpression> convertPredicate(ConnectorSession session,
 ConnectorExpression expression,
 Map<String,ColumnHandle> assignments)

getSplits

ConnectorSplitSource getSplits(ConnectorSession session,
 JdbcTableHandle tableHandle)

getSplits

ConnectorSplitSource getSplits(ConnectorSession session,
 JdbcProcedureHandle procedureHandle)

getConnection

Connection getConnection(ConnectorSession session,
 JdbcSplit split,
 JdbcTableHandle tableHandle)
                  throws SQLException

Throws:

SQLException

getConnection

Connection getConnection(ConnectorSession session,
 JdbcSplit split,
 JdbcProcedureHandle procedureHandle)
                  throws SQLException

Throws:

SQLException

abortReadConnection

default void abortReadConnection(Connection connection,
 ResultSet resultSet)
                          throws SQLException

Throws:

SQLException

prepareQuery

PreparedQuery prepareQuery(ConnectorSession session,
 JdbcTableHandle table,
 Optional<List<List<JdbcColumnHandle>>> groupingSets,
 List<JdbcColumnHandle> columns,
 Map<String,ParameterizedExpression> columnExpressions)

buildSql

PreparedStatement buildSql(ConnectorSession session,
 Connection connection,
 JdbcSplit split,
 JdbcTableHandle table,
 List<JdbcColumnHandle> columns)
                    throws SQLException

Throws:

SQLException

buildProcedure

CallableStatement buildProcedure(ConnectorSession session,
 Connection connection,
 JdbcSplit split,
 JdbcProcedureHandle procedureHandle)
                          throws SQLException

Throws:

SQLException

implementJoin

Optional<PreparedQuery> implementJoin(ConnectorSession session,
 JoinType joinType,
 PreparedQuery leftSource,
 PreparedQuery rightSource,
 List<JdbcJoinCondition> joinConditions,
 Map<JdbcColumnHandle,String> rightAssignments,
 Map<JdbcColumnHandle,String> leftAssignments,
 JoinStatistics statistics)

supportsTopN

boolean supportsTopN(ConnectorSession session,
 JdbcTableHandle handle,
 List<JdbcSortItem> sortOrder)

isTopNGuaranteed

boolean isTopNGuaranteed(ConnectorSession session)

Reports whether result cardinality and ordering is guaranteed when supportsTopN(ConnectorSession, JdbcTableHandle, List) returns true.

supportsLimit

boolean supportsLimit()

isLimitGuaranteed

boolean isLimitGuaranteed(ConnectorSession session)

getTableComment

default Optional<String> getTableComment(ResultSet resultSet)
                                  throws SQLException

Throws:

SQLException

setTableComment

default void setTableComment(ConnectorSession session,
 JdbcTableHandle handle,
 Optional<String> comment)

setColumnComment

default void setColumnComment(ConnectorSession session,
 JdbcTableHandle handle,
 JdbcColumnHandle column,
 Optional<String> comment)

addColumn

void addColumn(ConnectorSession session,
 JdbcTableHandle handle,
 ColumnMetadata column)

dropColumn

void dropColumn(ConnectorSession session,
 JdbcTableHandle handle,
 JdbcColumnHandle column)

renameColumn

void renameColumn(ConnectorSession session,
 JdbcTableHandle handle,
 JdbcColumnHandle jdbcColumn,
 String newColumnName)

setColumnType

void setColumnType(ConnectorSession session,
 JdbcTableHandle handle,
 JdbcColumnHandle column,
 Type type)

renameTable

void renameTable(ConnectorSession session,
 JdbcTableHandle handle,
 SchemaTableName newTableName)

setTableProperties

default void setTableProperties(ConnectorSession session,
 JdbcTableHandle handle,
 Map<String,Optional<Object>> properties)

createTable

void createTable(ConnectorSession session,
 ConnectorTableMetadata tableMetadata)

beginCreateTable

JdbcOutputTableHandle beginCreateTable(ConnectorSession session,
 ConnectorTableMetadata tableMetadata)

commitCreateTable

void commitCreateTable(ConnectorSession session,
 JdbcOutputTableHandle handle,
 Set<Long> pageSinkIds)

beginInsertTable

JdbcOutputTableHandle beginInsertTable(ConnectorSession session,
 JdbcTableHandle tableHandle,
 List<JdbcColumnHandle> columns)

finishInsertTable

void finishInsertTable(ConnectorSession session,
 JdbcOutputTableHandle handle,
 Set<Long> pageSinkIds)

dropTable

void dropTable(ConnectorSession session,
 JdbcTableHandle jdbcTableHandle)

rollbackCreateTable

void rollbackCreateTable(ConnectorSession session,
 JdbcOutputTableHandle handle)

supportsRetries

boolean supportsRetries()

buildInsertSql

String buildInsertSql(JdbcOutputTableHandle handle,
 List<WriteFunction> columnWriters)

getConnection

Connection getConnection(ConnectorSession session,
 JdbcOutputTableHandle handle)
                  throws SQLException

Throws:

SQLException

getPreparedStatement

PreparedStatement getPreparedStatement(Connection connection,
 String sql,
 Optional<Integer> columnCount)
                                throws SQLException

Throws:

SQLException

getTableStatistics

@Deprecated
TableStatistics getTableStatistics(ConnectorSession session,
 JdbcTableHandle handle,
 TupleDomain<ColumnHandle> tupleDomain)

Deprecated.

Use getTableStatistics(ConnectorSession, JdbcTableHandle)

getTableStatistics

default TableStatistics getTableStatistics(ConnectorSession session,
 JdbcTableHandle handle)

createSchema

void createSchema(ConnectorSession session,
 String schemaName)

dropSchema

void dropSchema(ConnectorSession session,
 String schemaName)

renameSchema

void renameSchema(ConnectorSession session,
 String schemaName,
 String newSchemaName)

getSystemTable

default Optional<SystemTable> getSystemTable(ConnectorSession session,
 SchemaTableName tableName)

quoted

String quoted(String name)

quoted

String quoted(RemoteTableName remoteTableName)

getTableProperties

Map<String,Object> getTableProperties(ConnectorSession session,
 JdbcTableHandle tableHandle)

getTableScanRedirection

default Optional<TableScanRedirectApplicationResult> getTableScanRedirection(ConnectorSession session,
 JdbcTableHandle tableHandle)

delete

OptionalLong delete(ConnectorSession session,
 JdbcTableHandle handle)

truncateTable

void truncateTable(ConnectorSession session,
 JdbcTableHandle handle)