Class HiveMetadataHandler
- java.lang.Object
-
- com.amazonaws.athena.connector.lambda.handlers.MetadataHandler
-
- com.amazonaws.athena.connectors.jdbc.manager.JdbcMetadataHandler
-
- com.amazonaws.athena.connectors.hortonworks.HiveMetadataHandler
-
- All Implemented Interfaces:
com.amazonaws.services.lambda.runtime.RequestStreamHandler
public class HiveMetadataHandler extends JdbcMetadataHandler
-
-
Field Summary
-
Fields inherited from class com.amazonaws.athena.connectors.jdbc.manager.JdbcMetadataHandler
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 HiveMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, Map<String,String> configOptions)
protected
HiveMetadataHandler(DatabaseConnectionConfig databaseConnectionConfiguration, software.amazon.awssdk.services.secretsmanager.SecretsManagerClient secretManager, software.amazon.awssdk.services.athena.AthenaClient athena, JdbcConnectionFactory jdbcConnectionFactory, Map<String,String> configOptions)
HiveMetadataHandler(Map<String,String> configOptions)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description 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).GetTableResponse
doGetTable(BlockAllocator blockAllocator, GetTableRequest getTableRequest)
Used to get definition (field names, types, descriptions, etc...) of a Hive Table.void
getPartitions(BlockWriter blockWriter, GetTableLayoutRequest getTableLayoutRequest, QueryStatusChecker queryStatusChecker)
Used to get the hive partitions that must be read from the request table in order to satisfy the requested predicate.org.apache.arrow.vector.types.pojo.Schema
getPartitionSchema(String catalogName)
Delegates creation of partition schema to database type implementation.-
Methods inherited from class com.amazonaws.athena.connectors.jdbc.manager.JdbcMetadataHandler
caseInsensitiveTableSearch, convertDatasourceTypeToArrow, doGetQueryPassthroughSchema, doListSchemaNames, doListTables, escapeNamePattern, getArrayArrowTypeFromTypeName, getCredentialProvider, getJdbcConnectionFactory, getSplitClauses, listPaginatedTables, listTables, setupQueryPassthroughSplit
-
Methods inherited from class com.amazonaws.athena.connector.lambda.handlers.MetadataHandler
doGetTableLayout, doHandleRequest, doPing, enhancePartitionSchema, getSecret, handleRequest, makeEncryptionKey, makeSpillLocation, onPing, resolveSecrets
-
-
-
-
Constructor Detail
-
HiveMetadataHandler
public HiveMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, Map<String,String> configOptions)
-
HiveMetadataHandler
protected HiveMetadataHandler(DatabaseConnectionConfig databaseConnectionConfiguration, software.amazon.awssdk.services.secretsmanager.SecretsManagerClient secretManager, software.amazon.awssdk.services.athena.AthenaClient athena, JdbcConnectionFactory jdbcConnectionFactory, Map<String,String> configOptions)
-
-
Method Detail
-
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 classMetadataHandler
- 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)
Delegates creation of partition schema to database type implementation.- Specified by:
getPartitionSchema
in classJdbcMetadataHandler
- Parameters:
catalogName
- Athena provided hive catalog name.- Returns:
- schema. See
Schema
-
getPartitions
public void getPartitions(BlockWriter blockWriter, GetTableLayoutRequest getTableLayoutRequest, QueryStatusChecker queryStatusChecker) throws Exception
Used to get the hive partitions that must be read from the request table in order to satisfy the requested predicate.- Specified by:
getPartitions
in classJdbcMetadataHandler
- Parameters:
blockWriter
- Used to write rows (hive partitions) into the Apache Arrow response.getTableLayoutRequest
- 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
- An Exception should be thrown for database connection failures , query syntax errors and so on.
-
doGetSplits
public GetSplitsResponse doGetSplits(BlockAllocator blockAllocator, GetSplitsRequest getSplitsRequest)
Used to split-up the reads required to scan the requested batch of partition(s).- Specified by:
doGetSplits
in classJdbcMetadataHandler
- Parameters:
blockAllocator
- Tool for creating and managing Apache Arrow Blocks.getSplitsRequest
- Provides details of the Hive catalog, database, table, and partition(s) being queried as well as any filter predicate.- Returns:
- A GetSplitsResponse which primarily contains: 1. A Set of Splits 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.
-
doGetTable
public GetTableResponse doGetTable(BlockAllocator blockAllocator, GetTableRequest getTableRequest) throws Exception
Used to get definition (field names, types, descriptions, etc...) of a Hive Table.- Overrides:
doGetTable
in classJdbcMetadataHandler
- Parameters:
blockAllocator
- Tool for creating and managing Apache Arrow Blocks.getTableRequest
- Provides details on who made the request and which Athena catalog, database, and Hive 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 Strings of partition column names (or empty if the table isn't partitioned).
- Throws:
Exception
-
-