software.amazon.jdbc.targetdriverdialect

Class GenericTargetDriverDialect

java.lang.Object

software.amazon.jdbc.targetdriverdialect.GenericTargetDriverDialect

All Implemented Interfaces:

TargetDriverDialect

Direct Known Subclasses:

MariadbTargetDriverDialect, MysqlConnectorJTargetDriverDialect, PgTargetDriverDialect

public class GenericTargetDriverDialect
extends java.lang.Object
implements TargetDriverDialect

Field Summary

Fields

Modifier and Type	Field and Description
static java.util.List<java.lang.String>	ALLOWED_ON_CLOSED_METHODS
static java.lang.String	CALL_GET_ARRAY
static java.lang.String	CALL_GET_BIG_DECIMAL
static java.lang.String	CALL_GET_BLOB
static java.lang.String	CALL_GET_BOOLEAN
static java.lang.String	CALL_GET_BYTE
static java.lang.String	CALL_GET_BYTES
static java.lang.String	CALL_GET_CHARACTER_STREAM
static java.lang.String	CALL_GET_CLOB
static java.lang.String	CALL_GET_DATE
static java.lang.String	CALL_GET_DOUBLE
static java.lang.String	CALL_GET_FLOAT
static java.lang.String	CALL_GET_INT
static java.lang.String	CALL_GET_LONG
static java.lang.String	CALL_GET_N_CHAR
static java.lang.String	CALL_GET_N_CLOB
static java.lang.String	CALL_GET_N_STRING
static java.lang.String	CALL_GET_OBJECT
static java.lang.String	CALL_GET_SHORT
static java.lang.String	CALL_GET_SQLXML
static java.lang.String	CALL_GET_STRING
static java.lang.String	CALL_GET_TIME
static java.lang.String	CALL_GET_TIMESTAMP
static java.lang.String	CALL_GET_URL
static java.lang.String	CALL_WAS_NULL
static java.lang.String	CONN_CLEAR_WARNINGS
static java.lang.String	CONN_CREATE_BLOB
static java.lang.String	CONN_CREATE_CLOB
static java.lang.String	CONN_CREATE_NCLOB
static java.lang.String	CONN_GET_AUTO_COMMIT
static java.lang.String	CONN_GET_CATALOG
static java.lang.String	CONN_GET_CLIENT_INFO
static java.lang.String	CONN_GET_HOLDABILITY
static java.lang.String	CONN_GET_METADATA
static java.lang.String	CONN_GET_NETWORK_TIMEOUT
static java.lang.String	CONN_GET_SCHEMA
static java.lang.String	CONN_GET_TYPE_MAP
static java.lang.String	CONN_IS_READ_ONLY
static java.lang.String	CONN_SET_HOLDABILITY
static java.lang.String	CONN_SET_SCHEMA
static java.lang.String	PREP_ADD_BATCH
static java.lang.String	PREP_CLEAR_PARAMS
static java.lang.String	STATEMENT_ADD_BATCH
static java.lang.String	STATEMENT_CLEAR_BATCH
static java.lang.String	STATEMENT_CLEAR_WARNINGS
static java.lang.String	STATEMENT_CLOSE_ON_COMPLETION
static java.lang.String	STATEMENT_GET_FETCH_SIZE
static java.lang.String	STATEMENT_GET_GENERATED_KEYS
static java.lang.String	STATEMENT_GET_MAX_FIELD_SIZE
static java.lang.String	STATEMENT_GET_MAX_ROWS
static java.lang.String	STATEMENT_GET_MORE_RESULTS
static java.lang.String	STATEMENT_GET_QUERY_TIMEOUT
static java.lang.String	STATEMENT_GET_RESULT_SET
static java.lang.String	STATEMENT_GET_RESULT_SET_CONCURRENCY
static java.lang.String	STATEMENT_GET_RESULT_SET_TYPE
static java.lang.String	STATEMENT_GET_UPDATE_COUNT
static java.lang.String	STATEMENT_GET_WARNINGS
static java.lang.String	STATEMENT_IS_CLOSE_ON_COMPLETION

Constructor Summary

Constructors

Constructor and Description
GenericTargetDriverDialect()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAllowedOnConnectionMethodNames()
boolean	isDialect(java.sql.Driver driver)
boolean	isDialect(java.lang.String dataSourceClass)
boolean	isDriverRegistered()
boolean	ping(@NonNull java.sql.Connection connection) Attempts to communicate to a database node in order to measure network latency.
ConnectInfo	prepareConnectInfo(@NonNull java.lang.String protocol, @NonNull HostSpec hostSpec, @NonNull java.util.Properties props)
void	prepareDataSource(@NonNull javax.sql.DataSource dataSource, @NonNull java.lang.String protocol, @NonNull HostSpec hostSpec, @NonNull java.util.Properties props)
void	registerDriver()

Methods inherited from class java.lang.Object

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

Field Detail

ALLOWED_ON_CLOSED_METHODS

public static final java.util.List<java.lang.String> ALLOWED_ON_CLOSED_METHODS

CONN_GET_AUTO_COMMIT

public static final java.lang.String CONN_GET_AUTO_COMMIT

See Also:

Constant Field Values

CONN_GET_CATALOG

public static final java.lang.String CONN_GET_CATALOG

See Also:

Constant Field Values

CONN_GET_SCHEMA

public static final java.lang.String CONN_GET_SCHEMA

See Also:

Constant Field Values

CONN_GET_NETWORK_TIMEOUT

public static final java.lang.String CONN_GET_NETWORK_TIMEOUT

See Also:

Constant Field Values

CONN_GET_METADATA

public static final java.lang.String CONN_GET_METADATA

See Also:

Constant Field Values

CONN_IS_READ_ONLY

public static final java.lang.String CONN_IS_READ_ONLY

See Also:

Constant Field Values

CONN_GET_HOLDABILITY

public static final java.lang.String CONN_GET_HOLDABILITY

See Also:

Constant Field Values

CONN_GET_CLIENT_INFO

public static final java.lang.String CONN_GET_CLIENT_INFO

See Also:

Constant Field Values

CONN_GET_TYPE_MAP

public static final java.lang.String CONN_GET_TYPE_MAP

See Also:

Constant Field Values

CONN_CREATE_CLOB

public static final java.lang.String CONN_CREATE_CLOB

See Also:

Constant Field Values

CONN_CREATE_BLOB

public static final java.lang.String CONN_CREATE_BLOB

See Also:

Constant Field Values

CONN_CREATE_NCLOB

public static final java.lang.String CONN_CREATE_NCLOB

See Also:

Constant Field Values

CONN_CLEAR_WARNINGS

public static final java.lang.String CONN_CLEAR_WARNINGS

See Also:

Constant Field Values

CONN_SET_HOLDABILITY

public static final java.lang.String CONN_SET_HOLDABILITY

See Also:

Constant Field Values

CONN_SET_SCHEMA

public static final java.lang.String CONN_SET_SCHEMA

See Also:

Constant Field Values

STATEMENT_CLEAR_WARNINGS

public static final java.lang.String STATEMENT_CLEAR_WARNINGS

See Also:

Constant Field Values

STATEMENT_GET_FETCH_SIZE

public static final java.lang.String STATEMENT_GET_FETCH_SIZE

See Also:

Constant Field Values

STATEMENT_GET_MAX_FIELD_SIZE

public static final java.lang.String STATEMENT_GET_MAX_FIELD_SIZE

See Also:

Constant Field Values

STATEMENT_GET_RESULT_SET_TYPE

public static final java.lang.String STATEMENT_GET_RESULT_SET_TYPE

See Also:

Constant Field Values

STATEMENT_IS_CLOSE_ON_COMPLETION

public static final java.lang.String STATEMENT_IS_CLOSE_ON_COMPLETION

See Also:

Constant Field Values

STATEMENT_CLEAR_BATCH

public static final java.lang.String STATEMENT_CLEAR_BATCH

See Also:

Constant Field Values

STATEMENT_CLOSE_ON_COMPLETION

public static final java.lang.String STATEMENT_CLOSE_ON_COMPLETION

See Also:

Constant Field Values

STATEMENT_GET_GENERATED_KEYS

public static final java.lang.String STATEMENT_GET_GENERATED_KEYS

See Also:

Constant Field Values

STATEMENT_GET_MAX_ROWS

public static final java.lang.String STATEMENT_GET_MAX_ROWS

See Also:

Constant Field Values

STATEMENT_GET_MORE_RESULTS

public static final java.lang.String STATEMENT_GET_MORE_RESULTS

See Also:

Constant Field Values

STATEMENT_GET_QUERY_TIMEOUT

public static final java.lang.String STATEMENT_GET_QUERY_TIMEOUT

See Also:

Constant Field Values

STATEMENT_GET_RESULT_SET

public static final java.lang.String STATEMENT_GET_RESULT_SET

See Also:

Constant Field Values

STATEMENT_GET_RESULT_SET_CONCURRENCY

public static final java.lang.String STATEMENT_GET_RESULT_SET_CONCURRENCY

See Also:

Constant Field Values

STATEMENT_GET_UPDATE_COUNT

public static final java.lang.String STATEMENT_GET_UPDATE_COUNT

See Also:

Constant Field Values

STATEMENT_GET_WARNINGS

public static final java.lang.String STATEMENT_GET_WARNINGS

See Also:

Constant Field Values

STATEMENT_ADD_BATCH

public static final java.lang.String STATEMENT_ADD_BATCH

See Also:

Constant Field Values

CALL_GET_ARRAY

public static final java.lang.String CALL_GET_ARRAY

See Also:

Constant Field Values

CALL_GET_BIG_DECIMAL

public static final java.lang.String CALL_GET_BIG_DECIMAL

See Also:

Constant Field Values

CALL_GET_BLOB

public static final java.lang.String CALL_GET_BLOB

See Also:

Constant Field Values

CALL_GET_BOOLEAN

public static final java.lang.String CALL_GET_BOOLEAN

See Also:

Constant Field Values

CALL_GET_BYTE

public static final java.lang.String CALL_GET_BYTE

See Also:

Constant Field Values

CALL_GET_BYTES

public static final java.lang.String CALL_GET_BYTES

See Also:

Constant Field Values

CALL_GET_CHARACTER_STREAM

public static final java.lang.String CALL_GET_CHARACTER_STREAM

See Also:

Constant Field Values

CALL_GET_CLOB

public static final java.lang.String CALL_GET_CLOB

See Also:

Constant Field Values

CALL_GET_DATE

public static final java.lang.String CALL_GET_DATE

See Also:

Constant Field Values

CALL_GET_DOUBLE

public static final java.lang.String CALL_GET_DOUBLE

See Also:

Constant Field Values

CALL_GET_FLOAT

public static final java.lang.String CALL_GET_FLOAT

See Also:

Constant Field Values

CALL_GET_INT

public static final java.lang.String CALL_GET_INT

See Also:

Constant Field Values

CALL_GET_LONG

public static final java.lang.String CALL_GET_LONG

See Also:

Constant Field Values

CALL_GET_N_CLOB

public static final java.lang.String CALL_GET_N_CLOB

See Also:

Constant Field Values

CALL_GET_N_CHAR

public static final java.lang.String CALL_GET_N_CHAR

See Also:

Constant Field Values

CALL_GET_N_STRING

public static final java.lang.String CALL_GET_N_STRING

See Also:

Constant Field Values

CALL_GET_OBJECT

public static final java.lang.String CALL_GET_OBJECT

See Also:

Constant Field Values

CALL_GET_SHORT

public static final java.lang.String CALL_GET_SHORT

See Also:

Constant Field Values

CALL_GET_SQLXML

public static final java.lang.String CALL_GET_SQLXML

See Also:

Constant Field Values

CALL_GET_TIME

public static final java.lang.String CALL_GET_TIME

See Also:

Constant Field Values

CALL_GET_STRING

public static final java.lang.String CALL_GET_STRING

See Also:

Constant Field Values

CALL_GET_TIMESTAMP

public static final java.lang.String CALL_GET_TIMESTAMP

See Also:

Constant Field Values

CALL_GET_URL

public static final java.lang.String CALL_GET_URL

See Also:

Constant Field Values

CALL_WAS_NULL

public static final java.lang.String CALL_WAS_NULL

See Also:

Constant Field Values

PREP_ADD_BATCH

public static final java.lang.String PREP_ADD_BATCH

See Also:

Constant Field Values

PREP_CLEAR_PARAMS

public static final java.lang.String PREP_CLEAR_PARAMS

See Also:

Constant Field Values

Constructor Detail

GenericTargetDriverDialect

public GenericTargetDriverDialect()

Method Detail

isDialect

public boolean isDialect(java.sql.Driver driver)

Specified by:

isDialect in interface TargetDriverDialect

isDialect

public boolean isDialect(java.lang.String dataSourceClass)

Specified by:

isDialect in interface TargetDriverDialect

prepareConnectInfo

public ConnectInfo prepareConnectInfo(@NonNull java.lang.String protocol,
                                      @NonNull HostSpec hostSpec,
                                      @NonNull java.util.Properties props)
                               throws java.sql.SQLException

Specified by:

prepareConnectInfo in interface TargetDriverDialect

Throws:

java.sql.SQLException

prepareDataSource

public void prepareDataSource(@NonNull javax.sql.DataSource dataSource,
                              @NonNull java.lang.String protocol,
                              @NonNull HostSpec hostSpec,
                              @NonNull java.util.Properties props)
                       throws java.sql.SQLException

Specified by:

prepareDataSource in interface TargetDriverDialect

Throws:

java.sql.SQLException

isDriverRegistered

public boolean isDriverRegistered()
                           throws java.sql.SQLException

Specified by:

isDriverRegistered in interface TargetDriverDialect

Throws:

java.sql.SQLException

registerDriver

public void registerDriver()
                    throws java.sql.SQLException

Specified by:

registerDriver in interface TargetDriverDialect

Throws:

java.sql.SQLException

ping

public boolean ping(@NonNull java.sql.Connection connection)

Description copied from interface: TargetDriverDialect

Attempts to communicate to a database node in order to measure network latency. Some database protocols may not support the simplest "ping" packet. In this case, it's recommended to execute a simple connection validation, or the simplest SQL query like "SELECT 1".

Specified by:

ping in interface TargetDriverDialect

Parameters:

connection - The database connection to a node to ping.

Returns:

True, if operation is succeeded. False, otherwise.

getAllowedOnConnectionMethodNames

public java.util.Set<java.lang.String> getAllowedOnConnectionMethodNames()

Specified by:

getAllowedOnConnectionMethodNames in interface TargetDriverDialect