Package com.amazonaws.athena.connectors.synapse

Class SynapseMetadataHandler

java.lang.Object

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

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

com.amazonaws.athena.connectors.synapse.SynapseMetadataHandler

All Implemented Interfaces:

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

public class SynapseMetadataHandler
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
	SynapseMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, Map<String,String> configOptions)	Used by Mux.
protected	SynapseMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, software.amazon.awssdk.services.secretsmanager.SecretsManagerClient secretsManager, software.amazon.awssdk.services.athena.AthenaClient athena, JdbcConnectionFactory jdbcConnectionFactory, Map<String,String> configOptions, JDBCCaseResolver caseResolver)
	SynapseMetadataHandler(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
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 CredentialsProvider	getCredentialProvider()
void	getPartitions(BlockWriter blockWriter, GetTableLayoutRequest getTableLayoutRequest, QueryStatusChecker queryStatusChecker)	Partition metadata queries will be extracted from template files, we can check whether the table is partitioned or not using these queries.
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)	Appropriate datatype to arrow type conversions will be done by fetching data types of columns

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

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

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

doGetTableLayout, doHandleRequest, doPing, enhancePartitionSchema, getCachableSecretsManager, getRequestOverrideConfig, getSecret, handleRequest, makeEncryptionKey, makeSpillLocation, onPing, resolveSecrets, resolveWithDefaultCredentials

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, getRequestOverrideConfig, getS3Client, getSessionCredentials

Constructor Detail

SynapseMetadataHandler

public SynapseMetadataHandler(Map<String,String> configOptions)

SynapseMetadataHandler

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

Used by Mux.

SynapseMetadataHandler

protected SynapseMetadataHandler(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

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.

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

getPartitions

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

Partition metadata queries will be extracted from template files, we can check whether the table is partitioned or not using these queries. If it is a table with no partition, then data will be fetched with single split. If it is 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)
                                                       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 -

Returns:

Throws:

Exception

getCredentialProvider

protected CredentialsProvider getCredentialProvider()

Overrides:

getCredentialProvider in class JdbcMetadataHandler