Queries

The clientCopy Anchor Link

import { createClient } from "@shipmantis/sdk";
import schema from "../mantis/schema";

export const mantis = createClient({
  url: process.env.MANTIS_URL!,
  key: process.env.MANTIS_SECRET_KEY!,
  schema,
});

mantis.from(table) gives you the table's client. Every call returns the rows it read or changed, typed from the schema.

SelectCopy Anchor Link

const todos = mantis.from("todos");

const open = await todos.select({
  columns: ["id", "title"],
  where: { done: false, dueAt: { lt: new Date().toISOString() } },
  orderBy: [{ column: "dueAt", direction: "asc" }],
  limit: 20,
  offset: 40,
});
//    ^? { id: string; title: string }[]

• columns picks the columns to return. Leave it out for all of them.
• orderBy sorts by one or more columns, asc by default. Rows are always sorted by id last, so pages are stable. Without orderBy, rows come oldest first.
• limit is 100 by default and at most 1000. offset skips rows.

WhereCopy Anchor Link

Every key in where must hold, so the conditions are joined with AND. A plain value means equal; an object compares:

await todos.select({ where: { listId: { in: [inbox, today] }, title: { ne: "" } } });

null asks for an empty column: { dueAt: null } and { dueAt: { eq: null } } both mean is null, and { dueAt: { ne: null } } means is not null. A ne with a value keeps the rows where the column is empty.

InsertCopy Anchor Link

const [todo] = await todos.insert({ title: "Ship it", listId: inbox });
await todos.insert([{ title: "One", listId: inbox }, { title: "Two", listId: inbox }]);

Pass one row or an array of up to 1000. Columns that are optional or have a default can be left out. The rows come back with id and createdAt filled.

Update and deleteCopy Anchor Link

await todos.update({ set: { done: true }, where: { id: todo.id } });
await todos.delete({ where: { done: true } });

Both need a where, so a missing filter can't change every row by accident. To mean every row, say so with where: {}.

ErrorsCopy Anchor Link

A refused call throws a MantisError with the HTTP status and a list of reasons:

import { MantisError } from "@shipmantis/sdk";

try {
  await todos.insert({ title: "No list" } as never);
} catch (error) {
  if (error instanceof MantisError) {
    console.log(error.status, error.reasons);
    // 422 [ ... ]
  }
}

Every write is recorded, so anything a query does can be rewound.