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
void	abortConnection(@NonNull java.sql.Connection connectionToAbort, @NonNull java.util.concurrent.Executor abortExecutor)
protected @Nullable java.lang.String	findSQLQueryString(java.sql.PreparedStatement ps, @Nullable java.lang.String queryHeader)
java.util.Set<java.lang.String>	getAllowedOnConnectionMethodNames()
byte[]	getEncryptedBytes(@NonNull java.sql.ResultSet rs, java.lang.Object columnRef)
java.util.Set<java.lang.String>	getNetworkBoundMethodNames(@Nullable java.util.Properties properties)
@Nullable java.lang.String	getSQLQueryString(java.sql.PreparedStatement ps)
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	registerDataType(@NonNull java.sql.Connection connection, @NonNull java.lang.String typeName, @NonNull java.lang.String className)
void	registerDriver()
void	setEncryptedParameter(@NonNull java.sql.PreparedStatement ps, int paramIndex, byte[] encrypted)
void	updateInternalState(@NonNull PluginService pluginService, @NonNull java.util.Properties props) Allows each target driver dialect to perform last-minute adjustments to the wrapper's internal state after the initial connection is established.

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

abortConnection

public void abortConnection(@NonNull java.sql.Connection connectionToAbort,
                            @NonNull java.util.concurrent.Executor abortExecutor)
                     throws java.sql.SQLException

Specified by:

abortConnection in interface TargetDriverDialect

Throws:

java.sql.SQLException

getSQLQueryString

public @Nullable java.lang.String getSQLQueryString(java.sql.PreparedStatement ps)

Specified by:

getSQLQueryString in interface TargetDriverDialect

registerDataType

public void registerDataType(@NonNull java.sql.Connection connection,
                             @NonNull java.lang.String typeName,
                             @NonNull java.lang.String className)
                      throws java.sql.SQLException

Specified by:

registerDataType in interface TargetDriverDialect

Throws:

java.sql.SQLException

setEncryptedParameter

public void setEncryptedParameter(@NonNull java.sql.PreparedStatement ps,
                                  int paramIndex,
                                  byte[] encrypted)
                           throws java.sql.SQLException

Specified by:

setEncryptedParameter in interface TargetDriverDialect

Throws:

java.sql.SQLException

getEncryptedBytes

public byte[] getEncryptedBytes(@NonNull java.sql.ResultSet rs,
                                java.lang.Object columnRef)
                         throws java.sql.SQLException

Specified by:

getEncryptedBytes in interface TargetDriverDialect

Throws:

java.sql.SQLException

updateInternalState

public void updateInternalState(@NonNull PluginService pluginService,
                                @NonNull java.util.Properties props)
                         throws java.sql.SQLException

Description copied from interface: TargetDriverDialect

Allows each target driver dialect to perform last-minute adjustments to the wrapper's internal state after the initial connection is established. This includes transferring driver-specific connection properties (e.g. PostgreSQL's currentSchema) into the wrapper's session state so they are preserved across connection switches (failover, read-write splitting, initial connection strategy, etc.).

Each dialect implementation should inspect the provided properties for driver-specific settings that affect session state and register them with the appropriate services (e.g. SessionStateService).

This method is called once after the initial connection is established in ConnectionWrapper.init().

Specified by:

updateInternalState in interface TargetDriverDialect

Parameters:

pluginService - the plugin service providing access to session state and other services

props - the connection properties that may contain driver-specific settings

Throws:

java.sql.SQLException - if an error occurs while updating internal state

findSQLQueryString

protected @Nullable java.lang.String findSQLQueryString(java.sql.PreparedStatement ps,
                                                        @Nullable java.lang.String queryHeader)