Package com.amazonaws.athena.connectors.jdbc.connection

Class GenericJdbcConnectionFactory

java.lang.Object

com.amazonaws.athena.connectors.jdbc.connection.GenericJdbcConnectionFactory

All Implemented Interfaces:

JdbcConnectionFactory, AutoCloseable

Direct Known Subclasses:

HiveJdbcConnectionFactory, SnowflakeConnectionFactory

public class GenericJdbcConnectionFactory
extends Object
implements JdbcConnectionFactory

Provides a generic jdbc connection factory that can be used to connect to standard databases. When running as a Glue managed connection (configOptions contains fas_token), uses direct DriverManager connections instead of HikariCP connection pooling.

Field Summary

Fields

Modifier and Type	Field	Description
protected DatabaseConnectionConfig	databaseConnectionConfig
protected DatabaseConnectionInfo	databaseConnectionInfo
protected Properties	jdbcProperties
protected static Pattern	SECRET_NAME_PATTERN

Constructor Summary

Constructors

Constructor	Description
GenericJdbcConnectionFactory(DatabaseConnectionConfig databaseConnectionConfig, Map<String,String> properties, DatabaseConnectionInfo databaseConnectionInfo)	Existing constructor — defaults to no configOptions (no Glue managed connection).
GenericJdbcConnectionFactory(DatabaseConnectionConfig databaseConnectionConfig, Map<String,String> properties, DatabaseConnectionInfo databaseConnectionInfo, Map<String,String> configOptions)

Method Summary

Modifier and Type	Method	Description
void	close()	Closes the connection pool, releasing pooled connections and their background threads.
Connection	getConnection(CredentialsProvider credentialsProvider)	Retrieves database connection for a database type.
protected Connection	getConnectionFromManagedPool(CredentialsProvider credentialsProvider)	Returns a connection from the HikariCP connection pool, initializing the pool on first call.

Methods inherited from class java.lang.Object

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

Field Detail

SECRET_NAME_PATTERN

protected static final Pattern SECRET_NAME_PATTERN

databaseConnectionConfig

protected final DatabaseConnectionConfig databaseConnectionConfig

jdbcProperties

protected final Properties jdbcProperties

databaseConnectionInfo

protected final DatabaseConnectionInfo databaseConnectionInfo

Constructor Detail

GenericJdbcConnectionFactory

public GenericJdbcConnectionFactory(DatabaseConnectionConfig databaseConnectionConfig,
                                    Map<String,String> properties,
                                    DatabaseConnectionInfo databaseConnectionInfo)

Existing constructor — defaults to no configOptions (no Glue managed connection).

GenericJdbcConnectionFactory

public GenericJdbcConnectionFactory(DatabaseConnectionConfig databaseConnectionConfig,
                                    Map<String,String> properties,
                                    DatabaseConnectionInfo databaseConnectionInfo,
                                    Map<String,String> configOptions)

Parameters:

databaseConnectionConfig - database connection configuration DatabaseConnectionConfig

properties - JDBC connection properties.

databaseConnectionInfo - Contains JDBC driver and default port details.

configOptions - environment/config options; when fas_token is present, uses direct DriverManager connections.

Method Detail

getConnection

public Connection getConnection(CredentialsProvider credentialsProvider)
                         throws Exception

Description copied from interface: JdbcConnectionFactory

Retrieves database connection for a database type.

Specified by:

getConnection in interface JdbcConnectionFactory

Parameters:

credentialsProvider - jdbc user and password provider.

Returns:

JDBC connection. See Connection.

Throws:

Exception

getConnectionFromManagedPool

protected Connection getConnectionFromManagedPool(CredentialsProvider credentialsProvider)
                                           throws SQLException

Returns a connection from the HikariCP connection pool, initializing the pool on first call. Subclasses can call this directly to bypass the useDirectConnection check.

Parameters:

credentialsProvider - jdbc user and password provider, or null if no credentials.

Returns:

JDBC connection from the pool.

Throws:

SQLException - if a connection cannot be obtained.

close

public void close()

Closes the connection pool, releasing pooled connections and their background threads. The factory stays usable: a later getConnection rebuilds the pool, so closing a handler that is subsequently reused does not permanently break it.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface JdbcConnectionFactory