Brand

DataStax C/C++ Driver

Attention: Viewing documentation for version
Download

struct CassUserType

A user defined type.

Requires Cassandra: 2.1+

Functions

CassUserType *

cass_user_type_new_from_data_type

( data_type )

Creates a new user defined type from existing data type;

Requires Cassandra: 2.1+

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

Returns a user defined type that must be freed. NULL is returned if the data type is not a user defined type.
See Also:
void

cass_user_type_free

( user_type )

Frees a user defined type instance.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
CassError

cass_user_type_set_null

( user_type, index )

Sets a null in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_null_by_name

( user_type, name )

Sets a null in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_null_by_name_n

( user_type, name, name_length )

Same as CassUserType::cass_user_type_set_null_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_null_by_name
See Also:
CassError

cass_user_type_set_int8

( user_type, index, value )

Sets a “tinyint” in a user defined type at the specified index.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int8_by_name

( user_type, name, value )

Sets a “tinyint” in a user defined type at the specified name.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int8_by_name_n

( user_type, name, name_length, value )

Same as CassUserType::cass_user_type_set_int8_by_name, but with lengths for string parameters.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_int8_by_name
See Also:
CassError

cass_user_type_set_int16

( user_type, index, value )

Sets an “smallint” in a user defined type at the specified index.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int16_by_name

( user_type, name, value )

Sets an “smallint” in a user defined type at the specified name.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int16_by_name_n

( user_type, name, name_length, value )

Same as CassUserType::cass_user_type_set_int16_by_name, but with lengths for string parameters.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_int16_by_name
See Also:
CassError

cass_user_type_set_int32

( user_type, index, value )

Sets an “int” in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int32_by_name

( user_type, name, value )

Sets an “int” in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int32_by_name_n

( user_type, name, name_length, value )

Same as CassUserType::cass_user_type_set_int32_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_int32_by_name
See Also:
CassError

cass_user_type_set_uint32

( user_type, index, value )

Sets a “date” in a user defined type at the specified index.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_uint32_by_name

( user_type, name, value )

Sets a “date” in a user defined type at the specified name.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_uint32_by_name_n

( user_type, name, name_length, value )

Same as CassUserType::cass_user_type_set_uint32_by_name, but with lengths for string parameters.

Requires Cassandra: 2.2+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_uint32_by_name
See Also:
CassError

cass_user_type_set_int64

( user_type, index, value )

Sets an “bigint”, “counter”, “timestamp” or “time” in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int64_by_name

( user_type, name, value )

Sets an “bigint”, “counter”, “timestamp” or “time” in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int64_by_name_n

( user_type, name, name_length, value )

Same as CassUserType::cass_user_type_set_int64_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_int64_by_name
See Also:
CassError

cass_user_type_set_float

( user_type, index, value )

Sets a “float” in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_float_by_name

( user_type, name, value )

Sets a “float” in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_float_by_name_n

( user_type, name, name_length, value )

Same as CassUserType::cass_user_type_set_float_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_float_by_name
See Also:
CassError

cass_user_type_set_double

( user_type, index, value )

Sets an “double” in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_double_by_name

( user_type, name, value )

Sets an “double” in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_double_by_name_n

( user_type, name, name_length, value )

Same as CassUserType::cass_user_type_set_double_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_double_by_name
See Also:
CassError

cass_user_type_set_bool

( user_type, index, value )

Sets a “boolean” in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_bool_by_name

( user_type, name, value )

Sets a “boolean” in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_bool_by_name_n

( user_type, name, name_length, value )

Same as CassUserType::cass_user_type_set_double_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_double_by_name
See Also:
CassError

cass_user_type_set_string

( user_type, index, value )

Sets an “ascii”, “text” or “varchar” in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_string_n

( user_type, index, value, value_length )

Same as CassUserType::cass_user_type_set_string, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in value
in value_length
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_string
See Also:
CassError

cass_user_type_set_string_by_name

( user_type, name, value )

Sets an “ascii”, “text” or “varchar” in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_string_by_name_n

( user_type, name, name_length, value, value_length )

Same as CassUserType::cass_user_type_set_string_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
in value_length
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_string_by_name
See Also:
CassError

cass_user_type_set_bytes

( user_type, index, value, value_size )

Sets a “blob” “varint” or “custom” in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in value
in value_size
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_bytes_by_name

( user_type, name, value, value_size )

Sets a “blob”, “varint” or “custom” in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in value
in value_size
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_bytes_by_name_n

( user_type, name, name_length, value, value_size )

Same as CassUserType::cass_user_type_set_bytes_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
in value_size
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_bytes_by_name
See Also:
CassError

cass_user_type_set_custom

( user_type, index, class_name, value, value_size )

Sets a “custom” in a user defined type at the specified index.

Parameters:
Name Type Details
in user_type
in index
in class_name
in value
in value_size
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_custom_n

( user_type, index, class_name, class_name_length, value, value_size )

Same as CassUserType::cass_user_type_set_custom, but with lengths for string parameters.

Parameters:
Name Type Details
in user_type
in index
in class_name
in class_name_length
in value
in value_size
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_custom
See Also:
CassError

cass_user_type_set_custom_by_name

( user_type, name, class_name, value, value_size )

Sets a “custom” in a user defined type at the specified name.

Parameters:
Name Type Details
in user_type
in name
in class_name
in value
in value_size
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_custom_by_name_n

( user_type, name, name_length, class_name, class_name_length, value, value_size )

Same as CassUserType::cass_user_type_set_custom_by_name, but with lengths for string parameters.

Parameters:
Name Type Details
in user_type
in name
in name_length
in class_name
in class_name_length
in value
in value_size
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_custom_by_name
See Also:
CassError

cass_user_type_set_uuid

( user_type, index, value )

Sets a “uuid” or “timeuuid” in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_uuid_by_name

( user_type, name, value )

Sets a “uuid” or “timeuuid” in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_uuid_by_name_n

( user_type, name, name_length, value )

Same as CassUserType::cass_user_type_set_uuid_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_uuid_by_name
See Also:
CassError

cass_user_type_set_inet

( user_type, index, value )

Sets a “inet” in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_inet_by_name

( user_type, name, value )

Sets a “inet” in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_inet_by_name_n

( user_type, name, name_length, value )

Same as CassUserType::cass_user_type_set_inet_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_inet_by_name
See Also:
CassError

cass_user_type_set_decimal

( user_type, index, varint, varint_size, scale )

Sets an “decimal” in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in varint
in varint_size
in scale
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_decimal_by_name

( user_type, name, varint, varint_size, scale )

Sets “decimal” in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in varint
in varint_size
in scale
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_decimal_by_name_n

( user_type, name, name_length, varint, varint_size, scale )

Same as CassUserType::cass_user_type_set_decimal_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
in varint
in varint_size
in scale
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_decimal_by_name
See Also:
CassError

cass_user_type_set_duration

( user_type, index, months, days, nanos )

Sets a “duration” in a user defined type at the specified index.

Requires Cassandra: 3.10+

Parameters:
Name Type Details
in user_type
in index
in months
in days
in nanos
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_duration_by_name

( user_type, name, months, days, nanos )

Sets “duration” in a user defined type at the specified name.

Requires Cassandra: 3.10+

Parameters:
Name Type Details
in user_type
in name
in months
in days
in nanos
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_duration_by_name_n

( user_type, name, name_length, months, days, nanos )

Same as CassUserType::cass_user_type_set_duration_by_name, but with lengths for string parameters.

Requires Cassandra: 3.10+

Parameters:
Name Type Details
in user_type
in name
in name_length
in months
in days
in nanos
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_duration_by_name
See Also:
CassError

cass_user_type_set_collection

( user_type, index, value )

Sets a “list”, “map” or “set” in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_collection_by_name

( user_type, name, value )

Sets a “list”, “map” or “set” in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_collection_by_name_n

( user_type, name, name_length, value )

Same as CassUserType::cass_user_type_set_collection_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_collection_by_name
See Also:
CassError

cass_user_type_set_tuple

( user_type, index, value )

Sets a “tuple” in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_tuple_by_name

( user_type, name, value )

Sets a “tuple” in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_tuple_by_name_n

( user_type, name, name_length, value )

Same as CassUserType::cass_user_type_set_tuple_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_tuple_by_name
See Also:
CassError

cass_user_type_set_user_type

( user_type, index, value )

Sets a user defined type in a user defined type at the specified index.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in index
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_user_type_by_name

( user_type, name, value )

Sets a user defined type in a user defined type at the specified name.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in value
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_user_type_by_name_n

( user_type, name, name_length, value )

Same as CassUserType::cass_user_type_set_user_type_by_name, but with lengths for string parameters.

Requires Cassandra: 2.1+

Parameters:
Name Type Details
in user_type
in name
in name_length
in value
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_user_type_by_name
See Also: