struct CassValue

A single primitive value or a collection of values.

Functions

CassError

cass_value_get_dse_date_range

( const CassValue * value, DseDateRange * range )

Gets a date-range for the specified value.

Parameters:
Name Type Details
in value const CassValue *
out range DseDateRange *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_dse_point

( const CassValue * value, cass_double_t * x, cass_double_t * y )

Gets a point for the specified value.

Parameters:
Name Type Details
in value const CassValue *
out x cass_double_t *
out y cass_double_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassIterator *

cass_iterator_from_collection

( const CassValue * value )

Creates a new iterator for the specified collection. This can be used to iterate over values in a collection.

Parameters:
Name Type Details
in value const CassValue *
Returns:
Type Details
CassIterator *

A new iterator that must be freed. NULL returned if the value is not a collection.
See Also:
CassIterator *

cass_iterator_from_map

( const CassValue * value )

Creates a new iterator for the specified map. This can be used to iterate over key/value pairs in a map.

Parameters:
Name Type Details
in value const CassValue *
Returns:
Type Details
CassIterator *

A new iterator that must be freed. NULL returned if the value is not a map.
See Also:
CassIterator *

cass_iterator_from_tuple

( const CassValue * value )

Creates a new iterator for the specified tuple. This can be used to iterate over values in a tuple.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in value const CassValue *
Returns:
Type Details
CassIterator *

A new iterator that must be freed. NULL returned if the value is not a tuple.
See Also:
CassIterator *

cass_iterator_fields_from_user_type

( const CassValue * value )

Creates a new iterator for the specified user defined type. This can be used to iterate over fields in a user defined type.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in value const CassValue *
Returns:
Type Details
CassIterator *

A new iterator that must be freed. NULL returned if the value is not a user defined type.
See Also:
const CassDataType *

cass_value_data_type

( const CassValue * value )

Gets the data type of a value.

Parameters:
Name Type Details
in value const CassValue *
Returns:
Type Details
const CassDataType *

Returns a reference to the data type of the value. Do not free this reference as it is bound to the lifetime of the value.
CassError

cass_value_get_int8

( const CassValue * value, cass_int8_t * output )

Gets an int8 for the specified value.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in value const CassValue *
out output cass_int8_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_int16

( const CassValue * value, cass_int16_t * output )

Gets an int16 for the specified value.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in value const CassValue *
out output cass_int16_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_int32

( const CassValue * value, cass_int32_t * output )

Gets an int32 for the specified value.

Parameters:
Name Type Details
in value const CassValue *
out output cass_int32_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_uint32

( const CassValue * value, cass_uint32_t * output )

Gets an uint32 for the specified value.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in value const CassValue *
out output cass_uint32_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_int64

( const CassValue * value, cass_int64_t * output )

Gets an int64 for the specified value.

Parameters:
Name Type Details
in value const CassValue *
out output cass_int64_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_float

( const CassValue * value, cass_float_t * output )

Gets a float for the specified value.

Parameters:
Name Type Details
in value const CassValue *
out output cass_float_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_double

( const CassValue * value, cass_double_t * output )

Gets a double for the specified value.

Parameters:
Name Type Details
in value const CassValue *
out output cass_double_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_bool

( const CassValue * value, cass_bool_t * output )

Gets a bool for the specified value.

Parameters:
Name Type Details
in value const CassValue *
out output cass_bool_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_uuid

( const CassValue * value, CassUuid * output )

Gets a UUID for the specified value.

Parameters:
Name Type Details
in value const CassValue *
out output CassUuid *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_inet

( const CassValue * value, CassInet * output )

Gets an INET for the specified value.

Parameters:
Name Type Details
in value const CassValue *
out output CassInet *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_string

( const CassValue * value, const char ** output, size_t * output_size )

Gets a string for the specified value.

Parameters:
Name Type Details
in value const CassValue *
out output const char **
out output_size size_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_bytes

( const CassValue * value, const cass_byte_t ** output, size_t * output_size )

Gets the bytes of the specified value.

Parameters:
Name Type Details
in value const CassValue *
out output const cass_byte_t **
out output_size size_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_decimal

( const CassValue * value, const cass_byte_t ** varint, size_t * varint_size, cass_int32_t * scale )

Gets a decimal for the specified value.

Parameters:
Name Type Details
in value const CassValue *
out varint const cass_byte_t **
out varint_size size_t *
out scale cass_int32_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassError

cass_value_get_duration

( const CassValue * value, cass_int32_t * months, cass_int32_t * days, cass_int64_t * nanos )

Gets a duration for the specified value.

Requires Cassandra: 3.10+

Parameters:
Name Type Details
in value const CassValue *
out months cass_int32_t *
out days cass_int32_t *
out nanos cass_int64_t *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise error occurred
CassValueType

cass_value_type

( const CassValue * value )

Gets the type of the specified value.

Parameters:
Name Type Details
in value const CassValue *
Returns:
Type Details
CassValueType

The type of the specified value.
cass_bool_t

cass_value_is_null

( const CassValue * value )

Returns true if a specified value is null.

Parameters:
Name Type Details
in value const CassValue *
Returns:
Type Details
cass_bool_t

true if the value is null, otherwise false.
cass_bool_t

cass_value_is_collection

( const CassValue * value )

Returns true if a specified value is a collection.

Parameters:
Name Type Details
in value const CassValue *
Returns:
Type Details
cass_bool_t

true if the value is a collection, otherwise false.
cass_bool_t

cass_value_is_duration

( const CassValue * value )

Returns true if a specified value is a duration.

Parameters:
Name Type Details
in value const CassValue *
Returns:
Type Details
cass_bool_t

true if the value is a duration, otherwise false.
size_t

cass_value_item_count

( const CassValue * collection )

Get the number of items in a collection. Works for all collection types.

Parameters:
Name Type Details
in collection const CassValue *
Returns:
Type Details
size_t

Count of items in a collection. 0 if not a collection.
CassValueType

cass_value_primary_sub_type

( const CassValue * collection )

Get the primary sub-type for a collection. This returns the sub-type for a list or set and the key type for a map.

Parameters:
Name Type Details
in collection const CassValue *
Returns:
Type Details
CassValueType

The type of the primary sub-type. CASS_VALUE_TYPE_UNKNOWN returned if not a collection.
CassValueType

cass_value_secondary_sub_type

( const CassValue * collection )

Get the secondary sub-type for a collection. This returns the value type for a map.

Parameters:
Name Type Details
in collection const CassValue *
Returns:
Type Details
CassValueType

The type of the primary sub-type. CASS_VALUE_TYPE_UNKNOWN returned if not a collection or not a map.