Skip to content

feat: failover read only connections #1609

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sergiyvamz merged 2 commits into from
Dec 1, 2025
Merged

feat: failover read only connections #1609

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1072e8e
trigger failover when connected instance turns into read-only mode
sergiyvamz Nov 22, 2025
ae00ea3
code review
sergiyvamz Nov 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions wrapper/src/main/java/software/amazon/jdbc/PartialPluginService.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -562,6 +562,22 @@ public boolean isLoginException(final String sqlState) {
return this.exceptionManager.isLoginException(this.dbDialect, sqlState);
}

@Override
public boolean isReadOnlyConnectionException(@Nullable String sqlState, @Nullable Integer errorCode) {
if (this.exceptionHandler != null) {
return this.exceptionHandler.isReadOnlyConnectionException(sqlState, errorCode);
}
return this.exceptionManager.isReadOnlyConnectionException(this.dbDialect, sqlState, errorCode);
}

@Override
public boolean isReadOnlyConnectionException(Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) {
if (this.exceptionHandler != null) {
return this.exceptionHandler.isReadOnlyConnectionException(throwable, targetDriverDialect);
}
return this.exceptionManager.isReadOnlyConnectionException(this.dbDialect, throwable, targetDriverDialect);
}

@Override
public Dialect getDialect() {
return this.dbDialect;
Expand Down
16 changes: 16 additions & 0 deletions wrapper/src/main/java/software/amazon/jdbc/PluginServiceImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -690,6 +690,22 @@ public boolean isLoginException(final String sqlState) {
return this.exceptionManager.isLoginException(this.dialect, sqlState);
}

@Override
public boolean isReadOnlyConnectionException(@Nullable String sqlState, @Nullable Integer errorCode) {
if (this.exceptionHandler != null) {
return this.exceptionHandler.isReadOnlyConnectionException(sqlState, errorCode);
}
return this.exceptionManager.isReadOnlyConnectionException(this.dialect, sqlState, errorCode);
}

@Override
public boolean isReadOnlyConnectionException(Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) {
if (this.exceptionHandler != null) {
return this.exceptionHandler.isReadOnlyConnectionException(throwable, targetDriverDialect);
}
return this.exceptionManager.isReadOnlyConnectionException(this.dialect, throwable, targetDriverDialect);
}

@Override
public Dialect getDialect() {
return this.dialect;
Expand Down
32 changes: 32 additions & 0 deletions wrapper/src/main/java/software/amazon/jdbc/exceptions/AbstractPgExceptionHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,4 +95,36 @@ public boolean isLoginException(final String sqlState) {
}
return getAccessErrors().contains(sqlState);
}

@Override
public boolean isReadOnlyConnectionException(
final @Nullable String sqlState, final @Nullable Integer errorCode) {
return "25006".equals(sqlState);
}

@Override
public boolean isReadOnlyConnectionException(
final Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) {

Throwable exception = throwable;

while (exception != null) {
String sqlState = null;
Integer errorCode = null;
if (exception instanceof SQLException) {
sqlState = ((SQLException) exception).getSQLState();
errorCode = ((SQLException) exception).getErrorCode();
} else if (targetDriverDialect != null) {
sqlState = targetDriverDialect.getSQLState(exception);
}

if (isReadOnlyConnectionException(sqlState, errorCode)) {
return true;
}

exception = exception.getCause();
}

return false;
}
}
4 changes: 4 additions & 0 deletions wrapper/src/main/java/software/amazon/jdbc/exceptions/ExceptionHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,8 @@ public interface ExceptionHandler {
boolean isLoginException(String sqlState);

boolean isLoginException(Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect);

boolean isReadOnlyConnectionException(final @Nullable String sqlState, final @Nullable Integer errorCode);

boolean isReadOnlyConnectionException(Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect);
}
13 changes: 13 additions & 0 deletions wrapper/src/main/java/software/amazon/jdbc/exceptions/ExceptionManager.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@

package software.amazon.jdbc.exceptions;

import org.checkerframework.checker.nullness.qual.Nullable;
import software.amazon.jdbc.Driver;
import software.amazon.jdbc.dialect.Dialect;
import software.amazon.jdbc.targetdriverdialect.TargetDriverDialect;
Expand Down Expand Up @@ -44,6 +45,18 @@ public boolean isNetworkException(final Dialect dialect, final String sqlState)
return handler.isNetworkException(sqlState);
}

public boolean isReadOnlyConnectionException(
final Dialect dialect, final Throwable throwable, final TargetDriverDialect targetDriverDialect) {
final ExceptionHandler handler = getHandler(dialect);
return handler.isReadOnlyConnectionException(throwable, targetDriverDialect);
}

public boolean isReadOnlyConnectionException(
final Dialect dialect, final @Nullable String sqlState, final @Nullable Integer errorCode) {
final ExceptionHandler handler = getHandler(dialect);
return handler.isReadOnlyConnectionException(sqlState, errorCode);
}

private ExceptionHandler getHandler(final Dialect dialect) {
final ExceptionHandler customHandler = Driver.getCustomExceptionHandler();
return customHandler != null ? customHandler : dialect.getExceptionHandler();
Expand Down
13 changes: 12 additions & 1 deletion wrapper/src/main/java/software/amazon/jdbc/exceptions/GenericExceptionHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public boolean isLoginException(final Throwable throwable, TargetDriverDialect t
if (exception instanceof SQLException) {
sqlState = ((SQLException) exception).getSQLState();
} else if (targetDriverDialect != null) {
sqlState = targetDriverDialect.getSQLState(throwable);
sqlState = targetDriverDialect.getSQLState(exception);
}

if (isLoginException(sqlState)) {
Expand All @@ -103,4 +103,15 @@ public boolean isLoginException(final Throwable throwable, TargetDriverDialect t
public boolean isLoginException(final String sqlState) {
return ACCESS_ERRORS.contains(sqlState);
}

@Override
public boolean isReadOnlyConnectionException(@Nullable String sqlState, @Nullable Integer errorCode) {
return false;
}

@Override
public boolean isReadOnlyConnectionException(
Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) {
return false;
}
}
34 changes: 33 additions & 1 deletion wrapper/src/main/java/software/amazon/jdbc/exceptions/MySQLExceptionHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ public boolean isLoginException(final Throwable throwable, @Nullable TargetDrive
if (exception instanceof SQLException) {
sqlState = ((SQLException) exception).getSQLState();
} else if (targetDriverDialect != null) {
sqlState = targetDriverDialect.getSQLState(throwable);
sqlState = targetDriverDialect.getSQLState(exception);
}

if (isLoginException(sqlState)) {
Expand All @@ -103,6 +103,38 @@ public boolean isLoginException(final String sqlState) {
return SQLSTATE_ACCESS_ERROR.equals(sqlState);
}

@Override
public boolean isReadOnlyConnectionException(
final @Nullable String sqlState, final @Nullable Integer errorCode) {
return "HY000".equals(sqlState) && errorCode != null && (errorCode == 1290 || errorCode == 1836);
}

@Override
public boolean isReadOnlyConnectionException(
final Throwable throwable, @Nullable TargetDriverDialect targetDriverDialect) {

Throwable exception = throwable;

while (exception != null) {
String sqlState = null;
Integer errorCode = null;
if (exception instanceof SQLException) {
sqlState = ((SQLException) exception).getSQLState();
errorCode = ((SQLException) exception).getErrorCode();
} else if (targetDriverDialect != null) {
sqlState = targetDriverDialect.getSQLState(exception);
}

if (isReadOnlyConnectionException(sqlState, errorCode)) {
return true;
}

exception = exception.getCause();
}

return false;
}

private boolean isHikariMariaDbNetworkException(final SQLException sqlException) {
return sqlException.getSQLState().equals(SQLSTATE_SYNTAX_ERROR_OR_ACCESS_VIOLATION)
&& sqlException.getMessage().contains(SET_NETWORK_TIMEOUT_ON_CLOSED_CONNECTION);
Expand Down
7 changes: 6 additions & 1 deletion wrapper/src/main/java/software/amazon/jdbc/plugin/failover/FailoverConnectionPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -890,7 +890,12 @@ protected boolean shouldExceptionTriggerConnectionSwitch(final Throwable t) {
return false;
}

return this.pluginService.isNetworkException(t, this.pluginService.getTargetDriverDialect());
if (this.pluginService.isNetworkException(t, this.pluginService.getTargetDriverDialect())) {
return true;
}

return this.failoverMode == FailoverMode.STRICT_WRITER
&& this.pluginService.isReadOnlyConnectionException(t, this.pluginService.getTargetDriverDialect());
}

/**
Expand Down
7 changes: 6 additions & 1 deletion wrapper/src/main/java/software/amazon/jdbc/plugin/failover2/FailoverConnectionPlugin.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -698,7 +698,12 @@ protected boolean shouldExceptionTriggerConnectionSwitch(final Throwable t) {
return false;
}

return this.pluginService.isNetworkException(t, this.pluginService.getTargetDriverDialect());
if (this.pluginService.isNetworkException(t, this.pluginService.getTargetDriverDialect())) {
return true;
}

return this.failoverMode == FailoverMode.STRICT_WRITER
&& this.pluginService.isReadOnlyConnectionException(t, this.pluginService.getTargetDriverDialect());
}

/**
Expand Down
Loading