software.amazon.jdbc.dialect

Class DialectUtils

java.lang.Object

software.amazon.jdbc.dialect.DialectUtils

public class DialectUtils
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
DialectUtils()

Method Summary

Modifier and Type	Method and Description
boolean	checkExistenceQueries(java.sql.Connection conn, java.lang.String... existenceQueries) Given a series of existence queries, returns true if they all execute successfully and contain at least one record.
HostRole	getHostRole(java.sql.Connection conn, java.lang.String isReaderQuery) Evaluate the database role of the given connection, either HostRole.WRITER or HostRole.READER.
@Nullable Pair<java.lang.String,java.lang.String>	getInstanceId(java.sql.Connection connection, java.lang.String instanceIdQuery) Identifies instances across different database types using instanceId and instanceName values.

Methods inherited from class java.lang.Object

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

Constructor Detail

DialectUtils

public DialectUtils()

Method Detail

checkExistenceQueries

public boolean checkExistenceQueries(java.sql.Connection conn,
                                     java.lang.String... existenceQueries)

Given a series of existence queries, returns true if they all execute successfully and contain at least one record. Otherwise, returns false.

Parameters:

conn - the connection to use for executing the queries.

existenceQueries - the queries to check for existing records.

Returns:

true if all queries execute successfully and return at least one record, false otherwise.

getHostRole

public HostRole getHostRole(java.sql.Connection conn,
                            java.lang.String isReaderQuery)
                     throws java.sql.SQLException

Evaluate the database role of the given connection, either HostRole.WRITER or HostRole.READER.

Parameters:

conn - the connection to evaluate.

isReaderQuery - it's a query to check if the connection is to a reader instance.

Returns:

the database role of the given connection.

Throws:

java.sql.SQLException - if an exception occurs when querying the database or processing the database response.

getInstanceId

public @Nullable Pair<java.lang.String,java.lang.String> getInstanceId(java.sql.Connection connection,
                                                                       java.lang.String instanceIdQuery)

Identifies instances across different database types using instanceId and instanceName values.

Database types handle these identifiers differently: - Aurora: Uses the instance name as both instanceId and instanceName Example: "test-instance-1" for both values - RDS Cluster: Uses distinct values for instanceId and instanceName Example: instanceId: "db-WQFQKBTL2LQUPIEFIFBGENS4ZQ" instanceName: "test-multiaz-instance-1"

Parameters:

connection - the connection to use for executing the query.

instanceIdQuery - the query to execute to retrieve the instance identifiers.

Returns:

a pair of instanceId and instanceName if successful, null otherwise.