Package org.apache.cassandra.cql3

Interface CQLStatement

All Known Subinterfaces:

CQLStatement.SingleKeyspaceCqlStatement

All Known Implementing Classes:

AddIdentityStatement, AlterKeyspaceStatement, AlterRoleStatement, AlterSchemaStatement, AlterTableStatement, AlterTableStatement.AlterColumn, AlterTableStatement.MaskColumn, AlterTypeStatement, AlterViewStatement, AuthenticationStatement, AuthorizationStatement, BatchStatement, CreateAggregateStatement, CreateFunctionStatement, CreateIndexStatement, CreateKeyspaceStatement, CreateRoleStatement, CreateTableStatement, CreateTriggerStatement, CreateTypeStatement, CreateViewStatement, DeleteStatement, DescribeStatement, DescribeStatement.Element, DescribeStatement.Listing, DropAggregateStatement, DropFunctionStatement, DropIdentityStatement, DropIndexStatement, DropKeyspaceStatement, DropRoleStatement, DropTableStatement, DropTriggerStatement, DropTypeStatement, DropViewStatement, GrantPermissionsStatement, GrantRoleStatement, ListPermissionsStatement, ListRolesStatement, ListUsersStatement, ModificationStatement, PermissionsManagementStatement, RevokePermissionsStatement, RevokeRoleStatement, RoleManagementStatement, SelectStatement, TruncateStatement, UpdateStatement, UseStatement

public interface CQLStatement

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	CQLStatement.Raw
static interface	CQLStatement.SingleKeyspaceCqlStatement

Method Summary

Modifier and Type	Method	Description
void	authorize(ClientState state)	Perform any access verification necessary for the statement.
ResultMessage	execute(QueryState state, QueryOptions options, Dispatcher.RequestTime requestTime)	Execute the statement and return the resulting result or null if there is no result.
ResultMessage	executeLocally(QueryState state, 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.
default java.util.List<ColumnSpecification>	getBindVariables()	Returns all bind variables for the statement
default java.lang.Iterable<Function>	getFunctions()	Return an Iterable over all of the functions (both native and user-defined) used by any component of the statement
default short[]	getPartitionKeyBindVariableIndexes()	Returns an array with the same length as the number of partition key columns for the table corresponding to table.
default boolean	hasConditions()	Whether or not this CQL Statement has LWT conditions
void	validate(ClientState state)	Perform additional validation required by the statment.

Method Detail

getBindVariables

default java.util.List<ColumnSpecification> getBindVariables()

Returns all bind variables for the statement

getPartitionKeyBindVariableIndexes

default short[] getPartitionKeyBindVariableIndexes()

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.

getFunctions

default java.lang.Iterable<Function> getFunctions()

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

Returns:

functions all functions found (may contain duplicates)

authorize

void authorize(ClientState state)

Perform any access verification necessary for the statement.

Parameters:

state - the current client state

validate

void validate(ClientState state)

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

Parameters:

state - the current client state

execute

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

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

Parameters:

state - the current query state

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

requestTime - request enqueue / and start times;

executeLocally

ResultMessage executeLocally(QueryState state,
                             QueryOptions options)

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

Parameters:

state - the current query state

getAuditLogContext

AuditLogContext getAuditLogContext()

Provides the context needed for audit logging statements.

hasConditions

default boolean hasConditions()

Whether or not this CQL Statement has LWT conditions