org.springframework.data.cassandra.core.cql

Class QueryOptions.QueryOptionsBuilder

java.lang.Object

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

Direct Known Subclasses:

WriteOptions.WriteOptionsBuilder

Enclosing class:

QueryOptions

public static class QueryOptions.QueryOptionsBuilder
extends Object

Builder for QueryOptions.

Since:

1.5

Author:

Mark Paluch

Field Summary

Fields

Modifier and Type	Field and Description
protected com.datastax.driver.core.ConsistencyLevel	consistencyLevel
protected Integer	fetchSize
protected Duration	readTimeout
protected com.datastax.driver.core.policies.RetryPolicy	retryPolicy
protected Boolean	tracing

Method Summary

Modifier and Type	Method and Description
QueryOptions	build() Builds a new QueryOptions with the configured values.
QueryOptions.QueryOptionsBuilder	consistencyLevel(com.datastax.driver.core.ConsistencyLevel consistencyLevel) Sets the ConsistencyLevel to use.
QueryOptions.QueryOptionsBuilder	fetchSize(int fetchSize) Sets the query fetch size for ResultSet chunks.
QueryOptions.QueryOptionsBuilder	readTimeout(Duration readTimeout) Sets the read timeout.
QueryOptions.QueryOptionsBuilder	readTimeout(long readTimeout) Sets the read timeout in milliseconds.
QueryOptions.QueryOptionsBuilder	readTimeout(long readTimeout, TimeUnit timeUnit) Deprecated. since 2.0, use readTimeout(Duration).
QueryOptions.QueryOptionsBuilder	retryPolicy(com.datastax.driver.core.policies.RetryPolicy retryPolicy) Sets the driver RetryPolicy to use.
QueryOptions.QueryOptionsBuilder	tracing(boolean tracing) Enables statement tracing.
QueryOptions.QueryOptionsBuilder	withTracing() Enables statement tracing.

Methods inherited from class java.lang.Object

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

Field Detail

tracing

@Nullable
protected Boolean tracing

consistencyLevel

@Nullable
protected com.datastax.driver.core.ConsistencyLevel consistencyLevel

readTimeout

protected Duration readTimeout

fetchSize

@Nullable
protected Integer fetchSize

retryPolicy

@Nullable
protected com.datastax.driver.core.policies.RetryPolicy retryPolicy

Method Detail

consistencyLevel

public QueryOptions.QueryOptionsBuilder consistencyLevel(com.datastax.driver.core.ConsistencyLevel consistencyLevel)

Sets the ConsistencyLevel to use.

Parameters:

consistencyLevel - must not be null.

Returns:

this QueryOptions.QueryOptionsBuilder

retryPolicy

public QueryOptions.QueryOptionsBuilder retryPolicy(com.datastax.driver.core.policies.RetryPolicy retryPolicy)

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

Parameters:

retryPolicy - must not be null.

Returns:

this QueryOptions.QueryOptionsBuilder

fetchSize

public QueryOptions.QueryOptionsBuilder fetchSize(int fetchSize)

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.

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 QueryOptions.QueryOptionsBuilder readTimeout(long readTimeout)

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

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 QueryOptions.QueryOptionsBuilder readTimeout(long readTimeout,
                                                                TimeUnit timeUnit)

Deprecated. since 2.0, use readTimeout(Duration).

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

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 QueryOptions.QueryOptionsBuilder readTimeout(Duration readTimeout)

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

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

Since:

2.0

See Also:

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

tracing

public QueryOptions.QueryOptionsBuilder tracing(boolean tracing)

Enables statement tracing.

Parameters:

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

Returns:

this QueryOptions.QueryOptionsBuilder

withTracing

public QueryOptions.QueryOptionsBuilder withTracing()

Enables statement tracing.

Returns:

this QueryOptions.QueryOptionsBuilder

build

public QueryOptions build()

Builds a new QueryOptions with the configured values.

Returns:

a new QueryOptions with the configured values