Module io.helidon.dbclient.jdbc

Package io.helidon.dbclient.jdbc

Interface JdbcParametersConfig

All Superinterfaces:

Prototype.Api

All Known Implementing Classes:

JdbcParametersConfig.BuilderBase.JdbcParametersConfigImpl

public interface JdbcParametersConfig
extends Prototype.Api

JDBC parameters setter configuration.

See Also:

• builder()
• create()

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JdbcParametersConfig.Builder	Fluent API builder for JdbcParametersConfig.
static class	JdbcParametersConfig.BuilderBase<BUILDER extends JdbcParametersConfig.BuilderBase<BUILDER,PROTOTYPE>,PROTOTYPE extends JdbcParametersConfig>	Fluent API builder base for JdbcParametersConfig.

Method Summary

Modifier and Type	Method	Description
static JdbcParametersConfig.Builder	builder()	Create a new fluent API builder to customize configuration.
static JdbcParametersConfig.Builder	builder(JdbcParametersConfig instance)	Create a new fluent API builder from an existing instance.
static JdbcParametersConfig	create()	Create a new instance with default values.
static JdbcParametersConfig	create(Config config)	Create a new instance from configuration.
boolean	setObjectForJavaTime()	Set all java.time Date/Time values directly using PreparedStatement.setObject(int, Object).
int	stringBindingSize()	String values with length above this limit will be bound using PreparedStatement.setCharacterStream(int, java.io.Reader, int) if useStringBinding() is set to true.
boolean	timestampForLocalTime()	Use PreparedStatement.setTimestamp(int, java.sql.Timestamp) to set LocalTime values when true or use PreparedStatement.setTime(int, java.sql.Time) when false.
boolean	useByteArrayBinding()	Use PreparedStatement.setBinaryStream(int, java.io.InputStream, int) binding for byte[] values.
boolean	useNString()	Use SQL NCHAR, NVARCHAR or LONGNVARCHAR value conversion for String values.
boolean	useStringBinding()	Use PreparedStatement.setCharacterStream(int, java.io.Reader, int) binding for String values with length above stringBindingSize() limit.

Method Details

builder

static JdbcParametersConfig.Builder builder()

Create a new fluent API builder to customize configuration.

Returns:

a new builder

builder

static JdbcParametersConfig.Builder builder(JdbcParametersConfig instance)

Create a new fluent API builder from an existing instance.

Parameters:

instance - an existing instance used as a base for the builder

Returns:

a builder based on an instance

create

static JdbcParametersConfig create(Config config)

Create a new instance from configuration.

Parameters:

config - used to configure the new instance

Returns:

a new instance configured from configuration

create

static JdbcParametersConfig create()

Create a new instance with default values.

Returns:

a new instance

useNString

boolean useNString()

Use SQL NCHAR, NVARCHAR or LONGNVARCHAR value conversion for String values. Default value is false.

Returns:

whether NString conversion is used

useStringBinding

boolean useStringBinding()

Use PreparedStatement.setCharacterStream(int, java.io.Reader, int) binding for String values with length above stringBindingSize() limit. Default value is true.

Returns:

whether to use CharArrayReader binding

stringBindingSize

int stringBindingSize()

String values with length above this limit will be bound using PreparedStatement.setCharacterStream(int, java.io.Reader, int) if useStringBinding() is set to true. Default value is 1024.

Returns:

String values length limit for CharArrayReader binding

useByteArrayBinding

boolean useByteArrayBinding()

Use PreparedStatement.setBinaryStream(int, java.io.InputStream, int) binding for byte[] values. Default value is true.

Returns:

whether to use ByteArrayInputStream binding

timestampForLocalTime

boolean timestampForLocalTime()

Use PreparedStatement.setTimestamp(int, java.sql.Timestamp) to set LocalTime values when true or use PreparedStatement.setTime(int, java.sql.Time) when false. Default value is true.

This option is vendor specific. Most of the databases are fine with Timestamp, but for example SQL Server requires Time. This option does not apply when setObjectForJavaTime() is set to true.

Returns:

whether to use Timestamp instead of Time for LocalTime values

setObjectForJavaTime

boolean setObjectForJavaTime()

Set all java.time Date/Time values directly using PreparedStatement.setObject(int, Object). This option shall work fine for recent JDBC drivers. Default value is true.

Returns:

whether to use PreparedStatement.setObject(int, Object) for java.time Date/Time values