Delete Index - CyborgDB Docs

This action is irreversible. Proceed with caution.

Deletes the current index and all its associated data.

void DeleteIndex(const KeyContext& key);

Parameters

Parameter	Type	Description
`key`	`KeyContext`	Key context for the operation. Must be the root 32-byte index KEK. A bare 32-byte index key implicitly converts to a `KeyContext`.

DeleteIndex requires the root index KEK. A per-user KeyContext (one built with a user_kek and user_id) is rejected — RBAC users cannot delete the index.

Exceptions

std::runtime_error

Throws if the index could not be deleted.
Throws if a per-user key context is supplied instead of the root KEK.

Example Usage

index->DeleteIndex(index_key);

index_key is the 32-byte std::array<uint8_t, 32> root index KEK and converts implicitly to a KeyContext.