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.Set<java.lang.String>	ALLOWED_ON_CLOSED_METHODS
static java.util.Set<java.lang.String>	NETWORK_BOUND_METHODS_FOR_ENTIRE_RESULTSET

Constructor Summary

Constructors

Constructor and Description
GenericTargetDriverDialect()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAllowedOnConnectionMethodNames()
java.util.Set<java.lang.String>	getNetworkBoundMethodNames(@Nullable java.util.Properties properties)
java.lang.String	getSQLState(java.lang.Throwable throwable)
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.Set<java.lang.String> ALLOWED_ON_CLOSED_METHODS

NETWORK_BOUND_METHODS_FOR_ENTIRE_RESULTSET

public static final java.util.Set<java.lang.String> NETWORK_BOUND_METHODS_FOR_ENTIRE_RESULTSET

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

getSQLState

public java.lang.String getSQLState(java.lang.Throwable throwable)

Specified by:

getSQLState in interface TargetDriverDialect

getNetworkBoundMethodNames

public java.util.Set<java.lang.String> getNetworkBoundMethodNames(@Nullable java.util.Properties properties)

Specified by:

getNetworkBoundMethodNames in interface TargetDriverDialect