Drivers Overview

interface DriverInterface {
  // Driver metadata
  readonly name: string;
  readonly version: string;
  readonly supports: DriverCapabilities;
  
  // Lifecycle
  connect?(): Promise<void>;
  disconnect?(): Promise<void>;
  checkHealth?(): Promise<boolean>;
  
  // Query execution (v4.0)
  executeQuery(ast: QueryAST, options?: any): Promise<QueryResult>;
  executeCommand(command: Command, options?: any): Promise<CommandResult>;
  
  // Legacy CRUD (backward compatible)
  find(objectName: string, query?: UnifiedQuery, options?: any): Promise<any[]>;
  findOne(objectName: string, id: string, query?: UnifiedQuery, options?: any): Promise<any>;
  create(objectName: string, data: any, options?: any): Promise<any>;
  update(objectName: string, id: string, data: any, options?: any): Promise<any>;
  delete(objectName: string, id: string, options?: any): Promise<boolean>;
  count(objectName: string, filters?: FilterExpression, options?: any): Promise<number>;
}

Start Here
    │
    ├─ Production App?
    │   ├─ Yes → SQL or MongoDB
    │   └─ No → Continue
    │
    ├─ Browser Only?
    │   ├─ Yes → LocalStorage (persistent) or Memory (temporary)
    │   └─ No → Continue
    │
    ├─ Need Persistence?
    │   ├─ Yes → File System (small) or Excel (import/export)
    │   └─ No → Memory
    │
    └─ Testing?
        └─ Yes → Memory (fastest, no cleanup needed)

# SQL Driver (PostgreSQL, MySQL, SQLite)
npm install @objectql/driver-sql

# MongoDB Driver
npm install @objectql/driver-mongo

# Memory Driver (included in core)
npm install @objectql/driver-memory

# File System Driver
npm install @objectql/driver-fs

# Excel Driver
npm install @objectql/driver-excel

# LocalStorage Driver (browser)
npm install @objectql/driver-localstorage

# Redis Driver (example)
npm install @objectql/driver-redis

# SDK/Remote Driver
npm install @objectql/sdk

# Common stack: SQL + Memory (for testing)
npm install @objectql/driver-sql @objectql/driver-memory

# Client-server stack
npm install @objectql/sdk @objectql/driver-localstorage

import { ObjectQL } from '@objectql/core';
import { SqlDriver } from '@objectql/driver-sql';

// Initialize driver
const driver = new SqlDriver({
  client: 'pg',
  connection: {
    host: 'localhost',
    user: 'myuser',
    password: 'mypassword',
    database: 'mydb'
  }
});

// Create ObjectQL instance
const app = new ObjectQL({
  datasources: {
    default: driver
  }
});

import { SqlDriver } from '@objectql/driver-sql';
import { MemoryDriver } from '@objectql/driver-memory';

const app = new ObjectQL({
  datasources: {
    default: new SqlDriver({ /* config */ }),
    cache: new MemoryDriver(),
    analytics: new MongoDriver({ /* config */ })
  }
});

// Use different datasources per object
app.registerObject({
  name: 'users',
  datasource: 'default',  // Uses SQL
  fields: { /* ... */ }
});

app.registerObject({
  name: 'sessions',
  datasource: 'cache',  // Uses Memory
  fields: { /* ... */ }
});

// Development
const devDriver = new MemoryDriver();

// Production
const prodDriver = new SqlDriver({
  client: 'pg',
  connection: process.env.DATABASE_URL
});

// Same code works with both!
const users = await driver.find('users', {
  filters: [['active', '=', true]]
});

// Offline mode
const offlineDriver = new LocalStorageDriver();

// Online mode
const onlineDriver = new RemoteDriver({
  baseUrl: 'https://api.example.com'
});

// Sync data when going online
const localData = await offlineDriver.find('tasks');
for (const task of localData) {
  await onlineDriver.create('tasks', task);
}