Reactive Relational Database Connectivity - SPI 1.0.0.RELEASE · io.r2dbc.spi

Interface Summary

Modifier and Type	Interface and Description
public interface	Batch A collection of statements that are executed in a batch for performance reasons.
public interface	Blob Represents a handle to a large binary object.
public interface	Clob Represents a handle to a large character object.
public interface	Closeable A `Closeable` is an object that can be closed.
public interface	ColumnMetadata Represents the metadata for a column of the results returned from a query.
public interface	Connection A single connection to a database.
public interface	ConnectionFactory A factory for creating `Connection`s and entry point for a driver.
public interface	ConnectionFactoryMetadata Metadata about the product a `ConnectionFactory` is applicable to.
public interface	ConnectionFactoryProvider A Java Service interface for implementations to examine a collection of `ConnectionFactoryOptions` and optionally return an implementation of `ConnectionFactory`.
public interface	ConnectionMetadata Metadata about the product a `Connection` is connected to.
public interface	Lifecycle A common interface defining methods for allocation/release lifecycle control.
public interface	OutParameterMetadata Represents the metadata for an `OUT` parameter.
public interface	OutParameters Represents a set of `OUT` parameters returned from a stored procedure.
public interface	OutParametersMetadata Represents the metadata for `OUT` parameters of the results returned from a stored procedure.
public interface	Parameter Represents a parameter to be interchanged.
public interface	Readable Represents a readable object, for example a set of columns or `OUT` parameters from a database query, later on referred to as items.
public interface	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.
public interface	Result Represents the results of a query against a database.
public interface	Row Represents a row returned from a database query.
public interface	RowMetadata Represents the metadata for a row of the results returned from a query.
public interface	Statement A statement that can be executed multiple times in a prepared and optimized way.
public interface	TransactionDefinition Specification of properties to be used when starting a transaction.
public interface	Type Type descriptor for column- and parameter types.
public interface	Wrapped< The R2DBC SPI type being wrapped T> Indicates that an instance wraps a concrete implementation of an R2DBC SPI interface.

Modifier and Type	Annotation and Description
pack-priv @interface	NonNullApi A common R2DBC annotation to declare that parameters and return values are to be considered as non-nullable by default for a given package.
pack-priv @interface	Nullable A common R2DBC annotation to declare that annotated elements can be `null` under some circumstance.

Class Summary

Modifier and Type	Class and Description
pack-priv abstract class	Assert Non-public assertion library for SPI implementations.
public class	ConnectionFactories Utility for discovering an available `ConnectionFactory` based on a set of `ConnectionFactoryOptions`.
public class	ConnectionFactoryOptions A holder for configuration options related to `ConnectionFactory`s.
pack-priv abstract class	ConnectionUrlParser Parser for R2DBC Connection URL's.
pack-priv abstract class	ConstantPool< the type of the constant T> A pool of constant instances.
pack-priv class	DefaultLob<T> Abstract implementation for large object types.
public class	IsolationLevel Represents a transaction isolation level constant.
public class	NoSuchOptionException Exception thrown by various accessor methods to indicate that the `Option` being requested does not exist or is not configured.
public class	Option< The value type of the option when configuring a value programmatically T> Represents a configuration option constant.
public class	Parameters Utility to create `Parameter` objects.
public class	R2dbcBadGrammarException Exception thrown when the SQL statement has a problem in its syntax.
public class	R2dbcDataIntegrityViolationException Exception thrown when an attempt to insert or update data results in a violation of an integrity constraint.
public abstract class	R2dbcException A root exception that should be extended by all server-related exceptions in an implementation.
public abstract class	R2dbcNonTransientException Base exception thrown when a retry of the same operation would fail unless the cause of the exception is corrected.
public class	R2dbcNonTransientResourceException Exception thrown when a resource fails completely and the failure is permanent.
public class	R2dbcPermissionDeniedException Exception thrown when the underlying resource denied a permission to access a specific element, such as a specific database table.
public class	R2dbcRollbackException Exception thrown when an attempt to commit a transaction resulted in an unexpected rollback due to deadlock or transaction serialization failures.
public class	R2dbcTimeoutException Exception thrown when the timeout specified by a database operation (query, login) is exceeded.
public abstract class	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.
public class	R2dbcTransientResourceException Exception thrown when a resource fails temporarily and the operation can be retried.

Modifier and Type	Enum and Description
public enum	Nullability Constants indicating nullability of column values.
public enum	R2dbcType Definition of generic SQL types.
public enum	ValidationDepth Constants indicating validation depth for a `Connection`.

Package io.r2dbc.spi

Interface Summary

Annotation Summary

Class Summary

Enum Summary