Package org.springframework.data.cassandra.core.cql

Class WriteOptions.WriteOptionsBuilder

java.lang.Object

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

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

Direct Known Subclasses:

DeleteOptions.DeleteOptionsBuilder, InsertOptions.InsertOptionsBuilder, UpdateOptions.UpdateOptionsBuilder

Enclosing class:

WriteOptions

public static class WriteOptions.WriteOptionsBuilder
extends QueryOptions.QueryOptionsBuilder

Builder for WriteOptions.

Since:

1.5

Author:

Mark Paluch, Lukasz Antoniak, Thomas Strauß, Tudor Marc

Field Summary

Fields

Modifier and Type	Field	Description
protected Long	timestamp
protected Duration	ttl

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

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

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	WriteOptionsBuilder()
protected	WriteOptionsBuilder(WriteOptions writeOptions)

Method Summary

Modifier and Type	Method	Description
WriteOptions	build()	Builds a new WriteOptions with the configured values.
WriteOptions.WriteOptionsBuilder	consistencyLevel(com.datastax.oss.driver.api.core.ConsistencyLevel consistencyLevel)	Sets the ConsistencyLevel to use.
WriteOptions.WriteOptionsBuilder	executionProfile(String profileName)	Sets the execution profile to use.
WriteOptions.WriteOptionsBuilder	executionProfile(ExecutionProfileResolver executionProfileResolver)	Sets the ExecutionProfileResolver to use.
WriteOptions.WriteOptionsBuilder	fetchSize(int pageSize)	Deprecated.
WriteOptions.WriteOptionsBuilder	idempotent(boolean idempotent)	Set query execution idempotency.
WriteOptions.WriteOptionsBuilder	keyspace(com.datastax.oss.driver.api.core.CqlIdentifier keyspace)	Sets the keyspace to use.
WriteOptions.WriteOptionsBuilder	pageSize(int pageSize)	Sets the query fetch size for ResultSet chunks.
WriteOptions.WriteOptionsBuilder	readTimeout(long readTimeout)	Deprecated.
WriteOptions.WriteOptionsBuilder	readTimeout(long readTimeout, TimeUnit timeUnit)	Deprecated.
WriteOptions.WriteOptionsBuilder	routingKey(ByteBuffer routingKey)	Set query routing key.
WriteOptions.WriteOptionsBuilder	routingKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier routingKeyspace)	Set query routing keyspace.
WriteOptions.WriteOptionsBuilder	serialConsistencyLevel(com.datastax.oss.driver.api.core.ConsistencyLevel consistencyLevel)	Sets the serial ConsistencyLevel to use.
WriteOptions.WriteOptionsBuilder	timeout(Duration timeout)	Sets the request timeout.
WriteOptions.WriteOptionsBuilder	timestamp(long timestamp)	Sets the timestamp of write operations.
WriteOptions.WriteOptionsBuilder	timestamp(Instant timestamp)	Sets the timestamp of write operations.
WriteOptions.WriteOptionsBuilder	tracing(boolean tracing)	Enables statement tracing.
WriteOptions.WriteOptionsBuilder	ttl(int ttl)	Sets the time to live in seconds for write operations.
WriteOptions.WriteOptionsBuilder	ttl(Duration ttl)	Sets the time to live in seconds for write operations.
WriteOptions.WriteOptionsBuilder	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

Field Details

ttl

protected Duration ttl

timestamp

protected Long timestamp

Constructor Details

WriteOptionsBuilder

protected WriteOptionsBuilder()

WriteOptionsBuilder

protected WriteOptionsBuilder(WriteOptions writeOptions)

Method Details

consistencyLevel

public WriteOptions.WriteOptionsBuilder consistencyLevel(com.datastax.oss.driver.api.core.ConsistencyLevel consistencyLevel)

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the ConsistencyLevel to use.

Overrides:

consistencyLevel in class QueryOptions.QueryOptionsBuilder

Parameters:

consistencyLevel - must not be null.

Returns:

this QueryOptions.QueryOptionsBuilder

executionProfile

public WriteOptions.WriteOptionsBuilder executionProfile(String profileName)

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the execution profile to use.

Overrides:

executionProfile in class QueryOptions.QueryOptionsBuilder

Parameters:

profileName - must not be null or empty.

Returns:

this QueryOptions.QueryOptionsBuilder

See Also:

• Statement.setExecutionProfileName(String)

executionProfile

public WriteOptions.WriteOptionsBuilder executionProfile(ExecutionProfileResolver executionProfileResolver)

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the ExecutionProfileResolver to use.

Overrides:

executionProfile in class QueryOptions.QueryOptionsBuilder

Parameters:

executionProfileResolver - must not be null.

Returns:

this QueryOptions.QueryOptionsBuilder

See Also:

• Statement.setExecutionProfile(DriverExecutionProfile)

fetchSize

@Deprecated
public WriteOptions.WriteOptionsBuilder fetchSize(int pageSize)

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 QueryOptions.QueryOptionsBuilder

Parameters:

pageSize - 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 WriteOptions.WriteOptionsBuilder idempotent(boolean idempotent)

Description copied from class: QueryOptions.QueryOptionsBuilder

Set query execution idempotency.

Overrides:

idempotent in class QueryOptions.QueryOptionsBuilder

Parameters:

idempotent - true to mark the query as idempotent.

Returns:

this QueryOptions.QueryOptionsBuilder.

keyspace

public WriteOptions.WriteOptionsBuilder 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 QueryOptions.QueryOptionsBuilder

Parameters:

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

Returns:

this QueryOptions.QueryOptionsBuilder.

pageSize

public WriteOptions.WriteOptionsBuilder 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 QueryOptions.QueryOptionsBuilder

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 WriteOptions.WriteOptionsBuilder 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 QueryOptions.QueryOptionsBuilder

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 WriteOptions.WriteOptionsBuilder 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 QueryOptions.QueryOptionsBuilder

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 WriteOptions.WriteOptionsBuilder routingKeyspace(com.datastax.oss.driver.api.core.CqlIdentifier routingKeyspace)

Description copied from class: QueryOptions.QueryOptionsBuilder

Set query routing keyspace.

Overrides:

routingKeyspace in class QueryOptions.QueryOptionsBuilder

Parameters:

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

Returns:

this QueryOptions.QueryOptionsBuilder.

routingKey

public WriteOptions.WriteOptionsBuilder routingKey(ByteBuffer routingKey)

Description copied from class: QueryOptions.QueryOptionsBuilder

Set query routing key.

Overrides:

routingKey in class QueryOptions.QueryOptionsBuilder

Parameters:

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

Returns:

this QueryOptions.QueryOptionsBuilder

serialConsistencyLevel

public WriteOptions.WriteOptionsBuilder 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 QueryOptions.QueryOptionsBuilder

Parameters:

consistencyLevel - must not be null.

Returns:

this QueryOptions.QueryOptionsBuilder

timeout

public WriteOptions.WriteOptionsBuilder timeout(Duration timeout)

Description copied from class: QueryOptions.QueryOptionsBuilder

Sets the request timeout. Overrides the default timeout.

Overrides:

timeout in class QueryOptions.QueryOptionsBuilder

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)

tracing

public WriteOptions.WriteOptionsBuilder tracing(boolean tracing)

Description copied from class: QueryOptions.QueryOptionsBuilder

Enables statement tracing.

Overrides:

tracing in class QueryOptions.QueryOptionsBuilder

Parameters:

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

Returns:

this QueryOptions.QueryOptionsBuilder

withTracing

public WriteOptions.WriteOptionsBuilder withTracing()

Description copied from class: QueryOptions.QueryOptionsBuilder

Enables statement tracing.

Overrides:

withTracing in class QueryOptions.QueryOptionsBuilder

Returns:

this QueryOptions.QueryOptionsBuilder

ttl

public WriteOptions.WriteOptionsBuilder ttl(int ttl)

Sets the time to live in seconds for write operations.

Parameters:

ttl - the time to live.

Returns:

this WriteOptions.WriteOptionsBuilder

ttl

public WriteOptions.WriteOptionsBuilder ttl(Duration ttl)

Sets the time to live in seconds for write operations.

Parameters:

ttl - the time to live.

Returns:

this WriteOptions.WriteOptionsBuilder

Since:

2.0

timestamp

public WriteOptions.WriteOptionsBuilder timestamp(long timestamp)

Sets the timestamp of write operations.

Parameters:

timestamp - mutation timestamp in microseconds.

Returns:

this WriteOptions.WriteOptionsBuilder

Since:

2.1

See Also:

• TimeUnit.MICROSECONDS

timestamp

public WriteOptions.WriteOptionsBuilder timestamp(Instant timestamp)

Sets the timestamp of write operations.

Parameters:

timestamp - mutation date time.

Returns:

this WriteOptions.WriteOptionsBuilder

Since:

2.1

build

public WriteOptions build()

Builds a new WriteOptions with the configured values.

Overrides:

build in class QueryOptions.QueryOptionsBuilder

Returns:

a new WriteOptions with the configured values