Package com.amazonaws.athena.connectors.oracle

Class OracleMetadataHandler

java.lang.Object

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

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

com.amazonaws.athena.connectors.oracle.OracleMetadataHandler

All Implemented Interfaces:

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

public class OracleMetadataHandler
extends JdbcMetadataHandler

Handles metadata for ORACLE. 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

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
	OracleMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, JdbcConnectionFactory jdbcConnectionFactory, Map<String,String> configOptions)
	OracleMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, Map<String,String> configOptions)	Used by Mux.
protected	OracleMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, software.amazon.awssdk.services.secretsmanager.SecretsManagerClient secretsManager, software.amazon.awssdk.services.athena.AthenaClient athena, JdbcConnectionFactory jdbcConnectionFactory, Map<String,String> configOptions, JDBCCaseResolver caseResolver)
	OracleMetadataHandler(Map<String,String> configOptions)	Instantiates handler to be used by Lambda function directly.

Method Summary

Modifier and Type	Method	Description
CredentialsProvider	createCredentialsProvider(String secretName, software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration requestOverrideConfiguration)	Factory method to create CredentialsProvider.
GetDataSourceCapabilitiesResponse	doGetDataSourceCapabilities(BlockAllocator allocator, GetDataSourceCapabilitiesRequest request)	Overridden this method 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 List<TableName>	getPaginatedTables(Connection connection, String databaseName, int token, int limit)
void	getPartitions(BlockWriter blockWriter, GetTableLayoutRequest getTableLayoutRequest, QueryStatusChecker queryStatusChecker)	If it is a table with no partition, then data will be fetched with single split.
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, software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration requestOverrideConfiguration)	Gets the schema for a table with optional request override configuration.
protected ListTablesResponse	listPaginatedTables(Connection connection, ListTablesRequest listTablesRequest)	This is default getAllTables without true pagination.

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

convertDatasourceTypeToArrow, doGetQueryPassthroughSchema, doGetTable, doListSchemaNames, doListTables, escapeNamePattern, getArrayArrowTypeFromTypeName, getColumns, getCredentialProvider, getDatabaseConnectionConfig, getDatabaseConnectionSecret, getJdbcConnectionFactory, getSplitClauses, listDatabaseNames, listTables, setupQueryPassthroughSplit, wrapNameWithEscapedCharacter

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

doGetTableLayout, doHandleRequest, doPing, enhancePartitionSchema, getCachableSecretsManager, getKmsEncryptionProvider, handleRequest, makeEncryptionKey, makeEncryptionKey, makeSpillLocation, onPing

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, getCredentialProvider, getRequestOverrideConfig, getRequestOverrideConfig, getRequestOverrideConfig, getS3Client, getSecret, getSecret, getSessionCredentials, isRequestFederated, resolveSecrets, resolveWithDefaultCredentials

Constructor Detail

OracleMetadataHandler

public OracleMetadataHandler(Map<String,String> configOptions)

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

OracleMetadataHandler

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

Used by Mux.

OracleMetadataHandler

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

OracleMetadataHandler

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

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

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:

getPaginatedTables

protected List<TableName> getPaginatedTables(Connection connection,
                                             String databaseName,
                                             int token,
                                             int limit)
                                      throws SQLException

Throws:

SQLException

listPaginatedTables

protected ListTablesResponse listPaginatedTables(Connection connection,
                                                 ListTablesRequest listTablesRequest)
                                          throws SQLException

Description copied from class: JdbcMetadataHandler

This is default getAllTables without true pagination. Paginated list of tables will be returned by retrieving all tables first, then returning subset based off request. Override this if you want to support true pagination behavior.

Overrides:

listPaginatedTables in class JdbcMetadataHandler

Returns:

Throws:

SQLException

doGetDataSourceCapabilities

public GetDataSourceCapabilitiesResponse doGetDataSourceCapabilities(BlockAllocator allocator,
                                                                     GetDataSourceCapabilitiesRequest request)

Overridden this method to describe the types of capabilities supported by a data source

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 capabilities

getSchema

protected org.apache.arrow.vector.types.pojo.Schema getSchema(Connection jdbcConnection,
                                                              TableName tableName,
                                                              org.apache.arrow.vector.types.pojo.Schema partitionSchema,
                                                              software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration requestOverrideConfiguration)
                                                       throws Exception

Description copied from class: JdbcMetadataHandler

Gets the schema for a table with optional request override configuration.

Overrides:

getSchema in class JdbcMetadataHandler

Parameters:

jdbcConnection -

tableName -

partitionSchema -

requestOverrideConfiguration - optional AWS request override configuration for credential federation

Returns:

Throws:

Exception

createCredentialsProvider

public CredentialsProvider createCredentialsProvider(String secretName,
                                                     software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration requestOverrideConfiguration)

Description copied from interface: FederationRequestHandler

Factory method to create CredentialsProvider. Subclasses can override this to provide custom credential provider implementations (e.g., SnowflakeCredentialsProvider).

Parameters:

secretName - The secret name to retrieve credentials from

requestOverrideConfiguration - Optional AWS request override configuration

Returns:

CredentialsProvider instance