Brand

DataStax C/C++ Driver

Attention: Viewing documentation for version
Download

struct CassIndexMeta

Index metadata

Functions

void

cass_index_meta_name

( index_meta, name, name_length )

Gets the name of the index.

Parameters:
Name Type Details
in index_meta
out name
out name_length
CassIndexType

cass_index_meta_type

( index_meta )

Gets the type of the index.

Parameters:
Name Type Details
in index_meta
Returns:
Type Details
CassIndexType

The index’s type.
void

cass_index_meta_target

( index_meta, target, target_length )

Gets the target of the index.

Parameters:
Name Type Details
in index_meta
out target
out target_length
const CassValue *

cass_index_meta_options

( index_meta )

Gets the options of the index.

Parameters:
Name Type Details
in index_meta
Returns:
Type Details
const CassValue *

The index’s options.
const CassValue *

cass_index_meta_field_by_name

( index_meta, 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.

Parameters:
Name Type Details
in index_meta
in name
Returns:
Type Details
const CassValue *

A metadata field value. NULL if the field does not exist.
const CassValue *

cass_index_meta_field_by_name_n

( index_meta, name, name_length )

Same as CassIndexMeta::cass_index_meta_field_by_name, but with lengths for string parameters.

Parameters:
Name Type Details
in index_meta
in name
in name_length
Returns:
Type Details
const CassValue *

same as CassIndexMeta::cass_index_meta_field_by_name
See Also:
CassIterator *

cass_iterator_fields_from_index_meta

( 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.

Parameters:
Name Type Details
in index_meta
Returns:
Type Details
CassIterator *

A new iterator that must be freed.
See Also: