@orchestree/databases

Database and table management for Orchestree. Create tables, manage records, build forms, and automate workflows with formulas.

Installation

npm install @orchestree/databases

Quick Start

const { DatabasesClient } = require('@orchestree/databases');

const client = new DatabasesClient({
  apiKey: 'your-api-key',
});

// Create a table
const table = await client.createTable({
  name: 'Contacts',
  fields: [
    { name: 'Name', type: 'text', required: true },
    { name: 'Email', type: 'email', required: true },
    { name: 'Phone', type: 'phone' },
  ],
});

// Add a record
const record = await client.addRecord(table.id, {
  Name: 'John Doe',
  Email: '[email protected]',
  Phone: '+1-555-0100',
});

// Create a form
const form = await client.createForm(table.id, {
  name: 'Contact Form',
  collectEmail: true,
});

API Reference

DatabasesClient

createTable(tableDef)

Create a new table.

const table = await client.createTable({
  name: 'Projects',
  fields: [
    { name: 'Title', type: 'text' },
    { name: 'Status', type: 'select', options: ['Active', 'Complete'] },
  ],
});

addRecord(tableId, record)

Add a record to a table.

const record = await client.addRecord(table.id, {
  Title: 'Website Redesign',
  Status: 'Active',
});

updateRecord(tableId, recordId, updates)

Update a record.

await client.updateRecord(table.id, record.id, {
  Status: 'Complete',
});

queryRecords(tableId, query)

Query records from a table.

const records = await client.queryRecords(table.id, {
  filter: { Status: 'Active' },
  sort: { Title: 'asc' },
});

License

MIT