Package com.amazonaws.athena.connectors.datalakegen2

Class DataLakeGen2RecordHandler

java.lang.Object

com.amazonaws.athena.connector.lambda.handlers.RecordHandler

com.amazonaws.athena.connectors.jdbc.manager.JdbcRecordHandler

com.amazonaws.athena.connectors.datalakegen2.DataLakeGen2RecordHandler

All Implemented Interfaces:

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

public class DataLakeGen2RecordHandler
extends JdbcRecordHandler

Field Summary

Fields inherited from class com.amazonaws.athena.connectors.jdbc.manager.JdbcRecordHandler

queryPassthrough

Fields inherited from class com.amazonaws.athena.connector.lambda.handlers.RecordHandler

configOptions

Constructor Summary

Constructors

Constructor	Description
DataLakeGen2RecordHandler(DatabaseConnectionConfig databaseConnectionConfig, Map<String,String> configOptions)
DataLakeGen2RecordHandler(Map<String,String> configOptions)

Method Summary

Modifier and Type	Method	Description
PreparedStatement	buildSplitSql(Connection jdbcConnection, String catalogName, TableName tableName, org.apache.arrow.vector.types.pojo.Schema schema, Constraints constraints, Split split)	Builds split SQL string and returns prepared statement.
CredentialsProvider	createCredentialsProvider(String secretName, software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration requestOverrideConfiguration)	Factory method to create CredentialsProvider.
void	readWithConstraint(BlockSpiller blockSpiller, ReadRecordsRequest readRecordsRequest, QueryStatusChecker queryStatusChecker)	A more stream lined option for reading the row data associated with the provided Split.

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

buildQueryPassthroughSql, disableCaseSensitivelyLookUpSession, enableCaseSensitivelyLookUpSession, getColumnNameRemapping, getDatabaseConnectionConfig, getDatabaseConnectionSecret, getJdbcConnectionFactory, getSqlDialect, makeExtractor, makeFactory

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

doHandleRequest, doReadRecords, getCachableSecretsManager, getKmsEncryptionProvider, getSpillConfig, handleRequest, 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, getCredentialProvider, getRequestOverrideConfig, getRequestOverrideConfig, getRequestOverrideConfig, getS3Client, getSecret, getSecret, getSessionCredentials, isRequestFederated, resolveSecrets, resolveWithDefaultCredentials

Constructor Detail

DataLakeGen2RecordHandler

public DataLakeGen2RecordHandler(Map<String,String> configOptions)

DataLakeGen2RecordHandler

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

Method Detail

buildSplitSql

public PreparedStatement buildSplitSql(Connection jdbcConnection,
                                       String catalogName,
                                       TableName tableName,
                                       org.apache.arrow.vector.types.pojo.Schema schema,
                                       Constraints constraints,
                                       Split split)
                                throws SQLException

Description copied from class: JdbcRecordHandler

Builds split SQL string and returns prepared statement.

Specified by:

buildSplitSql in class JdbcRecordHandler

Parameters:

jdbcConnection - jdbc connection. See Connection

catalogName - Athena provided catalog name.

tableName - database table name.

schema - table schema.

constraints - constraints to push down to the database.

split - table split.

Returns:

prepared statement with sql. See PreparedStatement

Throws:

SQLException - JDBC database 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

readWithConstraint

public void readWithConstraint(BlockSpiller blockSpiller,
                               ReadRecordsRequest readRecordsRequest,
                               QueryStatusChecker queryStatusChecker)
                        throws Exception

Description copied from class: RecordHandler

A more stream lined option for reading the row data associated with the provided Split. This method differs from doReadRecords(...) in that the SDK handles more of the request lifecycle, leaving you to focus more closely on the task of actually reading from your source.

Overrides:

readWithConstraint in class JdbcRecordHandler

Parameters:

blockSpiller - A BlockSpiller that should be used to write the row data associated with this Split. The BlockSpiller automatically handles chunking the response, encrypting, and spilling to S3.

readRecordsRequest - Details of the read request, including: 1. The Split 2. The Catalog, Database, and Table the read request is for. 3. The filtering predicate (if any) 4. The columns required for projection.

queryStatusChecker - A QueryStatusChecker that you can use to stop doing work for a query that has already terminated

Throws:

Exception