Brand

DataStax C/C++ Driver

Attention: Viewing documentation for version
Download

struct CassDataType

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

Functions

CassDataType *

cass_data_type_new

( type )

Creates a new data type with value type.

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

Returns a data type that must be freed.
See Also:
CassDataType *

cass_data_type_new_from_existing

( data_type )

Creates a new data type from an existing data type.

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

Returns a data type that must be freed.
See Also:
CassDataType *

cass_data_type_new_tuple

( item_count )

Creates a new tuple data type.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in item_count

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

( field_count )

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

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in field_count

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

( data_type )

Frees a data type instance.

Parameters:
Name Type Details
in data_type
CassError

cass_data_type_set_type_name_n

( data_type, type_name, type_name_length )

Same as cass_data_type_set_type_name, but with lengths for string parameters.

Parameters:
Name Type Details
in data_type
in type_name
in type_name_length
Returns:
Type Details
CassError

Returns a data type that must be freed.
CassError

cass_data_type_set_keyspace_n

( data_type, keyspace, keyspace_length )

Same as cass_data_type_set_keyspace, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in data_type
in keyspace
in keyspace_length
Returns:
Type Details
CassError

Returns a data type that must be freed.
CassError

cass_data_type_set_class_name_n

( data_type, class_name, class_name_length )

Same as cass_data_type_set_class_name, but with lengths for string parameters.

Parameters:
Name Type Details
in data_type
in class_name
in class_name_length
Returns:
Type Details
CassError

Returns a data type that must be freed.
const CassDataType *

cass_data_type_sub_data_type_by_name_n

( data_type, name, name_length )

Same as cass_data_type_sub_data_type_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in data_type
in name
in name_length
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.