Package org.apache.cassandra.cql3

Class QueryProcessor

java.lang.Object

org.apache.cassandra.cql3.QueryProcessor

All Implemented Interfaces:

QueryHandler

public class QueryProcessor
extends Object
implements QueryHandler

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.cassandra.cql3.QueryHandler

QueryHandler.Prepared

Field Summary

Fields

Modifier and Type	Field	Description
static final CassandraVersion	CQL_VERSION
static final QueryProcessor	instance
static final CQLMetrics	metrics
static final CassandraVersion	NEW_PREPARED_STATEMENT_BEHAVIOUR_SINCE_40
static final int	PRELOAD_PREPARED_STATEMENTS_FETCH_SIZE
static long	PREPARED_STATEMENT_CACHE_SIZE_BYTES

Method Summary

Modifier and Type	Method	Description
static void	clearInternalStatementsCache()	Clear our internal statmeent cache for test purposes.
static void	clearPreparedStatements(boolean memoryOnly)	Clears the prepared statement cache.
static void	clearPreparedStatementsCache()
void	evictPrepared(MD5Digest id)
static UntypedResultSet	execute(String query, ConsistencyLevel cl, Object... values)
static UntypedResultSet	execute(String query, ConsistencyLevel cl, QueryState state, Object... values)
static Future<UntypedResultSet>	executeAsync(InetAddressAndPort address, String query, Object... values)
static UntypedResultSet	executeInternal(String query, Object... values)
static Map<DecoratedKey,List<Row>>	executeInternalRawWithNow(long nowInSec, String query, Object... values)	A special version of executeInternal that takes the time used as "now" for the query in argument.
static UntypedResultSet	executeInternalWithNow(long nowInSec, Dispatcher.RequestTime requestTime, String query, Object... values)	A special version of executeLocally that takes the time used as "now" for the query in argument.
static UntypedResultSet	executeInternalWithNowInSec(String query, long nowInSec, Object... values)
static UntypedResultSet	executeInternalWithPaging(String query, int pageSize, Object... values)
static UntypedResultSet	executeOnceInternal(String query, Object... values)	Same than executeLocally, but to use for queries we know are only executed once so that the created statement object is not cached.
static UntypedResultSet	executeOnceInternalWithNowAndTimestamp(long nowInSec, long timestamp, String query, Object... values)	Execute an internal query with the provided nowInSec and timestamp for the QueryState.
static UntypedResultSet	executeOnceInternalWithPaging(String query, int pageSize, Object... values)	Executes with a non-prepared statement using paging.
static ConcurrentMap<String,QueryHandler.Prepared>	getInternalStatements()
QueryHandler.Prepared	getPrepared(MD5Digest id)
HashMap<MD5Digest,QueryHandler.Prepared>	getPreparedStatements()
static CQLStatement	getStatement(String queryStr, ClientState clientState)
static ResultMessage.Prepared	getStoredPreparedStatement(String queryString, String clientKeyspace)
static QueryState	internalQueryState()
static QueryOptions	makeInternalOptions(CQLStatement prepared, Object[] values)
static QueryOptions	makeInternalOptionsWithNowInSec(CQLStatement prepared, long nowInSec, Object[] values)
CQLStatement	parse(String queryString, QueryState queryState, QueryOptions options)
static QueryHandler.Prepared	parseAndPrepare(String query, ClientState clientState, boolean isInternal)
static QueryHandler.Prepared	parseAndPrepare(String query, ClientState clientState, boolean isInternal, boolean measure)
static CQLStatement.Raw	parseStatement(String queryStr)
static <T extends CQLStatement.Raw> T	parseStatement(String queryStr, Class<T> klass, String type)
static CQLStatement	parseStatement(String queryStr, ClientState clientState)
void	preloadPreparedStatements()
int	preloadPreparedStatements(int pageSize)
ResultMessage.Prepared	prepare(String queryString, ClientState clientState)	This method got slightly out of hand, but this is with best intentions: to allow users to be upgraded from any prior version, and help implementers avoid previous mistakes by clearly separating fully qualified and non-fully qualified statement behaviour.
ResultMessage.Prepared	prepare(String query, ClientState clientState, Map<String,ByteBuffer> customPayload)
static int	preparedStatementsCount()
static QueryHandler.Prepared	prepareInternal(String query)
static UntypedResultSet	process(String query, ConsistencyLevel cl)
static UntypedResultSet	process(String query, ConsistencyLevel cl, List<ByteBuffer> values)
static ResultMessage	process(String queryString, ConsistencyLevel cl, QueryState queryState, Dispatcher.RequestTime requestTime)
ResultMessage	process(CQLStatement statement, QueryState state, QueryOptions options, Map<String,ByteBuffer> customPayload, Dispatcher.RequestTime requestTime)
ResultMessage	process(CQLStatement prepared, QueryState queryState, QueryOptions options, Dispatcher.RequestTime requestTime)
ResultMessage	processBatch(BatchStatement statement, QueryState state, BatchQueryOptions options, Map<String,ByteBuffer> customPayload, Dispatcher.RequestTime requestTime)
ResultMessage	processBatch(BatchStatement batch, QueryState queryState, BatchQueryOptions options, Dispatcher.RequestTime requestTime)
ResultMessage	processPrepared(CQLStatement statement, QueryState state, QueryOptions options, Map<String,ByteBuffer> customPayload, Dispatcher.RequestTime requestTime)
ResultMessage	processPrepared(CQLStatement statement, QueryState queryState, QueryOptions options, Dispatcher.RequestTime requestTime)
ResultMessage	processStatement(CQLStatement statement, QueryState queryState, QueryOptions options, Dispatcher.RequestTime requestTime)
static UntypedResultSet	resultify(String query, PartitionIterator partitions)
static UntypedResultSet	resultify(String query, RowIterator partition)
static ResultMessage.Prepared	storePreparedStatement(String queryString, String keyspace, QueryHandler.Prepared prepared)
boolean	useNewPreparedStatementBehaviour()
static void	validateKey(ByteBuffer key)

Methods inherited from class java.lang.Object

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

Field Details

CQL_VERSION

public static final CassandraVersion CQL_VERSION

NEW_PREPARED_STATEMENT_BEHAVIOUR_SINCE_40

public static final CassandraVersion NEW_PREPARED_STATEMENT_BEHAVIOUR_SINCE_40

instance

public static final QueryProcessor instance

metrics

public static final CQLMetrics metrics

PRELOAD_PREPARED_STATEMENTS_FETCH_SIZE

public static final int PRELOAD_PREPARED_STATEMENTS_FETCH_SIZE

See Also:

• Constant Field Values

PREPARED_STATEMENT_CACHE_SIZE_BYTES

public static long PREPARED_STATEMENT_CACHE_SIZE_BYTES

Method Details

preparedStatementsCount

public static int preparedStatementsCount()

preloadPreparedStatements

public void preloadPreparedStatements()

preloadPreparedStatements

public int preloadPreparedStatements(int pageSize)

clearPreparedStatements

public static void clearPreparedStatements(boolean memoryOnly)

Clears the prepared statement cache.

Parameters:

memoryOnly - true if only the in memory caches must be cleared, false otherwise.

getInternalStatements

public static ConcurrentMap<String,QueryHandler.Prepared> getInternalStatements()

internalQueryState

public static QueryState internalQueryState()

evictPrepared

public void evictPrepared(MD5Digest id)

getPreparedStatements

public HashMap<MD5Digest,QueryHandler.Prepared> getPreparedStatements()

getPrepared

public QueryHandler.Prepared getPrepared(MD5Digest id)

Specified by:

getPrepared in interface QueryHandler

validateKey

public static void validateKey(ByteBuffer key)
                        throws InvalidRequestException

Throws:

InvalidRequestException

processStatement

public ResultMessage processStatement(CQLStatement statement,
 QueryState queryState,
 QueryOptions options,
 Dispatcher.RequestTime requestTime)
                               throws RequestExecutionException,
RequestValidationException

Throws:

RequestExecutionException

RequestValidationException

process

public static ResultMessage process(String queryString,
 ConsistencyLevel cl,
 QueryState queryState,
 Dispatcher.RequestTime requestTime)
                             throws RequestExecutionException,
RequestValidationException

Throws:

RequestExecutionException

RequestValidationException

parse

public CQLStatement parse(String queryString,
 QueryState queryState,
 QueryOptions options)

Specified by:

parse in interface QueryHandler

process

public ResultMessage process(CQLStatement statement,
 QueryState state,
 QueryOptions options,
 Map<String,ByteBuffer> customPayload,
 Dispatcher.RequestTime requestTime)
                      throws RequestExecutionException,
RequestValidationException

Specified by:

process in interface QueryHandler

Throws:

RequestExecutionException

RequestValidationException

process

public ResultMessage process(CQLStatement prepared,
 QueryState queryState,
 QueryOptions options,
 Dispatcher.RequestTime requestTime)
                      throws RequestExecutionException,
RequestValidationException

Throws:

RequestExecutionException

RequestValidationException

parseStatement

public static CQLStatement parseStatement(String queryStr,
 ClientState clientState)
                                   throws RequestValidationException

Throws:

RequestValidationException

process

public static UntypedResultSet process(String query,
 ConsistencyLevel cl)
                                throws RequestExecutionException

Throws:

RequestExecutionException

process

public static UntypedResultSet process(String query,
 ConsistencyLevel cl,
 List<ByteBuffer> values)
                                throws RequestExecutionException

Throws:

RequestExecutionException

makeInternalOptions

public static QueryOptions makeInternalOptions(CQLStatement prepared,
 Object[] values)

makeInternalOptionsWithNowInSec

public static QueryOptions makeInternalOptionsWithNowInSec(CQLStatement prepared,
 long nowInSec,
 Object[] values)

prepareInternal

public static QueryHandler.Prepared prepareInternal(String query)
                                             throws RequestValidationException

Throws:

RequestValidationException

parseAndPrepare

public static QueryHandler.Prepared parseAndPrepare(String query,
 ClientState clientState,
 boolean isInternal)
                                             throws RequestValidationException

Throws:

RequestValidationException

parseAndPrepare

public static QueryHandler.Prepared parseAndPrepare(String query,
 ClientState clientState,
 boolean isInternal,
 boolean measure)
                                             throws RequestValidationException

Throws:

RequestValidationException

executeInternal

public static UntypedResultSet executeInternal(String query,
 Object... values)

executeAsync

public static Future<UntypedResultSet> executeAsync(InetAddressAndPort address,
 String query,
 Object... values)

execute

public static UntypedResultSet execute(String query,
 ConsistencyLevel cl,
 Object... values)
                                throws RequestExecutionException

Throws:

RequestExecutionException

executeInternalWithNowInSec

public static UntypedResultSet executeInternalWithNowInSec(String query,
 long nowInSec,
 Object... values)

execute

public static UntypedResultSet execute(String query,
 ConsistencyLevel cl,
 QueryState state,
 Object... values)
                                throws RequestExecutionException

Throws:

RequestExecutionException

executeInternalWithPaging

public static UntypedResultSet executeInternalWithPaging(String query,
 int pageSize,
 Object... values)

executeOnceInternalWithPaging

public static UntypedResultSet executeOnceInternalWithPaging(String query,
 int pageSize,
 Object... values)

Executes with a non-prepared statement using paging. Generally executeInternalWithPaging(String, int, Object...) should be used instead of this, but this may be used in niche cases like SystemKeyspace.loadPreparedStatement(MD5Digest, SystemKeyspace.TriFunction) where prepared statements are being loaded into preparedStatements so it doesn't make sense to prepare a statement in this context.

executeOnceInternal

public static UntypedResultSet executeOnceInternal(String query,
 Object... values)

Same than executeLocally, but to use for queries we know are only executed once so that the created statement object is not cached.

executeOnceInternalWithNowAndTimestamp

public static UntypedResultSet executeOnceInternalWithNowAndTimestamp(long nowInSec,
 long timestamp,
 String query,
 Object... values)

Execute an internal query with the provided nowInSec and timestamp for the QueryState.

This method ensure that the statement will not be cached in the prepared statement cache.

executeInternalWithNow

public static UntypedResultSet executeInternalWithNow(long nowInSec,
 Dispatcher.RequestTime requestTime,
 String query,
 Object... values)

A special version of executeLocally that takes the time used as "now" for the query in argument. Note that this only make sense for Selects so this only accept SELECT statements and is only useful in rare cases.

executeInternalRawWithNow

public static Map<DecoratedKey,List<Row>> executeInternalRawWithNow(long nowInSec,
 String query,
 Object... values)

A special version of executeInternal that takes the time used as "now" for the query in argument. Note that this only make sense for Selects so this only accept SELECT statements and is only useful in rare cases.

resultify

public static UntypedResultSet resultify(String query,
 RowIterator partition)

resultify

public static UntypedResultSet resultify(String query,
 PartitionIterator partitions)

prepare

public ResultMessage.Prepared prepare(String query,
 ClientState clientState,
 Map<String,ByteBuffer> customPayload)
                               throws RequestValidationException

Specified by:

prepare in interface QueryHandler

Throws:

RequestValidationException

useNewPreparedStatementBehaviour

public boolean useNewPreparedStatementBehaviour()

prepare

public ResultMessage.Prepared prepare(String queryString,
 ClientState clientState)

This method got slightly out of hand, but this is with best intentions: to allow users to be upgraded from any prior version, and help implementers avoid previous mistakes by clearly separating fully qualified and non-fully qualified statement behaviour.

Basically we need to handle 4 different hashes here; 1. fully qualified query with keyspace 2. fully qualified query without keyspace 3. unqualified query with keyspace 4. unqualified query without keyspace

The correct combination to return is 2/3 - the problem is during upgrades (assuming upgrading from < 4.0.2) - Existing clients have hash 1 or 3 - Query prepared on a post-4.0.2 instance needs to return hash 1/3 to be able to execute it on a pre-4.0.2 instance - This is handled by the useNewPreparedStatementBehaviour flag - while there still are pre-4.0.2 instances in the cluster we always return hash 1/3 - Once fully upgraded we start returning hash 2/3, this will cause a prepared statement id mismatch for existing clients, but they will be able to continue using the old prepared statement id after that exception since we store the query both with and without keyspace.

getStoredPreparedStatement

public static ResultMessage.Prepared getStoredPreparedStatement(String queryString,
 String clientKeyspace)
                                                         throws InvalidRequestException

Throws:

InvalidRequestException

storePreparedStatement

public static ResultMessage.Prepared storePreparedStatement(String queryString,
 String keyspace,
 QueryHandler.Prepared prepared)
                                                     throws InvalidRequestException

Throws:

InvalidRequestException

processPrepared

public ResultMessage processPrepared(CQLStatement statement,
 QueryState state,
 QueryOptions options,
 Map<String,ByteBuffer> customPayload,
 Dispatcher.RequestTime requestTime)
                              throws RequestExecutionException,
RequestValidationException

Specified by:

processPrepared in interface QueryHandler

Throws:

RequestExecutionException

RequestValidationException

processPrepared

public ResultMessage processPrepared(CQLStatement statement,
 QueryState queryState,
 QueryOptions options,
 Dispatcher.RequestTime requestTime)
                              throws RequestExecutionException,
RequestValidationException

Throws:

RequestExecutionException

RequestValidationException

processBatch

public ResultMessage processBatch(BatchStatement statement,
 QueryState state,
 BatchQueryOptions options,
 Map<String,ByteBuffer> customPayload,
 Dispatcher.RequestTime requestTime)
                           throws RequestExecutionException,
RequestValidationException

Specified by:

processBatch in interface QueryHandler

Throws:

RequestExecutionException

RequestValidationException

processBatch

public ResultMessage processBatch(BatchStatement batch,
 QueryState queryState,
 BatchQueryOptions options,
 Dispatcher.RequestTime requestTime)
                           throws RequestExecutionException,
RequestValidationException

Throws:

RequestExecutionException

RequestValidationException

getStatement

public static CQLStatement getStatement(String queryStr,
 ClientState clientState)
                                 throws RequestValidationException

Throws:

RequestValidationException

parseStatement

public static <T extends CQLStatement.Raw> T parseStatement(String queryStr,
 Class<T> klass,
 String type)
                                                     throws SyntaxException

Throws:

SyntaxException

parseStatement

public static CQLStatement.Raw parseStatement(String queryStr)
                                       throws SyntaxException

Throws:

SyntaxException

clearInternalStatementsCache

public static void clearInternalStatementsCache()

Clear our internal statmeent cache for test purposes.

clearPreparedStatementsCache

public static void clearPreparedStatementsCache()