Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.cyborg.co/llms.txt

Use this file to discover all available pages before exploring further.

This action is irreversible. Proceed with caution.
Deletes the current index and all its associated data from the CyborgDB service. 
async deleteIndex(): Promise<{ status: string; message: string }>

​
Returns

Promise<{ status: string; message: string }>: A Promise that resolves to a response object containing:
FieldTypeDescription
statusstringOperation status (e.g., "success")
messagestringDescriptive message about the deletion result

​
Exceptions

  • Throws if the API request fails due to network connectivity issues.
  • Throws if authentication fails (invalid API key).
  • Throws if there are internal server errors preventing the deletion.
  • Returns success status if the index was already deleted or doesn’t exist.
  • Throws if the encryption key is invalid for the specified index (unless already deleted).

​
Example Usage

import { Client } from 'cyborgdb';

const client = new Client({ baseUrl: 'http://localhost:8000', apiKey: 'your-api-key' });

// Load an existing index
const indexKey = new Uint8Array(Buffer.from('your-stored-hex-key', 'hex'));
const index = await client.loadIndex({ indexName: 'temporary-index', indexKey });

// Delete the index when no longer needed
try {
    const result = await index.deleteIndex();
    console.log('Index deletion result:', result);
    // Possible outputs:
    // { status: 'success', message: "Index 'temporary-index' deleted successfully" }
    // { status: 'success', message: "Index 'temporary-index' was already deleted" }
    
} catch (error) {
    console.error('Failed to delete index:', error.message);
}