Delete Index

async deleteIndex(): Promise<SuccessResponseModel>

​

Returns

​

Exceptions

​

Example Usage

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

​

Response Format

// Standard successful deletion response
{
    "status": "success",
    "message": "Index 'index-name' deleted successfully"
}

// When index was already deleted (handled gracefully)
{
    "status": "success", 
    "message": "Index 'index-name' was already deleted"
}

​

Response Fields

​

Best Practices

• Confirmation: Always implement user confirmation for deletion operations in production applications
• Backup: Consider exporting important data before deletion if needed for recovery
• Cleanup: Remove local references to deleted indexes to prevent memory leaks
• Error Handling: Implement proper error handling to gracefully handle network failures
• Logging: Log deletion operations for audit trails and debugging
• Batch Operations: When deleting multiple indexes, handle failures gracefully to avoid partial cleanup states

​

Important Notes

• Once deleted, the index and all its data cannot be recovered
• The operation affects all vectors, metadata, and configuration associated with the index
• Other applications or services using the same index will lose access immediately
• The deletion is performed on the CyborgDB service and cannot be undone