Package com.amazonaws.athena.connectors.example

Class ExampleMetadataHandler

  • All Implemented Interfaces:
    com.amazonaws.services.lambda.runtime.RequestStreamHandler
    public class ExampleMetadataHandler
extends MetadataHandler
    This class is part of an tutorial that will walk you through how to build a connector for your custom data source. The README for this module (athena-example) will guide you through preparing your development environment, modifying this example Metadatahandler, building, deploying, and then using your new source in an Athena query.

    More specifically, this class is responsible for providing Athena with metadata about the schemas (aka databases), tables, and table partitions that your source contains. Lastly, this class tells Athena how to split up reads against this source. This gives you control over the level of performance and parallelism your source can support.

    For more examples, please see the other connectors in this repository (e.g. athena-cloudwatch, athena-docdb, etc...)

    • Constructor Detail

      • ExampleMetadataHandler

        public ExampleMetadataHandler​(Map<String,​String> configOptions)

      • ExampleMetadataHandler

        protected ExampleMetadataHandler​(EncryptionKeyFactory keyFactory,
                                 software.amazon.awssdk.services.secretsmanager.SecretsManagerClient awsSecretsManager,
                                 software.amazon.awssdk.services.athena.AthenaClient athena,
                                 String spillBucket,
                                 String spillPrefix,
                                 Map<String,​String> configOptions)

    • Method Detail

      • doListSchemaNames

        public ListSchemasResponse doListSchemaNames​(BlockAllocator allocator,
                                             ListSchemasRequest request)
        Used to get the list of schemas (aka databases) that this source contains.
        Specified by:
        doListSchemaNames in class MetadataHandler
        Parameters:
        allocator - Tool for creating and managing Apache Arrow Blocks.
        request - Provides details on who made the request and which Athena catalog they are querying.
        Returns:
        A ListSchemasResponse which primarily contains a Set of schema names and a catalog name corresponding the Athena catalog that was queried.

      • doListTables

        public ListTablesResponse doListTables​(BlockAllocator allocator,
                                       ListTablesRequest request)
        Used to get a paginated list of tables that this source contains.
        Specified by:
        doListTables in class MetadataHandler
        Parameters:
        allocator - Tool for creating and managing Apache Arrow Blocks.
        request - Provides details on who made the request and which Athena catalog and database they are querying.
        Returns:
        A ListTablesResponse which primarily contains a List enumerating the tables in this catalog, database tuple. It also contains the catalog name corresponding the Athena catalog that was queried.

      • doGetTable

        public GetTableResponse doGetTable​(BlockAllocator allocator,
                                   GetTableRequest request)
        Used to get definition (field names, types, descriptions, etc...) of a Table.
        Specified by:
        doGetTable in class MetadataHandler
        Parameters:
        allocator - Tool for creating and managing Apache Arrow Blocks.
        request - Provides details on who made the request and which Athena catalog, database, and table they are querying.
        Returns:
        A GetTableResponse which primarily contains: 1. An Apache Arrow Schema object describing the table's columns, types, and descriptions. 2. A Set of partition column names (or empty if the table isn't partitioned). 3. A TableName object confirming the schema and table name the response is for. 4. A catalog name corresponding the Athena catalog that was queried.

      • 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.
        Specified by:
        getPartitions in class MetadataHandler
        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)
        Used to split-up the reads required to scan the requested batch of partition(s).
        Specified by:
        doGetSplits in class MetadataHandler
        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.

      • doGetDataSourceCapabilities

        public GetDataSourceCapabilitiesResponse doGetDataSourceCapabilities​(BlockAllocator allocator,
                                                                     GetDataSourceCapabilitiesRequest request)
        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.