Delete Index - CyborgDB Docs

This action is irreversible. Proceed with caution.

Deletes the current index and all its associated data.

def delete_index(self,
                 *,
                 index_key: bytes,
                 user_id: bytes = None)

Deletes the current index and its associated data. This action is irreversible, so proceed with caution.

Parameters

Parameter	Type	Description
`index_key`	`bytes`	(Required, keyword-only) The 32-byte root index KEK.
`user_id`	`bytes`	(Optional, keyword-only) 16-byte RBAC user identifier.

Deleting an index is an admin operation gated on the root index KEK. It rejects RBAC user contexts — a per-user key cannot delete the index.

Exceptions

ValueError

Throws if the index could not be deleted.

Example Usage

# Load index
index = client.load_index(
    index_name=index_name, 
    index_key=index_key
)

# Delete the index
index.delete_index(index_key=index_key)