com.datastax.driver.core

Class QueryOptions

java.lang.Object

com.datastax.driver.core.QueryOptions

public class QueryOptions
extends Object

Options related to defaults for individual queries.

Field Summary

Fields

Modifier and Type	Field and Description
static ConsistencyLevel	DEFAULT_CONSISTENCY_LEVEL The default consistency level for queries: ConsistencyLevel.ONE.
static int	DEFAULT_FETCH_SIZE The default fetch size for SELECT queries: 5000.
static boolean	DEFAULT_IDEMPOTENCE The default value for getDefaultIdempotence(): false.
static ConsistencyLevel	DEFAULT_SERIAL_CONSISTENCY_LEVEL The default serial consistency level for conditional updates: ConsistencyLevel.SERIAL.

Constructor Summary

Constructors

Constructor and Description
QueryOptions() Creates a new QueryOptions instance using the DEFAULT_CONSISTENCY_LEVEL, DEFAULT_SERIAL_CONSISTENCY_LEVEL and DEFAULT_FETCH_SIZE.

Method Summary

Modifier and Type	Method and Description
ConsistencyLevel	getConsistencyLevel() The default consistency level used by queries.
boolean	getDefaultIdempotence() The default idempotence for queries.
int	getFetchSize() The default fetch size used by queries.
ConsistencyLevel	getSerialConsistencyLevel() The default serial consistency level used by queries.
QueryOptions	setConsistencyLevel(ConsistencyLevel consistencyLevel) Sets the default consistency level to use for queries.
QueryOptions	setDefaultIdempotence(boolean defaultIdempotence) Sets the default idempotence for queries.
QueryOptions	setFetchSize(int fetchSize) Sets the default fetch size to use for SELECT queries.
QueryOptions	setSerialConsistencyLevel(ConsistencyLevel serialConsistencyLevel) Sets the default serial consistency level to use for queries.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_CONSISTENCY_LEVEL

public static final ConsistencyLevel DEFAULT_CONSISTENCY_LEVEL

The default consistency level for queries: ConsistencyLevel.ONE.

DEFAULT_SERIAL_CONSISTENCY_LEVEL

public static final ConsistencyLevel DEFAULT_SERIAL_CONSISTENCY_LEVEL

The default serial consistency level for conditional updates: ConsistencyLevel.SERIAL.

DEFAULT_FETCH_SIZE

public static final int DEFAULT_FETCH_SIZE

The default fetch size for SELECT queries: 5000.

See Also:

Constant Field Values

DEFAULT_IDEMPOTENCE

public static final boolean DEFAULT_IDEMPOTENCE

The default value for getDefaultIdempotence(): false.

See Also:

Constant Field Values

Constructor Detail

QueryOptions

public QueryOptions()

Creates a new QueryOptions instance using the DEFAULT_CONSISTENCY_LEVEL, DEFAULT_SERIAL_CONSISTENCY_LEVEL and DEFAULT_FETCH_SIZE.

Method Detail

setConsistencyLevel

public QueryOptions setConsistencyLevel(ConsistencyLevel consistencyLevel)

Sets the default consistency level to use for queries.

The consistency level set through this method will be use for queries that don't explicitly have a consistency level, i.e. when Statement.getConsistencyLevel() returns null.

Parameters:

consistencyLevel - the new consistency level to set as default.

Returns:

this QueryOptions instance.

getConsistencyLevel

public ConsistencyLevel getConsistencyLevel()

The default consistency level used by queries.

Returns:

the default consistency level used by queries.

setSerialConsistencyLevel

public QueryOptions setSerialConsistencyLevel(ConsistencyLevel serialConsistencyLevel)

Sets the default serial consistency level to use for queries.

The serial consistency level set through this method will be use for queries that don't explicitly have a serial consistency level, i.e. when Statement.getSerialConsistencyLevel() returns null.

Parameters:

serialConsistencyLevel - the new serial consistency level to set as default.

Returns:

this QueryOptions instance.

getSerialConsistencyLevel

public ConsistencyLevel getSerialConsistencyLevel()

The default serial consistency level used by queries.

Returns:

the default serial consistency level used by queries.

setFetchSize

public QueryOptions setFetchSize(int fetchSize)

Sets the default fetch size to use for SELECT queries.

The fetch size set through this method will be use for queries that don't explicitly have a fetch size, i.e. when Statement.getFetchSize() is less or equal to 0.

Parameters:

fetchSize - the new fetch size to set as default. It must be strictly positive but you can use Integer.MAX_VALUE to disable paging.

Returns:

this QueryOptions instance.

Throws:

IllegalArgumentException - if fetchSize &lte; 0.

UnsupportedFeatureException - if version 1 of the native protocol is in use and fetchSize != Integer.MAX_VALUE as paging is not supported by version 1 of the protocol. See Cluster.Builder.withProtocolVersion(com.datastax.driver.core.ProtocolVersion) for more details on protocol versions.

getFetchSize

public int getFetchSize()

The default fetch size used by queries.

Returns:

the default fetch size used by queries.

setDefaultIdempotence

public QueryOptions setDefaultIdempotence(boolean defaultIdempotence)

Sets the default idempotence for queries.

This will be used for statements for which Statement.isIdempotent() returns null.

Parameters:

defaultIdempotence - the new value to set as default idempotence.

Returns:

this QueryOptions instance.

getDefaultIdempotence

public boolean getDefaultIdempotence()

The default idempotence for queries.

It defaults to DEFAULT_IDEMPOTENCE.

Returns:

the default idempotence for queries.