Writing - Confect 🧁

The DatabaseWriter service is used to insert, modify, and delete documents in the database.

import * as Effect from "effect/Effect";
import { DatabaseWriter } from "./confect/_generated/services";

Effect.gen(function* () {
  const writer = yield* DatabaseWriter;

  return yield* writer.table("notes").insert({
    text: "This is my first note",
  });
});

Methods

Insert

Insert a new document.

writer.table("notes").insert({
  text: "This is my first note",
  tag: "drafts",
});

Patch

Shallow merge the provided object with the existing document. New fields are added. Existing fields are overwritten. Optional fields set to undefined are unset.

writer.table("notes").patch(noteId, {
  text: "Patched text",
  author: { role: "user", name: "John Doe" },
  tag: undefined,
});

Replace

Replace the entire document.

writer.table("notes").replace(noteId, {
  text: "I'm replacing the whole document",
});

Delete

Delete the document with the given ID.

writer.table("notes").delete(noteId);