io.r2dbc.spi

Interface OutParameters

All Superinterfaces:

Readable

public interface OutParameters
extends Readable

Represents a set of OUT parameters returned from a stored procedure. Values from out parameters can be either retrieved by specifying a parameter name or the parameter index. Parameter indexes are 0-based.

Parameter names used as input to getter methods are case insensitive. When a get method is called with a parameter name and several parameters have the same name, then the value of the first matching parameter will be returned. Parameters that are not explicitly named in the query should be referenced through parameter indexes.

For maximum portability, parameters within each OutParameters should be read in left-to-right order, and each parameter should be read only once.

Readable.get(String) and Readable.get(int) without specifying a target type returns a suitable value representation. The R2DBC specification contains a mapping table that shows default mappings between database types and Java types. Specifying a target type, the R2DBC driver attempts to convert the value to the target type.

A parameter is invalidated after consumption.

The number, type and characteristics of parameters are described through OutParametersMetadata.

Since:

0.9

Method Summary

Modifier and Type	Method and Description
OutParametersMetadata	getMetadata() Returns the OutParametersMetadata for all out parameters.

Methods inherited from interface io.r2dbc.spi.Readable

get, get, get, get

Method Detail

getMetadata

OutParametersMetadata getMetadata()

Returns the OutParametersMetadata for all out parameters.

Returns:

the OutParametersMetadata for all out parameters