org.springframework.data.r2dbc.support

Class SqlErrorCodeR2dbcExceptionTranslator

java.lang.Object

org.springframework.data.r2dbc.support.AbstractFallbackR2dbcExceptionTranslator

org.springframework.data.r2dbc.support.SqlErrorCodeR2dbcExceptionTranslator

All Implemented Interfaces:

R2dbcExceptionTranslator

public class SqlErrorCodeR2dbcExceptionTranslator
extends AbstractFallbackR2dbcExceptionTranslator

Implementation of R2dbcExceptionTranslator that analyzes vendor-specific error codes. More precise than an implementation based on SQL state, but heavily vendor-specific.

This class applies the following matching rules:

• Try custom translation implemented by any subclass. Note that this class is concrete and is typically used itself, in which case this rule doesn't apply.
• Apply error code matching. Error codes are obtained from the SQLErrorCodesFactory by default. This factory loads a "sql-error-codes.xml" file from the class path, defining error code mappings for database names from database meta-data.
• Fallback to a fallback translator. SqlStateR2dbcExceptionTranslator is the default fallback translator, analyzing the exception's SQL state only.

The configuration file named "sql-error-codes.xml" is by default read from the org.springframework.jdbc.support package. It can be overridden through a file of the same name in the root of the class path (e.g. in the "/WEB-INF/classes" directory), as long as the Spring JDBC package is loaded from the same ClassLoader.

Author:

Mark Paluch

See Also:

SQLErrorCodesFactory, SqlStateR2dbcExceptionTranslator

Field Summary

Fields inherited from class org.springframework.data.r2dbc.support.AbstractFallbackR2dbcExceptionTranslator

logger

Constructor Summary

Constructors

Constructor and Description
SqlErrorCodeR2dbcExceptionTranslator() Creates a new SqlErrorCodeR2dbcExceptionTranslator.
SqlErrorCodeR2dbcExceptionTranslator(ConnectionFactory connectionFactory) Create a SQL error code translator for the given DataSource.
SqlErrorCodeR2dbcExceptionTranslator(SQLErrorCodes sec) Create a SQLErrorCode translator given these error codes.
SqlErrorCodeR2dbcExceptionTranslator(String dbName) Create a SQL error code translator for the given database product name.

Method Summary

Modifier and Type	Method and Description
protected DataAccessException	customTranslate(String task, String sql, R2dbcException ex) Subclasses can override this method to attempt a custom mapping from R2dbcException to DataAccessException.
protected DataAccessException	doTranslate(String task, String sql, R2dbcException ex) Template method for actually translating the given exception.
SQLErrorCodes	getSqlErrorCodes() Return the error codes used by this translator.
void	setConnectionFactory(ConnectionFactory connectionFactory) Set the DataSource for this translator.
void	setDatabaseProductName(String dbName) Set the database product name for this translator.
void	setSqlErrorCodes(SQLErrorCodes sec) Set custom error codes to be used for translation.

Methods inherited from class org.springframework.data.r2dbc.support.AbstractFallbackR2dbcExceptionTranslator

buildMessage, getFallbackTranslator, setFallbackTranslator, translate

Methods inherited from class java.lang.Object

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

Constructor Detail

SqlErrorCodeR2dbcExceptionTranslator

public SqlErrorCodeR2dbcExceptionTranslator()

Creates a new SqlErrorCodeR2dbcExceptionTranslator. The SQLErrorCodes or ConnectionFactory property must be set.

SqlErrorCodeR2dbcExceptionTranslator

public SqlErrorCodeR2dbcExceptionTranslator(ConnectionFactory connectionFactory)

Create a SQL error code translator for the given DataSource. Invoking this constructor will cause a Connection to be obtained from the DataSource to get the meta-data.

Parameters:

connectionFactory - ConnectionFactory to use to find meta-data and establish which error codes are usable.

See Also:

SQLErrorCodesFactory

SqlErrorCodeR2dbcExceptionTranslator

public SqlErrorCodeR2dbcExceptionTranslator(String dbName)

Create a SQL error code translator for the given database product name. Invoking this constructor will avoid obtaining a Connection from the DataSource to get the meta-data.

Parameters:

dbName - the database product name that identifies the error codes entry

See Also:

SQLErrorCodesFactory, DatabaseMetaData.getDatabaseProductName()

SqlErrorCodeR2dbcExceptionTranslator

public SqlErrorCodeR2dbcExceptionTranslator(@Nullable
                                            SQLErrorCodes sec)

Create a SQLErrorCode translator given these error codes. Does not require a database meta-data lookup to be performed using a connection.

Parameters:

sec - error codes

Method Detail

setConnectionFactory

public void setConnectionFactory(ConnectionFactory connectionFactory)

Set the DataSource for this translator.

Setting this property will cause a Connection to be obtained from the DataSource to get the meta-data.

Parameters:

connectionFactory - ConnectionFactory to use to find meta-data and establish which error codes are usable.

See Also:

SQLErrorCodesFactory.getErrorCodes(String), ConnectionFactoryMetadata.getName()

setDatabaseProductName

public void setDatabaseProductName(String dbName)

Set the database product name for this translator.

Setting this property will avoid obtaining a Connection from the DataSource to get the meta-data.

Parameters:

dbName - the database product name that identifies the error codes entry.

See Also:

SQLErrorCodesFactory.getErrorCodes(String), ConnectionFactoryMetadata.getName()

setSqlErrorCodes

public void setSqlErrorCodes(@Nullable
                             SQLErrorCodes sec)

Set custom error codes to be used for translation.

Parameters:

sec - custom error codes to use.

getSqlErrorCodes

@Nullable
public SQLErrorCodes getSqlErrorCodes()

Return the error codes used by this translator. Usually determined via a DataSource.

See Also:

setConnectionFactory(io.r2dbc.spi.ConnectionFactory)

doTranslate

@Nullable
protected DataAccessException doTranslate(String task,
                                                    @Nullable
                                                    String sql,
                                                    R2dbcException ex)

Description copied from class: AbstractFallbackR2dbcExceptionTranslator

Template method for actually translating the given exception.

The passed-in arguments will have been pre-checked. Furthermore, this method is allowed to return null to indicate that no exception match has been found and that fallback translation should kick in.

Specified by:

doTranslate in class AbstractFallbackR2dbcExceptionTranslator

Parameters:

task - readable text describing the task being attempted.

sql - SQL query or update that caused the problem (if known).

ex - the offending R2dbcException.

Returns:

the DataAccessException, wrapping the R2dbcException; or null if no exception match found.

customTranslate

@Nullable
protected DataAccessException customTranslate(String task,
                                                        @Nullable
                                                        String sql,
                                                        R2dbcException ex)

Subclasses can override this method to attempt a custom mapping from R2dbcException to DataAccessException.

Parameters:

task - readable text describing the task being attempted

sql - SQL query or update that caused the problem. May be null.

ex - the offending R2dbcException.

Returns:

null if no custom translation was possible, otherwise a DataAccessException resulting from custom translation. This exception should include the R2dbcException parameter as a nested root cause. This implementation always returns null, meaning that the translator always falls back to the default error codes.