Loading...
Loading...
Toolkit-first AppDB document CRUD, query operators, and collection wiring.
npx skill4agent add stahura/domo-ai-vibe-rules cap-apps-appdbAppDBClientdomo.get/post/put/deleteLegacy endpoint-first guidance has been archived to.archive/legacy-rules/domo-appdb.md
yarn add @domoinc/toolkitimport { AppDBClient } from '@domoinc/toolkit';
type Task = {
title: string;
status: 'active' | 'completed';
priority: 'Low' | 'High' | 'Urgent';
};
const tasksClient = new AppDBClient.DocumentsClient<Task>('TasksCollection');const created = await tasksClient.create({
title: 'New Task',
status: 'active',
priority: 'High'
});
const task = created.body;const all = await tasksClient.get();
const active = await tasksClient.get({ status: { $eq: 'active' } });
const highOpen = await tasksClient.get({
$and: [{ status: { $ne: 'completed' } }, { priority: { $in: ['High', 'Urgent'] } }]
});.get()doc.content.create(){ vendor: 'Acme', riskLevel: 'High', notes: 'Late payments' }.get()[
{
"id": "04b1756e-7b6d-4d77-842f-7975a6474d8a",
"datastoreId": "a3b85171-...",
"collectionId": "ba194a7d-...",
"syncRequired": true,
"owner": 767612617,
"createdOn": "2026-03-22T02:22:42.030Z",
"updatedOn": "2026-03-22T02:22:42.030Z",
"updatedBy": 767612617,
"content": {
"vendor": "Acme",
"riskLevel": "High",
"notes": "Late payments"
}
}
]doc.contentdoc.id.update().delete()datastoreIdcollectionIdownercreatedOnresponse.bodyconst response = await tasksClient.get();
const rawDocs = response.body || response;
const docs = Array.isArray(rawDocs) ? rawDocs : [];
const parsed = docs.map((doc) => ({
id: doc.id,
...doc.content
}));// WRONG: fields are inside content
const docs = response.body || response;
docs[0].vendor; // undefined
// CORRECT
docs[0].content.vendor; // "Acme"await tasksClient.update({
id: 'document-uuid',
content: { title: 'Updated', status: 'completed', priority: 'Low' }
});
await tasksClient.partialUpdate(
{ status: { $eq: 'active' } },
{ $set: { status: 'archived' } }
);await tasksClient.delete('document-uuid');
await tasksClient.delete(['uuid-1', 'uuid-2']);manifest.jsoncollections{
"collections": [
{
"name": "TasksCollection",
"schema": {
"columns": [
{ "name": "title", "type": "STRING" },
{ "name": "status", "type": "STRING" }
]
}
}
]
}.cursor/rules/04-toolkit.mdc.cursor/rules/09-gotchas.mdccollectionsAppDBClient.DocumentsClient.get()doc.content$eq$in$set$inc