Branch

Source: src/Neon/Branch.ts

A branch of a Neon project.

Branches are first-class, copy-on-write copies of a parent branch — they share storage with the parent until the new branch starts diverging.

Branching from a project’s default branch

const project = yield* Neon.Project("my-project");
const dev = yield* Neon.Branch("dev-branch", { project });

Branching from another branch

const dev = yield* Neon.Branch("dev", { project });
const featureBranch = yield* Neon.Branch("feature", {
  project,
  parentBranch: dev,
});

Point-in-time branches

const branch = yield* Neon.Branch("at-lsn", {
  project,
  parentLsn: "0/3FA01B0",
});

Migrations on a branch

const featureBranch = yield* Neon.Branch("feature", {
  project,
  migrationsDir: "./migrations",
});