Delete - CyborgDB Docs

This action is irreversible. Proceed with caution.

Deletes the specified encrypted items stored in the index, including all its associated fields (vector, contents, metadata).

def delete(self,
           ids: List[str],
           *,
           index_key: bytes,
           user_id: bytes = None)

Parameters

Parameter	Type	Description
`ids`	`List[str]`	IDs to delete.
`index_key`	`bytes`	(Required, keyword-only) 32-byte index KEK. See Index key.
`user_id`	`bytes`	(Optional, keyword-only) 16-byte RBAC user identifier. See Index key.

Exceptions

ValueError

Throws if the items could not be deleted.

Example Usage

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

# Delete "item_1" and "item_2"
index.delete(["item_1", "item_2"], index_key=index_key)

Index key

index_key is required on every call. Pass the same 32-byte index KEK you used with create_index() / load_index(). For an RBAC user, pass the user’s KEK as index_key= together with their user_id=:

index.delete(["item_1", "item_2"], index_key=user_kek, user_id=user_id)

Deleting items requires write permission. An RBAC user without a write wrap cannot delete items.