[][src]Crate cassandra_cpp_sys

Re-exports

pub use ffi_util::*;
pub use cassandra::cass_bool_t::cass_true;
pub use cassandra::cass_bool_t::cass_false;
pub use cassandra::CassError_::*;
pub use cassandra::CassSslVerifyFlags::*;
pub use cassandra::CassBatchType_::*;
pub use cassandra::CassLogLevel_::CASS_LOG_INFO;
pub use cassandra::CassValueType_::*;
pub use cassandra::CassCollectionType_::CASS_COLLECTION_TYPE_SET;
pub use cassandra::CassCollectionType_::CASS_COLLECTION_TYPE_LIST;
pub use cassandra::CassCollectionType_::CASS_COLLECTION_TYPE_MAP;

Modules

ffi_util

Structs

CassAggregateMeta_
CassAuthenticatorCallbacks_

Authenticator callbacks

CassAuthenticator_
CassBatch_
CassCluster_
CassCollection_
CassColumnMeta_
CassCustomPayload_
CassDataType_
CassErrorResult_
CassExecProfile_
CassFunctionMeta_
CassFuture_
CassIndexMeta_
CassInet_

IP address for either IPv4 or IPv6.

CassIterator_
CassKeyspaceMeta_
CassLogMessage_

A log message.

CassMaterializedViewMeta_
CassMetrics_

A snapshot of the session's performance/diagnostic metrics.

CassMetrics___bindgen_ty_1
CassMetrics___bindgen_ty_2
CassMetrics___bindgen_ty_3
CassPrepared_
CassResult_
CassRetryPolicy_
CassRow_
CassSchemaMeta_
CassSession_
CassSpeculativeExecutionMetrics_
CassSsl_
CassStatement_
CassTableMeta_
CassTimestampGen_
CassTuple_
CassUserType_
CassUuidGen_
CassUuid_

Version 1 (time-based) or version 4 (random) UUID.

CassValue_
CassVersion_

Describes the version of the connected Cassandra cluster.

Enums

CassBatchType
CassBatchType_
CassClusteringOrder
CassClusteringOrder_
CassCollectionType
CassCollectionType_
CassColumnType
CassColumnType_
CassConsistency
CassConsistency_
CassError
CassErrorSource
CassErrorSource_
CassError_
CassIndexType
CassIndexType_
CassIteratorType
CassIteratorType_
CassLogLevel
CassLogLevel_
CassProtocolVersion
CassProtocolVersion_
CassSslVerifyFlags
CassSslVerifyFlags_
CassValueType
CassValueType_
CassWriteType
CassWriteType_
cass_bool_t

Constants

CASS_INET_STRING_LENGTH
CASS_INET_V4_LENGTH
CASS_INET_V6_LENGTH
CASS_LOG_MAX_MESSAGE_SIZE
CASS_UINT64_MAX
CASS_UUID_STRING_LENGTH
CASS_VERSION_MAJOR
CASS_VERSION_MINOR
CASS_VERSION_PATCH
CASS_VERSION_SUFFIX
INT8_MIN
INT8_MAX
INT16_MIN
INT16_MAX
INT32_MIN
INT32_MAX
INTPTR_MAX
INTPTR_MIN
INT_FAST8_MIN
INT_FAST8_MAX
INT_FAST16_MIN
INT_FAST16_MAX
INT_FAST32_MIN
INT_FAST32_MAX
INT_LEAST8_MIN
INT_LEAST8_MAX
INT_LEAST16_MIN
INT_LEAST16_MAX
INT_LEAST32_MIN
INT_LEAST32_MAX
PTRDIFF_MAX
PTRDIFF_MIN
SIG_ATOMIC_MAX
SIG_ATOMIC_MIN
SIZE_MAX
UINT8_MAX
UINT16_MAX
UINT32_MAX
UINTPTR_MAX
UINT_FAST8_MAX
UINT_FAST16_MAX
UINT_FAST32_MAX
UINT_LEAST8_MAX
UINT_LEAST16_MAX
UINT_LEAST32_MAX
WCHAR_MAX
WCHAR_MIN
WINT_MAX
WINT_MIN
_ATFILE_SOURCE
_BITS_WCHAR_H
_BSD_SOURCE
_FEATURES_H
_POSIX_C_SOURCE
_POSIX_SOURCE
_STDC_PREDEF_H
_STDINT_H
_SVID_SOURCE
_SYS_CDEFS_H
__GLIBC_HAVE_LONG_LONG
__GLIBC_MINOR__
__GLIBC__
__GNU_LIBRARY__
__STDC_IEC_559__
__STDC_IEC_559_COMPLEX__
__STDC_ISO_10646__
__STDC_NO_THREADS__
__SYSCALL_WORDSIZE
__USE_ANSI
__USE_ATFILE
__USE_BSD
__USE_FORTIFY_LEVEL
__USE_ISOC11
__USE_ISOC95
__USE_ISOC99
__USE_MISC
__USE_POSIX
__USE_POSIX2
__USE_POSIX199309
__USE_POSIX199506
__USE_POSIX_IMPLICITLY
__USE_SVID
__USE_XOPEN2K
__USE_XOPEN2K8
__WCHAR_MAX
__WCHAR_MIN
__WORDSIZE
__WORDSIZE_TIME64_COMPAT32

Functions

cass_aggregate_meta_argument_count

Gets the number of arguments this aggregate takes.

cass_aggregate_meta_argument_type

Gets the aggregate's argument type for the provided index.

cass_aggregate_meta_field_by_name

Gets a metadata field for the provided name. Metadata fields allow direct access to the column data found in the underlying "aggregates" metadata table.

cass_aggregate_meta_field_by_name_n

Same as cass_aggregate_meta_field_by_name(), but with lengths for string parameters.

cass_aggregate_meta_final_func

Gets the function metadata for the aggregates's final function.

cass_aggregate_meta_full_name

Gets the full name of the aggregate. The full name includes the aggregate's name and the aggregate's signature: "name(type1 type2.. typeN)".

cass_aggregate_meta_init_cond

Gets the initial condition value for the aggregate.

cass_aggregate_meta_name

Gets the name of the aggregate.

cass_aggregate_meta_return_type

Gets the return type of the aggregate.

cass_aggregate_meta_state_func

Gets the function metadata for the aggregate's state function.

cass_aggregate_meta_state_type

Gets the state type of the aggregate.

cass_alloc_set_functions

Set custom allocation functions.

cass_authenticator_address

Gets the IP address of the host being authenticated.

cass_authenticator_class_name

Gets the class name for the server-side IAuthentication implementation.

cass_authenticator_exchange_data

Gets the user data created during the authenticator exchange. This is set using cass_authenticator_set_exchange_data().

cass_authenticator_hostname

Gets the hostname of the host being authenticated.

cass_authenticator_response

Gets a response token buffer of the provided size.

cass_authenticator_set_error

Sets an error for the authenticator exchange.

cass_authenticator_set_error_n

Same as cass_authenticator_set_error(), but with lengths for string parameters.

cass_authenticator_set_exchange_data

Sets the user data to be used during the authenticator exchange.

cass_authenticator_set_response

Sets the response token.

cass_batch_add_statement

Adds a statement to a batch.

cass_batch_free

Frees a batch instance. Batches can be immediately freed after being executed.

cass_batch_new

Creates a new batch statement with batch type.

cass_batch_set_consistency

Sets the batch's consistency level

cass_batch_set_custom_payload

Sets the batch's custom payload.

cass_batch_set_execution_profile

Sets the execution profile to execute the batch with.

cass_batch_set_execution_profile_n

Same as cass_batch_set_execution_profile(), but with lengths for string parameters.

cass_batch_set_is_idempotent

Sets whether the statements in a batch are idempotent. Idempotent batches are able to be automatically retried after timeouts/errors and can be speculatively executed.

cass_batch_set_keyspace

Sets the batch's keyspace. When using protocol v5 or greater it overrides the session's keyspace for the batch.

cass_batch_set_keyspace_n

Same as cass_batch_set_keyspace(), but with lengths for string parameters.

cass_batch_set_request_timeout

Sets the batch's timeout for waiting for a response from a node.

cass_batch_set_retry_policy

Sets the batch's retry policy.

cass_batch_set_serial_consistency

Sets the batch's serial consistency level.

cass_batch_set_timestamp

Sets the batch's timestamp.

cass_cluster_free

Frees a cluster instance.

cass_cluster_new

Creates a new cluster.

cass_cluster_set_authenticator_callbacks

Sets custom authenticator

cass_cluster_set_blacklist_dc_filtering

Same as cass_cluster_set_blacklist_filtering(), but blacklist all hosts of a dc

cass_cluster_set_blacklist_dc_filtering_n

Same as cass_cluster_set_blacklist_dc_filtering(), but with lengths for string parameters.

cass_cluster_set_blacklist_filtering

Sets/Appends blacklist hosts. The first call sets the blacklist hosts and any subsequent calls appends additional hosts. Passing an empty string will clear and disable the blacklist. White space is striped from the hosts.

cass_cluster_set_blacklist_filtering_n

Same as cass_cluster_set_blacklist_filtering_hosts(), but with lengths for string parameters.

cass_cluster_set_coalesce_delay

Sets the amount of time, in microseconds, to wait for new requests to coalesce into a single system call. This should be set to a value around the latency SLA of your application's requests while also considering the request's roundtrip time. Larger values should be used for throughput bound workloads and lower values should be used for latency bound workloads.

cass_cluster_set_connect_timeout

Sets the timeout for connecting to a node.

cass_cluster_set_connection_heartbeat_interval

Sets the amount of time between heartbeat messages and controls the amount of time the connection must be idle before sending heartbeat messages. This is useful for preventing intermediate network devices from dropping connections.

cass_cluster_set_connection_idle_timeout

Sets the amount of time a connection is allowed to be without a successful heartbeat response before being terminated and scheduled for reconnection.

cass_cluster_set_consistency

Sets default consistency level of statement.

cass_cluster_set_constant_speculative_execution_policy

Enable constant speculative executions with the supplied settings.

cass_cluster_set_contact_points

Sets/Appends contact points. This MUST be set. The first call sets the contact points and any subsequent calls appends additional contact points. Passing an empty string will clear the contact points. White space is striped from the contact points.

cass_cluster_set_contact_points_n

Same as cass_cluster_set_contact_points(), but with lengths for string parameters.

cass_cluster_set_core_connections_per_host

Sets the number of connections made to each server in each IO thread.

cass_cluster_set_credentials

Sets credentials for plain text authentication.

cass_cluster_set_credentials_n

Same as cass_cluster_set_credentials(), but with lengths for string parameters.

cass_cluster_set_execution_profile

Associates a named execution profile which can be utilized during execution.

cass_cluster_set_execution_profile_n

Same as cass_cluster_add_execution_profile(), but with lengths for string parameters.

cass_cluster_set_latency_aware_routing

Configures the cluster to use latency-aware request routing or not.

cass_cluster_set_latency_aware_routing_settings

Configures the settings for latency-aware request routing.

cass_cluster_set_load_balance_dc_aware

Configures the cluster to use DC-aware load balancing. For each query, all live nodes in a primary 'local' DC are tried first, followed by any node from other DCs.

cass_cluster_set_load_balance_dc_aware_n

Same as cass_cluster_set_load_balance_dc_aware(), but with lengths for string parameters.

cass_cluster_set_load_balance_round_robin

Configures the cluster to use round-robin load balancing.

cass_cluster_set_local_address

Sets the local address to bind when connecting to the cluster, if desired.

cass_cluster_set_local_address_n

Same as cass_cluster_set_local_address(), but with lengths for string parameters.

cass_cluster_set_max_concurrent_creation
cass_cluster_set_max_concurrent_requests_threshold
cass_cluster_set_max_connections_per_host
cass_cluster_set_max_requests_per_flush
cass_cluster_set_max_reusable_write_objects

Sets the maximum number of "pending write" objects that will be saved for re-use for marshalling new requests. These objects may hold on to a significant amount of memory and reducing the number of these objects may reduce memory usage of the application.

cass_cluster_set_max_schema_wait_time

Sets the maximum time to wait for schema agreement after a schema change is made (e.g. creating, altering, dropping a table/keyspace/view/index etc).

cass_cluster_set_new_request_ratio

Sets the ratio of time spent processing new requests versus handling the I/O and processing of outstanding requests. The range of this setting is 1 to 100, where larger values allocate more time to processing new requests and smaller values allocate more time to processing outstanding requests.

cass_cluster_set_no_compact

Enable the NO_COMPACT startup option.

cass_cluster_set_no_speculative_execution_policy

Disable speculative executions

cass_cluster_set_num_threads_io

Sets the number of IO threads. This is the number of threads that will handle query requests.

cass_cluster_set_pending_requests_high_water_mark
cass_cluster_set_pending_requests_low_water_mark
cass_cluster_set_port

Sets the port.

cass_cluster_set_prepare_on_all_hosts

Prepare statements on all available hosts.

cass_cluster_set_prepare_on_up_or_add_host

Enable pre-preparing cached prepared statements when existing hosts become available again or when new hosts are added to the cluster.

cass_cluster_set_protocol_version

Sets the protocol version. This will automatically downgrade to the lowest supported protocol version.

cass_cluster_set_queue_size_event
cass_cluster_set_queue_size_io

Sets the size of the fixed size queue that stores pending requests.

cass_cluster_set_reconnect_wait_time

Sets the amount of time to wait before attempting to reconnect.

cass_cluster_set_request_timeout

Sets the timeout for waiting for a response from a node.

cass_cluster_set_resolve_timeout

Sets the timeout for waiting for DNS name resolution.

cass_cluster_set_retry_policy

Sets the retry policy used for all requests unless overridden by setting a retry policy on a statement or a batch.

cass_cluster_set_serial_consistency

Sets default serial consistency level of statement.

cass_cluster_set_ssl

Sets the SSL context and enables SSL.

cass_cluster_set_tcp_keepalive

Enable/Disable TCP keep-alive

cass_cluster_set_tcp_nodelay

Enable/Disable Nagle's algorithm on connections.

cass_cluster_set_timestamp_gen

Sets the timestamp generator used to assign timestamps to all requests unless overridden by setting the timestamp on a statement or a batch.

cass_cluster_set_token_aware_routing

Configures the cluster to use token-aware request routing or not.

cass_cluster_set_token_aware_routing_shuffle_replicas

Configures token-aware routing to randomly shuffle replicas. This can reduce the effectiveness of server-side caching, but it can better distribute load over replicas for a given partition key.

cass_cluster_set_use_beta_protocol_version

Use the newest beta protocol version. This currently enables the use of protocol version v5 (CASS_PROTOCOL_VERSION_V5).

cass_cluster_set_use_hostname_resolution

Enable/Disable retrieving hostnames for IP addresses using reverse IP lookup.

cass_cluster_set_use_randomized_contact_points

Enable/Disable the randomization of the contact points list.

cass_cluster_set_use_schema

Enable/Disable retrieving and updating schema metadata. If disabled this is allows the driver to skip over retrieving and updating schema metadata and cass_session_get_schema_meta() will always return an empty object. This can be useful for reducing the startup overhead of short-lived sessions.

cass_cluster_set_whitelist_dc_filtering

Same as cass_cluster_set_whitelist_filtering(), but whitelist all hosts of a dc

cass_cluster_set_whitelist_dc_filtering_n

Same as cass_cluster_set_whitelist_dc_filtering(), but with lengths for string parameters.

cass_cluster_set_whitelist_filtering

Sets/Appends whitelist hosts. The first call sets the whitelist hosts and any subsequent calls appends additional hosts. Passing an empty string will clear and disable the whitelist. White space is striped from the hosts.

cass_cluster_set_whitelist_filtering_n

Same as cass_cluster_set_whitelist_filtering(), but with lengths for string parameters.

cass_cluster_set_write_bytes_high_water_mark
cass_cluster_set_write_bytes_low_water_mark
cass_collection_append_bool

Appends a "boolean" to the collection.

cass_collection_append_bytes

Appends a "blob", "varint" or "custom" to the collection.

cass_collection_append_collection

Appends a "list", "map" or "set" to the collection.

cass_collection_append_custom

Appends a "custom" to the collection.

cass_collection_append_custom_n

Same as cass_collection_append_custom(), but with lengths for string parameters.

cass_collection_append_decimal

Appends a "decimal" to the collection.

cass_collection_append_double

Appends a "double" to the collection.

cass_collection_append_duration

Appends a "duration" to the collection.

cass_collection_append_float

Appends a "float" to the collection.

cass_collection_append_inet

Appends an "inet" to the collection.

cass_collection_append_int8

Appends a "tinyint" to the collection.

cass_collection_append_int16

Appends an "smallint" to the collection.

cass_collection_append_int32

Appends an "int" to the collection.

cass_collection_append_int64

Appends a "bigint", "counter", "timestamp" or "time" to the collection.

cass_collection_append_string

Appends an "ascii", "text" or "varchar" to the collection.

cass_collection_append_string_n

Same as cass_collection_append_string(), but with lengths for string parameters.

cass_collection_append_tuple

Appends a "tuple" to the collection.

cass_collection_append_uint32

Appends a "date" to the collection.

cass_collection_append_user_type

Appends a "udt" to the collection.

cass_collection_append_uuid

Appends a "uuid" or "timeuuid" to the collection.

cass_collection_data_type

Gets the data type of a collection.

cass_collection_free

Frees a collection instance.

cass_collection_new

Creates a new collection.

cass_collection_new_from_data_type

Creates a new collection from an existing data type.

cass_column_meta_data_type

Gets the data type of the column.

cass_column_meta_field_by_name

Gets a metadata field for the provided name. Metadata fields allow direct access to the column data found in the underlying "columns" metadata table.

cass_column_meta_field_by_name_n

Same as cass_column_meta_field_by_name(), but with lengths for string parameters.

cass_column_meta_name

Gets the name of the column.

cass_column_meta_type

Gets the type of the column.

cass_consistency_string

Gets the string for a consistency.

cass_custom_payload_free

Frees a custom payload instance.

cass_custom_payload_new

Creates a new custom payload.

cass_custom_payload_remove

Removes an item from the custom payload.

cass_custom_payload_remove_n

Same as cass_custom_payload_set(), but with lengths for string parameters.

cass_custom_payload_set

Sets an item to the custom payload.

cass_custom_payload_set_n

Same as cass_custom_payload_set(), but with lengths for string parameters.

cass_data_sub_type_count
cass_data_type_add_sub_type

Adds a sub-data type to a tuple or collection.

cass_data_type_add_sub_type_by_name

Adds a sub-data type to a UDT (user defined type).

cass_data_type_add_sub_type_by_name_n

Same as cass_data_type_add_sub_type_by_name(), but with lengths for string parameters.

cass_data_type_add_sub_value_type

Adds a sub-data type to a tuple or collection using a value type.

cass_data_type_add_sub_value_type_by_name

Adds a sub-data type to a UDT (user defined type) using a value type.

cass_data_type_add_sub_value_type_by_name_n

Same as cass_data_type_add_sub_value_type_by_name(), but with lengths for string parameters.

cass_data_type_class_name

Gets the class name of a custom data type.

cass_data_type_free

Frees a data type instance.

cass_data_type_is_frozen

Gets whether a data type is frozen.

cass_data_type_keyspace

Gets the type name of a UDT data type.

cass_data_type_new

Creates a new data type with value type.

cass_data_type_new_from_existing

Creates a new data type from an existing data type.

cass_data_type_new_tuple

Creates a new tuple data type.

cass_data_type_new_udt

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

cass_data_type_set_class_name

Sets the class name of a custom data type.

cass_data_type_set_class_name_n

Same as cass_data_type_set_class_name(), but with lengths for string parameters.

cass_data_type_set_keyspace

Sets the keyspace of a UDT data type.

cass_data_type_set_keyspace_n

Same as cass_data_type_set_keyspace(), but with lengths for string parameters.

cass_data_type_set_type_name

Sets the type name of a UDT data type.

cass_data_type_set_type_name_n

Same as cass_data_type_set_type_name(), but with lengths for string parameters.

cass_data_type_sub_data_type

Gets the sub-data type of a UDT (user defined type), tuple or collection at the specified index.

cass_data_type_sub_data_type_by_name

Gets the sub-data type of a UDT (user defined type) at the specified index.

cass_data_type_sub_data_type_by_name_n

Same as cass_data_type_sub_data_type_by_name(), but with lengths for string parameters.

cass_data_type_sub_type_count

Gets the sub-data type count of a UDT (user defined type), tuple or collection.

cass_data_type_sub_type_name

Gets the sub-type name of a UDT (user defined type) at the specified index.

cass_data_type_type

Gets the value type of the specified data type.

cass_data_type_type_name

Gets the type name of a UDT data type.

cass_date_from_epoch

Converts a unix timestamp (in seconds) to the Cassandra "date" type. The "date" type represents the number of days since the Epoch (1970-01-01) with the Epoch centered at the value 2^31.

cass_date_time_to_epoch

Combines the Cassandra "date" and "time" types to Epoch time in seconds.

cass_error_desc

Gets a description for an error code.

cass_error_num_arg_types

Gets the number of argument types for the function failure error (CASS_ERROR_SERVER_FUNCTION_FAILURE) result type.

cass_error_result_arg_type

Gets the argument type at the specified index for the function failure error (CASS_ERROR_SERVER_FUNCTION_FAILURE) result type.

cass_error_result_code

Gets error code for the error result. This error code will always have an server error source.

cass_error_result_consistency

Gets consistency that triggered the error result of the following types:

cass_error_result_data_present

Determines whether the actual data was present in the responses from the replicas for the following error result types:

cass_error_result_free

Frees an error result instance.

cass_error_result_function

Gets the affected function for the function failure error (CASS_ERROR_SERVER_FUNCTION_FAILURE) result type.

cass_error_result_keyspace

Gets the affected keyspace for the following error result types:

cass_error_result_num_failures

Gets the number of nodes that experienced failures for the following error types:

cass_error_result_responses_received

Gets the actual number of received responses, received acknowledgments or alive nodes for following error result types, respectively:

cass_error_result_responses_required

Gets required responses, required acknowledgments or required alive nodes needed to successfully complete the request for following error result types, respectively:

cass_error_result_table

Gets the affected table for the already exists error (CASS_ERROR_SERVER_ALREADY_EXISTS) result type.

cass_error_result_write_type

Gets the write type of a request for the following error result types:

cass_execution_profile_free

Frees a execution profile instance.

cass_execution_profile_new

Creates a new execution profile.

cass_execution_profile_set_blacklist_dc_filtering

Same as cass_execution_profile_set_blacklist_filtering(), but blacklist all hosts of a dc.

cass_execution_profile_set_blacklist_dc_filtering_n

Same as cass_execution_profile_set_blacklist_dc_filtering(), but with lengths for string parameters.

cass_execution_profile_set_blacklist_filtering

Sets/Appends blacklist hosts for the execution profile. The first call sets the blacklist hosts and any subsequent calls appends additional hosts. Passing an empty string will clear and disable the blacklist. White space is striped from the hosts.

cass_execution_profile_set_blacklist_filtering_n

Same as cass_execution_profile_set_blacklist_filtering(), but with lengths for string parameters.

cass_execution_profile_set_consistency

Sets the consistency level.

cass_execution_profile_set_constant_speculative_execution_policy

Enable constant speculative executions with the supplied settings for the execution profile.

cass_execution_profile_set_latency_aware_routing

Configures the execution profile to use latency-aware request routing or not.

cass_execution_profile_set_latency_aware_routing_settings

Configures the execution profile's settings for latency-aware request routing.

cass_execution_profile_set_load_balance_dc_aware

Configures the execution profile to use DC-aware load balancing. For each query, all live nodes in a primary 'local' DC are tried first, followed by any node from other DCs.

cass_execution_profile_set_load_balance_dc_aware_n

Same as cass_execution_profile_set_load_balance_dc_aware(), but with lengths for string parameters.

cass_execution_profile_set_load_balance_round_robin

Configures the execution profile to use round-robin load balancing.

cass_execution_profile_set_no_speculative_execution_policy

Disable speculative executions for the execution profile.

cass_execution_profile_set_request_timeout

Sets the timeout waiting for a response from a node.

cass_execution_profile_set_retry_policy

Sets the execution profile's retry policy.

cass_execution_profile_set_serial_consistency

Sets the serial consistency level.

cass_execution_profile_set_token_aware_routing

Configures the execution profile to use token-aware request routing or not.

cass_execution_profile_set_token_aware_routing_shuffle_replicas

Configures the execution profile's token-aware routing to randomly shuffle replicas. This can reduce the effectiveness of server-side caching, but it can better distribute load over replicas for a given partition key.

cass_execution_profile_set_whitelist_dc_filtering

Same as cass_execution_profile_set_whitelist_filtering(), but whitelist all hosts of a dc.

cass_execution_profile_set_whitelist_dc_filtering_n

Same as cass_execution_profile_set_whitelist_dc_filtering(), but with lengths for string parameters.

cass_execution_profile_set_whitelist_filtering

Sets/Appends whitelist hosts for the execution profile. The first call sets the whitelist hosts and any subsequent calls appends additional hosts. Passing an empty string will clear and disable the whitelist. White space is striped from the hosts.

cass_execution_profile_set_whitelist_filtering_n

Same as cass_execution_profile_set_whitelist_filtering(), but with lengths for string parameters.

cass_function_meta_argument

Gets the function's argument name and type for the provided index.

cass_function_meta_argument_count

Gets the number of arguments this function takes.

cass_function_meta_argument_type_by_name

Gets the function's argument and type for the provided name.

cass_function_meta_argument_type_by_name_n

Same as cass_function_meta_argument_type_by_name(), but with lengths for string parameters.

cass_function_meta_body

Gets the body of the function.

cass_function_meta_called_on_null_input

Gets whether a function is called on "null".

cass_function_meta_field_by_name

Gets a metadata field for the provided name. Metadata fields allow direct access to the column data found in the underlying "functions" metadata table.

cass_function_meta_field_by_name_n

Same as cass_function_meta_field_by_name(), but with lengths for string parameters.

cass_function_meta_full_name

Gets the full name of the function. The full name includes the function's name and the function's signature: "name(type1 type2.. typeN)".

cass_function_meta_language

Gets the language of the function.

cass_function_meta_name

Gets the name of the function.

cass_function_meta_return_type

Gets the return type of the function.

cass_future_custom_payload_item

Gets a custom payload item from a response future at the specified index. If the future is not ready this method will wait for the future to be set.

cass_future_custom_payload_item_count

Gets a the number of custom payload items from a response future. If the future is not ready this method will wait for the future to be set.

cass_future_error_code

Gets the error code from future. If the future is not ready this method will wait for the future to be set.

cass_future_error_message

Gets the error message from future. If the future is not ready this method will wait for the future to be set.

cass_future_free

Frees a future instance. A future can be freed anytime.

cass_future_get_error_result

Gets the error result from a future that failed as a result of a server error. If the future is not ready this method will wait for the future to be set.

cass_future_get_prepared

Gets the result of a successful future. If the future is not ready this method will wait for the future to be set. The first successful call consumes the future, all subsequent calls will return NULL.

cass_future_get_result

Gets the result of a successful future. If the future is not ready this method will wait for the future to be set.

cass_future_ready

Gets the set status of the future.

cass_future_set_callback

Sets a callback that is called when a future is set

cass_future_wait

Wait for the future to be set with either a result or error.

cass_future_wait_timed

Wait for the future to be set or timeout.

cass_index_meta_field_by_name

Gets a metadata field for the provided name. Metadata fields allow direct access to the index data found in the underlying "indexes" metadata table.

cass_index_meta_field_by_name_n

Same as cass_index_meta_field_by_name(), but with lengths for string parameters.

cass_index_meta_name

Gets the name of the index.

cass_index_meta_options

Gets the options of the index.

cass_index_meta_target

Gets the target of the index.

cass_index_meta_type

Gets the type of the index.

cass_inet_from_string

Returns an inet for the specified string.

cass_inet_from_string_n

Same as cass_inet_from_string(), but with lengths for string parameters.

cass_inet_init_v4

Constructs an inet v4 object.

cass_inet_init_v6

Constructs an inet v6 object.

cass_inet_string

Returns a null-terminated string for the specified inet.

cass_iterator_aggregates_from_keyspace_meta

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over aggregates.

cass_iterator_columns_from_materialized_view_meta

Creates a new iterator for the specified materialized view metadata. This can be used to iterate over columns.

cass_iterator_columns_from_table_meta

Creates a new iterator for the specified table metadata. This can be used to iterate over columns.

cass_iterator_fields_from_aggregate_meta

Creates a new fields iterator for the specified aggregate metadata. Metadata fields allow direct access to the column data found in the underlying "aggregates" metadata table. This can be used to iterate those metadata field entries.

cass_iterator_fields_from_column_meta

Creates a new fields iterator for the specified column metadata. Metadata fields allow direct access to the column data found in the underlying "columns" metadata table. This can be used to iterate those metadata field entries.

cass_iterator_fields_from_function_meta

Creates a new fields iterator for the specified function metadata. Metadata fields allow direct access to the column data found in the underlying "functions" metadata table. This can be used to iterate those metadata field entries.

cass_iterator_fields_from_index_meta

Creates a new fields iterator for the specified index metadata. Metadata fields allow direct access to the index data found in the underlying "indexes" metadata table. This can be used to iterate those metadata field entries.

cass_iterator_fields_from_keyspace_meta

Creates a new fields iterator for the specified keyspace metadata. Metadata fields allow direct access to the column data found in the underlying "keyspaces" metadata table. This can be used to iterate those metadata field entries.

cass_iterator_fields_from_materialized_view_meta

Creates a new fields iterator for the specified materialized view metadata. Metadata fields allow direct access to the column data found in the underlying "views" metadata view. This can be used to iterate those metadata field entries.

cass_iterator_fields_from_table_meta

Creates a new fields iterator for the specified table metadata. Metadata fields allow direct access to the column data found in the underlying "tables" metadata table. This can be used to iterate those metadata field entries.

cass_iterator_fields_from_user_type

Creates a new iterator for the specified user defined type. This can be used to iterate over fields in a user defined type.

cass_iterator_free

Frees an iterator instance.

cass_iterator_from_collection

Creates a new iterator for the specified collection. This can be used to iterate over values in a collection.

cass_iterator_from_map

Creates a new iterator for the specified map. This can be used to iterate over key/value pairs in a map.

cass_iterator_from_result

Creates a new iterator for the specified result. This can be used to iterate over rows in the result.

cass_iterator_from_row

Creates a new iterator for the specified row. This can be used to iterate over columns in a row.

cass_iterator_from_tuple

Creates a new iterator for the specified tuple. This can be used to iterate over values in a tuple.

cass_iterator_functions_from_keyspace_meta

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over functions.

cass_iterator_get_aggregate_meta

Gets the aggregate metadata entry at the iterator's current position.

cass_iterator_get_column

Gets the column value at the row iterator's current position.

cass_iterator_get_column_meta

Gets the column metadata entry at the iterator's current position.

cass_iterator_get_function_meta

Gets the function metadata entry at the iterator's current position.

cass_iterator_get_index_meta

Gets the index metadata entry at the iterator's current position.

cass_iterator_get_keyspace_meta

Gets the keyspace metadata entry at the iterator's current position.

cass_iterator_get_map_key

Gets the key at the map iterator's current position.

cass_iterator_get_map_value

Gets the value at the map iterator's current position.

cass_iterator_get_materialized_view_meta

Gets the materialized view metadata entry at the iterator's current position.

cass_iterator_get_meta_field_name

Gets the metadata field name at the iterator's current position.

cass_iterator_get_meta_field_value

Gets the metadata field value at the iterator's current position.

cass_iterator_get_row

Gets the row at the result iterator's current position.

cass_iterator_get_table_meta

Gets the table metadata entry at the iterator's current position.

cass_iterator_get_user_type

Gets the type metadata entry at the iterator's current position.

cass_iterator_get_user_type_field_name

Gets the field name at the user type defined iterator's current position.

cass_iterator_get_user_type_field_value

Gets the field value at the user type defined iterator's current position.

cass_iterator_get_value

Gets the value at a collection or tuple iterator's current position.

cass_iterator_indexes_from_table_meta

Creates a new iterator for the specified table metadata. This can be used to iterate over indexes.

cass_iterator_keyspaces_from_schema_meta

Creates a new iterator for the specified schema metadata. This can be used to iterate over keyspace.

cass_iterator_materialized_views_from_keyspace_meta

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over views.

cass_iterator_materialized_views_from_table_meta

Creates a new iterator for the specified materialized view metadata. This can be used to iterate over columns.

cass_iterator_next

Advance the iterator to the next row, column or collection item.

cass_iterator_tables_from_keyspace_meta

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over tables.

cass_iterator_type

Gets the type of the specified iterator.

cass_iterator_user_types_from_keyspace_meta

Creates a new iterator for the specified keyspace metadata. This can be used to iterate over types.

cass_keyspace_meta_aggregate_by_name

Gets the aggregate metadata for the provided aggregate name.

cass_keyspace_meta_aggregate_by_name_n

Same as cass_keyspace_meta_aggregate_by_name(), but with lengths for string parameters.

cass_keyspace_meta_field_by_name

Gets a metadata field for the provided name. Metadata fields allow direct access to the column data found in the underlying "keyspaces" metadata table.

cass_keyspace_meta_field_by_name_n

Same as cass_keyspace_meta_field_by_name(), but with lengths for string parameters.

cass_keyspace_meta_function_by_name

Gets the function metadata for the provided function name.

cass_keyspace_meta_function_by_name_n

Same as cass_keyspace_meta_function_by_name(), but with lengths for string parameters.

cass_keyspace_meta_is_virtual

Determine if the keyspace is a virtual keyspace.

cass_keyspace_meta_materialized_view_by_name

Gets the materialized view metadata for the provided view name.

cass_keyspace_meta_materialized_view_by_name_n

Same as cass_keyspace_meta_materialized_view_by_name(), but with lengths for string parameters.

cass_keyspace_meta_name

Gets the name of the keyspace.

cass_keyspace_meta_table_by_name

Gets the table metadata for the provided table name.

cass_keyspace_meta_table_by_name_n

Same as cass_keyspace_meta_table_by_name(), but with lengths for string parameters.

cass_keyspace_meta_user_type_by_name

Gets the data type for the provided type name.

cass_keyspace_meta_user_type_by_name_n

Same as cass_keyspace_meta_type_by_name(), but with lengths for string parameters.

cass_log_cleanup
cass_log_level_string

Gets the string for a log level.

cass_log_set_callback

Sets a callback for handling logging events.

cass_log_set_level

Sets the log level.

cass_log_set_queue_size
cass_materialized_view_meta_base_table

Gets the base table of the view.

cass_materialized_view_meta_clustering_key

Gets the clustering key column metadata for the provided index.

cass_materialized_view_meta_clustering_key_count

Gets the number of columns for the view's clustering key.

cass_materialized_view_meta_clustering_key_order

Gets the clustering order column metadata for the provided index.

cass_materialized_view_meta_column

Gets the column metadata for the provided index.

cass_materialized_view_meta_column_by_name

Gets the column metadata for the provided column name.

cass_materialized_view_meta_column_by_name_n

Same as cass_materialized_view_meta_column_by_name(), but with lengths for string parameters.

cass_materialized_view_meta_column_count

Gets the total number of columns for the view.

cass_materialized_view_meta_field_by_name

Gets a metadata field for the provided name. Metadata fields allow direct access to the column data found in the underlying "views" metadata view.

cass_materialized_view_meta_field_by_name_n

Same as cass_materialized_view_meta_field_by_name(), but with lengths for string parameters.

cass_materialized_view_meta_name

Gets the name of the view.

cass_materialized_view_meta_partition_key

Gets the partition key column metadata for the provided index.

cass_materialized_view_meta_partition_key_count

Gets the number of columns for the view's partition key.

cass_prepared_bind

Creates a bound statement from a pre-prepared statement.

cass_prepared_free

Frees a prepared instance.

cass_prepared_parameter_data_type

Gets the data type of a parameter at the specified index.

cass_prepared_parameter_data_type_by_name

Gets the data type of a parameter for the specified name.

cass_prepared_parameter_data_type_by_name_n

Same as cass_prepared_parameter_data_type_by_name(), but with lengths for string parameters.

cass_prepared_parameter_name

Gets the name of a parameter at the specified index.

cass_result_column_count

Gets the number of columns per row for the specified result.

cass_result_column_data_type

Gets the column data type at index for the specified result.

cass_result_column_name

Gets the column name at index for the specified result.

cass_result_column_type

Gets the column type at index for the specified result.

cass_result_first_row

Gets the first row of the result.

cass_result_free

Frees a result instance.

cass_result_has_more_pages

Returns true if there are more pages.

cass_result_paging_state_token

Gets the raw paging state from the result. The paging state is bound to the lifetime of the result object. If paging state needs to live beyond the lifetime of the result object it must be copied.

cass_result_row_count

Gets the number of rows for the specified result.

cass_retry_policy_default_new

Creates a new default retry policy.

cass_retry_policy_downgrading_consistency_new

Creates a new downgrading consistency retry policy.

cass_retry_policy_fallthrough_new

Creates a new fallthrough retry policy.

cass_retry_policy_free

Frees a retry policy instance.

cass_retry_policy_logging_new

Creates a new logging retry policy.

cass_row_get_column

Get the column value at index for the specified row.

cass_row_get_column_by_name

Get the column value by name for the specified row.

cass_row_get_column_by_name_n

Same as cass_row_get_column_by_name(), but with lengths for string parameters.

cass_schema_meta_free

Frees a schema metadata instance.

cass_schema_meta_keyspace_by_name

Gets the keyspace metadata for the provided keyspace name.

cass_schema_meta_keyspace_by_name_n

Same as cass_schema_meta_keyspace_by_name(), but with lengths for string parameters.

cass_schema_meta_snapshot_version

Gets the version of the schema metadata snapshot.

cass_schema_meta_version

Gets the version of the connected Cassandra cluster.

cass_session_close

Closes the session instance, outputs a close future which can be used to determine when the session has been terminated. This allows in-flight requests to finish.

cass_session_connect

Connects a session.

cass_session_connect_keyspace

Connects a session and sets the keyspace.

cass_session_connect_keyspace_n

Same as cass_session_connect_keyspace(), but with lengths for string parameters.

cass_session_execute

Execute a query or bound statement.

cass_session_execute_batch

Execute a batch statement.

cass_session_free

Frees a session instance. If the session is still connected it will be synchronously closed before being deallocated.

cass_session_get_metrics

Gets a copy of this session's performance/diagnostic metrics.

cass_session_get_schema_meta

Gets a snapshot of this session's schema metadata. The returned snapshot of the schema metadata is not updated. This function must be called again to retrieve any schema changes since the previous call.

cass_session_get_speculative_execution_metrics

Gets a copy of this session's speculative execution metrics.

cass_session_new

Creates a new session.

cass_session_prepare

Create a prepared statement.

cass_session_prepare_from_existing

Create a prepared statement from an existing statement.

cass_session_prepare_n

Same as cass_session_prepare(), but with lengths for string parameters.

cass_ssl_add_trusted_cert

Adds a trusted certificate. This is used to verify the peer's certificate.

cass_ssl_add_trusted_cert_n

Same as cass_ssl_add_trusted_cert(), but with lengths for string parameters.

cass_ssl_free

Frees a SSL context instance.

cass_ssl_new

Creates a new SSL context.

cass_ssl_new_no_lib_init

Creates a new SSL context without initializing the underlying library implementation. The integrating application is responsible for initializing the underlying SSL implementation. The driver uses the SSL implmentation from several threads concurrently so it's important that it's properly setup for multithreaded use e.g. lock callbacks for OpenSSL.

cass_ssl_set_cert

Set client-side certificate chain. This is used to authenticate the client on the server-side. This should contain the entire Certificate chain starting with the certificate itself.

cass_ssl_set_cert_n

Same as cass_ssl_set_cert(), but with lengths for string parameters.

cass_ssl_set_private_key

Set client-side private key. This is used to authenticate the client on the server-side.

cass_ssl_set_private_key_n

Same as cass_ssl_set_private_key(), but with lengths for string parameters.

cass_ssl_set_verify_flags

Sets verification performed on the peer's certificate.

cass_statement_add_key_index

Adds a key index specifier to this a statement. When using token-aware routing, this can be used to tell the driver which parameters within a non-prepared, parameterized statement are part of the partition key.

cass_statement_bind_bool

Binds a "boolean" to a query or bound statement at the specified index.

cass_statement_bind_bool_by_name

Binds a "boolean" to all the values with the specified name.

cass_statement_bind_bool_by_name_n

Same as cass_statement_bind_bool_by_name(), but with lengths for string parameters.

cass_statement_bind_bytes

Binds a "blob", "varint" or "custom" to a query or bound statement at the specified index.

cass_statement_bind_bytes_by_name

Binds a "blob", "varint" or "custom" to all the values with the specified name.

cass_statement_bind_bytes_by_name_n

Same as cass_statement_bind_bytes_by_name(), but with lengths for string parameters.

cass_statement_bind_collection

Bind a "list", "map" or "set" to a query or bound statement at the specified index.

cass_statement_bind_collection_by_name

Bind a "list", "map" or "set" to all the values with the specified name.

cass_statement_bind_collection_by_name_n

Same as cass_statement_bind_collection_by_name(), but with lengths for string parameters.

cass_statement_bind_custom

Binds a "custom" to a query or bound statement at the specified index.

cass_statement_bind_custom_by_name

Binds a "custom" to all the values with the specified name.

cass_statement_bind_custom_by_name_n

Same as cass_statement_bind_custom_by_name(), but with lengths for string parameters.

cass_statement_bind_custom_n

Same as cass_statement_bind_custom(), but with lengths for string parameters.

cass_statement_bind_decimal

Bind a "decimal" to a query or bound statement at the specified index.

cass_statement_bind_decimal_by_name

Binds a "decimal" to all the values with the specified name.

cass_statement_bind_decimal_by_name_n

Same as cass_statement_bind_decimal_by_name(), but with lengths for string parameters.

cass_statement_bind_double

Binds a "double" to a query or bound statement at the specified index.

cass_statement_bind_double_by_name

Binds a "double" to all the values with the specified name.

cass_statement_bind_double_by_name_n

Same as cass_statement_bind_double_by_name(), but with lengths for string parameters.

cass_statement_bind_duration

Binds a "duration" to a query or bound statement at the specified index.

cass_statement_bind_duration_by_name

Binds a "duration" to all the values with the specified name.

cass_statement_bind_duration_by_name_n

Same as cass_statement_bind_duration_by_name(), but with lengths for string parameters.

cass_statement_bind_float

Binds a "float" to a query or bound statement at the specified index.

cass_statement_bind_float_by_name

Binds a "float" to all the values with the specified name.

cass_statement_bind_float_by_name_n

Same as cass_statement_bind_float_by_name(), but with lengths for string parameters.

cass_statement_bind_inet

Binds an "inet" to a query or bound statement at the specified index.

cass_statement_bind_inet_by_name

Binds an "inet" to all the values with the specified name.

cass_statement_bind_inet_by_name_n

Same as cass_statement_bind_inet_by_name(), but with lengths for string parameters.

cass_statement_bind_int8

Binds a "tinyint" to a query or bound statement at the specified index.

cass_statement_bind_int8_by_name

Binds a "tinyint" to all the values with the specified name.

cass_statement_bind_int8_by_name_n

Same as cass_statement_bind_int8_by_name(), but with lengths for string parameters.

cass_statement_bind_int16

Binds an "smallint" to a query or bound statement at the specified index.

cass_statement_bind_int16_by_name

Binds an "smallint" to all the values with the specified name.

cass_statement_bind_int16_by_name_n

Same as cass_statement_bind_int16_by_name(), but with lengths for string parameters.

cass_statement_bind_int32

Binds an "int" to a query or bound statement at the specified index.

cass_statement_bind_int32_by_name

Binds an "int" to all the values with the specified name.

cass_statement_bind_int32_by_name_n

Same as cass_statement_bind_int32_by_name(), but with lengths for string parameters.

cass_statement_bind_int64

Binds a "bigint", "counter", "timestamp" or "time" to a query or bound statement at the specified index.

cass_statement_bind_int64_by_name

Binds a "bigint", "counter", "timestamp" or "time" to all values with the specified name.

cass_statement_bind_int64_by_name_n

Same as cass_statement_bind_int64_by_name(), but with lengths for string parameters.

cass_statement_bind_null

Binds null to a query or bound statement at the specified index.

cass_statement_bind_null_by_name

Binds a null to all the values with the specified name.

cass_statement_bind_null_by_name_n

Same as cass_statement_bind_null_by_name(), but with lengths for string parameters.

cass_statement_bind_string

Binds an "ascii", "text" or "varchar" to a query or bound statement at the specified index.

cass_statement_bind_string_by_name

Binds an "ascii", "text" or "varchar" to all the values with the specified name.

cass_statement_bind_string_by_name_n

Same as cass_statement_bind_string_by_name(), but with lengths for string parameters.

cass_statement_bind_string_n

Same as cass_statement_bind_string(), but with lengths for string parameters.

cass_statement_bind_tuple

Bind a "tuple" to a query or bound statement at the specified index.

cass_statement_bind_tuple_by_name

Bind a "tuple" to all the values with the specified name.

cass_statement_bind_tuple_by_name_n

Same as cass_statement_bind_tuple_by_name(), but with lengths for string parameters.

cass_statement_bind_uint32

Binds a "date" to a query or bound statement at the specified index.

cass_statement_bind_uint32_by_name

Binds a "date" to all the values with the specified name.

cass_statement_bind_uint32_by_name_n

Same as cass_statement_bind_uint32_by_name(), but with lengths for string parameters.

cass_statement_bind_user_type

Bind a user defined type to a query or bound statement at the specified index.

cass_statement_bind_user_type_by_name

Bind a user defined type to a query or bound statement with the specified name.

cass_statement_bind_user_type_by_name_n

Same as cass_statement_bind_user_type_by_name(), but with lengths for string parameters.

cass_statement_bind_uuid

Binds a "uuid" or "timeuuid" to a query or bound statement at the specified index.

cass_statement_bind_uuid_by_name

Binds a "uuid" or "timeuuid" to all the values with the specified name.

cass_statement_bind_uuid_by_name_n

Same as cass_statement_bind_uuid_by_name(), but with lengths for string parameters.

cass_statement_free

Frees a statement instance. Statements can be immediately freed after being prepared, executed or added to a batch.

cass_statement_new

Creates a new query statement.

cass_statement_new_n

Same as cass_statement_new(), but with lengths for string parameters.

cass_statement_reset_parameters

Clear and/or resize the statement's parameters.

cass_statement_set_consistency

Sets the statement's consistency level.

cass_statement_set_custom_payload

Sets the statement's custom payload.

cass_statement_set_execution_profile

Sets the execution profile to execute the statement with.

cass_statement_set_execution_profile_n

Same as cass_statement_set_execution_profile(), but with lengths for string parameters.

cass_statement_set_is_idempotent

Sets whether the statement is idempotent. Idempotent statements are able to be automatically retried after timeouts/errors and can be speculatively executed.

cass_statement_set_keyspace

Sets the statement's keyspace. This is used for token-aware routing and when using protocol v5 or greater it also overrides the session's current keyspace for the statement.

cass_statement_set_keyspace_n

Same as cass_statement_set_keyspace(), but with lengths for string parameters.

cass_statement_set_paging_size

Sets the statement's page size.

cass_statement_set_paging_state

Sets the statement's paging state. This can be used to get the next page of data in a multi-page query.

cass_statement_set_paging_state_token

Sets the statement's paging state. This can be used to get the next page of data in a multi-page query.

cass_statement_set_request_timeout

Sets the statement's timeout for waiting for a response from a node.

cass_statement_set_retry_policy

Sets the statement's retry policy.

cass_statement_set_serial_consistency

Sets the statement's serial consistency level.

cass_statement_set_timestamp

Sets the statement's timestamp.

cass_table_meta_clustering_key

Gets the clustering key column metadata for the provided index.

cass_table_meta_clustering_key_count

Gets the number of columns for the table's clustering key.

cass_table_meta_clustering_key_order

Gets the clustering order column metadata for the provided index.

cass_table_meta_column

Gets the column metadata for the provided index.

cass_table_meta_column_by_name

Gets the column metadata for the provided column name.

cass_table_meta_column_by_name_n

Same as cass_table_meta_column_by_name(), but with lengths for string parameters.

cass_table_meta_column_count

Gets the total number of columns for the table.

cass_table_meta_field_by_name

Gets a metadata field for the provided name. Metadata fields allow direct access to the column data found in the underlying "tables" metadata table.

cass_table_meta_field_by_name_n

Same as cass_table_meta_field_by_name(), but with lengths for string parameters.

cass_table_meta_index

Gets the index metadata for the provided index.

cass_table_meta_index_by_name

Gets the index metadata for the provided index name.

cass_table_meta_index_by_name_n

Same as cass_table_meta_index_by_name(), but with lengths for string parameters.

cass_table_meta_index_count

Gets the total number of indexes for the table.

cass_table_meta_is_virtual

Determine if the table is a virtual table.

cass_table_meta_materialized_view

Gets the materialized view metadata for the provided index.

cass_table_meta_materialized_view_by_name

Gets the materialized view metadata for the provided view name.

cass_table_meta_materialized_view_by_name_n

Same as cass_table_meta_materialized_view_by_name(), but with lengths for string parameters.

cass_table_meta_materialized_view_count

Gets the total number of views for the table.

cass_table_meta_name

Gets the name of the table.

cass_table_meta_partition_key

Gets the partition key column metadata for the provided index.

cass_table_meta_partition_key_count

Gets the number of columns for the table's partition key.

cass_time_from_epoch

Converts a unix timestamp (in seconds) to the Cassandra "time" type. The "time" type represents the number of nanoseconds since midnight (range 0 to 86399999999999).

cass_timestamp_gen_free

Frees a timestamp generator instance.

cass_timestamp_gen_monotonic_new

Creates a new monotonically increasing timestamp generator with microsecond precision.

cass_timestamp_gen_monotonic_new_with_settings

Same as cass_timestamp_gen_monotonic_new(), but with settings for controlling warnings about clock skew.

cass_timestamp_gen_server_side_new

Creates a new server-side timestamp generator. This generator allows Cassandra to assign timestamps server-side.

cass_tuple_data_type

Gets the data type of a tuple.

cass_tuple_free

Frees a tuple instance.

cass_tuple_new

Creates a new tuple.

cass_tuple_new_from_data_type

Creates a new tuple from an existing data type.

cass_tuple_set_bool

Sets a "boolean" in a tuple at the specified index.

cass_tuple_set_bytes

Sets a "blob", "varint" or "custom" in a tuple at the specified index.

cass_tuple_set_collection

Sets a "list", "map" or "set" in a tuple at the specified index.

cass_tuple_set_custom

Sets a "custom" in a tuple at the specified index.

cass_tuple_set_custom_n

Same as cass_tuple_set_custom(), but with lengths for string parameters.

cass_tuple_set_decimal

Sets a "decimal" in a tuple at the specified index.

cass_tuple_set_double

Sets a "double" in a tuple at the specified index.

cass_tuple_set_duration

Sets a "duration" in a tuple at the specified index.

cass_tuple_set_float

Sets a "float" in a tuple at the specified index.

cass_tuple_set_inet

Sets an "inet" in a tuple at the specified index.

cass_tuple_set_int8

Sets a "tinyint" in a tuple at the specified index.

cass_tuple_set_int16

Sets an "smallint" in a tuple at the specified index.

cass_tuple_set_int32

Sets an "int" in a tuple at the specified index.

cass_tuple_set_int64

Sets a "bigint", "counter", "timestamp" or "time" in a tuple at the specified index.

cass_tuple_set_null

Sets an null in a tuple at the specified index.

cass_tuple_set_string

Sets an "ascii", "text" or "varchar" in a tuple at the specified index.

cass_tuple_set_string_n

Same as cass_tuple_set_string(), but with lengths for string parameters.

cass_tuple_set_tuple

Sets a "tuple" in a tuple at the specified index.

cass_tuple_set_uint32

Sets a "date" in a tuple at the specified index.

cass_tuple_set_user_type

Sets a "udt" in a tuple at the specified index.

cass_tuple_set_uuid

Sets a "uuid" or "timeuuid" in a tuple at the specified index.

cass_user_type_data_type

Gets the data type of a user defined type.

cass_user_type_free

Frees a user defined type instance.

cass_user_type_new_from_data_type

Creates a new user defined type from existing data type;

cass_user_type_set_bool

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

cass_user_type_set_bool_by_name

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

cass_user_type_set_bool_by_name_n

Same as cass_user_type_set_double_by_name(), but with lengths for string parameters.

cass_user_type_set_bytes

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

cass_user_type_set_bytes_by_name

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

cass_user_type_set_bytes_by_name_n

Same as cass_user_type_set_bytes_by_name(), but with lengths for string parameters.

cass_user_type_set_collection

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

cass_user_type_set_collection_by_name

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

cass_user_type_set_collection_by_name_n

Same as cass_user_type_set_collection_by_name(), but with lengths for string parameters.

cass_user_type_set_custom

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

cass_user_type_set_custom_by_name

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

cass_user_type_set_custom_by_name_n

Same as cass_user_type_set_custom_by_name(), but with lengths for string parameters.

cass_user_type_set_custom_n

Same as cass_user_type_set_custom(), but with lengths for string parameters.

cass_user_type_set_decimal

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

cass_user_type_set_decimal_by_name

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

cass_user_type_set_decimal_by_name_n

Same as cass_user_type_set_decimal_by_name(), but with lengths for string parameters.

cass_user_type_set_double

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

cass_user_type_set_double_by_name

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

cass_user_type_set_double_by_name_n

Same as cass_user_type_set_double_by_name(), but with lengths for string parameters.

cass_user_type_set_duration

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

cass_user_type_set_duration_by_name

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

cass_user_type_set_duration_by_name_n

Same as cass_user_type_set_duration_by_name(), but with lengths for string parameters.

cass_user_type_set_float

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

cass_user_type_set_float_by_name

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

cass_user_type_set_float_by_name_n

Same as cass_user_type_set_float_by_name(), but with lengths for string parameters.

cass_user_type_set_inet

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

cass_user_type_set_inet_by_name

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

cass_user_type_set_inet_by_name_n

Same as cass_user_type_set_inet_by_name(), but with lengths for string parameters.

cass_user_type_set_int8

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

cass_user_type_set_int8_by_name

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

cass_user_type_set_int8_by_name_n

Same as cass_user_type_set_int8_by_name(), but with lengths for string parameters.

cass_user_type_set_int16

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

cass_user_type_set_int16_by_name

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

cass_user_type_set_int16_by_name_n

Same as cass_user_type_set_int16_by_name(), but with lengths for string parameters.

cass_user_type_set_int32

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

cass_user_type_set_int32_by_name

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

cass_user_type_set_int32_by_name_n

Same as cass_user_type_set_int32_by_name(), but with lengths for string parameters.

cass_user_type_set_int64

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

cass_user_type_set_int64_by_name

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

cass_user_type_set_int64_by_name_n

Same as cass_user_type_set_int64_by_name(), but with lengths for string parameters.

cass_user_type_set_null

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

cass_user_type_set_null_by_name

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

cass_user_type_set_null_by_name_n

Same as cass_user_type_set_null_by_name(), but with lengths for string parameters.

cass_user_type_set_string

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

cass_user_type_set_string_by_name

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

cass_user_type_set_string_by_name_n

Same as cass_user_type_set_string_by_name(), but with lengths for string parameters.

cass_user_type_set_string_n

Same as cass_user_type_set_string(), but with lengths for string parameters.

cass_user_type_set_tuple

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

cass_user_type_set_tuple_by_name

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

cass_user_type_set_tuple_by_name_n

Same as cass_user_type_set_tuple_by_name(), but with lengths for string parameters.

cass_user_type_set_uint32

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

cass_user_type_set_uint32_by_name

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

cass_user_type_set_uint32_by_name_n

Same as cass_user_type_set_uint32_by_name(), but with lengths for string parameters.

cass_user_type_set_user_type

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

cass_user_type_set_user_type_by_name

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

cass_user_type_set_user_type_by_name_n

Same as cass_user_type_set_user_type_by_name(), but with lengths for string parameters.

cass_user_type_set_uuid

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

cass_user_type_set_uuid_by_name

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

cass_user_type_set_uuid_by_name_n

Same as cass_user_type_set_uuid_by_name(), but with lengths for string parameters.

cass_uuid_from_string

Returns a UUID for the specified string.

cass_uuid_from_string_n

Same as cass_uuid_from_string(), but with lengths for string parameters.

cass_uuid_gen_free

Frees a UUID generator instance.

cass_uuid_gen_from_time

Generates a V1 (time) UUID for the specified time.

cass_uuid_gen_new

Creates a new UUID generator.

cass_uuid_gen_new_with_node

Creates a new UUID generator with custom node information.

cass_uuid_gen_random

Generates a new V4 (random) UUID

cass_uuid_gen_time

Generates a V1 (time) UUID.

cass_uuid_max_from_time

Sets the UUID to the maximum V1 (time) value for the specified time.

cass_uuid_min_from_time

Sets the UUID to the minimum V1 (time) value for the specified time.

cass_uuid_string

Returns a null-terminated string for the specified UUID.

cass_uuid_timestamp

Gets the timestamp for a V1 UUID

cass_uuid_version

Gets the version for a UUID

cass_value_data_type

Gets the data type of a value.

cass_value_get_bool

Gets a bool for the specified value.

cass_value_get_bytes

Gets the bytes of the specified value.

cass_value_get_decimal

Gets a decimal for the specified value.

cass_value_get_double

Gets a double for the specified value.

cass_value_get_duration

Gets a duration for the specified value.

cass_value_get_float

Gets a float for the specified value.

cass_value_get_inet

Gets an INET for the specified value.

cass_value_get_int8

Gets an int8 for the specified value.

cass_value_get_int16

Gets an int16 for the specified value.

cass_value_get_int32

Gets an int32 for the specified value.

cass_value_get_int64

Gets an int64 for the specified value.

cass_value_get_string

Gets a string for the specified value.

cass_value_get_uint32

Gets an uint32 for the specified value.

cass_value_get_uuid

Gets a UUID for the specified value.

cass_value_is_collection

Returns true if a specified value is a collection.

cass_value_is_duration

Returns true if a specified value is a duration.

cass_value_is_null

Returns true if a specified value is null.

cass_value_item_count

Get the number of items in a collection. Works for all collection types.

cass_value_primary_sub_type

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.

cass_value_secondary_sub_type

Get the secondary sub-type for a collection. This returns the value type for a map.

cass_value_type

Gets the type of the specified value.

cass_write_type_string

Write type

Type Definitions

CassAggregateMeta

@struct CassAggregateMeta

CassAuthenticator

An authenticator.

CassAuthenticatorCallbacks
CassAuthenticatorChallengeCallback

A callback used when an authentication challenge initiated by the server.

CassAuthenticatorCleanupCallback

A callback used to cleanup resources that were acquired during the process of the authentication exchange. This is called after the termination of the exchange regardless of the outcome.

CassAuthenticatorDataCleanupCallback

A callback used to cleanup resources.

CassAuthenticatorInitialCallback

A callback used to initiate an authentication exchange.

CassAuthenticatorSuccessCallback

A callback used to indicate the success of the authentication exchange.

CassBatch

A group of statements that are executed as a single batch.

CassCluster

A cluster object describes the configuration of the Cassandra cluster and is used to construct a session instance. Unlike other DataStax drivers the cluster object does not maintain the control connection.

CassCollection

A collection of values.

CassColumnMeta

Column metadata

CassCustomPayload

@struct CassCustomPayload

CassDataType

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

CassErrorResult

A error result of a request

CassExecProfile

An execution profile object provides a mechanism to group together a set of configuration options and reuse them across different statement executions. This feature is useful when dealing with different query workloads.

CassFreeFunction

A custom free function. This function deallocates the memory pointed to by "ptr" that was previously allocated by a "CassMallocFunction" or "CassReallocFunction" function.

CassFunctionMeta

@struct CassFunctionMeta

CassFuture

The future result of an operation.

CassFutureCallback

A callback that's notified when the future is set.

CassIndexMeta

Index metadata

CassInet
CassIterator

An object used to iterate over a group of rows, columns or collection values.

CassKeyspaceMeta

Keyspace metadata

CassLogCallback

A callback that's used to handle logging.

CassLogMessage
CassMallocFunction

A custom malloc function. This function should allocate "size" bytes and return a pointer to that memory

CassMaterializedViewMeta

MaterializedView metadata

CassMetrics
CassPrepared

A statement that has been prepared cluster-side (It has been pre-parsed and cached).

CassReallocFunction

A custom realloc function. This function attempts to change the size of the memory pointed to by "ptr". If the memory cannot be resized then new memory should be allocated and contain the contents of the original memory at "ptr".

CassResult

The result of a query.

CassRetryPolicy

@struct CassRetryPolicy

CassRow

A collection of column values.

CassSchemaMeta

A snapshot of the schema's metadata.

CassSession

A session object is used to execute queries and maintains cluster state through the control connection. The control connection is used to auto-discover nodes and monitor cluster changes (topology and schema). Each session also maintains multiple pools of connections to cluster nodes which are used to query the cluster.

CassSpeculativeExecutionMetrics
CassSsl

Describes the SSL configuration of a cluster.

CassStatement

A statement object is an executable query. It represents either a regular (adhoc) statement or a prepared statement. It maintains the queries' parameter values along with query options (consistency level, paging state, etc.)

CassTableMeta

Table metadata

CassTimestampGen

Policies that defined the behavior of a request when a server-side read/write timeout or unavailable error occurs.

CassTuple

A tuple of values.

CassUserType

A user defined type.

CassUuid
CassUuidGen

A UUID generator object.

CassValue

A single primitive value or a collection of values.

CassVersion
cass_byte_t
cass_double_t
cass_duration_t
cass_float_t
cass_int8_t
cass_int16_t
cass_int32_t
cass_int64_t
cass_uint8_t
cass_uint16_t
cass_uint32_t
cass_uint64_t
int_fast8_t
int_fast16_t
int_fast32_t
int_fast64_t
int_least8_t
int_least16_t
int_least32_t
int_least64_t
intmax_t
uint_fast8_t
uint_fast16_t
uint_fast32_t
uint_fast64_t
uint_least8_t
uint_least16_t
uint_least32_t
uint_least64_t
uintmax_t
wchar_t