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, fetchSize, readTimeout, retryPolicy, tracing

Method Summary

Modifier and Type	Method and Description
UpdateOptions	build() Builds a new UpdateOptions with the configured values.
UpdateOptions.UpdateOptionsBuilder	consistencyLevel(com.datastax.driver.core.ConsistencyLevel consistencyLevel) Sets the ConsistencyLevel to use.
UpdateOptions.UpdateOptionsBuilder	fetchSize(int fetchSize) Sets the query fetch size for ResultSet chunks.
UpdateOptions.UpdateOptionsBuilder	ifExists(boolean ifNotExists) Use light-weight transactions by applying IF EXISTS.
UpdateOptions.UpdateOptionsBuilder	readTimeout(Duration readTimeout) Sets the read timeout.
UpdateOptions.UpdateOptionsBuilder	readTimeout(long readTimeout) Sets the read timeout in milliseconds.
UpdateOptions.UpdateOptionsBuilder	readTimeout(long readTimeout, TimeUnit timeUnit) Deprecated.
UpdateOptions.UpdateOptionsBuilder	retryPolicy(com.datastax.driver.core.policies.RetryPolicy driverRetryPolicy) Sets the driver RetryPolicy to use.
UpdateOptions.UpdateOptionsBuilder	timestamp(Instant timestamp) Sets the timestamp of write operations.
UpdateOptions.UpdateOptionsBuilder	timestamp(long timestamp) Sets the timestamp of write operations.
UpdateOptions.UpdateOptionsBuilder	tracing(boolean tracing) Enables statement tracing.
UpdateOptions.UpdateOptionsBuilder	ttl(Duration ttl) Sets the time to live in seconds for write operations.
UpdateOptions.UpdateOptionsBuilder	ttl(int 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 java.lang.Object

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

Method Detail

consistencyLevel

public UpdateOptions.UpdateOptionsBuilder consistencyLevel(com.datastax.driver.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

retryPolicy

public UpdateOptions.UpdateOptionsBuilder retryPolicy(com.datastax.driver.core.policies.RetryPolicy driverRetryPolicy)

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the driver RetryPolicy to use. Setting both ( RetryPolicy and driver RetryPolicy) retry policies is not supported.

Overrides:

retryPolicy in class WriteOptions.WriteOptionsBuilder

Parameters:

driverRetryPolicy - must not be null.

Returns:

this QueryOptions.QueryOptionsBuilder

fetchSize

public UpdateOptions.UpdateOptionsBuilder fetchSize(int fetchSize)

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

See Also:

QueryOptions.getFetchSize(), Cluster.Builder.withQueryOptions(com.datastax.driver.core.QueryOptions)

readTimeout

public UpdateOptions.UpdateOptionsBuilder readTimeout(long readTimeout)

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:

SocketOptions.getReadTimeoutMillis(), Cluster.Builder.withSocketOptions(SocketOptions)

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:

SocketOptions.getReadTimeoutMillis(), Cluster.Builder.withSocketOptions(SocketOptions)

readTimeout

public UpdateOptions.UpdateOptionsBuilder readTimeout(Duration readTimeout)

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. Negative values are not allowed. If it is 0, the read timeout will be disabled for this statement.

Returns:

this QueryOptions.QueryOptionsBuilder

See Also:

SocketOptions.getReadTimeoutMillis(), Cluster.Builder.withSocketOptions(SocketOptions)

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

withIfExists

public UpdateOptions.UpdateOptionsBuilder withIfExists()

Use light-weight transactions by applying IF EXISTS.

Returns:

this UpdateOptions.UpdateOptionsBuilder

ifExists

public UpdateOptions.UpdateOptionsBuilder ifExists(boolean ifNotExists)

Use light-weight transactions by applying IF EXISTS.

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