Package org.springframework.data.cassandra.core

Class UpdateOptions.UpdateOptionsBuilder

java.lang.Object

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

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

org.springframework.data.cassandra.core.UpdateOptions.UpdateOptionsBuilder

Enclosing class:

UpdateOptions

public static class UpdateOptions.UpdateOptionsBuilder
extends WriteOptions.WriteOptionsBuilder

Builder for UpdateOptions.

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
UpdateOptions	build()	Builds a new UpdateOptions with the configured values.
UpdateOptions.UpdateOptionsBuilder	consistencyLevel(com.datastax.oss.driver.api.core.ConsistencyLevel consistencyLevel)	Sets the ConsistencyLevel to use.
UpdateOptions.UpdateOptionsBuilder	executionProfile(String profileName)	Sets the execution profile to use.
UpdateOptions.UpdateOptionsBuilder	executionProfile(ExecutionProfileResolver executionProfileResolver)	Sets the ExecutionProfileResolver to use.
UpdateOptions.UpdateOptionsBuilder	fetchSize(int fetchSize)	Deprecated.
UpdateOptions.UpdateOptionsBuilder	idempotent(boolean idempotent)	Set query execution idempotency.
UpdateOptions.UpdateOptionsBuilder	ifCondition(CriteriaDefinition criteria)	Use light-weight transactions by applying IF condition.
UpdateOptions.UpdateOptionsBuilder	ifCondition(Filter condition)	Use light-weight transactions by applying IF condition.
UpdateOptions.UpdateOptionsBuilder	ifExists(boolean ifNotExists)	Use light-weight transactions by applying IF EXISTS.
UpdateOptions.UpdateOptionsBuilder	keyspace(com.datastax.oss.driver.api.core.CqlIdentifier keyspace)	Sets the keyspace to use.
UpdateOptions.UpdateOptionsBuilder	pageSize(int pageSize)	Sets the query fetch size for ResultSet chunks.
UpdateOptions.UpdateOptionsBuilder	readTimeout(long readTimeout)	Deprecated.
UpdateOptions.UpdateOptionsBuilder	readTimeout(long readTimeout, TimeUnit timeUnit)	Deprecated.
UpdateOptions.UpdateOptionsBuilder	routingKey(ByteBuffer routingKey)	Set query routing key.
UpdateOptions.UpdateOptionsBuilder	routingKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier routingKeyspace)	Set query routing keyspace.
UpdateOptions.UpdateOptionsBuilder	serialConsistencyLevel(com.datastax.oss.driver.api.core.ConsistencyLevel consistencyLevel)	Sets the serial ConsistencyLevel to use.
UpdateOptions.UpdateOptionsBuilder	timeout(Duration timeout)	Sets the request timeout.
UpdateOptions.UpdateOptionsBuilder	timestamp(long timestamp)	Sets the timestamp of write operations.
UpdateOptions.UpdateOptionsBuilder	timestamp(Instant timestamp)	Sets the timestamp of write operations.
UpdateOptions.UpdateOptionsBuilder	tracing(boolean tracing)	Enables statement tracing.
UpdateOptions.UpdateOptionsBuilder	ttl(int ttl)	Sets the time to live in seconds for write operations.
UpdateOptions.UpdateOptionsBuilder	ttl(Duration ttl)	Sets the time to live in seconds for write operations.
UpdateOptions.UpdateOptionsBuilder	withIfExists()	Use light-weight transactions by applying IF EXISTS.
UpdateOptions.UpdateOptionsBuilder	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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder withTracing()

Description copied from class: QueryOptions.QueryOptionsBuilder

Enables statement tracing.

Overrides:

withTracing in class WriteOptions.WriteOptionsBuilder

Returns:

this QueryOptions.QueryOptionsBuilder

ttl

public UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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 UpdateOptions.UpdateOptionsBuilder 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

ifCondition

public UpdateOptions.UpdateOptionsBuilder ifCondition(CriteriaDefinition criteria)

Use light-weight transactions by applying IF condition. Replaces a previous ifCondition(Filter) and ifExists(boolean).

Parameters:

criteria - the criteria to apply for conditional updates, must not be null.

Returns:

this UpdateOptions.UpdateOptionsBuilder

Since:

2.2

ifCondition

public UpdateOptions.UpdateOptionsBuilder ifCondition(Filter condition)

Use light-weight transactions by applying IF condition. Replaces a previous ifCondition(Filter) and ifExists(boolean).

Parameters:

condition - the condition to apply for conditional updates, must not be null.

Returns:

this UpdateOptions.UpdateOptionsBuilder

Since:

2.2

withIfExists

public UpdateOptions.UpdateOptionsBuilder withIfExists()

Use light-weight transactions by applying IF EXISTS. Replaces a previous ifCondition(Filter).

Returns:

this UpdateOptions.UpdateOptionsBuilder

ifExists

public UpdateOptions.UpdateOptionsBuilder ifExists(boolean ifNotExists)

Use light-weight transactions by applying IF EXISTS. Replaces a previous ifCondition(Filter).

Parameters:

ifNotExists - true to enable IF EXISTS.

Returns:

this UpdateOptions.UpdateOptionsBuilder

build

public UpdateOptions build()

Builds a new UpdateOptions with the configured values.

Overrides:

build in class WriteOptions.WriteOptionsBuilder

Returns:

a new UpdateOptions with the configured values