Package io.trino.plugin.sqlserver

Class SqlServerClient

java.lang.Object

io.trino.plugin.jdbc.BaseJdbcClient

io.trino.plugin.sqlserver.SqlServerClient

All Implemented Interfaces:

JdbcClient

public class SqlServerClient
extends BaseJdbcClient

Nested Class Summary

Nested classes/interfaces inherited from class io.trino.plugin.jdbc.BaseJdbcClient

BaseJdbcClient.TopNFunction

Field Summary

Fields

Modifier and Type	Field	Description
static final JdbcTypeHandle	BIGINT_TYPE
static final int	SQL_SERVER_DEADLOCK_ERROR_CODE
static final int	SQL_SERVER_MAX_LIST_EXPRESSIONS

Fields inherited from class io.trino.plugin.jdbc.BaseJdbcClient

connectionFactory, identifierQuote, jdbcTypesMappedToVarchar, queryBuilder, queryModifier

Constructor Summary

Constructors

Constructor	Description
SqlServerClient(BaseJdbcConfig config, JdbcStatisticsConfig statisticsConfig, ConnectionFactory connectionFactory, QueryBuilder queryBuilder, IdentifierMapping identifierMapping, RemoteQueryModifier queryModifier)

Method Summary

Modifier and Type	Method	Description
void	abortReadConnection(Connection connection, ResultSet resultSet)
JdbcOutputTableHandle	beginCreateTable(ConnectorSession session, ConnectorTableMetadata tableMetadata)
JdbcOutputTableHandle	beginInsertTable(ConnectorSession session, JdbcTableHandle tableHandle, List<JdbcColumnHandle> columns)
Optional<ParameterizedExpression>	convertPredicate(ConnectorSession session, ConnectorExpression expression, Map<String,ColumnHandle> assignments)
protected void	copyTableSchema(ConnectorSession session, Connection connection, String catalogName, String schemaName, String tableName, String newTableName, List<String> columnNames)
protected String	createTableSql(RemoteTableName remoteTableName, List<String> columns, ConnectorTableMetadata tableMetadata)
protected void	dropSchema(ConnectorSession session, Connection connection, String remoteSchemaName, boolean cascade)
protected void	enableTableLockOnBulkLoadTableOption(ConnectorSession session, JdbcOutputTableHandle table)
protected String	escapeObjectNameForMetadataQuery(String name, String escape)
protected Map<String,CaseSensitivity>	getCaseSensitivityForColumns(ConnectorSession session, Connection connection, JdbcTableHandle tableHandle)
Connection	getConnection(ConnectorSession session, JdbcOutputTableHandle handle)
JdbcProcedureHandle	getProcedureHandle(ConnectorSession session, JdbcProcedureHandle.ProcedureQuery procedureQuery)
Map<String,Object>	getTableProperties(ConnectorSession session, JdbcTableHandle tableHandle)
TableStatistics	getTableStatistics(ConnectorSession session, JdbcTableHandle handle)
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)
protected boolean	isSupportedJoinCondition(ConnectorSession session, JdbcJoinCondition joinCondition)
protected boolean	isTableLockNeeded(ConnectorSession session)	Table lock is a prerequisite for `minimal logging` in SQL Server
boolean	isTopNGuaranteed(ConnectorSession session)
protected Optional<BiFunction<String,Long,String>>	limitFunction()
protected String	postProcessInsertTableNameClause(ConnectorSession session, String tableName)
protected void	renameColumn(ConnectorSession session, Connection connection, RemoteTableName remoteTableName, String remoteColumnName, String newRemoteColumnName)
void	renameSchema(ConnectorSession session, String schemaName, String newSchemaName)
protected void	renameTable(ConnectorSession session, Connection connection, String catalogName, String remoteSchemaName, String remoteTableName, String newRemoteSchemaName, String newRemoteTableName)
static <T> T	retryOnDeadlock(dev.failsafe.function.CheckedSupplier<T> supplier, String attemptLogMessage)
void	setColumnType(ConnectorSession session, JdbcTableHandle handle, JdbcColumnHandle column, Type type)
boolean	supportsAggregationPushdown(ConnectorSession session, JdbcTableHandle table, List<AggregateFunction> aggregates, Map<String,ColumnHandle> assignments, List<List<ColumnHandle>> groupingSets)
boolean	supportsTopN(ConnectorSession session, JdbcTableHandle handle, List<JdbcSortItem> sortOrder)
Optional<ColumnMapping>	toColumnMapping(ConnectorSession session, Connection connection, JdbcTypeHandle typeHandle)
protected Optional<BaseJdbcClient.TopNFunction>	topNFunction()
WriteMapping	toWriteMapping(ConnectorSession session, Type type)
static ColumnMapping	varbinaryColumnMapping()
static SliceWriteFunction	varbinaryWriteFunction()
protected void	verifyColumnName(DatabaseMetaData databaseMetadata, String columnName)
protected void	verifyTableName(DatabaseMetaData databaseMetadata, String tableName)

Methods inherited from class io.trino.plugin.jdbc.BaseJdbcClient

addColumn, addColumn, applyQueryTransformations, buildInsertSql, buildProcedure, buildSql, commitCreateTable, createSchema, createSchema, createTable, createTable, createTable, createTableSqls, delete, dropColumn, dropSchema, dropTable, dropTable, escapeObjectNameForMetadataQuery, execute, execute, filterSchema, finishInsertTable, getAdditionalPredicate, getColumnDefinitionSql, getColumns, getColumns, getColumns, getConnection, getConnection, getForcedMappingToVarchar, getIdentifierMapping, getInteger, getMaxWriteParallelism, getPreparedStatement, getRemoteIdentifiers, getSchemaNames, getSplits, getSplits, getTableHandle, getTableHandle, getTableNames, getTables, getTableSchemaName, getTableStatistics, getTableTypes, listSchemas, mapToUnboundedVarchar, prepareQuery, prepareQuery, preventTextualTypeAggregationPushdown, quoted, quoted, quoted, renameColumn, renameSchema, renameTable, renameTable, rollbackCreateTable, supportsLimit, supportsRetries, toColumnMappings, truncateTable, varcharLiteral, verifySchemaName

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

getSupportedType, getSystemTable, getTableComment, getTableScanRedirection, schemaExists, setColumnComment, setTableComment, setTableProperties

Field Details

SQL_SERVER_MAX_LIST_EXPRESSIONS

public static final int SQL_SERVER_MAX_LIST_EXPRESSIONS

See Also:

• Constant Field Values

SQL_SERVER_DEADLOCK_ERROR_CODE

public static final int SQL_SERVER_DEADLOCK_ERROR_CODE

See Also:

• Constant Field Values

BIGINT_TYPE

public static final JdbcTypeHandle BIGINT_TYPE

Constructor Details

SqlServerClient

@Inject
public SqlServerClient(BaseJdbcConfig config,
 JdbcStatisticsConfig statisticsConfig,
 ConnectionFactory connectionFactory,
 QueryBuilder queryBuilder,
 IdentifierMapping identifierMapping,
 RemoteQueryModifier queryModifier)

Method Details

dropSchema

protected void dropSchema(ConnectorSession session,
 Connection connection,
 String remoteSchemaName,
 boolean cascade)
                   throws SQLException

Overrides:

dropSchema in class BaseJdbcClient

Throws:

SQLException

beginCreateTable

public JdbcOutputTableHandle beginCreateTable(ConnectorSession session,
 ConnectorTableMetadata tableMetadata)

Specified by:

beginCreateTable in interface JdbcClient

Overrides:

beginCreateTable in class BaseJdbcClient

beginInsertTable

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

Specified by:

beginInsertTable in interface JdbcClient

Overrides:

beginInsertTable in class BaseJdbcClient

enableTableLockOnBulkLoadTableOption

protected void enableTableLockOnBulkLoadTableOption(ConnectorSession session,
 JdbcOutputTableHandle table)

isTableLockNeeded

protected boolean isTableLockNeeded(ConnectorSession session)

Table lock is a prerequisite for `minimal logging` in SQL Server

See Also:

• minimal logging

verifyTableName

protected void verifyTableName(DatabaseMetaData databaseMetadata,
 String tableName)
                        throws SQLException

Overrides:

verifyTableName in class BaseJdbcClient

Throws:

SQLException

verifyColumnName

protected void verifyColumnName(DatabaseMetaData databaseMetadata,
 String columnName)
                         throws SQLException

Overrides:

verifyColumnName in class BaseJdbcClient

Throws:

SQLException

renameTable

protected void renameTable(ConnectorSession session,
 Connection connection,
 String catalogName,
 String remoteSchemaName,
 String remoteTableName,
 String newRemoteSchemaName,
 String newRemoteTableName)
                    throws SQLException

Overrides:

renameTable in class BaseJdbcClient

Throws:

SQLException

renameColumn

protected void renameColumn(ConnectorSession session,
 Connection connection,
 RemoteTableName remoteTableName,
 String remoteColumnName,
 String newRemoteColumnName)
                     throws SQLException

Overrides:

renameColumn in class BaseJdbcClient

Throws:

SQLException

setColumnType

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

Specified by:

setColumnType in interface JdbcClient

Overrides:

setColumnType in class BaseJdbcClient

convertPredicate

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

renameSchema

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

Specified by:

renameSchema in interface JdbcClient

Overrides:

renameSchema in class BaseJdbcClient

copyTableSchema

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

Overrides:

copyTableSchema in class BaseJdbcClient

getCaseSensitivityForColumns

protected Map<String,CaseSensitivity> getCaseSensitivityForColumns(ConnectorSession session,
 Connection connection,
 JdbcTableHandle tableHandle)

Overrides:

getCaseSensitivityForColumns in class BaseJdbcClient

toColumnMapping

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

toWriteMapping

public WriteMapping toWriteMapping(ConnectorSession session,
 Type type)

getTableStatistics

public TableStatistics getTableStatistics(ConnectorSession session,
 JdbcTableHandle handle)

getProcedureHandle

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

Specified by:

getProcedureHandle in interface JdbcClient

Overrides:

getProcedureHandle in class BaseJdbcClient

escapeObjectNameForMetadataQuery

protected String escapeObjectNameForMetadataQuery(String name,
 String escape)

Overrides:

escapeObjectNameForMetadataQuery in class BaseJdbcClient

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

Overrides:

implementJoin in class BaseJdbcClient

implementAggregation

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

supportsAggregationPushdown

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

limitFunction

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

Overrides:

limitFunction in class BaseJdbcClient

isLimitGuaranteed

public boolean isLimitGuaranteed(ConnectorSession session)

Specified by:

isLimitGuaranteed in interface JdbcClient

Overrides:

isLimitGuaranteed in class BaseJdbcClient

supportsTopN

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

Specified by:

supportsTopN in interface JdbcClient

Overrides:

supportsTopN in class BaseJdbcClient

topNFunction

protected Optional<BaseJdbcClient.TopNFunction> topNFunction()

Overrides:

topNFunction in class BaseJdbcClient

isTopNGuaranteed

public boolean isTopNGuaranteed(ConnectorSession session)

Specified by:

isTopNGuaranteed in interface JdbcClient

Overrides:

isTopNGuaranteed in class BaseJdbcClient

isSupportedJoinCondition

protected boolean isSupportedJoinCondition(ConnectorSession session,
 JdbcJoinCondition joinCondition)

Overrides:

isSupportedJoinCondition in class BaseJdbcClient

createTableSql

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

Overrides:

createTableSql in class BaseJdbcClient

postProcessInsertTableNameClause

protected String postProcessInsertTableNameClause(ConnectorSession session,
 String tableName)

Overrides:

postProcessInsertTableNameClause in class BaseJdbcClient

getTableProperties

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

Specified by:

getTableProperties in interface JdbcClient

Overrides:

getTableProperties in class BaseJdbcClient

abortReadConnection

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

Throws:

SQLException

getConnection

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

Specified by:

getConnection in interface JdbcClient

Overrides:

getConnection in class BaseJdbcClient

Throws:

SQLException

varbinaryColumnMapping

public static ColumnMapping varbinaryColumnMapping()

varbinaryWriteFunction

public static SliceWriteFunction varbinaryWriteFunction()

retryOnDeadlock

public static <T> T retryOnDeadlock(dev.failsafe.function.CheckedSupplier<T> supplier,
 String attemptLogMessage)