Documentation Index
Fetch the complete documentation index at: https://docs.ondb.ai/llms.txt
Use this file to discover all available pages before exploring further.
Installation
Quick Start
import { createClient } from '@ondb/sdk';
const client = createClient({
endpoint: 'https://api.ondb.io',
appId: 'your-app-id',
appKey: 'your-app-key'
});
// Store data
await client.store({
collection: 'users',
data: [{ name: 'Alice', email: 'alice@example.com' }]
});
// Query data
const users = await client.queryBuilder()
.collection('users')
.whereField('active').isTrue()
.limit(10)
.execute();
Client Initialization
import { createClient } from '@ondb/sdk';
const client = createClient({
endpoint: string, // OnDB server endpoint
appKey?: string, // App API key for writes (X-App-Key header)
appId?: string, // Application ID for automatic root building
timeout?: number, // Request timeout (default: 30000ms)
retryCount?: number, // Retry attempts (default: 3)
retryDelay?: number, // Retry delay (default: 1000ms)
});
API Overview
Client
createClient and core methods
Query Builder
Fluent query API reference
Database Manager
Collections, indexes, and views