software.amazon.jdbc.dialect

Interface Dialect

All Known Subinterfaces:

AuroraLimitlessDialect, GlobalAuroraTopologyDialect, MultiAzClusterDialect, TopologyDialect

All Known Implementing Classes:

AuroraMysqlDialect, AuroraPgDialect, GlobalAuroraMysqlDialect, GlobalAuroraPgDialect, MariaDbDialect, MultiAzClusterMysqlDialect, MultiAzClusterPgDialect, MysqlDialect, PgDialect, RdsMysqlDialect, RdsPgDialect, UnknownDialect

public interface Dialect

Method Summary

Modifier and Type	Method and Description
default java.util.List<HostSpec>	filterAvailableHosts(@NonNull java.util.List<HostSpec> hosts, @Nullable java.util.Set<java.lang.String> accessibleRegions) Filters the provided list of hosts by the set of accessible AWS regions.
int	getDefaultPort()
@Nullable java.util.List<java.lang.String>	getDialectUpdateCandidates()
ExceptionHandler	getExceptionHandler()
java.util.EnumSet<FailoverRestriction>	getFailoverRestrictions()
@Nullable java.lang.String	getHostAliasQuery()
@Nullable Pair<java.lang.String,java.lang.String>	getHostId(java.sql.Connection connection)
HostListProviderSupplier	getHostListProviderSupplier()
HostRole	getHostRole(java.sql.Connection connection)
@Nullable java.lang.String	getServerVersionQuery()
boolean	isDialect(java.sql.Connection connection)
void	prepareConnectProperties(@NonNull java.util.Properties connectProperties, @NonNull java.lang.String protocol, @NonNull HostSpec hostSpec)

Method Detail

isDialect

boolean isDialect(java.sql.Connection connection)

getDefaultPort

int getDefaultPort()

getDialectUpdateCandidates

@Nullable java.util.List<java.lang.String> getDialectUpdateCandidates()

getExceptionHandler

ExceptionHandler getExceptionHandler()

getHostListProviderSupplier

HostListProviderSupplier getHostListProviderSupplier()

getHostAliasQuery

@Nullable java.lang.String getHostAliasQuery()

prepareConnectProperties

void prepareConnectProperties(@NonNull java.util.Properties connectProperties,
                              @NonNull java.lang.String protocol,
                              @NonNull HostSpec hostSpec)

getFailoverRestrictions

java.util.EnumSet<FailoverRestriction> getFailoverRestrictions()

getServerVersionQuery

@Nullable java.lang.String getServerVersionQuery()

getHostRole

HostRole getHostRole(java.sql.Connection connection)
              throws java.sql.SQLException

Throws:

java.sql.SQLException

getHostId

@Nullable Pair<java.lang.String,java.lang.String> getHostId(java.sql.Connection connection)
                                                     throws java.sql.SQLException

Throws:

java.sql.SQLException

filterAvailableHosts

default java.util.List<HostSpec> filterAvailableHosts(@NonNull java.util.List<HostSpec> hosts,
                                                      @Nullable java.util.Set<java.lang.String> accessibleRegions)

Filters the provided list of hosts by the set of accessible AWS regions. Implementations that do not support multi-region clusters should return the original list unchanged. Dialects supporting multi-region clusters (e.g., Global Aurora) should restrict the host list to nodes in accessible regions.

Parameters:

hosts - the list of hosts to filter

accessibleRegions - the set of accessible AWS regions (lowercase), or null for no restriction

Returns:

the filtered list of hosts, or the original list if no filtering is applied