Package com.amazonaws.athena.connectors.docdb

Class DocDBRecordHandler

java.lang.Object

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

com.amazonaws.athena.connectors.docdb.DocDBRecordHandler

All Implemented Interfaces:

com.amazonaws.services.lambda.runtime.RequestStreamHandler

public class DocDBRecordHandler
extends RecordHandler

Handles data read record requests for the Athena DocumentDB Connector.

For more detail, please see the module's README.md, some notable characteristics of this class include:

1. Attempts to resolve sensitive configuration fields such as HBase connection string via SecretsManager so that you can substitute variables with values from by doing something like hostname:port:password=${my_secret}

Field Summary

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

configOptions

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	DocDBRecordHandler(com.amazonaws.services.s3.AmazonS3 amazonS3, com.amazonaws.services.secretsmanager.AWSSecretsManager secretsManager, com.amazonaws.services.athena.AmazonAthena athena, DocDBConnectionFactory connectionFactory, Map<String,String> configOptions)
	DocDBRecordHandler(Map<String,String> configOptions)

Method Summary

Modifier and Type	Method	Description
protected void	readWithConstraint(BlockSpiller spiller, ReadRecordsRequest recordsRequest, QueryStatusChecker queryStatusChecker)	Scans DocumentDB using the scan settings set on the requested Split by DocDBeMetadataHandler.

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

DocDBRecordHandler

public DocDBRecordHandler(Map<String,String> configOptions)

DocDBRecordHandler

protected DocDBRecordHandler(com.amazonaws.services.s3.AmazonS3 amazonS3,
                             com.amazonaws.services.secretsmanager.AWSSecretsManager secretsManager,
                             com.amazonaws.services.athena.AmazonAthena athena,
                             DocDBConnectionFactory connectionFactory,
                             Map<String,String> configOptions)

Method Detail

readWithConstraint

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

Scans DocumentDB using the scan settings set on the requested Split by DocDBeMetadataHandler.

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

See Also:

RecordHandler