Package org.apache.cassandra.cql3.statements

Class BatchStatement

java.lang.Object

org.apache.cassandra.cql3.statements.BatchStatement

All Implemented Interfaces:

CQLStatement

public class BatchStatement
extends Object
implements CQLStatement

A BATCH statement parsed from a CQL query.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BatchStatement.Parsed
static enum	BatchStatement.Type

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

CQLStatement.Raw, CQLStatement.SingleKeyspaceCqlStatement

Field Summary

Fields

Modifier and Type	Field	Description
static final BatchMetrics	metrics
final BatchStatement.Type	type

Constructor Summary

Constructors

Constructor	Description
BatchStatement(BatchStatement.Type type, VariableSpecifications bindVariables, List<ModificationStatement> statements, Attributes attrs)	Creates a new BatchStatement.

Method Summary

Modifier and Type	Method	Description
void	authorize(ClientState state)	Perform any access verification necessary for the statement.
ResultMessage	execute(QueryState queryState, BatchQueryOptions options, Dispatcher.RequestTime requestTime)
ResultMessage	execute(QueryState queryState, QueryOptions options, Dispatcher.RequestTime requestTime)	Execute the statement and return the resulting result or null if there is no result.
ResultMessage	executeLocally(QueryState queryState, QueryOptions options)	Variant of execute used for internal query against the system tables, and thus only query the local node.
AuditLogContext	getAuditLogContext()	Provides the context needed for audit logging statements.
List<ColumnSpecification>	getBindVariables()	Returns all bind variables for the statement
Iterable<Function>	getFunctions()	Return an Iterable over all of the functions (both native and user-defined) used by any component of the statement
List<? extends IMutation>	getMutations(ClientState state, BatchQueryOptions options, boolean local, long batchTimestamp, long nowInSeconds, Dispatcher.RequestTime requestTime)
short[]	getPartitionKeyBindVariableIndexes()	Returns an array with the same length as the number of partition key columns for the table corresponding to table.
List<ModificationStatement>	getStatements()
boolean	hasConditions()	Whether or not this CQL Statement has LWT conditions
String	toString()
void	validate()
void	validate(ClientState state)	Perform additional validation required by the statment.

Methods inherited from class java.lang.Object

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

Field Details

type

public final BatchStatement.Type type

metrics

public static final BatchMetrics metrics

Constructor Details

BatchStatement

public BatchStatement(BatchStatement.Type type,
 VariableSpecifications bindVariables,
 List<ModificationStatement> statements,
 Attributes attrs)

Creates a new BatchStatement.

Parameters:

type - type of the batch

statements - the list of statements in the batch

attrs - additional attributes for statement (CL, timestamp, timeToLive)

Method Details

getBindVariables

public List<ColumnSpecification> getBindVariables()

Description copied from interface: CQLStatement

Returns all bind variables for the statement

Specified by:

getBindVariables in interface CQLStatement

getPartitionKeyBindVariableIndexes

public short[] getPartitionKeyBindVariableIndexes()

Description copied from interface: CQLStatement

Returns an array with the same length as the number of partition key columns for the table corresponding to table. Each short in the array represents the bind index of the marker that holds the value for that partition key column. If there are no bind markers for any of the partition key columns, null is returned.

Specified by:

getPartitionKeyBindVariableIndexes in interface CQLStatement

getFunctions

public Iterable<Function> getFunctions()

Description copied from interface: CQLStatement

Return an Iterable over all of the functions (both native and user-defined) used by any component of the statement

Specified by:

getFunctions in interface CQLStatement

Returns:

functions all functions found (may contain duplicates)

authorize

public void authorize(ClientState state)
               throws InvalidRequestException,
UnauthorizedException

Description copied from interface: CQLStatement

Perform any access verification necessary for the statement.

Specified by:

authorize in interface CQLStatement

Parameters:

state - the current client state

Throws:

InvalidRequestException

UnauthorizedException

validate

public void validate()
              throws InvalidRequestException

Throws:

InvalidRequestException

validate

public void validate(ClientState state)
              throws InvalidRequestException

Description copied from interface: CQLStatement

Perform additional validation required by the statment. To be overriden by subclasses if needed.

Specified by:

validate in interface CQLStatement

Parameters:

state - the current client state

Throws:

InvalidRequestException

getStatements

public List<ModificationStatement> getStatements()

getMutations

public List<? extends IMutation> getMutations(ClientState state,
 BatchQueryOptions options,
 boolean local,
 long batchTimestamp,
 long nowInSeconds,
 Dispatcher.RequestTime requestTime)

execute

public ResultMessage execute(QueryState queryState,
 QueryOptions options,
 Dispatcher.RequestTime requestTime)

Description copied from interface: CQLStatement

Execute the statement and return the resulting result or null if there is no result.

Specified by:

execute in interface CQLStatement

Parameters:

queryState - the current query state

options - options for this query (consistency, variables, pageSize, ...)

requestTime - request enqueue / and start times;

execute

public ResultMessage execute(QueryState queryState,
 BatchQueryOptions options,
 Dispatcher.RequestTime requestTime)

hasConditions

public boolean hasConditions()

Description copied from interface: CQLStatement

Whether or not this CQL Statement has LWT conditions

Specified by:

hasConditions in interface CQLStatement

executeLocally

public ResultMessage executeLocally(QueryState queryState,
 QueryOptions options)
                             throws RequestValidationException,
RequestExecutionException

Description copied from interface: CQLStatement

Variant of execute used for internal query against the system tables, and thus only query the local node.

Specified by:

executeLocally in interface CQLStatement

Parameters:

queryState - the current query state

Throws:

RequestValidationException

RequestExecutionException

toString

public String toString()

Overrides:

toString in class Object

getAuditLogContext

public AuditLogContext getAuditLogContext()

Description copied from interface: CQLStatement

Provides the context needed for audit logging statements.

Specified by:

getAuditLogContext in interface CQLStatement