Top Description Methods
io.r2dbc.spi

public Interface RowMetadata

Imports
java.util.List, .NoSuchElementException
Represents the metadata for a row of the results returned from a query. Metadata for columns can be either retrieved by specifying a column name or the column index. Columns indexes are 0-based. Column names do not necessarily reflect the column names how they are in the underlying tables but rather how columns are represented (e.g. aliased) in the result.

Method Summary

Modifier and TypeMethod and Description
public default boolean

Returns:

true if this object contains metadata for columnName; false otherwise.
contains(String
the name of the column. Column names are case-insensitive. When a get method contains several columns with same name, then the value of the first matching column will be returned
columnName)

Returns whether this object contains metadata for columnName.

public ColumnMetadata

Returns:

the ColumnMetadata for one column in this row
getColumnMetadata(int
the column index starting at 0
index)

Returns the ColumnMetadata for one column in this row.

public ColumnMetadata

Returns:

the ColumnMetadata for one column in this row
getColumnMetadata(String
the name of the column. Column names are case-insensitive. When a get method contains several columns with same name, then the value of the first matching column will be returned
name)

Returns the ColumnMetadata for one column in this row.

public List<? extends ColumnMetadata>

Returns:

the ColumnMetadata for all columns in this row
getColumnMetadatas()

Returns the ColumnMetadata for all columns in this row.

Method Detail

containsback to summary
public default boolean contains(String columnName)

Returns whether this object contains metadata for columnName. Lookups are case-insensitive. Implementations may allow escape characters to enforce a particular mode of comparison when querying for presence/absence of a column.

Parameters
columnName:String

the name of the column. Column names are case-insensitive. When a get method contains several columns with same name, then the value of the first matching column will be returned

Returns:boolean

true if this object contains metadata for columnName; false otherwise.

Since
0.9
getColumnMetadataback to summary
public ColumnMetadata getColumnMetadata(int index)

Returns the ColumnMetadata for one column in this row.

Parameters
index:int

the column index starting at 0

Returns:ColumnMetadata

the ColumnMetadata for one column in this row

Exceptions
IndexOutOfBoundsException:
if index is out of range (negative or equals/exceeds getColumnMetadatas().size())
getColumnMetadataback to summary
public ColumnMetadata getColumnMetadata(String name)

Returns the ColumnMetadata for one column in this row.

Parameters
name:String

the name of the column. Column names are case-insensitive. When a get method contains several columns with same name, then the value of the first matching column will be returned

Returns:ColumnMetadata

the ColumnMetadata for one column in this row

Exceptions
IllegalArgumentException:
if name is null
NoSuchElementException:
if there is no column with the name
getColumnMetadatasback to summary
public List<? extends ColumnMetadata> getColumnMetadatas()

Returns the ColumnMetadata for all columns in this row.

Returns:List<? extends ColumnMetadata>

the ColumnMetadata for all columns in this row