Package com.amazonaws.athena.connectors.sqlserver

Class SqlServerMetadataHandler

java.lang.Object

com.amazonaws.athena.connector.lambda.handlers.MetadataHandler

com.amazonaws.athena.connectors.jdbc.manager.JdbcMetadataHandler

com.amazonaws.athena.connectors.sqlserver.SqlServerMetadataHandler

All Implemented Interfaces:

FederationRequestHandler, com.amazonaws.services.lambda.runtime.RequestStreamHandler

public class SqlServerMetadataHandler
extends JdbcMetadataHandler

Field Summary

Fields inherited from class com.amazonaws.athena.connectors.jdbc.manager.JdbcMetadataHandler

caseResolver, jdbcQueryPassthrough, TABLES_AND_VIEWS

Fields inherited from class com.amazonaws.athena.connector.lambda.handlers.MetadataHandler

configOptions, DISABLE_SPILL_ENCRYPTION, KMS_KEY_ID_ENV, SPILL_BUCKET_ENV, SPILL_PREFIX_ENV

Constructor Summary

Constructors

Modifier	Constructor	Description
	SqlServerMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, JdbcConnectionFactory jdbcConnectionFactory, Map<String,String> configOptions)
	SqlServerMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, Map<String,String> configOptions)	Used by Mux.
protected	SqlServerMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, software.amazon.awssdk.services.secretsmanager.SecretsManagerClient secretsManager, software.amazon.awssdk.services.athena.AthenaClient athena, JdbcConnectionFactory jdbcConnectionFactory, Map<String,String> configOptions, JDBCCaseResolver caseResolver)
	SqlServerMetadataHandler(Map<String,String> configOptions)

Method Summary

Modifier and Type	Method	Description
protected Optional<org.apache.arrow.vector.types.pojo.ArrowType>	convertDatasourceTypeToArrow(int columnIndex, int precision, Map<String,String> configOptions, ResultSetMetaData metadata)	A method that takes in a JDBC type; and converts it to Arrow Type This can be overriden by other Metadata Handlers extending JDBC
CredentialsProvider	createCredentialsProvider(String secretName, software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration requestOverrideConfiguration)	Factory method to create CredentialsProvider.
GetDataSourceCapabilitiesResponse	doGetDataSourceCapabilities(BlockAllocator allocator, GetDataSourceCapabilitiesRequest request)	Used to describe the types of capabilities supported by a data source.
GetSplitsResponse	doGetSplits(BlockAllocator blockAllocator, GetSplitsRequest getSplitsRequest)	Used to split-up the reads required to scan the requested batch of partition(s).
protected List<TableName>	getPaginatedTables(Connection connection, String databaseName, int token, int limit)
void	getPartitions(BlockWriter blockWriter, GetTableLayoutRequest getTableLayoutRequest, QueryStatusChecker queryStatusChecker)	Check whether input table is a view or not.
org.apache.arrow.vector.types.pojo.Schema	getPartitionSchema(String catalogName)	Delegates creation of partition schema to database type implementation.
protected org.apache.arrow.vector.types.pojo.Schema	getSchema(Connection jdbcConnection, TableName tableName, org.apache.arrow.vector.types.pojo.Schema partitionSchema, software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration requestOverrideConfiguration)	Appropriate datatype to arrow type conversions will be done by fetching data types of columns
protected Set<String>	listDatabaseNames(Connection jdbcConnection)
protected ListTablesResponse	listPaginatedTables(Connection connection, ListTablesRequest listTablesRequest)	This is default getAllTables without true pagination.

Methods inherited from class com.amazonaws.athena.connectors.jdbc.manager.JdbcMetadataHandler

doGetQueryPassthroughSchema, doGetTable, doListSchemaNames, doListTables, escapeNamePattern, getArrayArrowTypeFromTypeName, getColumns, getDatabaseConnectionConfig, getDatabaseConnectionSecret, getJdbcConnectionFactory, getSplitClauses, listTables, setupQueryPassthroughSplit, wrapNameWithEscapedCharacter

Methods inherited from class com.amazonaws.athena.connector.lambda.handlers.MetadataHandler

doGetTableLayout, doHandleRequest, doPing, enhancePartitionSchema, getCachableSecretsManager, getKmsEncryptionProvider, handleRequest, makeEncryptionKey, makeEncryptionKey, makeSpillLocation, onPing

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amazonaws.athena.connector.lambda.handlers.FederationRequestHandler

getAthenaClient, getCredentialProvider, getCredentialProvider, getRequestOverrideConfig, getRequestOverrideConfig, getRequestOverrideConfig, getS3Client, getSecret, getSecret, getSessionCredentials, isRequestFederated, resolveSecrets, resolveWithDefaultCredentials

Constructor Detail

SqlServerMetadataHandler

public SqlServerMetadataHandler(Map<String,String> configOptions)

SqlServerMetadataHandler

public SqlServerMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig,
                                Map<String,String> configOptions)

Used by Mux.

SqlServerMetadataHandler

public SqlServerMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig,
                                JdbcConnectionFactory jdbcConnectionFactory,
                                Map<String,String> configOptions)

SqlServerMetadataHandler

protected SqlServerMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig,
                                   software.amazon.awssdk.services.secretsmanager.SecretsManagerClient secretsManager,
                                   software.amazon.awssdk.services.athena.AthenaClient athena,
                                   JdbcConnectionFactory jdbcConnectionFactory,
                                   Map<String,String> configOptions,
                                   JDBCCaseResolver caseResolver)

Method Detail

getPartitionSchema

public org.apache.arrow.vector.types.pojo.Schema getPartitionSchema(String catalogName)

Description copied from class: JdbcMetadataHandler

Delegates creation of partition schema to database type implementation.

Specified by:

getPartitionSchema in class JdbcMetadataHandler

Parameters:

catalogName - Athena provided catalog name.

Returns:

schema. See Schema

getPaginatedTables

protected List<TableName> getPaginatedTables(Connection connection,
                                             String databaseName,
                                             int token,
                                             int limit)
                                      throws SQLException

Throws:

SQLException

listPaginatedTables

protected ListTablesResponse listPaginatedTables(Connection connection,
                                                 ListTablesRequest listTablesRequest)
                                          throws SQLException

Description copied from class: JdbcMetadataHandler

This is default getAllTables without true pagination. Paginated list of tables will be returned by retrieving all tables first, then returning subset based off request. Override this if you want to support true pagination behavior.

Overrides:

listPaginatedTables in class JdbcMetadataHandler

Returns:

Throws:

SQLException

doGetDataSourceCapabilities

public GetDataSourceCapabilitiesResponse doGetDataSourceCapabilities(BlockAllocator allocator,
                                                                     GetDataSourceCapabilitiesRequest request)

Description copied from class: MetadataHandler

Used to describe the types of capabilities supported by a data source. An engine can use this to determine what portions of the query to push down. A connector that returns any optimization will guarantee that the associated predicate will be pushed down.

Overrides:

doGetDataSourceCapabilities in class MetadataHandler

Parameters:

allocator - Tool for creating and managing Apache Arrow Blocks.

request - Provides details about the catalog being used.

Returns:

A GetDataSourceCapabilitiesResponse object which returns a map of supported optimizations that the connector is advertising to the consumer. The connector assumes all responsibility for whatever is passed here.

getPartitions

public void getPartitions(BlockWriter blockWriter,
                          GetTableLayoutRequest getTableLayoutRequest,
                          QueryStatusChecker queryStatusChecker)
                   throws Exception

Check whether input table is a view or not. If it's a view, it will not have any partition info and data will be fetched with single split.If it's a table with no partition, then data will be fetched with single split. If it's a partitioned table, we are fetching the partition info and creating splits equals to the number of partitions for parallel processing.

Specified by:

getPartitions in class JdbcMetadataHandler

Parameters:

blockWriter -

getTableLayoutRequest -

queryStatusChecker -

Throws:

Exception

doGetSplits

public GetSplitsResponse doGetSplits(BlockAllocator blockAllocator,
                                     GetSplitsRequest getSplitsRequest)

Description copied from class: MetadataHandler

Used to split-up the reads required to scan the requested batch of partition(s).

Specified by:

doGetSplits in class JdbcMetadataHandler

Parameters:

blockAllocator -

getSplitsRequest -

Returns:

convertDatasourceTypeToArrow

protected Optional<org.apache.arrow.vector.types.pojo.ArrowType> convertDatasourceTypeToArrow(int columnIndex,
                                                                                              int precision,
                                                                                              Map<String,String> configOptions,
                                                                                              ResultSetMetaData metadata)
                                                                                       throws SQLException

Description copied from class: JdbcMetadataHandler

A method that takes in a JDBC type; and converts it to Arrow Type This can be overriden by other Metadata Handlers extending JDBC

Overrides:

convertDatasourceTypeToArrow in class JdbcMetadataHandler

Returns:

Arrow Type

Throws:

SQLException

getSchema

protected org.apache.arrow.vector.types.pojo.Schema getSchema(Connection jdbcConnection,
                                                              TableName tableName,
                                                              org.apache.arrow.vector.types.pojo.Schema partitionSchema,
                                                              software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration requestOverrideConfiguration)
                                                       throws Exception

Appropriate datatype to arrow type conversions will be done by fetching data types of columns

Overrides:

getSchema in class JdbcMetadataHandler

Parameters:

jdbcConnection -

tableName -

partitionSchema -

requestOverrideConfiguration - optional AWS request override configuration for credential federation

Returns:

Throws:

Exception

listDatabaseNames

protected Set<String> listDatabaseNames(Connection jdbcConnection)
                                 throws SQLException

Overrides:

listDatabaseNames in class JdbcMetadataHandler

Throws:

SQLException

createCredentialsProvider

public CredentialsProvider createCredentialsProvider(String secretName,
                                                     software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration requestOverrideConfiguration)

Description copied from interface: FederationRequestHandler

Factory method to create CredentialsProvider. Subclasses can override this to provide custom credential provider implementations (e.g., SnowflakeCredentialsProvider).

Parameters:

secretName - The secret name to retrieve credentials from

requestOverrideConfiguration - Optional AWS request override configuration

Returns:

CredentialsProvider instance