io.r2dbc.spi

Interface Statement

public interface Statement

A statement that can be executed multiple times in a prepared and optimized way.

Method Summary

Modifier and Type	Method and Description
Statement	add() Save the current binding and create a new one.
default Statement	bind(int index, boolean value) Bind a value to an index.
default Statement	bind(int index, byte value) Bind a value to an index.
default Statement	bind(int index, char value) Bind a value to an index.
default Statement	bind(int index, double value) Bind a value to an index.
default Statement	bind(int index, float value) Bind a value to an index.
default Statement	bind(int index, int value) Bind a value to an index.
default Statement	bind(int index, long value) Bind a value to an index.
Statement	bind(int index, Object value) Bind a value to an index.
default Statement	bind(int index, short value) Bind a value to an index.
Statement	bind(Object identifier, Object value) Bind a value.
Statement	bindNull(int index, Class<?> type) Bind a null value.
Statement	bindNull(Object identifier, Class<?> type) Bind a null value.
org.reactivestreams.Publisher<? extends Result>	execute() Executes one or more SQL statements and returns the Results.
default Statement	returnGeneratedValues(String... columns) Configures Statement to return the generated values from any rows created by this Statement in the Result returned from execute().

Method Detail

add

Statement add()

Save the current binding and create a new one.

Returns:

this Statement

bind

Statement bind(Object identifier,
               Object value)

Bind a value.

Parameters:

identifier - the identifier to bind to

value - the value to bind

Returns:

this Statement

Throws:

IllegalArgumentException - if identifier or value is null

bind

Statement bind(int index,
               Object value)

Bind a value to an index. Indexes are zero-based.

Parameters:

index - the index to bind to

value - the value to bind

Returns:

this Statement

Throws:

IllegalArgumentException - if value is null

bind

default Statement bind(int index,
                       boolean value)

Bind a value to an index. Indexes are zero-based.

Parameters:

index - the index to bind to

value - the value to bind

Returns:

this Statement

bind

default Statement bind(int index,
                       byte value)

Bind a value to an index. Indexes are zero-based.

Parameters:

index - the index to bind to

value - the value to bind

Returns:

this Statement

bind

default Statement bind(int index,
                       char value)

Bind a value to an index. Indexes are zero-based.

Parameters:

index - the index to bind to

value - the value to bind

Returns:

this Statement

bind

default Statement bind(int index,
                       double value)

Bind a value to an index. Indexes are zero-based.

Parameters:

index - the index to bind to

value - the value to bind

Returns:

this Statement

bind

default Statement bind(int index,
                       float value)

Bind a value to an index. Indexes are zero-based.

Parameters:

index - the index to bind to

value - the value to bind

Returns:

this Statement

bind

default Statement bind(int index,
                       int value)

Bind a value to an index. Indexes are zero-based.

Parameters:

index - the index to bind to

value - the value to bind

Returns:

this Statement

bind

default Statement bind(int index,
                       long value)

Bind a value to an index. Indexes are zero-based.

Parameters:

index - the index to bind to

value - the value to bind

Returns:

this Statement

bind

default Statement bind(int index,
                       short value)

Bind a value to an index. Indexes are zero-based.

Parameters:

index - the index to bind to

value - the value to bind

Returns:

this Statement

bindNull

Statement bindNull(Object identifier,
                   Class<?> type)

Bind a null value.

Parameters:

identifier - the identifier to bind to

type - the type of null value

Returns:

this Statement

Throws:

IllegalArgumentException - if identifier or type is null

bindNull

Statement bindNull(int index,
                   Class<?> type)

Bind a null value.

Parameters:

index - the index to bind to

type - the type of null value

Returns:

this Statement

Throws:

IllegalArgumentException - if type is null

execute

org.reactivestreams.Publisher<? extends Result> execute()

Executes one or more SQL statements and returns the Results.

Returns:

the Results, returned by each statement

returnGeneratedValues

default Statement returnGeneratedValues(String... columns)

Configures Statement to return the generated values from any rows created by this Statement in the Result returned from execute(). If no columns are specified, implementations are free to choose which columns will be returned. If called multiple times, only the columns requested in the final invocation will be returned.

The default implementation of this method is a no op.

Parameters:

columns - the names of the columns to return

Returns:

this Statement

Throws:

IllegalArgumentException - if columns, or any item in columns is null