Package com.amazonaws.athena.connectors.example

Class ExampleRecordHandler

java.lang.Object

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

com.amazonaws.athena.connectors.example.ExampleRecordHandler

All Implemented Interfaces:

com.amazonaws.services.lambda.runtime.RequestStreamHandler

public class ExampleRecordHandler
extends RecordHandler

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 RecordHandler, building, deploying, and then using your new source in an Athena query.

More specifically, this class is responsible for providing Athena with actual rows level data from your source. Athena will call readWithConstraint(...) on this class for each 'Split' you generated in ExampleMetadataHandler.

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

Field Summary

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

configOptions

Constructor Summary

Constructors

Modifier	Constructor	Description
	ExampleRecordHandler(Map<String,String> configOptions)
protected	ExampleRecordHandler(software.amazon.awssdk.services.s3.S3Client amazonS3, software.amazon.awssdk.services.secretsmanager.SecretsManagerClient secretsManager, software.amazon.awssdk.services.athena.AthenaClient amazonAthena, Map<String,String> configOptions)

Method Summary

Modifier and Type	Method	Description
protected void	readWithConstraint(BlockSpiller spiller, ReadRecordsRequest recordsRequest, QueryStatusChecker queryStatusChecker)	Used to read the row data associated with the provided Split.

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

doHandleRequest, doReadRecords, getSecret, getSpillConfig, handleRequest, onPing, resolveSecrets

Methods inherited from class java.lang.Object

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

Constructor Detail

ExampleRecordHandler

public ExampleRecordHandler(Map<String,String> configOptions)

ExampleRecordHandler

protected ExampleRecordHandler(software.amazon.awssdk.services.s3.S3Client amazonS3,
                               software.amazon.awssdk.services.secretsmanager.SecretsManagerClient secretsManager,
                               software.amazon.awssdk.services.athena.AthenaClient amazonAthena,
                               Map<String,String> configOptions)

Method Detail

readWithConstraint

protected void readWithConstraint(BlockSpiller spiller,
                                  ReadRecordsRequest recordsRequest,
                                  QueryStatusChecker queryStatusChecker)
                           throws IOException

Used to read the row data associated with the provided Split.

Specified by:

readWithConstraint in class RecordHandler

Parameters:

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

recordsRequest - 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:

IOException