software.amazon.jdbc.targetdriverdialect

Interface TargetDriverDialect

All Known Implementing Classes:

GenericTargetDriverDialect, MariadbTargetDriverDialect, MysqlConnectorJTargetDriverDialect, PgTargetDriverDialect

public interface TargetDriverDialect

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()

Method Detail

isDialect

boolean isDialect(java.sql.Driver driver)

isDialect

boolean isDialect(java.lang.String dataSourceClass)

prepareConnectInfo

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

Throws:

java.sql.SQLException

prepareDataSource

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

Throws:

java.sql.SQLException

isDriverRegistered

boolean isDriverRegistered()
                    throws java.sql.SQLException

Throws:

java.sql.SQLException

registerDriver

void registerDriver()
             throws java.sql.SQLException

Throws:

java.sql.SQLException

ping

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

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".

Parameters:

connection - The database connection to a node to ping.

Returns:

True, if operation is succeeded. False, otherwise.

getAllowedOnConnectionMethodNames

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

getSQLState

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

getNetworkBoundMethodNames

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