io.asyncer.r2dbc.mysql.api

Interface MySqlStatement

All Superinterfaces:

io.r2dbc.spi.Statement

public interface MySqlStatement
extends io.r2dbc.spi.Statement

A strongly typed abstraction of Statement for a SQL statement against a MySQL database.

Since:

1.1.3

Method Summary

Modifier and Type	Method and Description
MySqlStatement	add()
MySqlStatement	bind(int index, Object value)
MySqlStatement	bind(String name, Object value)
MySqlStatement	bindNull(int index, Class<?> type)
MySqlStatement	bindNull(String name, Class<?> type)
Flux<? extends MySqlResult>	execute()
default MySqlStatement	fetchSize(int rows)
default MySqlStatement	returnGeneratedValues(String... columns)

Method Detail

add

MySqlStatement add()

Specified by:

add in interface io.r2dbc.spi.Statement

Returns:

this

Throws:

IllegalStateException - if the statement is parameterized and not all parameters are provided

bind

MySqlStatement bind(int index,
                    Object value)

Specified by:

bind in interface io.r2dbc.spi.Statement

Parameters:

index - the index to bind to

value - the value to bind

Returns:

this

Throws:

IllegalArgumentException - if value is null

IndexOutOfBoundsException - if the parameter index is out of range

UnsupportedOperationException - if the statement is not a parameterized statement

bind

MySqlStatement bind(String name,
                    Object value)

Specified by:

bind in interface io.r2dbc.spi.Statement

Parameters:

name - the name of identifier to bind to

value - the value to bind

Returns:

this

Throws:

IllegalArgumentException - if name or value is null

NoSuchElementException - if name is not a known name to bind

UnsupportedOperationException - if the statement is not a parameterized statement

bindNull

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

Specified by:

bindNull in interface io.r2dbc.spi.Statement

Parameters:

index - the index to bind to

type - the type of null value

Returns:

this

Throws:

IllegalArgumentException - if type is null

IndexOutOfBoundsException - if the parameter index is out of range

UnsupportedOperationException - if the statement is not a parameterized statement

bindNull

MySqlStatement bindNull(String name,
                        Class<?> type)

Specified by:

bindNull in interface io.r2dbc.spi.Statement

Parameters:

name - the name of identifier to bind to

type - the type of null value

Returns:

this

Throws:

IllegalArgumentException - if name or type is null

NoSuchElementException - if name is not a known name to bind

UnsupportedOperationException - if the statement is not a parameterized statement

execute

Flux<? extends MySqlResult> execute()

Specified by:

execute in interface io.r2dbc.spi.Statement

Returns:

a Flux representing MySqlResults of the statement

Throws:

IllegalStateException - if the statement is parameterized and not all parameters are provided

returnGeneratedValues

default MySqlStatement returnGeneratedValues(String... columns)

Specified by:

returnGeneratedValues in interface io.r2dbc.spi.Statement

Parameters:

columns - the names of the columns to return

Returns:

this

Throws:

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

fetchSize

default MySqlStatement fetchSize(int rows)

Specified by:

fetchSize in interface io.r2dbc.spi.Statement

Parameters:

rows - the number of rows to fetch

Returns:

this

Throws:

IllegalArgumentException - if fetch size is less than zero