Menu

CassValue

struct CassValue

A single primitive value or a collection of values.

Public Functions

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.

Return

A new iterator that must be freed. NULL returned if the value is not a collection.

See

cass_iterator_free()

Parameters
  • value:

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.

Return

A new iterator that must be freed. NULL returned if the value is not a map.

See

cass_iterator_free()

Parameters
  • value:

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 Apache Cassandra: 2.1+

Return

A new iterator that must be freed. NULL returned if the value is not a tuple.

See

cass_iterator_free()

Parameters
  • value:

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 Apache Cassandra: 2.1+

Return

A new iterator that must be freed. NULL returned if the value is not a user defined type.

See

cass_iterator_free()

Parameters
  • value:

const CassDataType *cass_value_data_type(const CassValue *value)

Gets the data type of a value.

Return

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.

Parameters
  • value:

CassError cass_value_get_int8(const CassValue *value, cass_int8_t *output)

Gets an int8 for the specified value.

Requires Apache Cassandra: 2.2+

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • output:

CassError cass_value_get_int16(const CassValue *value, cass_int16_t *output)

Gets an int16 for the specified value.

Requires Apache Cassandra: 2.2+

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • output:

CassError cass_value_get_int32(const CassValue *value, cass_int32_t *output)

Gets an int32 for the specified value.

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • output:

CassError cass_value_get_uint32(const CassValue *value, cass_uint32_t *output)

Gets an uint32 for the specified value.

Requires Apache Cassandra: 2.2+

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • output:

CassError cass_value_get_int64(const CassValue *value, cass_int64_t *output)

Gets an int64 for the specified value.

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • output:

CassError cass_value_get_float(const CassValue *value, cass_float_t *output)

Gets a float for the specified value.

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • output:

CassError cass_value_get_double(const CassValue *value, cass_double_t *output)

Gets a double for the specified value.

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • output:

CassError cass_value_get_bool(const CassValue *value, cass_bool_t *output)

Gets a bool for the specified value.

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • output:

CassError cass_value_get_uuid(const CassValue *value, CassUuid *output)

Gets a UUID for the specified value.

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • output:

CassError cass_value_get_inet(const CassValue *value, CassInet *output)

Gets an INET for the specified value.

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • output:

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

Gets a string for the specified value.

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • output:

  • output_size:

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

Gets the bytes of the specified value.

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • output:

  • output_size:

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.

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • varint:

  • varint_size:

  • scale:

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 Apache Cassandra: 3.10+

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • months:

  • days:

  • nanos:

CassValueType cass_value_type(const CassValue *value)

Gets the type of the specified value.

Return

The type of the specified value.

Parameters
  • value:

cass_bool_t cass_value_is_null(const CassValue *value)

Returns true if a specified value is null.

Return

true if the value is null, otherwise false.

Parameters
  • value:

cass_bool_t cass_value_is_collection(const CassValue *value)

Returns true if a specified value is a collection.

Return

true if the value is a collection, otherwise false.

Parameters
  • value:

cass_bool_t cass_value_is_duration(const CassValue *value)

Returns true if a specified value is a duration.

Return

true if the value is a duration, otherwise false.

Parameters
  • value:

size_t cass_value_item_count(const CassValue *collection)

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

Return

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

Parameters
  • 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.

Return

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

Parameters
  • 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.

Return

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

Parameters
  • collection:

CassError cass_value_get_dse_date_range(const CassValue *value, DseDateRange *range)

Gets a date-range for the specified value.

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • range:

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

Gets a point for the specified value.

Return

CASS_OK if successful, otherwise error occurred

Parameters
  • value:

  • x:

  • y: