Package org.apache.cassandra.cql3.statements

Class ModificationStatement

java.lang.Object

org.apache.cassandra.cql3.statements.ModificationStatement

All Implemented Interfaces:

CQLStatement, CQLStatement.SingleKeyspaceCqlStatement

Direct Known Subclasses:

DeleteStatement, UpdateStatement

public abstract class ModificationStatement
extends Object
implements CQLStatement.SingleKeyspaceCqlStatement

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ModificationStatement.Parsed

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

CQLStatement.Raw, CQLStatement.SingleKeyspaceCqlStatement

Field Summary

Fields

Modifier and Type	Field	Description
protected final VariableSpecifications	bindVariables
static final ColumnIdentifier	CAS_RESULT_COLUMN
static final String	CUSTOM_EXPRESSIONS_NOT_ALLOWED
protected static final org.slf4j.Logger	logger
final TableMetadata	metadata
protected final StatementType	type

Constructor Summary

Constructors

Constructor	Description
ModificationStatement(StatementType type, VariableSpecifications bindVariables, TableMetadata metadata, Operations operations, StatementRestrictions restrictions, Conditions conditions, Attributes attrs)

Method Summary

Modifier and Type	Method	Description
void	addConditions(Clustering<?> clustering, CQL3CasRequest request, QueryOptions options)
void	addFunctionsTo(List<Function> functions)
abstract void	addUpdateForKey(PartitionUpdate.Builder updateBuilder, Clustering<?> clustering, UpdateParameters params)
abstract void	addUpdateForKey(PartitionUpdate.Builder updateBuilder, Slice slice, UpdateParameters params)
Iterable<Operation>	allOperations()
static boolean	appliesOnlyToStaticColumns(Operations operation, Conditions conditions)	Checks that the specified operations and conditions only apply to static columns.
void	authorize(ClientState state)	Perform any access verification necessary for the statement.
List<ByteBuffer>	buildPartitionKeyNames(QueryOptions options, ClientState state)
RegularAndStaticColumns	conditionColumns()
NavigableSet<Clustering<?>>	createClustering(QueryOptions options, ClientState state)
Slices	createSlices(QueryOptions options)
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	executeInternalWithCondition(QueryState state, QueryOptions options)
ResultMessage	executeInternalWithoutCondition(QueryState queryState, QueryOptions options, Dispatcher.RequestTime requestTime)
ResultMessage	executeLocally(QueryState queryState, QueryOptions options)	Variant of execute used for internal query against the system tables, and thus only query the local node.
List<ColumnSpecification>	getBindVariables()	Returns all bind variables for the statement
Iterable<ColumnMetadata>	getColumnsWithConditions()
Iterable<Function>	getFunctions()	Return an Iterable over all of the functions (both native and user-defined) used by any component of the statement
short[]	getPartitionKeyBindVariableIndexes()	Returns an array with the same length as the number of partition key columns for the table corresponding to table.
List<Operation>	getRegularOperations()
StatementRestrictions	getRestrictions()
List<Operation>	getStaticOperations()
long	getTimestamp(long now, QueryOptions options)
int	getTimeToLive(QueryOptions options)
boolean	hasConditions()	Whether or not this CQL Statement has LWT conditions
boolean	hasIfExistCondition()
boolean	hasIfNotExistCondition()
boolean	hasSlices()
boolean	isCounter()
boolean	isTimestampSet()
boolean	isView()
boolean	isVirtual()
String	keyspace()
TableMetadata	metadata()
boolean	requiresRead()
String	table()
static Slices	toSlices(ClusteringComparator comparator, SortedSet<ClusteringBound<?>> startBounds, SortedSet<ClusteringBound<?>> endBounds)
static Slices	toSlices(TableMetadata metadata, SortedSet<ClusteringBound<?>> startBounds, SortedSet<ClusteringBound<?>> endBounds)
RegularAndStaticColumns	updatedColumns()
boolean	updatesRegularRows()
boolean	updatesStaticRow()
void	validate(ClientState state)	Perform additional validation required by the statment.
void	validateDiskUsage(QueryOptions options, ClientState state)
void	validateTimestamp(QueryState queryState, QueryOptions options)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.cassandra.cql3.CQLStatement

getAuditLogContext

Field Details

logger

protected static final org.slf4j.Logger logger

CUSTOM_EXPRESSIONS_NOT_ALLOWED

public static final String CUSTOM_EXPRESSIONS_NOT_ALLOWED

See Also:

• Constant Field Values

CAS_RESULT_COLUMN

public static final ColumnIdentifier CAS_RESULT_COLUMN

type

protected final StatementType type

bindVariables

protected final VariableSpecifications bindVariables

metadata

public final TableMetadata metadata

Constructor Details

ModificationStatement

public ModificationStatement(StatementType type,
 VariableSpecifications bindVariables,
 TableMetadata metadata,
 Operations operations,
 StatementRestrictions restrictions,
 Conditions conditions,
 Attributes attrs)

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)

addFunctionsTo

public void addFunctionsTo(List<Function> functions)

metadata

public TableMetadata metadata()

getRestrictions

public StatementRestrictions getRestrictions()

addUpdateForKey

public abstract void addUpdateForKey(PartitionUpdate.Builder updateBuilder,
 Clustering<?> clustering,
 UpdateParameters params)

addUpdateForKey

public abstract void addUpdateForKey(PartitionUpdate.Builder updateBuilder,
 Slice slice,
 UpdateParameters params)

keyspace

public String keyspace()

Specified by:

keyspace in interface CQLStatement.SingleKeyspaceCqlStatement

table

public String table()

isCounter

public boolean isCounter()

isView

public boolean isView()

isVirtual

public boolean isVirtual()

getTimestamp

public long getTimestamp(long now,
 QueryOptions options)
                  throws InvalidRequestException

Throws:

InvalidRequestException

isTimestampSet

public boolean isTimestampSet()

getTimeToLive

public int getTimeToLive(QueryOptions options)
                  throws InvalidRequestException

Throws:

InvalidRequestException

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(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

validateDiskUsage

public void validateDiskUsage(QueryOptions options,
 ClientState state)

validateTimestamp

public void validateTimestamp(QueryState queryState,
 QueryOptions options)

updatedColumns

public RegularAndStaticColumns updatedColumns()

conditionColumns

public RegularAndStaticColumns conditionColumns()

updatesRegularRows

public boolean updatesRegularRows()

updatesStaticRow

public boolean updatesStaticRow()

getRegularOperations

public List<Operation> getRegularOperations()

getStaticOperations

public List<Operation> getStaticOperations()

allOperations

public Iterable<Operation> allOperations()

getColumnsWithConditions

public Iterable<ColumnMetadata> getColumnsWithConditions()

hasIfNotExistCondition

public boolean hasIfNotExistCondition()

hasIfExistCondition

public boolean hasIfExistCondition()

buildPartitionKeyNames

public List<ByteBuffer> buildPartitionKeyNames(QueryOptions options,
 ClientState state)
                                        throws InvalidRequestException

Throws:

InvalidRequestException

createClustering

public NavigableSet<Clustering<?>> createClustering(QueryOptions options,
 ClientState state)
                                             throws InvalidRequestException

Throws:

InvalidRequestException

appliesOnlyToStaticColumns

public static boolean appliesOnlyToStaticColumns(Operations operation,
 Conditions conditions)

Checks that the specified operations and conditions only apply to static columns.

Returns:

true if the specified operations and conditions only apply to static columns, false otherwise.

requiresRead

public boolean requiresRead()

hasConditions

public boolean hasConditions()

Description copied from interface: CQLStatement

Whether or not this CQL Statement has LWT conditions

Specified by:

hasConditions in interface CQLStatement

hasSlices

public boolean hasSlices()

execute

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

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;

Throws:

RequestExecutionException

RequestValidationException

addConditions

public void addConditions(Clustering<?> clustering,
 CQL3CasRequest request,
 QueryOptions options)
                   throws InvalidRequestException

Throws:

InvalidRequestException

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

executeInternalWithoutCondition

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

Throws:

RequestValidationException

RequestExecutionException

executeInternalWithCondition

public ResultMessage executeInternalWithCondition(QueryState state,
 QueryOptions options)

createSlices

public Slices createSlices(QueryOptions options)

toSlices

public static Slices toSlices(TableMetadata metadata,
 SortedSet<ClusteringBound<?>> startBounds,
 SortedSet<ClusteringBound<?>> endBounds)

toSlices

public static Slices toSlices(ClusteringComparator comparator,
 SortedSet<ClusteringBound<?>> startBounds,
 SortedSet<ClusteringBound<?>> endBounds)