Package io.trino.plugin.jdbc

Class BaseJdbcClient

java.lang.Object

io.trino.plugin.jdbc.BaseJdbcClient

All Implemented Interfaces:

JdbcClient

public abstract class BaseJdbcClient
extends Object
implements JdbcClient

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	caseInsensitiveNameMatching
protected ConnectionFactory	connectionFactory
protected String	identifierQuote
protected Set<String>	jdbcTypesMappedToVarchar
protected com.google.common.cache.Cache<JdbcIdentity,Map<String,String>>	remoteSchemaNames
protected com.google.common.cache.Cache<io.trino.plugin.jdbc.RemoteTableNameCacheKey,Map<String,String>>	remoteTableNames

Constructor Summary

Constructors

Constructor	Description
BaseJdbcClient(BaseJdbcConfig config, String identifierQuote, ConnectionFactory connectionFactory)
BaseJdbcClient(String identifierQuote, ConnectionFactory connectionFactory, Set<String> jdbcTypesMappedToVarchar, boolean caseInsensitiveNameMatching, io.airlift.units.Duration caseInsensitiveNameMatchingCacheTtl)

Method Summary

Modifier and Type	Method	Description
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)
PreparedStatement	buildSql(ConnectorSession session, Connection connection, JdbcSplit split, JdbcTableHandle table, List<JdbcColumnHandle> columns)
void	commitCreateTable(ConnectorSession session, JdbcOutputTableHandle handle)
protected void	copyTableSchema(Connection connection, String catalogName, String schemaName, String tableName, String newTableName, List<String> columnNames)
void	createSchema(ConnectorSession session, String schemaName)
void	createTable(ConnectorSession session, ConnectorTableMetadata tableMetadata)
protected JdbcOutputTableHandle	createTable(ConnectorSession session, ConnectorTableMetadata tableMetadata, String tableName)
protected String	createTableSql(RemoteTableName remoteTableName, List<String> columns, ConnectorTableMetadata tableMetadata)
void	dropColumn(ConnectorSession session, JdbcTableHandle handle, JdbcColumnHandle column)
void	dropSchema(ConnectorSession session, String schemaName)
void	dropTable(ConnectorSession session, JdbcTableHandle handle)
protected static Optional<String>	escapeNamePattern(Optional<String> name, String escape)
protected void	execute(ConnectorSession session, String query)
protected void	execute(Connection connection, String query)
protected boolean	filterSchema(String schemaName)
void	finishInsertTable(ConnectorSession session, JdbcOutputTableHandle handle)
protected String	generateTemporaryTableName()
protected String	getColumnDefinitionSql(ConnectorSession session, ColumnMetadata column, String columnName)
protected ResultSet	getColumns(JdbcTableHandle tableHandle, DatabaseMetaData metadata)
List<JdbcColumnHandle>	getColumns(ConnectorSession session, JdbcTableHandle tableHandle)
Connection	getConnection(ConnectorSession session, JdbcOutputTableHandle handle)
Connection	getConnection(ConnectorSession session, JdbcSplit split)
protected Optional<ColumnMapping>	getForcedMappingToVarchar(JdbcTypeHandle typeHandle)
protected static Optional<Integer>	getInteger(ResultSet resultSet, String columnLabel)
PreparedStatement	getPreparedStatement(Connection connection, String sql)
Set<String>	getSchemaNames(ConnectorSession session)
ConnectorSplitSource	getSplits(ConnectorSession session, JdbcTableHandle tableHandle)
Optional<JdbcTableHandle>	getTableHandle(ConnectorSession session, SchemaTableName schemaTableName)
List<SchemaTableName>	getTableNames(ConnectorSession session, Optional<String> schema)
Map<String,Object>	getTableProperties(ConnectorSession session, JdbcTableHandle tableHandle)
protected ResultSet	getTables(Connection connection, Optional<String> schemaName, Optional<String> tableName)
protected String	getTableSchemaName(ResultSet resultSet)
TableStatistics	getTableStatistics(ConnectorSession session, JdbcTableHandle handle, TupleDomain<ColumnHandle> tupleDomain)
protected Optional<List<String>>	getTableTypes()
boolean	isLimitGuaranteed(ConnectorSession session)
protected Optional<ColumnMapping>	legacyToPrestoType(ConnectorSession session, Connection connection, JdbcTypeHandle typeHandle)	Deprecated. Each connector should provide its own explicit type mapping, along with respective tests.
protected WriteMapping	legacyToWriteMapping(ConnectorSession session, Type type)	Deprecated. Each connector should provide its own explicit type mapping, along with respective tests.
protected Optional<BiFunction<String,Long,String>>	limitFunction()
protected Collection<String>	listSchemas(Connection connection)
protected Map<String,String>	listSchemasByLowerCase(Connection connection)
protected Map<String,String>	listTablesByLowerCase(Connection connection, String remoteSchema)
protected static Optional<ColumnMapping>	mapToUnboundedVarchar(JdbcTypeHandle typeHandle)
PreparedQuery	prepareQuery(ConnectorSession session, JdbcTableHandle table, Optional<List<List<JdbcColumnHandle>>> groupingSets, List<JdbcColumnHandle> columns, Map<String,String> columnExpressions)
String	quoted(RemoteTableName remoteTableName)
String	quoted(String name)
protected String	quoted(String catalog, String schema, String table)
void	renameColumn(ConnectorSession session, JdbcTableHandle handle, JdbcColumnHandle jdbcColumn, String newColumnName)
void	renameTable(ConnectorSession session, JdbcTableHandle handle, SchemaTableName newTableName)
protected void	renameTable(ConnectorSession session, String catalogName, String schemaName, String tableName, SchemaTableName newTable)
void	rollbackCreateTable(ConnectorSession session, JdbcOutputTableHandle handle)
boolean	supportsLimit()
List<ColumnMapping>	toColumnMappings(ConnectorSession session, List<JdbcTypeHandle> typeHandles)	Bulk variant of JdbcClient.toColumnMapping(ConnectorSession, Connection, JdbcTypeHandle).
protected String	toRemoteSchemaName(JdbcIdentity identity, Connection connection, String schemaName)
protected String	toRemoteTableName(JdbcIdentity identity, Connection connection, String remoteSchema, String tableName)
protected Function<String,String>	tryApplyLimit(OptionalLong limit)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.trino.plugin.jdbc.JdbcClient

abortReadConnection, getSystemTable, getTableScanRedirection, implementAggregation, schemaExists, setColumnComment, supportsAggregationPushdown, toColumnMapping, toWriteMapping

Field Detail

connectionFactory

protected final ConnectionFactory connectionFactory

identifierQuote

protected final String identifierQuote

jdbcTypesMappedToVarchar

protected final Set<String> jdbcTypesMappedToVarchar

caseInsensitiveNameMatching

protected final boolean caseInsensitiveNameMatching

remoteSchemaNames

protected final com.google.common.cache.Cache<JdbcIdentity,Map<String,String>> remoteSchemaNames

remoteTableNames

protected final com.google.common.cache.Cache<io.trino.plugin.jdbc.RemoteTableNameCacheKey,Map<String,String>> remoteTableNames

Constructor Detail

BaseJdbcClient

public BaseJdbcClient(BaseJdbcConfig config,
                      String identifierQuote,
                      ConnectionFactory connectionFactory)

BaseJdbcClient

public BaseJdbcClient(String identifierQuote,
                      ConnectionFactory connectionFactory,
                      Set<String> jdbcTypesMappedToVarchar,
                      boolean caseInsensitiveNameMatching,
                      io.airlift.units.Duration caseInsensitiveNameMatchingCacheTtl)

Method Detail

getSchemaNames

public final Set<String> getSchemaNames(ConnectorSession session)

Specified by:

getSchemaNames in interface JdbcClient

listSchemas

protected Collection<String> listSchemas(Connection connection)

filterSchema

protected boolean filterSchema(String schemaName)

getTableNames

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

Specified by:

getTableNames in interface JdbcClient

getTableHandle

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

Specified by:

getTableHandle in interface JdbcClient

getColumns

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

Specified by:

getColumns in interface JdbcClient

getInteger

protected static Optional<Integer> getInteger(ResultSet resultSet,
                                              String columnLabel)
                                       throws SQLException

Throws:

SQLException

getColumns

protected ResultSet getColumns(JdbcTableHandle tableHandle,
                               DatabaseMetaData metadata)
                        throws SQLException

Throws:

SQLException

legacyToPrestoType

@Deprecated
protected Optional<ColumnMapping> legacyToPrestoType(ConnectorSession session,
                                                     Connection connection,
                                                     JdbcTypeHandle typeHandle)

Deprecated.

Each connector should provide its own explicit type mapping, along with respective tests.

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

getForcedMappingToVarchar

protected Optional<ColumnMapping> getForcedMappingToVarchar(JdbcTypeHandle typeHandle)

mapToUnboundedVarchar

protected static Optional<ColumnMapping> mapToUnboundedVarchar(JdbcTypeHandle typeHandle)

getSplits

public ConnectorSplitSource getSplits(ConnectorSession session,
                                      JdbcTableHandle tableHandle)

Specified by:

getSplits in interface JdbcClient

getConnection

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

Specified by:

getConnection in interface JdbcClient

Throws:

SQLException

prepareQuery

public PreparedQuery prepareQuery(ConnectorSession session,
                                  JdbcTableHandle table,
                                  Optional<List<List<JdbcColumnHandle>>> groupingSets,
                                  List<JdbcColumnHandle> columns,
                                  Map<String,String> 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

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

createTable

protected JdbcOutputTableHandle createTable(ConnectorSession session,
                                            ConnectorTableMetadata tableMetadata,
                                            String tableName)
                                     throws SQLException

Throws:

SQLException

createTableSql

protected String createTableSql(RemoteTableName remoteTableName,
                                List<String> columns,
                                ConnectorTableMetadata tableMetadata)

getColumnDefinitionSql

protected String getColumnDefinitionSql(ConnectorSession session,
                                        ColumnMetadata column,
                                        String columnName)

beginInsertTable

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

Specified by:

beginInsertTable in interface JdbcClient

copyTableSchema

protected void copyTableSchema(Connection connection,
                               String catalogName,
                               String schemaName,
                               String tableName,
                               String newTableName,
                               List<String> columnNames)

generateTemporaryTableName

protected String generateTemporaryTableName()

commitCreateTable

public void commitCreateTable(ConnectorSession session,
                              JdbcOutputTableHandle handle)

Specified by:

commitCreateTable in interface JdbcClient

renameTable

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

Specified by:

renameTable in interface JdbcClient

renameTable

protected void renameTable(ConnectorSession session,
                           String catalogName,
                           String schemaName,
                           String tableName,
                           SchemaTableName newTable)

finishInsertTable

public void finishInsertTable(ConnectorSession session,
                              JdbcOutputTableHandle handle)

Specified by:

finishInsertTable in interface JdbcClient

addColumn

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

Specified by:

addColumn in interface JdbcClient

renameColumn

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

Specified by:

renameColumn in interface JdbcClient

dropColumn

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

Specified by:

dropColumn in interface JdbcClient

dropTable

public void dropTable(ConnectorSession session,
                      JdbcTableHandle handle)

Specified by:

dropTable in interface JdbcClient

rollbackCreateTable

public void rollbackCreateTable(ConnectorSession session,
                                JdbcOutputTableHandle handle)

Specified by:

rollbackCreateTable 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)
                                       throws SQLException

Specified by:

getPreparedStatement in interface JdbcClient

Throws:

SQLException

getTables

protected ResultSet getTables(Connection connection,
                              Optional<String> schemaName,
                              Optional<String> tableName)
                       throws SQLException

Throws:

SQLException

getTableTypes

protected Optional<List<String>> getTableTypes()

getTableSchemaName

protected String getTableSchemaName(ResultSet resultSet)
                             throws SQLException

Throws:

SQLException

toRemoteSchemaName

protected String toRemoteSchemaName(JdbcIdentity identity,
                                    Connection connection,
                                    String schemaName)

listSchemasByLowerCase

protected Map<String,String> listSchemasByLowerCase(Connection connection)

toRemoteTableName

protected String toRemoteTableName(JdbcIdentity identity,
                                   Connection connection,
                                   String remoteSchema,
                                   String tableName)

listTablesByLowerCase

protected Map<String,String> listTablesByLowerCase(Connection connection,
                                                         String remoteSchema)

getTableStatistics

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

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

execute

protected void execute(ConnectorSession session,
                       String query)

execute

protected void execute(Connection connection,
                       String query)

legacyToWriteMapping

@Deprecated
protected WriteMapping legacyToWriteMapping(ConnectorSession session,
                                            Type type)

Deprecated.

Each connector should provide its own explicit type mapping, along with respective tests.

tryApplyLimit

protected Function<String,String> tryApplyLimit(OptionalLong limit)

supportsLimit

public boolean supportsLimit()

Specified by:

supportsLimit in interface JdbcClient

limitFunction

protected Optional<BiFunction<String,Long,String>> limitFunction()

isLimitGuaranteed

public boolean isLimitGuaranteed(ConnectorSession session)

Specified by:

isLimitGuaranteed 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

quoted

protected String quoted(@Nullable
                        String catalog,
                        @Nullable
                        String schema,
                        String table)

escapeNamePattern

protected static Optional<String> escapeNamePattern(Optional<String> name,
                                                    String escape)