io.asyncer.r2dbc.mysql

Interface MySqlParameter

All Superinterfaces:

Disposable

public interface MySqlParameter
extends Disposable

A parameter value bound to an Binding.

TODO: add ScalarParameter for better performance.

Nested Class Summary

Nested classes/interfaces inherited from interface reactor.core.Disposable

Disposable.Composite, Disposable.Swap

Method Summary

Modifier and Type	Method and Description
default void	dispose()
MySqlType	getType() Get the MySqlType of this parameter data.
default boolean	isNull() Note: the null is processed by built-in codecs.
Publisher<io.netty.buffer.ByteBuf>	publishBinary() Binary protocol encoding.
Mono<Void>	publishText(ParameterWriter writer) Text protocol encoding.

Methods inherited from interface reactor.core.Disposable

isDisposed

Method Detail

isNull

default boolean isNull()

Note: the null is processed by built-in codecs.

Returns:

true if it is null. Codec extensions should always return false.

publishBinary

Publisher<io.netty.buffer.ByteBuf> publishBinary()

Binary protocol encoding. See MySQL protocol documentations, if don't want to support the binary protocol, please receive an exception.

Note: not like the text protocol, it make a sense for state-less.

Binary protocol maybe need to add a var-integer length before encoded content. So if makes it like Mono<Void> publishBinary (Xxx binaryWriter), and if supports multiple times writing like a OutputStream or Writer for each parameter, this make a hell of a complex state system. If we don't support multiple times writing, it will be hard to understand and maybe make a confuse to user.

Returns:

the encoded binary buffer(s).

publishText

Mono<Void> publishText(ParameterWriter writer)

Text protocol encoding.

Note: not like the binary protocol, it make a sense for copy-less.

If it seems like Publisher<? extends CharSequence> publishText(), then we need to always deep copy results (with escaping) into the string buffer of the synthesized SQL statement.

WARNING: the output requires state synchronization after this function called, so if external writer buffered the writer, please flush the external buffer before receiving the completion signal.

Parameters:

writer - the text protocol writer, extended Writer, not thread-safety.

Returns:

the encoding completion signal.

getType

MySqlType getType()

Get the MySqlType of this parameter data.

If don't want to support the binary protocol, just throw an exception please.

Returns:

the MySQL type.

dispose

default void dispose()

Specified by:

dispose in interface Disposable