Package com.amazonaws.athena.connectors.clickhouse

Class ClickHouseMetadataHandler

java.lang.Object

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

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

com.amazonaws.athena.connectors.mysql.MySqlMetadataHandler

com.amazonaws.athena.connectors.clickhouse.ClickHouseMetadataHandler

All Implemented Interfaces:

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

public class ClickHouseMetadataHandler
extends MySqlMetadataHandler

Class handles metadata for ClickHouse and reuses code from Athena MySQL module for compatibility. 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
	ClickHouseMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, JdbcConnectionFactory jdbcConnectionFactory, Map<String,String> configOptions)
	ClickHouseMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, Map<String,String> configOptions)	Used by Mux.
protected	ClickHouseMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig, software.amazon.awssdk.services.secretsmanager.SecretsManagerClient secretsManager, software.amazon.awssdk.services.athena.AthenaClient athena, JdbcConnectionFactory jdbcConnectionFactory, Map<String,String> configOptions)
	ClickHouseMetadataHandler(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).
protected List<TableName>	getPaginatedTables(Connection connection, String databaseName, int token, int limit)
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.
protected Set<String>	listDatabaseNames(Connection jdbcConnection)
protected ListTablesResponse	listPaginatedTables(Connection connection, ListTablesRequest listTablesRequest)	This is default getAllTables without true pagination.
protected List<TableName>	listTables(Connection jdbcConnection, String databaseName)

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

convertDatasourceTypeToArrow, doGetQueryPassthroughSchema, doGetTable, doListSchemaNames, doListTables, escapeNamePattern, getArrayArrowTypeFromTypeName, getColumns, getCredentialProvider, getDatabaseConnectionConfig, getDatabaseConnectionSecret, getJdbcConnectionFactory, getSchema, getSplitClauses, 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

createCredentialsProvider, getAthenaClient, getCredentialProvider, getRequestOverrideConfig, getRequestOverrideConfig, getRequestOverrideConfig, getS3Client, getSecret, getSecret, getSessionCredentials, isRequestFederated, resolveSecrets, resolveWithDefaultCredentials

Constructor Detail

ClickHouseMetadataHandler

public ClickHouseMetadataHandler(Map<String,String> configOptions)

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

ClickHouseMetadataHandler

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

Used by Mux.

ClickHouseMetadataHandler

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

ClickHouseMetadataHandler

protected ClickHouseMetadataHandler(DatabaseConnectionConfig databaseConnectionConfig,
                                    software.amazon.awssdk.services.secretsmanager.SecretsManagerClient secretsManager,
                                    software.amazon.awssdk.services.athena.AthenaClient 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 MySqlMetadataHandler

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.

Overrides:

getPartitionSchema in class MySqlMetadataHandler

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.

Overrides:

getPartitions in class MySqlMetadataHandler

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

Overrides:

doGetSplits in class MySqlMetadataHandler

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.

getPaginatedTables

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

Overrides:

getPaginatedTables in class MySqlMetadataHandler

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 MySqlMetadataHandler

Returns:

Throws:

SQLException

listTables

protected List<TableName> listTables(Connection jdbcConnection,
                                     String databaseName)
                              throws SQLException

Overrides:

listTables in class MySqlMetadataHandler

Throws:

SQLException

listDatabaseNames

protected Set<String> listDatabaseNames(Connection jdbcConnection)
                                 throws SQLException

Overrides:

listDatabaseNames in class JdbcMetadataHandler

Throws:

SQLException