Package com.amazonaws.athena.connectors.teradata

Class TeradataMetadataHandler

java.lang.Object

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

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

com.amazonaws.athena.connectors.teradata.TeradataMetadataHandler

All Implemented Interfaces:

com.amazonaws.services.lambda.runtime.RequestStreamHandler

public class TeradataMetadataHandler
extends JdbcMetadataHandler

Handles metadata for Teradata. User must have access to `schemata`, `tables`, `columns`, `partitions` tables in information_schema.

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
	TeradataMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, JdbcConnectionFactory jdbcConnectionFactory, Map<String,String> configOptions)
protected	TeradataMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, com.amazonaws.services.secretsmanager.AWSSecretsManager secretsManager, com.amazonaws.services.athena.AmazonAthena athena, JdbcConnectionFactory jdbcConnectionFactory, Map<String,String> configOptions)
	TeradataMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, Map<String,String> configOptions)	Used by Mux.
	TeradataMetadataHandler(Map<String,String> configOptions)	Instantiates handler to be used by Lambda function directly.

Method Summary

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 Table.
void	getPartitions(BlockWriter blockWriter, GetTableLayoutRequest getTableLayoutRequest, QueryStatusChecker queryStatusChecker)	Used to get the 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.
static org.apache.arrow.vector.types.pojo.ArrowType	toArrowType(int jdbcType, int precision, int scale)

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

Methods inherited from class java.lang.Object

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

Constructor Detail

TeradataMetadataHandler

public TeradataMetadataHandler(Map<String,String> configOptions)

Instantiates handler to be used by Lambda function directly. Recommend using TeradataMuxCompositeHandler instead.

TeradataMetadataHandler

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

Used by Mux.

TeradataMetadataHandler

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

TeradataMetadataHandler

protected TeradataMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig,
                                  com.amazonaws.services.secretsmanager.AWSSecretsManager secretsManager,
                                  com.amazonaws.services.athena.AmazonAthena athena,
                                  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.

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

Description copied from class: MetadataHandler

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 JdbcMetadataHandler

Parameters:

blockWriter - Used to write rows (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

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 - Tool for creating and managing Apache Arrow Blocks.

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

doGetTable

public GetTableResponse doGetTable(BlockAllocator blockAllocator,
                                   GetTableRequest getTableRequest)
                            throws Exception

Description copied from class: MetadataHandler

Used to get definition (field names, types, descriptions, etc...) of a Table.

Overrides:

doGetTable in class JdbcMetadataHandler

Parameters:

blockAllocator - Tool for creating and managing Apache Arrow Blocks.

getTableRequest - 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).

Throws:

Exception

toArrowType

public static org.apache.arrow.vector.types.pojo.ArrowType toArrowType(int jdbcType,
                                                                       int precision,
                                                                       int scale)