Package com.amazonaws.athena.connectors.snowflake

Class SnowflakeMetadataHandler

  • All Implemented Interfaces:
    FederationRequestHandler, com.amazonaws.services.lambda.runtime.RequestStreamHandler
    public class SnowflakeMetadataHandler
extends JdbcMetadataHandler
    Handles metadata for Snowflake. User must have access to `schemata`, `tables`, `columns` in information_schema.

    • Constructor Detail

      • SnowflakeMetadataHandler

        public SnowflakeMetadataHandler​(Map<String,​String> configOptions)
        Instantiates handler to be used by Lambda function directly.

      • SnowflakeMetadataHandler

        protected SnowflakeMetadataHandler​(DatabaseConnectionConfig databaseConnectionConfig,
                                   software.amazon.awssdk.services.secretsmanager.SecretsManagerClient secretsManager,
                                   software.amazon.awssdk.services.athena.AthenaClient athena,
                                   software.amazon.awssdk.services.s3.S3Client s3Client,
                                   JdbcConnectionFactory jdbcConnectionFactory,
                                   Map<String,​String> configOptions)

    • 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.

      • enhancePartitionSchema

        public void enhancePartitionSchema​(SchemaBuilder partitionSchemaBuilder,
                                   GetTableLayoutRequest request)
        Here we inject the additional column to hold the Prepared SQL Statement.
        Overrides:
        enhancePartitionSchema in class MetadataHandler
        Parameters:
        partitionSchemaBuilder - The SchemaBuilder you can use to add additional columns and metadata to the partitions response.
        request - The GetTableLayoutResquest that triggered this call.

      • getPartitions

        public void getPartitions​(BlockWriter blockWriter,
                          GetTableLayoutRequest request,
                          QueryStatusChecker queryStatusChecker)
                   throws Exception
        Used to get the partitions that must be read from the request table in order to satisfy the requested predicate. Here generating the SQL from the request and attaching it as a additional column
        Specified by:
        getPartitions in class JdbcMetadataHandler
        Parameters:
        blockWriter - Used to write rows (partitions) into the Apache Arrow response.
        request - Provides details of the catalog, database, and table being queried as well as any filter predicate.
        queryStatusChecker - A QueryStatusChecker that you can use to stop doing work for a query that has already terminated
        Throws:
        Exception

      • doGetSplits

        public GetSplitsResponse doGetSplits​(BlockAllocator allocator,
                                     GetSplitsRequest request)
        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:
        allocator - Tool for creating and managing Apache Arrow Blocks.
        request - Provides details of the catalog, database, table, andpartition(s) being queried as well as any filter predicate.
        Returns:
        A GetSplitsResponse which primarily contains: 1. A Set which represent read operations Amazon Athena must perform by calling your read function. 2. (Optional) A continuation token which allows you to paginate the generation of splits for large queries.

      • getSchema

        protected org.apache.arrow.vector.types.pojo.Schema getSchema​(Connection jdbcConnection,
                                                              TableName tableName,
                                                              org.apache.arrow.vector.types.pojo.Schema partitionSchema)
                                                       throws Exception
        Overrides:
        getSchema in class JdbcMetadataHandler
        Parameters:
        jdbcConnection -
        tableName -
        partitionSchema -
        Returns:
        Throws:
        Exception

      • 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

      • getS3ExportBucket

        public String getS3ExportBucket()

      • getRoleArn

        public String getRoleArn​(com.amazonaws.services.lambda.runtime.Context context)