Branch

The Branch resource lets you create and manage PlanetScale database branches for development workflows, allowing you to safely develop schema changes in isolation.

Minimal Example

Create a development branch from the main branch:

import { Branch } from "alchemy/planetscale";

const devBranch = await Branch("feature-123", {
  name: "feature-123",
  organizationId: "my-org",
  databaseName: "my-database",
  parentBranch: "main",
  isProduction: false,
});

Production Branch with Cluster Size

Create a production branch with specific cluster sizing:

import { Branch } from "alchemy/planetscale";

const prodBranch = await Branch("production", {
  name: "production",
  organizationId: "my-org",
  databaseName: "my-database",
  parentBranch: "main",
  isProduction: true,
  clusterSize: "PS_20",
});

Branch from Another Branch Object

Create a branch using another Branch resource as the parent:

import { Branch } from "alchemy/planetscale";

const stagingBranch = await Branch("staging", {
  name: "staging",
  organizationId: "my-org",
  databaseName: "my-database",
  parentBranch: "main",
  isProduction: false,
});

const featureBranch = await Branch("feature-456", {
  name: "feature-456",
  organizationId: "my-org",
  databaseName: "my-database",
  parentBranch: stagingBranch, // Using Branch object
  isProduction: false,
});

Branch from Backup

Create a branch restored from a backup:

import { Branch } from "alchemy/planetscale";

const restoredBranch = await Branch("restored-data", {
  name: "restored-data",
  organizationId: "my-org",
  databaseName: "my-database",
  parentBranch: "main",
  isProduction: true,
  backupId: "backup-123",
  clusterSize: "PS_10",
});

Branch with Safe Migrations

Create a branch with safe migrations enabled:

import { Branch } from "alchemy/planetscale";

const safeBranch = await Branch("safe-migrations", {
  name: "safe-migrations",
  organizationId: "my-org",
  databaseName: "my-database",
  parentBranch: "main",
  isProduction: false,
  safeMigrations: true,
});

Adopting Existing Branch

Adopt and manage an existing branch:

import { Branch } from "alchemy/planetscale";

const existingBranch = await Branch("existing-feature", {
  name: "existing-feature",
  organizationId: "my-org",
  databaseName: "my-database",
  parentBranch: "main",
  isProduction: false,
  adopt: true,
  safeMigrations: false,
});

Branch with Seed Data

Create a branch with seeded data from the last successful backup:

import { Branch } from "alchemy/planetscale";

const seededBranch = await Branch("seeded-dev", {
  name: "seeded-dev",
  organizationId: "my-org",
  databaseName: "my-database",
  parentBranch: "main",
  isProduction: false,
  seedData: "last_successful_backup",
});