Package org.springframework.data.cassandra.core

Class DeleteOptions.DeleteOptionsBuilder

java.lang.Object

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

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

org.springframework.data.cassandra.core.DeleteOptions.DeleteOptionsBuilder

Enclosing class:

DeleteOptions

public static class DeleteOptions.DeleteOptionsBuilder
extends WriteOptions.WriteOptionsBuilder

Builder for DeleteOptions.

Author:

Mark Paluch

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

Description copied from class: QueryOptions.QueryOptionsBuilder

Enables statement tracing.

Overrides:

withTracing in class WriteOptions.WriteOptionsBuilder

Returns:

this QueryOptions.QueryOptionsBuilder

ttl

public DeleteOptions.DeleteOptionsBuilder 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 DeleteOptions.DeleteOptionsBuilder 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 DeleteOptions.DeleteOptionsBuilder 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 DeleteOptions.DeleteOptionsBuilder withIfExists()

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

Returns:

this DeleteOptions.DeleteOptionsBuilder

ifExists

public DeleteOptions.DeleteOptionsBuilder 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 DeleteOptions.DeleteOptionsBuilder

ifCondition

public DeleteOptions.DeleteOptionsBuilder 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 DeleteOptions.DeleteOptionsBuilder

ifCondition

public DeleteOptions.DeleteOptionsBuilder 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 deletes, must not be null.

Returns:

this DeleteOptions.DeleteOptionsBuilder

build

public DeleteOptions build()

Builds a new DeleteOptions with the configured values.

Overrides:

build in class WriteOptions.WriteOptionsBuilder

Returns:

a new DeleteOptions with the configured values