@NonNullApi

Package io.r2dbc.spi

The Service Provider Interface for R2DBC.

See: Description

Interface Summary

Interface	Description
Batch	A collection of statements that are executed in a batch for performance reasons.
Blob	Represents a handle to a large binary object.
Clob	Represents a handle to a large character object.
Closeable	A Closeable is an object that can be closed.
ColumnMetadata	Represents the metadata for a column of the results returned from a query.
Connection	A single connection to a database.
ConnectionFactory	A factory for creating Connections and entry point for a driver.
ConnectionFactoryMetadata	Metadata about the product a ConnectionFactory is applicable to.
ConnectionFactoryProvider	A Java Service interface for implementations to examine a collection of ConnectionFactoryOptions and optionally return an implementation of ConnectionFactory.
ConnectionMetadata	Metadata about the product a Connection is connected to.
Lifecycle	A common interface defining methods for allocation/release lifecycle control.
OutParameterMetadata	Represents the metadata for an OUT parameter.
OutParameters	Represents a set of OUT parameters returned from a stored procedure.
OutParametersMetadata	Represents the metadata for OUT parameters of the results returned from a stored procedure.
Parameter	Represents a parameter to be interchanged.
Parameter.In	Marker interface to classify a parameter as input parameter.
Parameter.Out	Marker interface to classify a parameter as output parameter.
Readable	Represents a readable object, for example a set of columns or OUT parameters from a database query, later on referred to as items.
ReadableMetadata	Represents the metadata for readable object, for example a column of the results returned from a query or OUT parameter as result of running a stored procedure.
Result	Represents the results of a query against a database.
Result.Message	Message segment reported as result of the statement processing.
Result.OutSegment	Out parameters segment consisting of readable data.
Result.RowSegment	Row segment consisting of row data.
Result.Segment	Marker interface for a result segment.
Result.UpdateCount	Update count segment consisting providing a affected rows count.
Row	Represents a row returned from a database query.
RowMetadata	Represents the metadata for a row of the results returned from a query.
Statement	A statement that can be executed multiple times in a prepared and optimized way.
TransactionDefinition	Specification of properties to be used when starting a transaction.
Type	Type descriptor for column- and parameter types.
Type.InferredType	Marker interface to indicate type inference.
Wrapped<T>	Indicates that an instance wraps a concrete implementation of an R2DBC SPI interface.

Class Summary

Class	Description
ConnectionFactories	Utility for discovering an available ConnectionFactory based on a set of ConnectionFactoryOptions.
ConnectionFactoryOptions	A holder for configuration options related to ConnectionFactorys.
ConnectionFactoryOptions.Builder	A builder for ConnectionFactoryOptions instances.
IsolationLevel	Represents a transaction isolation level constant.
Option<T>	Represents a configuration option constant.
Parameters	Utility to create Parameter objects.

Enum Summary

Enum	Description
Nullability	Constants indicating nullability of column values.
R2dbcType	Definition of generic SQL types.
ValidationDepth	Constants indicating validation depth for a Connection.

Exception Summary

Exception	Description
NoSuchOptionException	Exception thrown by various accessor methods to indicate that the Option being requested does not exist or is not configured.
R2dbcBadGrammarException	Exception thrown when the SQL statement has a problem in its syntax.
R2dbcDataIntegrityViolationException	Exception thrown when an attempt to insert or update data results in a violation of an integrity constraint.
R2dbcException	A root exception that should be extended by all server-related exceptions in an implementation.
R2dbcNonTransientException	Base exception thrown when a retry of the same operation would fail unless the cause of the exception is corrected.
R2dbcNonTransientResourceException	Exception thrown when a resource fails completely and the failure is permanent.
R2dbcPermissionDeniedException	Exception thrown when the underlying resource denied a permission to access a specific element, such as a specific database table.
R2dbcRollbackException	Exception thrown when an attempt to commit a transaction resulted in an unexpected rollback due to deadlock or transaction serialization failures.
R2dbcTimeoutException	Exception thrown when the timeout specified by a database operation (query, login) is exceeded.
R2dbcTransientException	Base exception thrown when a previously failed operation might be able to succeed if the operation is retried without any intervention by an application-level functionality.
R2dbcTransientResourceException	Exception thrown when a resource fails temporarily and the operation can be retried.

Package io.r2dbc.spi Description

The Service Provider Interface for R2DBC. All interfaces in this package should be implemented for each database implementation. See R2DBC SPI Compliance for details on R2DBC compliance.