/*
* Copyright (C) 2012 DataStax Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.datastax.driver.core;
import com.datastax.driver.core.exceptions.UnsupportedFeatureException;
/**
* Options related to defaults for individual queries.
*/
public class QueryOptions {
/**
* The default consistency level for queries: {@code ConsistencyLevel.ONE}.
*/
public static final ConsistencyLevel DEFAULT_CONSISTENCY_LEVEL = ConsistencyLevel.ONE;
/**
* The default serial consistency level for conditional updates: {@code ConsistencyLevel.SERIAL}.
*/
public static final ConsistencyLevel DEFAULT_SERIAL_CONSISTENCY_LEVEL = ConsistencyLevel.SERIAL;
/**
* The default fetch size for SELECT queries: 5000.
*/
public static final int DEFAULT_FETCH_SIZE = 5000;
private volatile ConsistencyLevel consistency = DEFAULT_CONSISTENCY_LEVEL;
private volatile ConsistencyLevel serialConsistency = DEFAULT_SERIAL_CONSISTENCY_LEVEL;
private volatile int fetchSize = DEFAULT_FETCH_SIZE;
private volatile Cluster.Manager manager;
/**
* Creates a new {@code QueryOptions} instance using the {@code DEFAULT_CONSISTENCY_LEVEL},
* {@code DEFAULT_SERIAL_CONSISTENCY_LEVEL} and {@code DEFAULT_FETCH_SIZE}.
*/
public QueryOptions() {}
void register(Cluster.Manager manager) {
this.manager = manager;
}
/**
* Sets the default consistency level to use for queries.
* <p>
* The consistency level set through this method will be use for queries
* that don't explicitely have a consistency level, i.e. when {@link Statement#getConsistencyLevel}
* returns {@code null}.
*
* @param consistencyLevel the new consistency level to set as default.
* @return this {@code QueryOptions} instance.
*/
public QueryOptions setConsistencyLevel(ConsistencyLevel consistencyLevel) {
this.consistency = consistencyLevel;
return this;
}
/**
* The default consistency level used by queries.
*
* @return the default consistency level used by queries.
*/
public ConsistencyLevel getConsistencyLevel() {
return consistency;
}
/**
* Sets the default serial consistency level to use for queries.
* <p>
* The serial consistency level set through this method will be use for queries
* that don't explicitely have a serial consistency level, i.e. when {@link Statement#getSerialConsistencyLevel}
* returns {@code null}.
*
* @param serialConsistencyLevel the new serial consistency level to set as default.
* @return this {@code QueryOptions} instance.
*/
public QueryOptions setSerialConsistencyLevel(ConsistencyLevel serialConsistencyLevel) {
this.serialConsistency = serialConsistencyLevel;
return this;
}
/**
* The default serial consistency level used by queries.
*
* @return the default serial consistency level used by queries.
*/
public ConsistencyLevel getSerialConsistencyLevel() {
return serialConsistency;
}
/**
* Sets the default fetch size to use for SELECT queries.
* <p>
* The fetch size set through this method will be use for queries
* that don't explicitely have a fetch size, i.e. when {@link Statement#getFetchSize}
* is less or equal to 0.
*
* @param fetchSize the new fetch size to set as default. It must be
* strictly positive but you can use {@code Integer.MAX_VALUE} to disable
* paging.
* @return this {@code QueryOptions} instance.
*
* @throws IllegalArgumentException if {@code fetchSize <e; 0}.
* @throws UnsupportedFeatureException if version 1 of the native protocol is in
* use and {@code fetchSize != Integer.MAX_VALUE} as paging is not supported by
* version 1 of the protocol. See {@link Cluster.Builder#withProtocolVersion}
* for more details on protocol versions.
*/
public QueryOptions setFetchSize(int fetchSize) {
if (fetchSize <= 0)
throw new IllegalArgumentException("Invalid fetchSize, should be > 0, got " + fetchSize);
int version = manager == null ? -1 : manager.protocolVersion();
if (fetchSize != Integer.MAX_VALUE && version == 1)
throw new UnsupportedFeatureException("Paging is not supported");
this.fetchSize = fetchSize;
return this;
}
/**
* The default fetch size used by queries.
*
* @return the default fetch size used by queries.
*/
public int getFetchSize() {
return fetchSize;
}
}