CassIndexMeta¶

struct CassIndexMeta¶

Index metadata

Public Functions

void cass_index_meta_name(const CassIndexMeta *index_meta, const char **name, size_t *name_length)¶

Gets the name of the index.

Parameters

• index_meta – [in]

• name – [out]

• name_length – [out]

CassIndexType cass_index_meta_type(const CassIndexMeta *index_meta)¶

Gets the type of the index.

Parameters

index_meta – [in]

Returns

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

• index_meta – [in]

• target – [out]

• target_length – [out]

const CassValue *cass_index_meta_options(const CassIndexMeta *index_meta)¶

Gets the options of the index.

Parameters

index_meta – [in]

Returns

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

• index_meta – [in]

• name – [in]

Returns

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 cass_index_meta_field_by_name(), but with lengths for string parameters.

See also

cass_index_meta_field_by_name()

Parameters

• index_meta – [in]

• name – [in]

• name_length – [in]

Returns

same as cass_index_meta_field_by_name()

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.

See also

cass_iterator_get_meta_field_name()

See also

cass_iterator_get_meta_field_value()

See also

cass_iterator_free()

Parameters

index_meta – [in]

Returns

A new iterator that must be freed.