struct CassIndexMeta

Index metadata

Functions

void

cass_index_meta_name

( const CassIndexMeta * index_meta, const char ** name, size_t * name_length )

Gets the name of the index.

Parameters:
Name Type Details
in index_meta const CassIndexMeta *
out name const char **
out name_length size_t *
CassIndexType

cass_index_meta_type

( const CassIndexMeta * index_meta )

Gets the type of the index.

Parameters:
Name Type Details
in index_meta const CassIndexMeta *
Returns:
Type Details
CassIndexType

The index’s type.
void

cass_index_meta_target

( const CassIndexMeta * index_meta, const char ** target, size_t * target_length )

Gets the target of the index.

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

cass_index_meta_options

( const CassIndexMeta * index_meta )

Gets the options of the index.

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

The index’s options.
const CassValue *

cass_index_meta_field_by_name

( const CassIndexMeta * index_meta, const char * 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 const CassIndexMeta *
in name const char *
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

( const CassIndexMeta * index_meta, const char * name, size_t name_length )

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

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

same as CassIndexMeta::cass_index_meta_field_by_name
See Also:
CassIterator *

cass_iterator_fields_from_index_meta

( const CassIndexMeta * 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 const CassIndexMeta *
Returns:
Type Details
CassIterator *

A new iterator that must be freed.
See Also: