software.amazon.jdbc.targetdriverdialect

Class MysqlConnectorJTargetDriverDialect

java.lang.Object

software.amazon.jdbc.targetdriverdialect.GenericTargetDriverDialect

software.amazon.jdbc.targetdriverdialect.MysqlConnectorJTargetDriverDialect

All Implemented Interfaces:

TargetDriverDialect

public class MysqlConnectorJTargetDriverDialect
extends GenericTargetDriverDialect

Field Summary

Fields inherited from class software.amazon.jdbc.targetdriverdialect.GenericTargetDriverDialect

ALLOWED_ON_CLOSED_METHODS, NETWORK_BOUND_METHODS_FOR_ENTIRE_RESULTSET

Constructor Summary

Constructors

Constructor and Description
MysqlConnectorJTargetDriverDialect()

Method Summary

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAllowedOnConnectionMethodNames()
@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)
java.lang.String	prepareTargetDataSource(@NonNull javax.sql.CommonDataSource dataSource, @NonNull java.lang.String url, @NonNull java.util.Properties props) Applies AWS Wrapper connection settings that a target data source can only receive through driver-specific bean setters (for example connect/socket timeouts, whose unit differs per driver), and returns the connection URL to apply to that data source.
void	registerDriver()

Methods inherited from class software.amazon.jdbc.targetdriverdialect.GenericTargetDriverDialect

abortConnection, findSQLQueryString, getEncryptedBytes, getNetworkBoundMethodNames, registerDataType, setEncryptedParameter, updateInternalState

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jdbc.targetdriverdialect.TargetDriverDialect

removeHostSelectionProperties

Constructor Detail

MysqlConnectorJTargetDriverDialect

public MysqlConnectorJTargetDriverDialect()

Method Detail

isDialect

public boolean isDialect(java.sql.Driver driver)

Specified by:

isDialect in interface TargetDriverDialect

Overrides:

isDialect in class GenericTargetDriverDialect

isDialect

public boolean isDialect(java.lang.String dataSourceClass)

Specified by:

isDialect in interface TargetDriverDialect

Overrides:

isDialect in class GenericTargetDriverDialect

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

Overrides:

prepareConnectInfo in class GenericTargetDriverDialect

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

Overrides:

prepareDataSource in class GenericTargetDriverDialect

Throws:

java.sql.SQLException

prepareTargetDataSource

public java.lang.String prepareTargetDataSource(@NonNull javax.sql.CommonDataSource dataSource,
                                                @NonNull java.lang.String url,
                                                @NonNull java.util.Properties props)
                                         throws java.sql.SQLException

Description copied from interface: TargetDriverDialect

Applies AWS Wrapper connection settings that a target data source can only receive through driver-specific bean setters (for example connect/socket timeouts, whose unit differs per driver), and returns the connection URL to apply to that data source.

This is used by the XA datasource path, which configures a target driver XADataSource directly instead of going through TargetDriverDialect.prepareConnectInfo(String, HostSpec, Properties). Because that path hands the target only its own (non-wrapper) properties, wrapper properties such as socketTimeout would otherwise be dropped. Dialects whose target data source cannot express a setting as a bean property may instead add it to the returned URL.

The default implementation applies nothing and returns url unchanged.

Parameters:

dataSource - the target driver data source being configured.

url - the target driver URL, with AWS Wrapper parameters already removed.

props - the effective connection properties, including AWS Wrapper properties.

Returns:

the URL to apply to the target data source.

Throws:

java.sql.SQLException - if a setting cannot be applied to the target data source.

isDriverRegistered

public boolean isDriverRegistered()
                           throws java.sql.SQLException

Specified by:

isDriverRegistered in interface TargetDriverDialect

Overrides:

isDriverRegistered in class GenericTargetDriverDialect

Throws:

java.sql.SQLException

registerDriver

public void registerDriver()
                    throws java.sql.SQLException

Specified by:

registerDriver in interface TargetDriverDialect

Overrides:

registerDriver in class GenericTargetDriverDialect

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

Overrides:

ping in class GenericTargetDriverDialect

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

Overrides:

getAllowedOnConnectionMethodNames in class GenericTargetDriverDialect

getSQLState

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

Specified by:

getSQLState in interface TargetDriverDialect

Overrides:

getSQLState in class GenericTargetDriverDialect

getSQLQueryString

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

Specified by:

getSQLQueryString in interface TargetDriverDialect

Overrides:

getSQLQueryString in class GenericTargetDriverDialect