Package io.trino.plugin.jdbc

Class CachingJdbcClient

java.lang.Object

io.trino.plugin.jdbc.CachingJdbcClient

All Implemented Interfaces:

JdbcClient

public class CachingJdbcClient
extends Object
implements JdbcClient

Constructor Summary

Constructors

Constructor	Description
CachingJdbcClient(JdbcClient delegate, Set<SessionPropertiesProvider> sessionPropertiesProviders, IdentityCacheMapping identityMapping, io.airlift.units.Duration metadataCachingTtl, boolean cacheMissing, long cacheMaximumSize)
CachingJdbcClient(JdbcClient delegate, Set<SessionPropertiesProvider> sessionPropertiesProviders, IdentityCacheMapping identityMapping, io.airlift.units.Duration metadataCachingTtl, io.airlift.units.Duration schemaNamesCachingTtl, io.airlift.units.Duration tableNamesCachingTtl, boolean cacheMissing, long cacheMaximumSize)
CachingJdbcClient(JdbcClient delegate, Set<SessionPropertiesProvider> sessionPropertiesProviders, IdentityCacheMapping identityMapping, BaseJdbcConfig config)

Method Summary

Modifier and Type	Method	Description
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)
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)
void	flushCache()
List<JdbcColumnHandle>	getColumns(ConnectorSession session, JdbcTableHandle tableHandle)
io.airlift.jmx.CacheStatsMBean	getColumnsCache()
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)
io.airlift.jmx.CacheStatsMBean	getSchemaNamesStats()
ConnectorSplitSource	getSplits(ConnectorSession session, JdbcProcedureHandle procedureHandle)
ConnectorSplitSource	getSplits(ConnectorSession session, JdbcTableHandle tableHandle)
io.airlift.jmx.CacheStatsMBean	getStatisticsCache()
Optional<SystemTable>	getSystemTable(ConnectorSession session, SchemaTableName tableName)
Optional<String>	getTableComment(ResultSet resultSet)
JdbcTableHandle	getTableHandle(ConnectorSession session, PreparedQuery preparedQuery)
Optional<JdbcTableHandle>	getTableHandle(ConnectorSession session, SchemaTableName schemaTableName)
io.airlift.jmx.CacheStatsMBean	getTableHandlesByNameCache()
io.airlift.jmx.CacheStatsMBean	getTableHandlesByQueryCache()
List<SchemaTableName>	getTableNames(ConnectorSession session, Optional<String> schema)
io.airlift.jmx.CacheStatsMBean	getTableNamesCache()
Map<String,Object>	getTableProperties(ConnectorSession session, JdbcTableHandle tableHandle)
Optional<TableScanRedirectApplicationResult>	getTableScanRedirection(ConnectorSession session, JdbcTableHandle tableHandle)
TableStatistics	getTableStatistics(ConnectorSession session, JdbcTableHandle handle)
TableStatistics	getTableStatistics(ConnectorSession session, JdbcTableHandle handle, TupleDomain<ColumnHandle> tupleDomain)
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 JdbcClient.supportsTopN(ConnectorSession, JdbcTableHandle, List) returns true.
void	onDataChanged(JdbcTableHandle handle)	Deprecated. JdbcTableHandle is not a good representation of the table.
void	onDataChanged(SchemaTableName table)
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)
boolean	schemaExists(ConnectorSession session, String schema)
void	setColumnComment(ConnectorSession session, JdbcTableHandle handle, JdbcColumnHandle column, Optional<String> comment)
void	setColumnType(ConnectorSession session, JdbcTableHandle handle, JdbcColumnHandle column, Type type)
void	setTableComment(ConnectorSession session, JdbcTableHandle handle, Optional<String> comment)
void	setTableProperties(ConnectorSession session, JdbcTableHandle handle, Map<String,Optional<Object>> properties)
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 JdbcClient.toColumnMapping(ConnectorSession, Connection, JdbcTypeHandle).
WriteMapping	toWriteMapping(ConnectorSession session, Type type)
void	truncateTable(ConnectorSession session, JdbcTableHandle handle)

Methods inherited from class java.lang.Object

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

Constructor Details

CachingJdbcClient

@Inject
public CachingJdbcClient(JdbcClient delegate,
 Set<SessionPropertiesProvider> sessionPropertiesProviders,
 IdentityCacheMapping identityMapping,
 BaseJdbcConfig config)

CachingJdbcClient

public CachingJdbcClient(JdbcClient delegate,
 Set<SessionPropertiesProvider> sessionPropertiesProviders,
 IdentityCacheMapping identityMapping,
 io.airlift.units.Duration metadataCachingTtl,
 boolean cacheMissing,
 long cacheMaximumSize)

CachingJdbcClient

public CachingJdbcClient(JdbcClient delegate,
 Set<SessionPropertiesProvider> sessionPropertiesProviders,
 IdentityCacheMapping identityMapping,
 io.airlift.units.Duration metadataCachingTtl,
 io.airlift.units.Duration schemaNamesCachingTtl,
 io.airlift.units.Duration tableNamesCachingTtl,
 boolean cacheMissing,
 long cacheMaximumSize)

Method Details

schemaExists

public boolean schemaExists(ConnectorSession session,
 String schema)

Specified by:

schemaExists in interface JdbcClient

getSchemaNames

public Set<String> getSchemaNames(ConnectorSession session)

Specified by:

getSchemaNames in interface JdbcClient

getTableNames

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

Specified by:

getTableNames in interface JdbcClient

getColumns

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

Specified by:

getColumns in interface JdbcClient

toColumnMapping

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

Specified by:

toColumnMapping in interface JdbcClient

toColumnMappings

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

Description copied from interface: JdbcClient

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

Specified by:

toColumnMappings in interface JdbcClient

toWriteMapping

public WriteMapping toWriteMapping(ConnectorSession session,
 Type type)

Specified by:

toWriteMapping in interface JdbcClient

supportsAggregationPushdown

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

Specified by:

supportsAggregationPushdown in interface JdbcClient

implementAggregation

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

Specified by:

implementAggregation in interface JdbcClient

convertPredicate

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

Specified by:

convertPredicate in interface JdbcClient

getSplits

public ConnectorSplitSource getSplits(ConnectorSession session,
 JdbcTableHandle tableHandle)

Specified by:

getSplits in interface JdbcClient

getSplits

public ConnectorSplitSource getSplits(ConnectorSession session,
 JdbcProcedureHandle procedureHandle)

Specified by:

getSplits in interface JdbcClient

getConnection

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

Specified by:

getConnection in interface JdbcClient

Throws:

SQLException

getConnection

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

Specified by:

getConnection in interface JdbcClient

Throws:

SQLException

abortReadConnection

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

Specified by:

abortReadConnection in interface JdbcClient

Throws:

SQLException

prepareQuery

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

Specified by:

prepareQuery in interface JdbcClient

buildSql

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

Specified by:

buildSql in interface JdbcClient

Throws:

SQLException

buildProcedure

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

Specified by:

buildProcedure in interface JdbcClient

Throws:

SQLException

implementJoin

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

Specified by:

implementJoin in interface JdbcClient

supportsTopN

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

Specified by:

supportsTopN in interface JdbcClient

isTopNGuaranteed

public boolean isTopNGuaranteed(ConnectorSession session)

Description copied from interface: JdbcClient

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

Specified by:

isTopNGuaranteed in interface JdbcClient

supportsLimit

public boolean supportsLimit()

Specified by:

supportsLimit in interface JdbcClient

isLimitGuaranteed

public boolean isLimitGuaranteed(ConnectorSession session)

Specified by:

isLimitGuaranteed in interface JdbcClient

getTableHandle

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

Specified by:

getTableHandle in interface JdbcClient

getTableHandle

public JdbcTableHandle getTableHandle(ConnectorSession session,
 PreparedQuery preparedQuery)

Specified by:

getTableHandle in interface JdbcClient

getProcedureHandle

public JdbcProcedureHandle getProcedureHandle(ConnectorSession session,
 JdbcProcedureHandle.ProcedureQuery procedureQuery)

Specified by:

getProcedureHandle in interface JdbcClient

commitCreateTable

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

Specified by:

commitCreateTable in interface JdbcClient

beginInsertTable

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

Specified by:

beginInsertTable in interface JdbcClient

finishInsertTable

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

Specified by:

finishInsertTable in interface JdbcClient

dropTable

public void dropTable(ConnectorSession session,
 JdbcTableHandle jdbcTableHandle)

Specified by:

dropTable in interface JdbcClient

rollbackCreateTable

public void rollbackCreateTable(ConnectorSession session,
 JdbcOutputTableHandle handle)

Specified by:

rollbackCreateTable in interface JdbcClient

supportsRetries

public boolean supportsRetries()

Specified by:

supportsRetries in interface JdbcClient

buildInsertSql

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

Specified by:

buildInsertSql in interface JdbcClient

getConnection

public Connection getConnection(ConnectorSession session,
 JdbcOutputTableHandle handle)
                         throws SQLException

Specified by:

getConnection in interface JdbcClient

Throws:

SQLException

getPreparedStatement

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

Specified by:

getPreparedStatement in interface JdbcClient

Throws:

SQLException

getTableStatistics

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

Specified by:

getTableStatistics in interface JdbcClient

getTableStatistics

public TableStatistics getTableStatistics(ConnectorSession session,
 JdbcTableHandle handle)

Specified by:

getTableStatistics in interface JdbcClient

createSchema

public void createSchema(ConnectorSession session,
 String schemaName)

Specified by:

createSchema in interface JdbcClient

dropSchema

public void dropSchema(ConnectorSession session,
 String schemaName)

Specified by:

dropSchema in interface JdbcClient

renameSchema

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

Specified by:

renameSchema in interface JdbcClient

getTableComment

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

Specified by:

getTableComment in interface JdbcClient

Throws:

SQLException

setTableComment

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

Specified by:

setTableComment in interface JdbcClient

setColumnComment

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

Specified by:

setColumnComment in interface JdbcClient

addColumn

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

Specified by:

addColumn in interface JdbcClient

dropColumn

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

Specified by:

dropColumn in interface JdbcClient

renameColumn

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

Specified by:

renameColumn in interface JdbcClient

setColumnType

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

Specified by:

setColumnType in interface JdbcClient

renameTable

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

Specified by:

renameTable in interface JdbcClient

setTableProperties

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

Specified by:

setTableProperties in interface JdbcClient

createTable

public void createTable(ConnectorSession session,
 ConnectorTableMetadata tableMetadata)

Specified by:

createTable in interface JdbcClient

beginCreateTable

public JdbcOutputTableHandle beginCreateTable(ConnectorSession session,
 ConnectorTableMetadata tableMetadata)

Specified by:

beginCreateTable in interface JdbcClient

getSystemTable

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

Specified by:

getSystemTable in interface JdbcClient

quoted

public String quoted(String name)

Specified by:

quoted in interface JdbcClient

quoted

public String quoted(RemoteTableName remoteTableName)

Specified by:

quoted in interface JdbcClient

getTableProperties

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

Specified by:

getTableProperties in interface JdbcClient

getTableScanRedirection

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

Specified by:

getTableScanRedirection in interface JdbcClient

onDataChanged

public void onDataChanged(SchemaTableName table)

onDataChanged

@Deprecated
public void onDataChanged(JdbcTableHandle handle)

Deprecated.

JdbcTableHandle is not a good representation of the table. For example, we don't want to distinguish between "a plan table" and "table with selected columns", or "a table with a constraint" here. Use onDataChanged(SchemaTableName), which avoids these ambiguities.

delete

public OptionalLong delete(ConnectorSession session,
 JdbcTableHandle handle)

Specified by:

delete in interface JdbcClient

truncateTable

public void truncateTable(ConnectorSession session,
 JdbcTableHandle handle)

Specified by:

truncateTable in interface JdbcClient

flushCache

public void flushCache()

getSchemaNamesStats

public io.airlift.jmx.CacheStatsMBean getSchemaNamesStats()

getTableNamesCache

public io.airlift.jmx.CacheStatsMBean getTableNamesCache()

getTableHandlesByNameCache

public io.airlift.jmx.CacheStatsMBean getTableHandlesByNameCache()

getTableHandlesByQueryCache

public io.airlift.jmx.CacheStatsMBean getTableHandlesByQueryCache()

getColumnsCache

public io.airlift.jmx.CacheStatsMBean getColumnsCache()

getStatisticsCache

public io.airlift.jmx.CacheStatsMBean getStatisticsCache()