Delete Index

Deleting an index is irreversible.

Deletes the index and all of its data from the CyborgDB service.

async deleteIndex(): Promise<{ status?: string; message: string }>

Returns

Promise<{ status, message }>, e.g. { status: 'success', message: "Index 'temporary-index' deleted successfully" }.

Exceptions

CyborgDBNotFoundError

The index doesn’t exist, for example because it was already deleted (HTTP 404).

CyborgDBAuthenticationError

The indexKey or apiKey is invalid (HTTP 401), or the client is using a per-user key: deleting an index requires the root key (HTTP 403).

CyborgDBServiceError

The service returns 5xx.

See Errors for the full hierarchy.

Example Usage

const result = await index.deleteIndex();
console.log(result.status);
// Output: success

console.log((await client.listIndexes()).includes(await index.getIndexName()));
// Output: false

Introduction

Client

Encrypted Index

Types & Helpers

Returns

Exceptions

Example Usage

​Returns

​Exceptions

​Example Usage

Returns

Exceptions

Example Usage