io.r2dbc.spi

Interface OutParametersMetadata

public interface OutParametersMetadata

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

Method Summary

Modifier and Type	Method and Description
OutParameterMetadata	getParameterMetadata(int index) Returns the OutParameterMetadata for one out parameter.
OutParameterMetadata	getParameterMetadata(String name) Returns the OutParameterMetadata for one parameter.
List<? extends OutParameterMetadata>	getParameterMetadatas() Returns the OutParameterMetadata for all out parameters.

Method Detail

getParameterMetadata

OutParameterMetadata getParameterMetadata(int index)

Returns the OutParameterMetadata for one out parameter.

Parameters:

index - the out parameter index starting at 0

Returns:

the OutParameterMetadata for one out parameter

Throws:

IndexOutOfBoundsException - if index is out of range (negative or equals/exceeds getParameterMetadatas().size())

getParameterMetadata

OutParameterMetadata getParameterMetadata(String name)

Returns the OutParameterMetadata for one parameter.

Parameters:

name - the name of the out parameter. Parameter names are case-insensitive.

Returns:

the OutParameterMetadata for one out parameter

Throws:

IllegalArgumentException - if name is null

NoSuchElementException - if there is no out parameter with the name

getParameterMetadatas

List<? extends OutParameterMetadata> getParameterMetadatas()

Returns the OutParameterMetadata for all out parameters.

Returns:

the OutParameterMetadata for all out parameters