com.datastax.driver.core

Class BoundStatement

java.lang.Object

com.datastax.driver.core.Statement

com.datastax.driver.core.BoundStatement

All Implemented Interfaces:

GettableData

public class BoundStatement
extends Statement
implements GettableData

A prepared statement with values bound to the bind variables.

Once values has been provided for the variables of the PreparedStatement it has been created from, such BoundStatement can be executed (through Session.execute(Statement)).

The values of a BoundStatement can be set by either index or name. When setting them by name, names follow the case insensitivity rules explained in ColumnDefinitions but with the difference that if multiple bind variables have the same name, setting that name will set all the variables for that name.

Any variable that hasn't been specifically set will be considered null.

Bound values may also be retrieved using get*() methods. Note that this may have a non-negligible impact on performance: internally, values are stored in serialized form, so they need to be deserialized again. These methods are provided for debugging purposes.

Field Summary

Fields inherited from class com.datastax.driver.core.Statement

idempotent

Constructor Summary

Constructors

Constructor and Description
BoundStatement(PreparedStatement statement) Creates a new BoundStatement from the provided prepared statement.

Method Summary

Modifier and Type	Method and Description
BoundStatement	bind(Object... values) Bound values to the variables of this statement.
boolean	getBool(int i) Returns the ith value as a boolean.
boolean	getBool(String name) Returns the value for name as a boolean.
ByteBuffer	getBytes(int i) Returns the ith value as a byte array.
ByteBuffer	getBytes(String name) Returns the value for name as a byte array.
ByteBuffer	getBytesUnsafe(int i) Returns the ith value as a ByteBuffer.
ByteBuffer	getBytesUnsafe(String name) Returns the value for name as a ByteBuffer.
Date	getDate(int i) Returns the ith value as a date.
Date	getDate(String name) Returns the value for name as a date.
BigDecimal	getDecimal(int i) Returns the ith value as a variable length decimal.
BigDecimal	getDecimal(String name) Returns the value for name as a variable length decimal.
double	getDouble(int i) Returns the ith value as a double.
double	getDouble(String name) Returns the value for name as a double.
float	getFloat(int i) Returns the ith value as a float.
float	getFloat(String name) Returns the value for name as a float.
InetAddress	getInet(int i) Returns the ith value as an InetAddress.
InetAddress	getInet(String name) Returns the value for name as an InetAddress.
int	getInt(int i) Returns the ith value as an integer.
int	getInt(String name) Returns the value for name as an integer.
String	getKeyspace() Returns the keyspace this query operates on.
<T> List<T>	getList(int i, Class<T> elementsClass) Returns the ith value as a list.
<T> List<T>	getList(String name, Class<T> elementsClass) Returns the value for name as a list.
long	getLong(int i) Returns the ith value as a long.
long	getLong(String name) Returns the value for name as a long.
<K,V> Map<K,V>	getMap(int i, Class<K> keysClass, Class<V> valuesClass) Returns the ith value as a map.
<K,V> Map<K,V>	getMap(String name, Class<K> keysClass, Class<V> valuesClass) Returns the value for name as a map.
Object	getObject(int i) Returns the ith value as the Java type matching its CQL type.
Object	getObject(String name) Returns the value for name as the Java type matching its CQL type.
ByteBuffer	getRoutingKey() The routing key for this bound query.
<T> Set<T>	getSet(int i, Class<T> elementsClass) Returns the ith value as a set.
<T> Set<T>	getSet(String name, Class<T> elementsClass) Returns the value for name as a set.
String	getString(int i) Returns the ith value as a string.
String	getString(String name) Returns the value for name as a string.
UUID	getUUID(int i) Returns the ith value as a UUID.
UUID	getUUID(String name) Returns the value for name as a UUID.
BigInteger	getVarint(int i) Returns the ith value as a variable length integer.
BigInteger	getVarint(String name) Returns the value for name as a variable length integer.
boolean	isNull(int i) Returns whether the ith value is NULL.
boolean	isNull(String name) Returns whether the value for name is NULL.
boolean	isSet(int i) Returns whether the ith variable has been bound to a non null value.
boolean	isSet(String name) Returns whether the first occurrence of variable name has been bound to a non-null value.
PreparedStatement	preparedStatement() Returns the prepared statement on which this BoundStatement is based.
BoundStatement	setBool(int i, boolean v) Sets the ith value to the provided boolean.
BoundStatement	setBool(String name, boolean v) Sets the value for (all occurrences of) variable name to the provided boolean.
BoundStatement	setBytes(int i, ByteBuffer v) Sets the ith value to the provided byte buffer.
BoundStatement	setBytes(String name, ByteBuffer v) Sets the value for (all occurrences of) variable name to the provided byte buffer.
BoundStatement	setBytesUnsafe(int i, ByteBuffer v) Sets the ith value to the provided byte buffer.
BoundStatement	setBytesUnsafe(String name, ByteBuffer v) Sets the value for (all occurrences of) variable name to the provided byte buffer.
BoundStatement	setDate(int i, Date v) Set the ith value to the provided date.
BoundStatement	setDate(String name, Date v) Sets the value for (all occurrences of) variable name to the provided date.
BoundStatement	setDecimal(int i, BigDecimal v) Sets the ith value to the provided big decimal.
BoundStatement	setDecimal(String name, BigDecimal v) Sets the value for (all occurrences of) variable name to the provided big decimal.
BoundStatement	setDouble(int i, double v) Sets the ith value to the provided double.
BoundStatement	setDouble(String name, double v) Sets the value for (all occurrences of) variable name to the provided double.
BoundStatement	setFloat(int i, float v) Sets the ith value to the provided float.
BoundStatement	setFloat(String name, float v) Sets the value for (all occurrences of) variable name to the provided float.
BoundStatement	setInet(int i, InetAddress v) Sets the ith value to the provided inet address.
BoundStatement	setInet(String name, InetAddress v) Sets the value for (all occurrences of) variable name to the provided inet address.
BoundStatement	setInt(int i, int v) Set the ith value to the provided integer.
BoundStatement	setInt(String name, int v) Sets the value for (all occurrences of) variable name to the provided integer.
<T> BoundStatement	setList(int i, List<T> v) Sets the ith value to the provided list.
<T> BoundStatement	setList(String name, List<T> v) Sets the value for (all occurrences of) variable name to the provided list.
BoundStatement	setLong(int i, long v) Sets the ith value to the provided long.
BoundStatement	setLong(String name, long v) Sets the value for (all occurrences of) variable name to the provided long.
<K,V> BoundStatement	setMap(int i, Map<K,V> v) Sets the ith value to the provided map.
<K,V> BoundStatement	setMap(String name, Map<K,V> v) Sets the value for (all occurrences of) variable name to the provided map.
BoundStatement	setPartitionKeyToken(Token v) Sets the value for (all occurrences of) variable "partition key token" to the provided token (this is the name generated by Cassandra for markers corresponding to a token(...) call).
BoundStatement	setRoutingKey(ByteBuffer routingKey) Sets the routing key for this bound statement.
<T> BoundStatement	setSet(int i, Set<T> v) Sets the ith value to the provided set.
<T> BoundStatement	setSet(String name, Set<T> v) Sets the value for (all occurrences of) variable name to the provided set.
BoundStatement	setString(int i, String v) Sets the ith value to the provided string.
BoundStatement	setString(String name, String v) Sets the value for (all occurrences of) variable name to the provided string.
BoundStatement	setToken(int i, Token v) Sets the ith value to the provided Token.
BoundStatement	setToken(String name, Token v) Sets the value for (all occurrences of) variable name to the provided token.
BoundStatement	setUUID(int i, UUID v) Sets the ith value to the provided UUID.
BoundStatement	setUUID(String name, UUID v) Sets the value for (all occurrences of) variable name to the provided UUID.
BoundStatement	setVarint(int i, BigInteger v) Sets the ith value to the provided big integer.
BoundStatement	setVarint(String name, BigInteger v) Sets the value for (all occurrences of) variable name to the provided big integer.

Methods inherited from class com.datastax.driver.core.Statement

disableTracing, enableTracing, getConsistencyLevel, getFetchSize, getRetryPolicy, getSerialConsistencyLevel, isIdempotent, isTracing, setConsistencyLevel, setFetchSize, setIdempotent, setPagingState, setPagingStateUnsafe, setRetryPolicy, setSerialConsistencyLevel

Methods inherited from class java.lang.Object

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

Constructor Detail

BoundStatement

public BoundStatement(PreparedStatement statement)

Creates a new BoundStatement from the provided prepared statement.

Parameters:

statement - the prepared statement from which to create a BoundStatement.

Method Detail

preparedStatement

public PreparedStatement preparedStatement()

Returns the prepared statement on which this BoundStatement is based.

Returns:

the prepared statement on which this BoundStatement is based.

isSet

public boolean isSet(int i)

Returns whether the ith variable has been bound to a non null value.

Parameters:

i - the index of the variable to check.

Returns:

whether the ith variable has been bound to a non null value.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

isSet

public boolean isSet(String name)

Returns whether the first occurrence of variable name has been bound to a non-null value.

Parameters:

name - the name of the variable to check.

Returns:

whether the first occurrence of variable name has been bound to a non-null value.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is if !this.preparedStatement().variables().names().contains(name).

bind

public BoundStatement bind(Object... values)

Bound values to the variables of this statement. This is a convenience method to bind all the variables of the BoundStatement in one call.

Parameters:

values - the values to bind to the variables of the newly created BoundStatement. The first element of values will be bound to the first bind variable, etc. It is legal to provide fewer values than the statement has bound variables. In that case, the remaining variable need to be bound before execution. If more values than variables are provided however, an IllegalArgumentException wil be raised.

Returns:

this bound statement.

Throws:

IllegalArgumentException - if more values are provided than there is of bound variables in this statement.

InvalidTypeException - if any of the provided value is not of correct type to be bound to the corresponding bind variable.

NullPointerException - if one of values is a collection (List, Set or Map) containing a null value. Nulls are not supported in collections by CQL.

setRoutingKey

public BoundStatement setRoutingKey(ByteBuffer routingKey)

Sets the routing key for this bound statement.

This is useful when the routing key can neither be set on the PreparedStatement this bound statement was built from, nor automatically computed from bound variables. In particular, this is the case if the partition key is composite and only some of its components are bound.

Parameters:

routingKey - the raw (binary) value to use as routing key.

Returns:

this BoundStatement object.

See Also:

getRoutingKey()

getRoutingKey

public ByteBuffer getRoutingKey()

The routing key for this bound query.

This method will return a non-null value if either of the following occur:

• The routing key has been set directly through setRoutingKey(java.nio.ByteBuffer).
• The routing key has been set through PreparedStatement.setRoutingKey(java.nio.ByteBuffer) for the PreparedStatement this statement has been built from.
• All the columns composing the partition key are bound variables of this BoundStatement. The routing key will then be built using the values provided for these partition key columns.

Otherwise, null is returned.

Note that if the routing key has been set through setRoutingKey(java.nio.ByteBuffer), then that takes precedence. If the routing key has been set through PreparedStatement.setRoutingKey(java.nio.ByteBuffer) then that is used next. If neither of those are set then it is computed.

Specified by:

getRoutingKey in class Statement

Returns:

the routing key for this statement or null.

getKeyspace

public String getKeyspace()

Returns the keyspace this query operates on.

This method will always return a non-null value (unless the statement has no variables, but you should avoid prepared statement in the first in that case). The keyspace returned will be the one corresponding to the first variable prepared in this statement (which in almost all case will be the keyspace for the operation, though it's possible in CQL to build a batch statement that acts on multiple keyspace).

Specified by:

getKeyspace in class Statement

Returns:

the keyspace for this statement (see above), or null if the statement has no variables.

setBool

public BoundStatement setBool(int i,
                              boolean v)

Sets the ith value to the provided boolean.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not of type BOOLEAN.

setBool

public BoundStatement setBool(String name,
                              boolean v)

Sets the value for (all occurrences of) variable name to the provided boolean.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any one occurrence of) name is not of type BOOLEAN.

setInt

public BoundStatement setInt(int i,
                             int v)

Set the ith value to the provided integer.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not of type INT.

setInt

public BoundStatement setInt(String name,
                             int v)

Sets the value for (all occurrences of) variable name to the provided integer.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any one occurrence of) name is not of type INT.

setLong

public BoundStatement setLong(int i,
                              long v)

Sets the ith value to the provided long.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not of type BIGINT or COUNTER.

setLong

public BoundStatement setLong(String name,
                              long v)

Sets the value for (all occurrences of) variable name to the provided long.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not of type BIGINT or COUNTER.

setDate

public BoundStatement setDate(int i,
                              Date v)

Set the ith value to the provided date.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not of type TIMESTAMP.

setDate

public BoundStatement setDate(String name,
                              Date v)

Sets the value for (all occurrences of) variable name to the provided date.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not of type TIMESTAMP.

setFloat

public BoundStatement setFloat(int i,
                               float v)

Sets the ith value to the provided float.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not of type FLOAT.

setFloat

public BoundStatement setFloat(String name,
                               float v)

Sets the value for (all occurrences of) variable name to the provided float.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not of type FLOAT.

setDouble

public BoundStatement setDouble(int i,
                                double v)

Sets the ith value to the provided double.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not of type DOUBLE.

setDouble

public BoundStatement setDouble(String name,
                                double v)

Sets the value for (all occurrences of) variable name to the provided double.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not of type DOUBLE.

setString

public BoundStatement setString(int i,
                                String v)

Sets the ith value to the provided string.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is of neither of the following types: VARCHAR, TEXT or ASCII.

setString

public BoundStatement setString(String name,
                                String v)

Sets the value for (all occurrences of) variable name to the provided string.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is of neither of the following types: VARCHAR, TEXT or ASCII.

setBytes

public BoundStatement setBytes(int i,
                               ByteBuffer v)

Sets the ith value to the provided byte buffer. This method validate that the type of the column set is BLOB. If you want to insert manually serialized data into columns of another type, use setBytesUnsafe(int, java.nio.ByteBuffer) instead.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not of type BLOB.

setBytes

public BoundStatement setBytes(String name,
                               ByteBuffer v)

Sets the value for (all occurrences of) variable name to the provided byte buffer. This method validate that the type of the column set is BLOB. If you want to insert manually serialized data into columns of another type, use setBytesUnsafe(int, java.nio.ByteBuffer) instead.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not of type BLOB.

setBytesUnsafe

public BoundStatement setBytesUnsafe(int i,
                                     ByteBuffer v)

Sets the ith value to the provided byte buffer. Contrary to setBytes(int, java.nio.ByteBuffer), this method does not check the type of the column set. If you insert data that is not compatible with the type of the column, you will get an InvalidQueryException at execute time.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

setBytesUnsafe

public BoundStatement setBytesUnsafe(String name,
                                     ByteBuffer v)

Sets the value for (all occurrences of) variable name to the provided byte buffer. Contrary to setBytes(int, java.nio.ByteBuffer), this method does not check the type of the column set. If you insert data that is not compatible with the type of the column, you will get an InvalidQueryException at execute time.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is if !this.preparedStatement().variables().names().contains(name).

setVarint

public BoundStatement setVarint(int i,
                                BigInteger v)

Sets the ith value to the provided big integer.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not of type VARINT.

setVarint

public BoundStatement setVarint(String name,
                                BigInteger v)

Sets the value for (all occurrences of) variable name to the provided big integer.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not of type VARINT.

setDecimal

public BoundStatement setDecimal(int i,
                                 BigDecimal v)

Sets the ith value to the provided big decimal.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not of type DECIMAL.

setDecimal

public BoundStatement setDecimal(String name,
                                 BigDecimal v)

Sets the value for (all occurrences of) variable name to the provided big decimal.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not of type DECIMAL.

setUUID

public BoundStatement setUUID(int i,
                              UUID v)

Sets the ith value to the provided UUID.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not of type UUID or TIMEUUID, or if column i is of type TIMEUUID but v is not a type 1 UUID.

setUUID

public BoundStatement setUUID(String name,
                              UUID v)

Sets the value for (all occurrences of) variable name to the provided UUID.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not of type UUID or TIMEUUID, or if column name is of type TIMEUUID but v is not a type 1 UUID.

setInet

public BoundStatement setInet(int i,
                              InetAddress v)

Sets the ith value to the provided inet address.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not of type INET.

setInet

public BoundStatement setInet(String name,
                              InetAddress v)

Sets the value for (all occurrences of) variable name to the provided inet address.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not of type INET.

setToken

public BoundStatement setToken(int i,
                               Token v)

Sets the ith value to the provided Token.

setPartitionKeyToken(Token) should generally be preferred if you have a single token variable.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not of the type of the token's value.

setToken

public BoundStatement setToken(String name,
                               Token v)

Sets the value for (all occurrences of) variable name to the provided token.

setPartitionKeyToken(Token) should generally be preferred if you have a single token variable.

If you have multiple token variables, use positional binding (setToken(int, Token), or named bind markers:

 
 PreparedStatement pst = session.prepare("SELECT * FROM my_table WHERE token(k) > :min AND token(k) <= :max");
 BoundStatement b = pst.bind().setToken("min", minToken).setToken("max", maxToken);
 
 

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not of the type of the token's value.

setPartitionKeyToken

public BoundStatement setPartitionKeyToken(Token v)

Sets the value for (all occurrences of) variable "partition key token" to the provided token (this is the name generated by Cassandra for markers corresponding to a token(...) call).

This method is a shorthand for statements with a single token variable:

 
 Token token = ...
 PreparedStatement pst = session.prepare("SELECT * FROM my_table WHERE token(k) = ?");
 BoundStatement b = pst.bind().setPartitionKeyToken(token);
 
 

If you have multiple token variables, use positional binding (setToken(int, Token), or named bind markers:

 
 PreparedStatement pst = session.prepare("SELECT * FROM my_table WHERE token(k) > :min AND token(k) <= :max");
 BoundStatement b = pst.bind().setToken("min", minToken).setToken("max", maxToken);
 
 

Parameters:

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not of the type of the token's value.

setList

public <T> BoundStatement setList(int i,
                                  List<T> v)

Sets the ith value to the provided list.

Please note that null values are not supported inside collection by CQL.

Type Parameters:

T - the type of the elements of the list to set.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not a list type or if the elements of v are not of the type of the elements of column i.

NullPointerException - if v contains null values. Nulls are not supported in collections by CQL.

setList

public <T> BoundStatement setList(String name,
                                  List<T> v)

Sets the value for (all occurrences of) variable name to the provided list.

Please note that null values are not supported inside collection by CQL.

Type Parameters:

T - the type of the elements of the list to set.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not a list type or if the elements of v are not of the type of the elements of column name.

NullPointerException - if v contains null values. Nulls are not supported in collections by CQL.

setMap

public <K,V> BoundStatement setMap(int i,
                                   Map<K,V> v)

Sets the ith value to the provided map.

Please note that null values are not supported inside collection by CQL.

Type Parameters:

K - the type of the keys for the map to set.

V - the type of the values for the map to set.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not a map type or if the elements (keys or values) of v are not of the type of the elements of column i.

NullPointerException - if v contains null values. Nulls are not supported in collections by CQL.

setMap

public <K,V> BoundStatement setMap(String name,
                                   Map<K,V> v)

Sets the value for (all occurrences of) variable name to the provided map.

Please note that null values are not supported inside collection by CQL.

Type Parameters:

K - the type of the keys for the map to set.

V - the type of the values for the map to set.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not a map type or if the elements (keys or values) of v are not of the type of the elements of column name.

NullPointerException - if v contains null values. Nulls are not supported in collections by CQL.

setSet

public <T> BoundStatement setSet(int i,
                                 Set<T> v)

Sets the ith value to the provided set.

Please note that null values are not supported inside collection by CQL.

Type Parameters:

T - the type of the elements of the set to set.

Parameters:

i - the index of the variable to set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IndexOutOfBoundsException - if i < 0 || i >= this.preparedStatement().variables().size().

InvalidTypeException - if column i is not a set type or if the elements of v are not of the type of the elements of column i.

NullPointerException - if v contains null values. Nulls are not supported in collections by CQL.

setSet

public <T> BoundStatement setSet(String name,
                                 Set<T> v)

Sets the value for (all occurrences of) variable name to the provided set.

Please note that null values are not supported inside collection by CQL.

Type Parameters:

T - the type of the elements of the set to set.

Parameters:

name - the name of the variable to set; if multiple variables name are prepared, all of them are set.

v - the value to set.

Returns:

this BoundStatement.

Throws:

IllegalArgumentException - if name is not a prepared variable, that is, if !this.preparedStatement().variables().names().contains(name).

InvalidTypeException - if (any occurrence of) name is not a map type or if the elements of v are not of the type of the elements of column name.

NullPointerException - if v contains null values. Nulls are not supported in collections by CQL.

isNull

public boolean isNull(int i)

Description copied from interface: GettableData

Returns whether the ith value is NULL.

Specified by:

isNull in interface GettableData

Parameters:

i - the index (0 <= i < size()) of the value to check.

Returns:

whether the ith value is NULL.

isNull

public boolean isNull(String name)

Description copied from interface: GettableData

Returns whether the value for name is NULL.

Specified by:

isNull in interface GettableData

Parameters:

name - the name of the value to check.

Returns:

whether the value for name is NULL.

getBool

public boolean getBool(int i)

Description copied from interface: GettableData

Returns the ith value as a boolean.

Specified by:

getBool in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the boolean value of the ith value. If the value is NULL, false is returned.

getBool

public boolean getBool(String name)

Description copied from interface: GettableData

Returns the value for name as a boolean.

Specified by:

getBool in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the boolean value for name. If the value is NULL, false is returned.

getInt

public int getInt(int i)

Description copied from interface: GettableData

Returns the ith value as an integer.

Specified by:

getInt in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value as an integer. If the value is NULL, 0 is returned.

getInt

public int getInt(String name)

Description copied from interface: GettableData

Returns the value for name as an integer.

Specified by:

getInt in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the value for name as an integer. If the value is NULL, 0 is returned.

getLong

public long getLong(int i)

Description copied from interface: GettableData

Returns the ith value as a long.

Specified by:

getLong in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value as a long. If the value is NULL, 0L is returned.

getLong

public long getLong(String name)

Description copied from interface: GettableData

Returns the value for name as a long.

Specified by:

getLong in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the value for name as a long. If the value is NULL, 0L is returned.

getDate

public Date getDate(int i)

Description copied from interface: GettableData

Returns the ith value as a date.

Specified by:

getDate in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value as a data. If the value is NULL, null is returned.

getDate

public Date getDate(String name)

Description copied from interface: GettableData

Returns the value for name as a date.

Specified by:

getDate in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the value for name as a date. If the value is NULL, null is returned.

getFloat

public float getFloat(int i)

Description copied from interface: GettableData

Returns the ith value as a float.

Specified by:

getFloat in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value as a float. If the value is NULL, 0.0f is returned.

getFloat

public float getFloat(String name)

Description copied from interface: GettableData

Returns the value for name as a float.

Specified by:

getFloat in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the value for name as a float. If the value is NULL, 0.0f is returned.

getDouble

public double getDouble(int i)

Description copied from interface: GettableData

Returns the ith value as a double.

Specified by:

getDouble in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value as a double. If the value is NULL, 0.0 is returned.

getDouble

public double getDouble(String name)

Description copied from interface: GettableData

Returns the value for name as a double.

Specified by:

getDouble in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the value for name as a double. If the value is NULL, 0.0 is returned.

getBytesUnsafe

public ByteBuffer getBytesUnsafe(int i)

Description copied from interface: GettableData

Returns the ith value as a ByteBuffer. Note: this method always return the bytes composing the value, even if it is not of type BLOB. That is, this method never throw an InvalidTypeException. However, if the type is not BLOB, it is up to the caller to handle the returned value correctly.

Specified by:

getBytesUnsafe in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value as a ByteBuffer. If the value is NULL, null is returned.

getBytesUnsafe

public ByteBuffer getBytesUnsafe(String name)

Description copied from interface: GettableData

Returns the value for name as a ByteBuffer. Note: this method always return the bytes composing the value, even if it is not of type BLOB. That is, this method never throw an InvalidTypeException. However, if the type is not BLOB, it is up to the caller to handle the returned value correctly.

Specified by:

getBytesUnsafe in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the value for name as a ByteBuffer. If the value is NULL, null is returned.

getBytes

public ByteBuffer getBytes(int i)

Description copied from interface: GettableData

Returns the ith value as a byte array.

Note that this method validate that the value is of type BLOB. If you want to retrieve the bytes for any type of values, use GettableData.getBytesUnsafe(int) instead.

Specified by:

getBytes in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value as a byte array. If the value is NULL, null is returned.

getBytes

public ByteBuffer getBytes(String name)

Description copied from interface: GettableData

Returns the value for name as a byte array.

Note that this method validate that the value is of type BLOB. If you want to retrieve the bytes for any type of values, use GettableData.getBytesUnsafe(String) instead.

Specified by:

getBytes in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the value for name as a byte array. If the value is NULL, null is returned.

getString

public String getString(int i)

Description copied from interface: GettableData

Returns the ith value as a string.

Specified by:

getString in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value as a string. If the value is NULL, null is returned.

getString

public String getString(String name)

Description copied from interface: GettableData

Returns the value for name as a string.

Specified by:

getString in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the value for name as a string. If the value is NULL, null is returned.

getVarint

public BigInteger getVarint(int i)

Description copied from interface: GettableData

Returns the ith value as a variable length integer.

Specified by:

getVarint in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value as a variable length integer. If the value is NULL, null is returned.

getVarint

public BigInteger getVarint(String name)

Description copied from interface: GettableData

Returns the value for name as a variable length integer.

Specified by:

getVarint in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the value for name as a variable length integer. If the value is NULL, null is returned.

getDecimal

public BigDecimal getDecimal(int i)

Description copied from interface: GettableData

Returns the ith value as a variable length decimal.

Specified by:

getDecimal in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value as a variable length decimal. If the value is NULL, null is returned.

getDecimal

public BigDecimal getDecimal(String name)

Description copied from interface: GettableData

Returns the value for name as a variable length decimal.

Specified by:

getDecimal in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the value for name as a variable length decimal. If the value is NULL, null is returned.

getUUID

public UUID getUUID(int i)

Description copied from interface: GettableData

Returns the ith value as a UUID.

Specified by:

getUUID in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value as a UUID. If the value is NULL, null is returned.

getUUID

public UUID getUUID(String name)

Description copied from interface: GettableData

Returns the value for name as a UUID.

Specified by:

getUUID in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the value for name as a UUID. If the value is NULL, null is returned.

getInet

public InetAddress getInet(int i)

Description copied from interface: GettableData

Returns the ith value as an InetAddress.

Specified by:

getInet in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value as an InetAddress. If the value is NULL, null is returned.

getInet

public InetAddress getInet(String name)

Description copied from interface: GettableData

Returns the value for name as an InetAddress.

Specified by:

getInet in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the value for name as an InetAddress. If the value is NULL, null is returned.

getList

public <T> List<T> getList(int i,
                           Class<T> elementsClass)

Description copied from interface: GettableData

Returns the ith value as a list.

Specified by:

getList in interface GettableData

Type Parameters:

T - the type of the elements of the list to return.

Parameters:

i - the index to retrieve.

elementsClass - the class for the elements of the list to retrieve.

Returns:

the value of the ith value as a list of elementsClass objects. If the value is NULL, an empty list is returned (note that Cassandra makes no difference between an empty list and column of type list that is not set). The returned list is immutable.

getList

public <T> List<T> getList(String name,
                           Class<T> elementsClass)

Description copied from interface: GettableData

Returns the value for name as a list.

Specified by:

getList in interface GettableData

Type Parameters:

T - the type of the elements of the list to return.

Parameters:

name - the name to retrieve.

elementsClass - the class for the elements of the list to retrieve.

Returns:

the value of the ith value as a list of elementsClass objects. If the value is NULL, an empty list is returned (note that Cassandra makes no difference between an empty list and column of type list that is not set). The returned list is immutable.

getSet

public <T> Set<T> getSet(int i,
                         Class<T> elementsClass)

Description copied from interface: GettableData

Returns the ith value as a set.

Specified by:

getSet in interface GettableData

Type Parameters:

T - the type of the elements of the set to return.

Parameters:

i - the index to retrieve.

elementsClass - the class for the elements of the set to retrieve.

Returns:

the value of the ith value as a set of elementsClass objects. If the value is NULL, an empty set is returned (note that Cassandra makes no difference between an empty set and column of type set that is not set). The returned set is immutable.

getSet

public <T> Set<T> getSet(String name,
                         Class<T> elementsClass)

Description copied from interface: GettableData

Returns the value for name as a set.

Specified by:

getSet in interface GettableData

Type Parameters:

T - the type of the elements of the set to return.

Parameters:

name - the name to retrieve.

elementsClass - the class for the elements of the set to retrieve.

Returns:

the value of the ith value as a set of elementsClass objects. If the value is NULL, an empty set is returned (note that Cassandra makes no difference between an empty set and column of type set that is not set). The returned set is immutable.

getMap

public <K,V> Map<K,V> getMap(int i,
                             Class<K> keysClass,
                             Class<V> valuesClass)

Description copied from interface: GettableData

Returns the ith value as a map.

Specified by:

getMap in interface GettableData

Type Parameters:

K - the type of the keys of the map to return.

V - the type of the values of the map to return.

Parameters:

i - the index to retrieve.

keysClass - the class for the keys of the map to retrieve.

valuesClass - the class for the values of the map to retrieve.

Returns:

the value of the ith value as a map of keysClass to valuesClass objects. If the value is NULL, an empty map is returned (note that Cassandra makes no difference between an empty map and column of type map that is not set). The returned map is immutable.

getMap

public <K,V> Map<K,V> getMap(String name,
                             Class<K> keysClass,
                             Class<V> valuesClass)

Description copied from interface: GettableData

Returns the value for name as a map.

Specified by:

getMap in interface GettableData

Type Parameters:

K - the type of the keys of the map to return.

V - the type of the values of the map to return.

Parameters:

name - the name to retrieve.

keysClass - the class for the keys of the map to retrieve.

valuesClass - the class for the values of the map to retrieve.

Returns:

the value of the ith value as a map of keysClass to valuesClass objects. If the value is NULL, an empty map is returned (note that Cassandra makes no difference between an empty map and column of type map that is not set). The returned map is immutable.

getObject

public Object getObject(int i)

Description copied from interface: GettableData

Returns the ith value as the Java type matching its CQL type.

Specified by:

getObject in interface GettableData

Parameters:

i - the index to retrieve.

Returns:

the value of the ith value as the Java type matching its CQL type. If the value is NULL and is a simple type, NULL is returned. If it is NULL and is a collection type, an empty (immutable) collection is returned.

getObject

public Object getObject(String name)

Description copied from interface: GettableData

Returns the value for name as the Java type matching its CQL type.

Specified by:

getObject in interface GettableData

Parameters:

name - the name to retrieve.

Returns:

the value of the ith value as the Java type matching its CQL type. If the value is NULL and is a simple type, NULL is returned. If it is NULL and is a collection type, an empty (immutable) collection is returned.