Top Description Methods
io.r2dbc.spi

public Interface OutParametersMetadata

Imports
java.util.List, .NoSuchElementException
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 TypeMethod and Description
public OutParameterMetadata

Returns:

the OutParameterMetadata for one out parameter
getParameterMetadata(int
the out parameter index starting at 0
index)

Returns the OutParameterMetadata for one out parameter.

public OutParameterMetadata

Returns:

the OutParameterMetadata for one out parameter
getParameterMetadata(String
the name of the out parameter. Parameter names are case-insensitive.
name)

Returns the OutParameterMetadata for one parameter.

public List<? extends OutParameterMetadata>

Returns:

the OutParameterMetadata for all out parameters
getParameterMetadatas()

Returns the OutParameterMetadata for all out parameters.

Method Detail

getParameterMetadataback to summary
public OutParameterMetadata getParameterMetadata(int index)

Returns the OutParameterMetadata for one out parameter.

Parameters
index:int

the out parameter index starting at 0

Returns:OutParameterMetadata

the OutParameterMetadata for one out parameter

Exceptions
IndexOutOfBoundsException:
if index is out of range (negative or equals/exceeds getParameterMetadatas().size())
getParameterMetadataback to summary
public OutParameterMetadata getParameterMetadata(String name)

Returns the OutParameterMetadata for one parameter.

Parameters
name:String

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

Returns:OutParameterMetadata

the OutParameterMetadata for one out parameter

Exceptions
IllegalArgumentException:
if name is null
NoSuchElementException:
if there is no out parameter with the name
getParameterMetadatasback to summary
public List<? extends OutParameterMetadata> getParameterMetadatas()

Returns the OutParameterMetadata for all out parameters.

Returns:List<? extends OutParameterMetadata>

the OutParameterMetadata for all out parameters