ScyllaDB University Live | Free Virtual Training Event
Learn more
ScyllaDB Documentation Logo Documentation
  • Server
  • Cloud
  • Tools
    • ScyllaDB Manager
    • ScyllaDB Monitoring Stack
    • ScyllaDB Operator
  • Drivers
    • CQL Drivers
    • DynamoDB Drivers
  • Resources
    • ScyllaDB University
    • Community Forum
    • Tutorials
Download
ScyllaDB Docs Scylla C/C++ Driver API Documentation CassValue

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.

See also

cass_iterator_free()

Parameters:

value – [in]

Returns:

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

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.

See also

cass_iterator_free()

Parameters:

value – [in]

Returns:

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

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+

See also

cass_iterator_free()

Parameters:

value – [in]

Returns:

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

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+

See also

cass_iterator_free()

Parameters:

value – [in]

Returns:

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

const CassDataType *cass_value_data_type(const CassValue *value)¶

Gets the data type of a value.

Parameters:

value – [in]

Returns:

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

Parameters:
  • value – [in]

  • output – [out]

Returns:

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

Parameters:
  • value – [in]

  • output – [out]

Returns:

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:
  • value – [in]

  • output – [out]

Returns:

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

Parameters:
  • value – [in]

  • output – [out]

Returns:

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:
  • value – [in]

  • output – [out]

Returns:

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:
  • value – [in]

  • output – [out]

Returns:

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:
  • value – [in]

  • output – [out]

Returns:

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:
  • value – [in]

  • output – [out]

Returns:

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:
  • value – [in]

  • output – [out]

Returns:

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:
  • value – [in]

  • output – [out]

Returns:

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:
  • value – [in]

  • output – [out]

  • output_size – [out]

Returns:

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:
  • value – [in]

  • output – [out]

  • output_size – [out]

Returns:

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:
  • value – [in]

  • varint – [out]

  • varint_size – [out]

  • scale – [out]

Returns:

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

Parameters:
  • value – [in]

  • months – [out]

  • days – [out]

  • nanos – [out]

Returns:

CASS_OK if successful, otherwise error occurred

CassValueType cass_value_type(const CassValue *value)¶

Gets the type of the specified value.

Parameters:

value – [in]

Returns:

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:

value – [in]

Returns:

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:

value – [in]

Returns:

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:

value – [in]

Returns:

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:

collection – [in]

Returns:

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:

collection – [in]

Returns:

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:

collection – [in]

Returns:

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

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

Gets a date-range for the specified value.

Parameters:
  • value – [in]

  • range – [out]

Returns:

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:
  • value – [in]

  • x – [out]

  • y – [out]

Returns:

CASS_OK if successful, otherwise error occurred

Was this page helpful?

PREVIOUS
CassUuidGen
NEXT
CassVersion
  • Create an issue
  • Edit this page

On this page

  • CassValue
    • CassValue
      • CassValue::cass_iterator_from_collection()
      • CassValue::cass_iterator_from_map()
      • CassValue::cass_iterator_from_tuple()
      • CassValue::cass_iterator_fields_from_user_type()
      • CassValue::cass_value_data_type()
      • CassValue::cass_value_get_int8()
      • CassValue::cass_value_get_int16()
      • CassValue::cass_value_get_int32()
      • CassValue::cass_value_get_uint32()
      • CassValue::cass_value_get_int64()
      • CassValue::cass_value_get_float()
      • CassValue::cass_value_get_double()
      • CassValue::cass_value_get_bool()
      • CassValue::cass_value_get_uuid()
      • CassValue::cass_value_get_inet()
      • CassValue::cass_value_get_string()
      • CassValue::cass_value_get_bytes()
      • CassValue::cass_value_get_decimal()
      • CassValue::cass_value_get_duration()
      • CassValue::cass_value_type()
      • CassValue::cass_value_is_null()
      • CassValue::cass_value_is_collection()
      • CassValue::cass_value_is_duration()
      • CassValue::cass_value_item_count()
      • CassValue::cass_value_primary_sub_type()
      • CassValue::cass_value_secondary_sub_type()
      • CassValue::cass_value_get_dse_date_range()
      • CassValue::cass_value_get_dse_point()
Scylla C/C++ Driver
  • master
    • master
  • C/C++ Driver for ScyllaDB
  • API Documentation
    • CassAggregateMeta
    • CassAuthenticator
    • CassAuthenticatorCallbacks
    • CassBatch
    • CassCluster
    • CassCollection
    • CassColumnMeta
    • CassCustomPayload
    • CassDataType
    • CassErrorResult
    • CassExecProfile
    • CassFunctionMeta
    • CassFuture
    • CassIndexMeta
    • CassInet
    • CassIterator
    • CassKeyspaceMeta
    • CassLogMessage
    • CassMaterializedViewMeta
    • CassMetrics
    • CassNode
    • CassPrepared
    • CassResult
    • CassRetryPolicy
    • CassRow
    • CassSchemaMeta
    • CassSession
    • CassSpeculativeExecutionMetrics
    • CassSsl
    • CassStatement
    • CassTableMeta
    • CassTimestampGen
    • CassTuple
    • CassUserType
    • CassUuid
    • CassUuidGen
    • CassValue
    • CassVersion
    • DseDateRange
    • DseDateRangeBound
    • DseLineString
    • DseLineStringIterator
    • DsePolygon
    • DsePolygonIterator
  • Features
    • Basics
      • Batches
      • Binding Parameters
      • Client-side timestamps
      • Consistency
      • Data Types
      • The date and time Types
      • Futures
      • Handling Results
      • Keyspaces
      • Prepared Statements
      • Schema Metadata
      • Tuples
      • User-Defined Types (UDTs)
      • UUIDs
    • Building
    • Client Configuration
    • Cloud
    • Configuration
      • Retry policies
    • Execution Profiles
    • FAQ
    • Installation
    • Logging
    • Metrics
    • Scylla Specific Features
    • Security
      • SSL
    • Testing
      • Cassandra Cluster Manager (CCM)
    • Tracing
  • DSE Features
    • Authentication
    • Geospatial types
Docs Tutorials University Contact Us About Us
© 2025, ScyllaDB. All rights reserved. | Terms of Service | Privacy Policy | ScyllaDB, and ScyllaDB Cloud, are registered trademarks of ScyllaDB, Inc.
Last updated on 28 April 2025.
Powered by Sphinx 7.4.7 & ScyllaDB Theme 1.8.6