struct CassUserType

A user defined type.

Functions

CassUserType *

cass_user_type_new_from_data_type

( const CassDataType * data_type )

Creates a new user defined type from existing data type;

Parameters:
Name Type Details
in data_type const CassDataType *
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

( CassUserType * user_type )

Frees a user defined type instance.

Parameters:
Name Type Details
in user_type CassUserType *
CassError

cass_user_type_set_null

( CassUserType * user_type, size_t index )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_null_by_name

( CassUserType * user_type, const char * name )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_null_by_name_n

( CassUserType * user_type, const char * name, size_t name_length )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_null_by_name
See Also:
CassError

cass_user_type_set_int8

( CassUserType * user_type, size_t index, cass_int8_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value cass_int8_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int8_by_name

( CassUserType * user_type, const char * name, cass_int8_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value cass_int8_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int8_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, cass_int8_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value cass_int8_t
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_int8_by_name
See Also:
CassError

cass_user_type_set_int16

( CassUserType * user_type, size_t index, cass_int16_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value cass_int16_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int16_by_name

( CassUserType * user_type, const char * name, cass_int16_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value cass_int16_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int16_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, cass_int16_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value cass_int16_t
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_int16_by_name
See Also:
CassError

cass_user_type_set_int32

( CassUserType * user_type, size_t index, cass_int32_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value cass_int32_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int32_by_name

( CassUserType * user_type, const char * name, cass_int32_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value cass_int32_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int32_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, cass_int32_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value cass_int32_t
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_int32_by_name
See Also:
CassError

cass_user_type_set_uint32

( CassUserType * user_type, size_t index, cass_uint32_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value cass_uint32_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_uint32_by_name

( CassUserType * user_type, const char * name, cass_uint32_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value cass_uint32_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_uint32_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, cass_uint32_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value cass_uint32_t
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_uint32_by_name
See Also:
CassError

cass_user_type_set_int64

( CassUserType * user_type, size_t index, cass_int64_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value cass_int64_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int64_by_name

( CassUserType * user_type, const char * name, cass_int64_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value cass_int64_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_int64_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, cass_int64_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value cass_int64_t
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_int64_by_name
See Also:
CassError

cass_user_type_set_float

( CassUserType * user_type, size_t index, cass_float_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value cass_float_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_float_by_name

( CassUserType * user_type, const char * name, cass_float_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value cass_float_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_float_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, cass_float_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value cass_float_t
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_float_by_name
See Also:
CassError

cass_user_type_set_double

( CassUserType * user_type, size_t index, cass_double_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value cass_double_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_double_by_name

( CassUserType * user_type, const char * name, cass_double_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value cass_double_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_double_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, cass_double_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value cass_double_t
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_double_by_name
See Also:
CassError

cass_user_type_set_bool

( CassUserType * user_type, size_t index, cass_bool_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value cass_bool_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_bool_by_name

( CassUserType * user_type, const char * name, cass_bool_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value cass_bool_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_bool_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, cass_bool_t value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value cass_bool_t
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_double_by_name
See Also:
CassError

cass_user_type_set_string

( CassUserType * user_type, size_t index, const char * value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value const char *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_string_n

( CassUserType * user_type, size_t index, const char * value, size_t value_length )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value const char *
in value_length size_t
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_string
See Also:
CassError

cass_user_type_set_string_by_name

( CassUserType * user_type, const char * name, const char * value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value const char *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_string_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, const char * value, size_t value_length )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value const char *
in value_length size_t
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_string_by_name
See Also:
CassError

cass_user_type_set_bytes

( CassUserType * user_type, size_t index, const cass_byte_t * value, size_t value_size )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value const cass_byte_t *
in value_size size_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_bytes_by_name

( CassUserType * user_type, const char * name, const cass_byte_t * value, size_t value_size )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value const cass_byte_t *
in value_size size_t
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_bytes_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, const cass_byte_t * value, size_t value_size )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value const cass_byte_t *
in value_size size_t
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_bytes_by_name
See Also:
CassError

cass_user_type_set_uuid

( CassUserType * user_type, size_t index, CassUuid value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value CassUuid
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_uuid_by_name

( CassUserType * user_type, const char * name, CassUuid value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value CassUuid
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_uuid_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, CassUuid value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value CassUuid
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_uuid_by_name
See Also:
CassError

cass_user_type_set_inet

( CassUserType * user_type, size_t index, CassInet value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value CassInet
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_inet_by_name

( CassUserType * user_type, const char * name, CassInet value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value CassInet
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_inet_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, CassInet value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value CassInet
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_inet_by_name
See Also:
CassError

cass_user_type_set_decimal

( CassUserType * user_type, size_t index, const cass_byte_t * varint, size_t varint_size, int scale )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in varint const cass_byte_t *
in varint_size size_t
in scale int
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_decimal_by_name

( CassUserType * user_type, const char * name, const cass_byte_t * varint, size_t varint_size, int scale )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in varint const cass_byte_t *
in varint_size size_t
in scale int
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_decimal_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, const cass_byte_t * varint, size_t varint_size, int scale )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in varint const cass_byte_t *
in varint_size size_t
in scale int
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_decimal_by_name
See Also:
CassError

cass_user_type_set_collection

( CassUserType * user_type, size_t index, const CassCollection * value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value const CassCollection *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_collection_by_name

( CassUserType * user_type, const char * name, const CassCollection * value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value const CassCollection *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_collection_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, const CassCollection * value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value const CassCollection *
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_collection_by_name
See Also:
CassError

cass_user_type_set_tuple

( CassUserType * user_type, size_t index, const CassTuple * value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value const CassTuple *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_tuple_by_name

( CassUserType * user_type, const char * name, const CassTuple * value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value const CassTuple *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_tuple_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, const CassTuple * value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value const CassTuple *
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_tuple_by_name
See Also:
CassError

cass_user_type_set_user_type

( CassUserType * user_type, size_t index, const CassUserType * value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in index size_t
in value const CassUserType *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_user_type_by_name

( CassUserType * user_type, const char * name, const CassUserType * value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in value const CassUserType *
Returns:
Type Details
CassError

CASS_OK if successful, otherwise an error occurred.
CassError

cass_user_type_set_user_type_by_name_n

( CassUserType * user_type, const char * name, size_t name_length, const CassUserType * value )

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

Parameters:
Name Type Details
in user_type CassUserType *
in name const char *
in name_length size_t
in value const CassUserType *
Returns:
Type Details
CassError

same as CassUserType::cass_user_type_set_user_type_by_name
See Also: