A data type used to describe a value, collection or user defined type.

Functions

CassDataType *

cass_data_type_new

( CassValueType type )

Creates a new data type with value type.

Parameters:
Name Type Details
in type CassValueType
Returns:
Type Details
CassDataType *

Returns a data type that must be freed.

See Also:
CassDataType *

cass_data_type_new_from_existing

( const CassDataType * data_type )

Creates a new data type from an existing data type.

Parameters:
Name Type Details
in data_type const CassDataType *
Returns:
Type Details
CassDataType *

Returns a data type that must be freed.

See Also:
CassDataType *

cass_data_type_new_tuple

( size_t item_count )

Creates a new tuple data type.

Requires Apache Cassandra: 2.1+

Parameters:
Name Type Details
in item_count size_t

The number of items in the tuple

Returns:
Type Details
CassDataType *

Returns a data type that must be freed.

See Also:
CassDataType *

cass_data_type_new_udt

( size_t field_count )

Creates a new UDT (user defined type) data type.

Requires Apache Cassandra: 2.1+

Parameters:
Name Type Details
in field_count size_t

The number of fields in the UDT

Returns:
Type Details
CassDataType *

Returns a data type that must be freed.

See Also:
void

cass_data_type_free

( CassDataType * data_type )

Frees a data type instance.

Parameters:
Name Type Details
in data_type CassDataType *
CassError

cass_data_type_set_type_name_n

( CassDataType * data_type, const char * type_name, size_t type_name_length )

Same as cass_data_type_set_type_name, but with lengths for string parameters.

Parameters:
Name Type Details
in data_type CassDataType *
in type_name const char *
in type_name_length size_t
Returns:
Type Details
CassError

Returns a data type that must be freed.

CassError

cass_data_type_set_keyspace_n

( CassDataType * data_type, const char * keyspace, size_t keyspace_length )

Same as cass_data_type_set_keyspace, but with lengths for string parameters.

Requires Apache Cassandra: 2.1+

Parameters:
Name Type Details
in data_type CassDataType *
in keyspace const char *
in keyspace_length size_t
Returns:
Type Details
CassError

Returns a data type that must be freed.

CassError

cass_data_type_set_class_name_n

( CassDataType * data_type, const char * class_name, size_t class_name_length )

Same as cass_data_type_set_class_name, but with lengths for string parameters.

Parameters:
Name Type Details
in data_type CassDataType *
in class_name const char *
in class_name_length size_t
Returns:
Type Details
CassError

Returns a data type that must be freed.

const CassDataType *

cass_data_type_sub_data_type_by_name_n

( const CassDataType * data_type, const char * name, size_t name_length )

Same as cass_data_type_sub_data_type_by_name, but with lengths for string parameters.

Requires Apache Cassandra: 2.1+

Parameters:
Name Type Details
in data_type const CassDataType *
in name const char *
in name_length size_t
Returns:
Type Details
const CassDataType *

Returns a reference to a child data type. Do not free this reference as it is bound to the lifetime of the parent data type. NULL is returned if the name doesn’t exist.