io.r2dbc.spi

Interface Result

public interface Result

Represents the results of a query against a database. Results can be consumed only once by either consuming getRowsUpdated() or map(BiFunction).

A Result object maintains a consumption state that may be backed by a cursor pointing to its current row of data. A Result allows read-only and forward-only consumption of statement results. Thus, you can consume either getRowsUpdated() or Rows through it only once and only from the first row to the last row.

Method Summary

Modifier and Type	Method and Description
Publisher<Integer>	getRowsUpdated() Returns the number of rows updated by a query against a database.
<T> Publisher<T>	map(BiFunction<Row,RowMetadata,? extends T> mappingFunction) Returns a mapping of the rows that are the results of a query against a database.

Method Detail

getRowsUpdated

Publisher<Integer> getRowsUpdated()

Returns the number of rows updated by a query against a database. May be empty if the query did not update any rows.

Returns:

the number of rows updated by a query against a database

Throws:

IllegalStateException - if the result was consumed

map

<T> Publisher<T> map(BiFunction<Row,RowMetadata,? extends T> mappingFunction)

Returns a mapping of the rows that are the results of a query against a database. May be empty if the query did not return any rows. A Row can be only considered valid within a mapping function callback.

Type Parameters:

T - the type of the mapped value

Parameters:

mappingFunction - the BiFunction that maps a Row and RowMetadata to a value

Returns:

a mapping of the rows that are the results of a query against a database

Throws:

IllegalArgumentException - if mappingFunction is null

IllegalStateException - if the result was consumed