Databases

{
  "tables": {
    "contacts": {
      "columns": {
        "name": { "type": "text" },
        "email": { "type": "text", "unique": true },
        "notes": { "type": "text", "nullable": true }
      }
    }
  }
}

import { PolpoClient } from "@polpo-ai/sdk";

// Runs on your application server.
const polpo = new PolpoClient({
  baseUrl: "https://YOUR_PROJECT.polpo.cloud",
  apiKey: process.env.POLPO_API_KEY,
});
const contacts = polpo.data("RESOURCE_UUID").table("contacts");
const contact = await contacts.insert(
  { name: "Mario", email: "mario@example.com" },
  { idempotencyKey: "contact-import-42" },
);
const page = await contacts.list({ limit: 25 });
await contacts.update(contact._id, { name: "Maria" }, contact._version);

{
  "resource": "shop",
  "table": "orders",
  "filter": { "status": { "eq": "paid" } },
  "orderBy": [{ "column": "_created_at", "direction": "desc" }],
  "limit": 20
}

const [page] = await ctx.data.execute("RESOURCE_UUID", {
  operations: [{ op: "list", table: "contacts", limit: 25 }],
});

const database = polpo.data("crm");
const counts = await database.query({
  sql: "SELECT count(*) AS total FROM contacts WHERE name = $1",
  params: ["Maria"],
});
await database.query({
  sql: "UPDATE contacts SET name = $1 WHERE _id = $2 AND _version = $3 RETURNING *",
  params: ["Mario", contact._id, contact._version],
  mode: "write",
  idempotencyKey: "rename-customer-42",
});

const current = await database.describe();
await database.migrateSql({
  id: "customer_source",
  expectedVersion: current.schemaVersion,
  statements: [
    { sql: "ALTER TABLE contacts ADD COLUMN source text" },
    { sql: "UPDATE contacts SET source = $1", params: ["import"] },
    { sql: "ALTER TABLE contacts ALTER COLUMN source SET NOT NULL" },
    { sql: "CREATE INDEX customer_source ON contacts(source)" },
  ],
});
const history = await database.migrations();

polpo data list
polpo data describe crm
polpo data create resource.json
polpo data execute crm operations.json
polpo data query crm query.json
polpo data migrate-sql crm migration.json
polpo data migrations crm