Package org.springframework.data.cassandra.core

Class InsertOptions.InsertOptionsBuilder

java.lang.Object

org.springframework.data.cassandra.core.cql.QueryOptions.QueryOptionsBuilder

org.springframework.data.cassandra.core.cql.WriteOptions.WriteOptionsBuilder

org.springframework.data.cassandra.core.InsertOptions.InsertOptionsBuilder

Enclosing class:

InsertOptions

public static class InsertOptions.InsertOptionsBuilder
extends WriteOptions.WriteOptionsBuilder

Builder for InsertOptions.

Since:

2.0

Author:

Mark Paluch, Lukasz Antoniak

Field Summary

Fields inherited from class org.springframework.data.cassandra.core.cql.WriteOptions.WriteOptionsBuilder

timestamp, ttl

Fields inherited from class org.springframework.data.cassandra.core.cql.QueryOptions.QueryOptionsBuilder

consistencyLevel, executionProfileResolver, idempotent, keyspace, pageSize, routingKey, routingKeyspace, serialConsistencyLevel, timeout, tracing

Method Summary

Modifier and Type	Method	Description
InsertOptions	build()	Builds a new InsertOptions with the configured values.
InsertOptions.InsertOptionsBuilder	consistencyLevel(com.datastax.oss.driver.api.core.ConsistencyLevel consistencyLevel)	Sets the ConsistencyLevel to use.
InsertOptions.InsertOptionsBuilder	executionProfile(String profileName)	Sets the execution profile to use.
InsertOptions.InsertOptionsBuilder	executionProfile(ExecutionProfileResolver executionProfileResolver)	Sets the ExecutionProfileResolver to use.
InsertOptions.InsertOptionsBuilder	fetchSize(int fetchSize)	Deprecated.
InsertOptions.InsertOptionsBuilder	idempotent(boolean idempotent)	Set query execution idempotency.
InsertOptions.InsertOptionsBuilder	ifNotExists(boolean ifNotExists)	Use light-weight transactions by applying IF NOT EXISTS.
InsertOptions.InsertOptionsBuilder	keyspace(com.datastax.oss.driver.api.core.CqlIdentifier keyspace)	Sets the keyspace to use.
InsertOptions.InsertOptionsBuilder	pageSize(int pageSize)	Sets the query fetch size for ResultSet chunks.
InsertOptions.InsertOptionsBuilder	readTimeout(long readTimeout)	Deprecated.
InsertOptions.InsertOptionsBuilder	readTimeout(long readTimeout, TimeUnit timeUnit)	Deprecated.
InsertOptions.InsertOptionsBuilder	routingKey(ByteBuffer routingKey)	Set query routing key.
InsertOptions.InsertOptionsBuilder	routingKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier routingKeyspace)	Set query routing keyspace.
InsertOptions.InsertOptionsBuilder	serialConsistencyLevel(com.datastax.oss.driver.api.core.ConsistencyLevel consistencyLevel)	Sets the serial ConsistencyLevel to use.
InsertOptions.InsertOptionsBuilder	timeout(Duration timeout)	Sets the request timeout.
InsertOptions.InsertOptionsBuilder	timestamp(long timestamp)	Sets the timestamp of write operations.
InsertOptions.InsertOptionsBuilder	timestamp(Instant timestamp)	Sets the timestamp of write operations.
InsertOptions.InsertOptionsBuilder	tracing(boolean tracing)	Enables statement tracing.
InsertOptions.InsertOptionsBuilder	ttl(int ttl)	Sets the time to live in seconds for write operations.
InsertOptions.InsertOptionsBuilder	ttl(Duration ttl)	Sets the time to live in seconds for write operations.
InsertOptions.InsertOptionsBuilder	withIfNotExists()	Use light-weight transactions by applying IF NOT EXISTS.
InsertOptions.InsertOptionsBuilder	withInsertNulls()	Insert null values from an entity.
InsertOptions.InsertOptionsBuilder	withInsertNulls(boolean insertNulls)	Insert null values from an entity.
InsertOptions.InsertOptionsBuilder	withTracing()	Enables statement tracing.

Methods inherited from class org.springframework.data.cassandra.core.cql.QueryOptions.QueryOptionsBuilder

readTimeout

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

consistencyLevel

public InsertOptions.InsertOptionsBuilder consistencyLevel(com.datastax.oss.driver.api.core.ConsistencyLevel consistencyLevel)

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the ConsistencyLevel to use.

Overrides:

consistencyLevel in class WriteOptions.WriteOptionsBuilder

Parameters:

consistencyLevel - must not be null.

Returns:

this QueryOptions.QueryOptionsBuilder

executionProfile

public InsertOptions.InsertOptionsBuilder executionProfile(String profileName)

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the execution profile to use.

Overrides:

executionProfile in class WriteOptions.WriteOptionsBuilder

Parameters:

profileName - must not be null or empty.

Returns:

this QueryOptions.QueryOptionsBuilder

See Also:

• Statement.setExecutionProfileName(String)

executionProfile

public InsertOptions.InsertOptionsBuilder executionProfile(ExecutionProfileResolver executionProfileResolver)

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the ExecutionProfileResolver to use.

Overrides:

executionProfile in class WriteOptions.WriteOptionsBuilder

Parameters:

executionProfileResolver - must not be null.

Returns:

this QueryOptions.QueryOptionsBuilder

See Also:

• Statement.setExecutionProfile(DriverExecutionProfile)

fetchSize

@Deprecated
public InsertOptions.InsertOptionsBuilder fetchSize(int fetchSize)

Deprecated.

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the query fetch size for ResultSet chunks.

The fetch size controls how much resulting rows will be retrieved simultaneously (the goal being to avoid loading too much results in memory for queries yielding large results). Please note that while value as low as 1 can be used, it is *highly* discouraged to use such a low value in practice as it will yield very poor performance.

Overrides:

fetchSize in class WriteOptions.WriteOptionsBuilder

Parameters:

fetchSize - the number of rows to fetch per chunking request. To disable chunking of the result set, use fetchSize == Integer.MAX_VALUE. Negative values are not allowed.

Returns:

this QueryOptions.QueryOptionsBuilder

idempotent

public InsertOptions.InsertOptionsBuilder idempotent(boolean idempotent)

Description copied from class: QueryOptions.QueryOptionsBuilder

Set query execution idempotency.

Overrides:

idempotent in class WriteOptions.WriteOptionsBuilder

Parameters:

idempotent - true to mark the query as idempotent.

Returns:

this QueryOptions.QueryOptionsBuilder.

keyspace

public InsertOptions.InsertOptionsBuilder keyspace(com.datastax.oss.driver.api.core.CqlIdentifier keyspace)

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the keyspace to use. If left unconfigured, then the keyspace set on the statement or CqlSession will be used.

Overrides:

keyspace in class WriteOptions.WriteOptionsBuilder

Parameters:

keyspace - the specific keyspace to use to run a statement, must not be null.

Returns:

this QueryOptions.QueryOptionsBuilder.

pageSize

public InsertOptions.InsertOptionsBuilder pageSize(int pageSize)

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the query fetch size for ResultSet chunks.

The fetch size controls how much resulting rows will be retrieved simultaneously (the goal being to avoid loading too many results in memory for queries yielding large results). Please note that while value as low as 1 can be used, it is highly discouraged to use such a low value in practice as it will yield very poor performance.

Overrides:

pageSize in class WriteOptions.WriteOptionsBuilder

Parameters:

pageSize - the number of rows to fetch per chunking request. To disable chunking of the result set, use pageSize == Integer.MAX_VALUE. Negative values are not allowed.

Returns:

this QueryOptions.QueryOptionsBuilder

readTimeout

@Deprecated
public InsertOptions.InsertOptionsBuilder readTimeout(long readTimeout)

Deprecated.

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the read timeout in milliseconds. Overrides the default per-host read timeout.

Overrides:

readTimeout in class WriteOptions.WriteOptionsBuilder

Parameters:

readTimeout - the read timeout in milliseconds. Negative values are not allowed. If it is 0, the read timeout will be disabled for this statement.

Returns:

this QueryOptions.QueryOptionsBuilder

See Also:

• Statement.setTimeout(Duration)

readTimeout

@Deprecated
public InsertOptions.InsertOptionsBuilder readTimeout(long readTimeout,
 TimeUnit timeUnit)

Deprecated.

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the read timeout. Overrides the default per-host read timeout.

Overrides:

readTimeout in class WriteOptions.WriteOptionsBuilder

Parameters:

readTimeout - the read timeout value. Negative values are not allowed. If it is 0, the read timeout will be disabled for this statement.

timeUnit - the TimeUnit for the supplied timeout; must not be null.

Returns:

this QueryOptions.QueryOptionsBuilder

See Also:

• Statement.setTimeout(Duration)

routingKeyspace

public InsertOptions.InsertOptionsBuilder routingKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier routingKeyspace)

Description copied from class: QueryOptions.QueryOptionsBuilder

Set query routing keyspace.

Overrides:

routingKeyspace in class WriteOptions.WriteOptionsBuilder

Parameters:

routingKeyspace - the routing keyspace to use for token-aware routing.

Returns:

this QueryOptions.QueryOptionsBuilder.

routingKey

public InsertOptions.InsertOptionsBuilder routingKey(ByteBuffer routingKey)

Description copied from class: QueryOptions.QueryOptionsBuilder

Set query routing key.

Overrides:

routingKey in class WriteOptions.WriteOptionsBuilder

Parameters:

routingKey - the routing key to use for token-aware routing.

Returns:

this QueryOptions.QueryOptionsBuilder

serialConsistencyLevel

public InsertOptions.InsertOptionsBuilder serialConsistencyLevel(com.datastax.oss.driver.api.core.ConsistencyLevel consistencyLevel)

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the serial ConsistencyLevel to use.

Overrides:

serialConsistencyLevel in class WriteOptions.WriteOptionsBuilder

Parameters:

consistencyLevel - must not be null.

Returns:

this QueryOptions.QueryOptionsBuilder

timeout

public InsertOptions.InsertOptionsBuilder timeout(Duration timeout)

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the request timeout. Overrides the default timeout.

Overrides:

timeout in class WriteOptions.WriteOptionsBuilder

Parameters:

timeout - the read timeout. Negative values are not allowed. If it is 0, the read timeout will be disabled for this statement.

Returns:

this QueryOptions.QueryOptionsBuilder

See Also:

• Statement.setTimeout(Duration)

ttl

public InsertOptions.InsertOptionsBuilder ttl(Duration ttl)

Description copied from class: WriteOptions.WriteOptionsBuilder

Sets the time to live in seconds for write operations.

Overrides:

ttl in class WriteOptions.WriteOptionsBuilder

Parameters:

ttl - the time to live.

Returns:

this WriteOptions.WriteOptionsBuilder

tracing

public InsertOptions.InsertOptionsBuilder tracing(boolean tracing)

Description copied from class: QueryOptions.QueryOptionsBuilder

Enables statement tracing.

Overrides:

tracing in class WriteOptions.WriteOptionsBuilder

Parameters:

tracing - true to enable statement tracing to the executed statements.

Returns:

this QueryOptions.QueryOptionsBuilder

withTracing

public InsertOptions.InsertOptionsBuilder withTracing()

Description copied from class: QueryOptions.QueryOptionsBuilder

Enables statement tracing.

Overrides:

withTracing in class WriteOptions.WriteOptionsBuilder

Returns:

this QueryOptions.QueryOptionsBuilder

ttl

public InsertOptions.InsertOptionsBuilder ttl(int ttl)

Description copied from class: WriteOptions.WriteOptionsBuilder

Sets the time to live in seconds for write operations.

Overrides:

ttl in class WriteOptions.WriteOptionsBuilder

Parameters:

ttl - the time to live.

Returns:

this WriteOptions.WriteOptionsBuilder

timestamp

public InsertOptions.InsertOptionsBuilder timestamp(long timestamp)

Description copied from class: WriteOptions.WriteOptionsBuilder

Sets the timestamp of write operations.

Overrides:

timestamp in class WriteOptions.WriteOptionsBuilder

Parameters:

timestamp - mutation timestamp in microseconds.

Returns:

this WriteOptions.WriteOptionsBuilder

See Also:

• TimeUnit.MICROSECONDS

timestamp

public InsertOptions.InsertOptionsBuilder timestamp(Instant timestamp)

Description copied from class: WriteOptions.WriteOptionsBuilder

Sets the timestamp of write operations.

Overrides:

timestamp in class WriteOptions.WriteOptionsBuilder

Parameters:

timestamp - mutation date time.

Returns:

this WriteOptions.WriteOptionsBuilder

withIfNotExists

public InsertOptions.InsertOptionsBuilder withIfNotExists()

Use light-weight transactions by applying IF NOT EXISTS.

Returns:

this InsertOptions.InsertOptionsBuilder

ifNotExists

public InsertOptions.InsertOptionsBuilder ifNotExists(boolean ifNotExists)

Use light-weight transactions by applying IF NOT EXISTS.

Parameters:

ifNotExists - true to enable IF NOT EXISTS.

Returns:

this InsertOptions.InsertOptionsBuilder

withInsertNulls

public InsertOptions.InsertOptionsBuilder withInsertNulls()

Insert null values from an entity. This allows the usage of INSERT statements as upsert by ensuring that the whole entity state is persisted. Inserting nulls in Cassandra creates tombstones so this option should be used with caution.

Returns:

this InsertOptions.InsertOptionsBuilder

Since:

2.1

withInsertNulls

public InsertOptions.InsertOptionsBuilder withInsertNulls(boolean insertNulls)

Insert null values from an entity. This allows the usage of INSERT statements as upsert by ensuring that the whole entity state is persisted. Inserting nulls in Cassandra creates tombstones so this option should be used with caution.

Parameters:

insertNulls - true to enable insertion of null values.

Returns:

this InsertOptions.InsertOptionsBuilder

Since:

2.1

build

public InsertOptions build()

Builds a new InsertOptions with the configured values.

Overrides:

build in class WriteOptions.WriteOptionsBuilder

Returns:

a new InsertOptions with the configured values