@alchemy.run/planetscale 0.0.0 → 2.0.0-beta.85

package/lib/Database.d.ts

@@ -0,0 +1,138 @@
+import type { MigrationsInput } from "@alchemy.run/sql/Migrations";
+/**
+ * Region selector for a PlanetScale Database.
+ */
+export interface DatabaseRegion {
+    /**
+     * Region slug (e.g. `"us-east"`, `"eu-west"`, `"gcp-us-central1"`).
+     * @see https://planetscale.com/docs/concepts/regions#available-regions
+     */
+    slug: "us-east" | "eu-west" | "gcp-us-central1" | (string & {});
+}
+/**
+ * Properties shared between {@link MySQLDatabase} and
+ * {@link PostgresDatabase}. Engine-specific props live on the per-engine
+ * resource types.
+ */
+export interface BaseDatabaseProps {
+    /**
+     * Database name. Must be lowercase. If omitted, a unique name will be
+     * generated from the stack/stage/logical-id. A change that replaces the
+     * database needs a new name, so it fails while an explicit name stays
+     * the same.
+     */
+    name?: string;
+    /**
+     * Region where the database will be created. Cannot be changed after
+     * creation. If omitted, the organization's default region is used.
+     */
+    region?: DatabaseRegion;
+    /**
+     * Number of replicas for the database. `0` for non-HA, `2+` for HA.
+     * Create-only for PostgreSQL databases; MySQL databases reconcile
+     * changes in place ({@link MySQLDatabaseProps.replicas}).
+     */
+    replicas?: number;
+    /**
+     * Whether deploy requests must be approved by a database administrator
+     * other than the request creator.
+     */
+    requireApprovalForDeploy?: boolean;
+    /**
+     * Whether to limit branch creation to the same region as the one
+     * selected during database creation.
+     */
+    restrictBranchRegion?: boolean;
+    /**
+     * Whether the web console can be used on the production branch.
+     */
+    productionBranchWebConsole?: boolean;
+    /**
+     * Whether PlanetScale refuses to delete the database. While enabled,
+     * destroying or replacing the database fails with a
+     * `PlanetscaleDeletionProtected` error; set it to `false` and deploy
+     * before deleting. If omitted, Alchemy leaves the database's current
+     * setting unchanged.
+     *
+     * A replacement (e.g. a region change) creates the new database first,
+     * so deleting the protected old one fails afterwards. The resource then
+     * manages the new database, so turn protection off on the old one in
+     * PlanetScale directly and deploy again.
+     */
+    deletionProtection?: boolean;
+    /**
+     * The default branch of the database.
+     * @default "main"
+     */
+    defaultBranch?: string;
+    /**
+     * SQL migrations to apply against the default branch. Accepts a directory
+     * path, a `Drizzle.Schema` resource, or `{ dir, table? }`.
+     *
+     * Bookkeeping always lives in Alchemy's `__alchemy_migrations` table. A
+     * database previously migrated by drizzle-kit or Prisma is adopted by a
+     * one-way conversion on first deploy: the old tool's applied history is
+     * copied into Alchemy's table and the old table is left frozen. No
+     * baselining required.
+     */
+    migrations?: MigrationsInput;
+    /**
+     * Paths to additional `.sql` files to apply after migrations. Each file is
+     * hashed; only files whose contents change are re-applied on later deploys.
+     */
+    importFiles?: string[];
+}
+/**
+ * Output attributes shared by both database engines.
+ */
+export interface BaseDatabaseAttributes {
+    /** The unique identifier of the database. */
+    id: string;
+    /** The name of the database. */
+    name: string;
+    /** The PlanetScale organization slug that owns the database. */
+    organization: string;
+    /** The current state of the database. */
+    state: string;
+    /** The default branch name. */
+    defaultBranch: string;
+    /** The plan tier (e.g. `"hobby"`, `"scaler"`). */
+    plan: string;
+    /** Time at which the database was created (ISO 8601). */
+    createdAt: string;
+    /** Time at which the database was last updated (ISO 8601). */
+    updatedAt: string;
+    /** HTML URL for accessing the database in the dashboard. */
+    htmlUrl: string;
+    /** The region of the database as reported by PlanetScale. */
+    region: DatabaseRegion;
+    /** The cluster size that was actually applied. */
+    clusterSize: string;
+    /** Directory containing migration files, if configured. */
+    migrationsDir: string | undefined;
+    /** Table used to track applied migrations, if configured. */
+    migrationsTable: string | undefined;
+    /** Content hashes for the last applied migration files. */
+    migrationsHashes: Record<string, string>;
+    /** Content hashes for the last applied import files. */
+    importHashes: Record<string, string>;
+    /**
+     * Whether deploy requests must be approved by a database administrator
+     * other than the request creator.
+     */
+    requireApprovalForDeploy: boolean;
+    /**
+     * Whether to limit branch creation to the same region as the one
+     * selected during database creation.
+     */
+    restrictBranchRegion: boolean;
+    /**
+     * Whether the web console can be used on the production branch.
+     */
+    productionBranchWebConsole: boolean;
+    /**
+     * Whether deletion protection is enabled for the database.
+     */
+    deletionProtection: boolean;
+}
+//# sourceMappingURL=Database.d.ts.map

package/lib/Database.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"Database.d.ts","sourceRoot":"","sources":["../src/Database.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,6BAA6B,CAAC;AAEnE;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B;;;OAGG;IACH,IAAI,EAAE,SAAS,GAAG,SAAS,GAAG,iBAAiB,GAAG,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;CACjE;AAED;;;;GAIG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,wBAAwB,CAAC,EAAE,OAAO,CAAC;IAEnC;;;OAGG;IACH,oBAAoB,CAAC,EAAE,OAAO,CAAC;IAE/B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;;;;;;;;;;OAWG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;OAGG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;;;;OASG;IACH,UAAU,CAAC,EAAE,eAAe,CAAC;IAE7B;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,EAAE,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,6CAA6C;IAC7C,EAAE,EAAE,MAAM,CAAC;IACX,gCAAgC;IAChC,IAAI,EAAE,MAAM,CAAC;IACb,gEAAgE;IAChE,YAAY,EAAE,MAAM,CAAC;IACrB,yCAAyC;IACzC,KAAK,EAAE,MAAM,CAAC;IACd,+BAA+B;IAC/B,aAAa,EAAE,MAAM,CAAC;IACtB,kDAAkD;IAClD,IAAI,EAAE,MAAM,CAAC;IACb,yDAAyD;IACzD,SAAS,EAAE,MAAM,CAAC;IAClB,8DAA8D;IAC9D,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;IAChB,6DAA6D;IAC7D,MAAM,EAAE,cAAc,CAAC;IACvB,kDAAkD;IAClD,WAAW,EAAE,MAAM,CAAC;IACpB,2DAA2D;IAC3D,aAAa,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,6DAA6D;IAC7D,eAAe,EAAE,MAAM,GAAG,SAAS,CAAC;IACpC,2DAA2D;IAC3D,gBAAgB,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,wDAAwD;IACxD,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACrC;;;OAGG;IACH,wBAAwB,EAAE,OAAO,CAAC;IAElC;;;OAGG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;CAC7B"}

package/lib/Database.js

@@ -0,0 +1 @@
+//# sourceMappingURL=Database.js.map

package/lib/Database.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"Database.js","sourceRoot":"","sources":["../src/Database.ts"],"names":[],"mappings":""}

package/lib/MySQL/MySQLBranch.d.ts

@@ -0,0 +1,87 @@
+import { Resource } from "alchemy/Resource";
+import { type BaseBranchAttributes, type BaseBranchProps } from "../Branch.ts";
+import type { Providers } from "../Providers.ts";
+import type { MySQLClusterSize } from "./MySQLClusterSize.ts";
+import type { MySQLDatabase } from "./MySQLDatabase.ts";
+/**
+ * Properties for creating or updating a {@link MySQLBranch}.
+ */
+export interface MySQLBranchProps extends BaseBranchProps {
+    /**
+     * Whether the branch should be a production branch.
+     */
+    isProduction: boolean;
+    /**
+     * The MySQL database. Either a string database name or a
+     * {@link MySQLDatabase} resource.
+     */
+    database: string | MySQLDatabase;
+    /**
+     * MySQL cluster size for the branch. Required if `backupId` is provided.
+     * For non-production branches must be `"PS_DEV"`.
+     */
+    clusterSize?: MySQLClusterSize;
+    /**
+     * Parent branch — either a string name or another {@link MySQLBranch}.
+     * @default "main"
+     */
+    parentBranch?: string | MySQLBranch;
+}
+/**
+ * Output attributes of a deployed {@link MySQLBranch}.
+ */
+export interface MySQLBranchAttributes extends BaseBranchAttributes {
+}
+/**
+ * A PlanetScale branch of a {@link MySQLDatabase}. For PostgreSQL branches
+ * use {@link PostgresBranch} instead.
+ *
+ * ### Creating a Branch
+ * **Example:** Branch from main
+ * ```typescript
+ * const branch = yield* Planetscale.MySQLBranch("Feature123", {
+ *   database: "my-db",
+ *   parentBranch: "main",
+ *   isProduction: false,
+ * });
+ * ```
+ *
+ * **Example:** Branch from a MySQLDatabase resource
+ * ```typescript
+ * const db = yield* Planetscale.MySQLDatabase("MyDb", { clusterSize: "PS_10" });
+ * const branch = yield* Planetscale.MySQLBranch("Feature456", {
+ *   database: db,
+ *   parentBranch: "main",
+ *   isProduction: false,
+ * });
+ * ```
+ *
+ * ### Restoring from Backup
+ * **Example:** Branch restored from a backup
+ * ```typescript
+ * const branch = yield* Planetscale.MySQLBranch("Restored", {
+ *   database: "my-db",
+ *   parentBranch: "main",
+ *   isProduction: true,
+ *   backupId: "backup-123",
+ *   clusterSize: "PS_10",
+ * });
+ * ```
+ *
+ * ### Migrations and seed data
+ * **Example:** Apply migrations on a branch
+ * ```typescript
+ * const branch = yield* Planetscale.MySQLBranch("Feature123", {
+ *   database: db,
+ *   parentBranch: "main",
+ *   isProduction: false,
+ *   migrationsDir: "./migrations",
+ *   importFiles: ["./seed.sql"],
+ * });
+ * ```
+ */
+export type MySQLBranch = Resource<"Planetscale.MySQLBranch", MySQLBranchProps, MySQLBranchAttributes, never, Providers>;
+/** @resource */
+export declare const MySQLBranch: import("alchemy/Resource").ResourceClass<MySQLBranch>;
+export declare const MySQLBranchProvider: () => import("effect/Layer").Layer<import("alchemy/Provider").Provider<MySQLBranch>, never, never>;
+//# sourceMappingURL=MySQLBranch.d.ts.map

package/lib/MySQL/MySQLBranch.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MySQLBranch.d.ts","sourceRoot":"","sources":["../../src/MySQL/MySQLBranch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAE,KAAK,oBAAoB,EAAE,KAAK,eAAe,EAAsB,MAAM,cAAc,CAAC;AACnG,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AAC9D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AAGxD;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,eAAe;IACvD;;OAEG;IACH,YAAY,EAAE,OAAO,CAAC;IAEtB;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,aAAa,CAAC;IAEjC;;;OAGG;IACH,WAAW,CAAC,EAAE,gBAAgB,CAAC;IAE/B;;;OAGG;IACH,YAAY,CAAC,EAAE,MAAM,GAAG,WAAW,CAAC;CACrC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAsB,SAAQ,oBAAoB;CAAG;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA+CG;AACH,MAAM,MAAM,WAAW,GAAG,QAAQ,CAChC,yBAAyB,EACzB,gBAAgB,EAChB,qBAAqB,EACrB,KAAK,EACL,SAAS,CACV,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,WAAW,uDAAmD,CAAC;AAE5E,eAAO,MAAM,mBAAmB,oGAS5B,CAAC"}

package/lib/MySQL/MySQLBranch.js

@@ -0,0 +1,15 @@
+import { Resource } from "alchemy/Resource";
+import { makeBranchProvider } from "../Branch.js";
+import { runMySQLImports, runMySQLMigrations } from "./MySQLMigrations.js";
+/** @resource */
+export const MySQLBranch = Resource("Planetscale.MySQLBranch");
+export const MySQLBranchProvider = () => makeBranchProvider({
+    resource: MySQLBranch,
+    expectedKind: "mysql",
+    engineLabel: "MySQLBranch",
+    runners: {
+        runMigrations: runMySQLMigrations,
+        runImports: runMySQLImports,
+    },
+});
+//# sourceMappingURL=MySQLBranch.js.map

package/lib/MySQL/MySQLBranch.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MySQLBranch.js","sourceRoot":"","sources":["../../src/MySQL/MySQLBranch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAC5C,OAAO,EAAmD,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAInG,OAAO,EAAE,eAAe,EAAE,kBAAkB,EAAE,MAAM,sBAAsB,CAAC;AA2F3E,gBAAgB;AAChB,MAAM,CAAC,MAAM,WAAW,GAAG,QAAQ,CAAc,yBAAyB,CAAC,CAAC;AAE5E,MAAM,CAAC,MAAM,mBAAmB,GAAG,GAAG,EAAE,CACtC,kBAAkB,CAAC;IACjB,QAAQ,EAAE,WAAW;IACrB,YAAY,EAAE,OAAO;IACrB,WAAW,EAAE,aAAa;IAC1B,OAAO,EAAE;QACP,aAAa,EAAE,kBAAkB;QACjC,UAAU,EAAE,eAAe;KAC5B;CACF,CAAC,CAAC"}

package/lib/MySQL/MySQLClusterSize.d.ts

@@ -0,0 +1,32 @@
+import * as ps from "@distilled.cloud/planetscale";
+import * as Effect from "effect/Effect";
+import { PlanetscaleConflict } from "../Util.ts";
+/**
+ * Available PlanetScale MySQL (Vitess) cluster sizes.
+ *
+ * `PS_*` sizes are backed by network-attached storage (NAS) and can be
+ * specified either as the short size (`"PS_10"`) or the API SKU
+ * (`"PS_10_AWS_X86"`)
+ *
+ * @see https://planetscale.com/docs/concepts/planetscale-skus
+ */
+export type MySQLClusterSize = "PS_DEV" | "PS_5" | "PS_10" | "PS_20" | "PS_40" | "PS_80" | "PS_160" | "PS_320" | "PS_400" | "PS_640" | "PS_700" | "PS_900" | "PS_1280" | "PS_1400" | "PS_1800" | "PS_2100" | "PS_2560" | "PS_2700" | "PS_2800" | (string & {});
+/**
+ * Polls keyspaces in a branch until the named keyspace reports
+ * `resizing === false` (i.e. any in-flight resize has completed).
+ */
+export declare const waitForKeyspaceReady: (organization: string, database: string, branch: string, keyspace: string) => Effect.Effect<void, ps.ListKeyspacesError, ps.PlanetScaleOpContext>;
+/**
+ * Observes the total replica count of a branch's default keyspace, or
+ * `undefined` when the branch or keyspace does not exist (yet).
+ */
+export declare const observeDefaultKeyspaceReplicas: (organization: string, database: string, branch: string) => Effect.Effect<number | undefined, ps.BadGateway | ps.BadRequest | ps.ConfigError | ps.Conflict | ps.Forbidden | ps.Services.planetscale.Forbidden | ps.GatewayTimeout | import("effect/http/HttpClientError").HttpClientError | ps.InternalServerError | import("@distilled.cloud/core/protocol-http").InvalidInput | ps.Locked | ps.PlanetScaleParseError | ps.ServiceUnavailable | ps.TooManyRequests | ps.Unauthorized | ps.UnknownPlanetScaleError | ps.UnprocessableEntity | ps.Services.planetscale.UnprocessableEntity, ps.PlanetScaleOpContext>;
+/**
+ * Ensures the default keyspace of a MySQL production branch has the
+ * expected cluster size and (optionally) total replica count, driving
+ * PlanetScale's in-place keyspace resize lifecycle when it doesn't.
+ * Cluster sizes can only be configured on production branches. Returns
+ * the final observed keyspace.
+ */
+export declare const ensureMySQLProductionBranchClusterSize: (organization: string, database: string, branch: string, expectedClusterSize: MySQLClusterSize, expectedReplicas?: number | undefined) => Effect.Effect<ps.PaginatedDatabaseBranchKeyspaceDataItem, PlanetscaleConflict | ps.ListKeyspacesError, ps.PlanetScaleOpContext>;
+//# sourceMappingURL=MySQLClusterSize.d.ts.map

package/lib/MySQL/MySQLClusterSize.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MySQLClusterSize.d.ts","sourceRoot":"","sources":["../../src/MySQL/MySQLClusterSize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,8BAA8B,CAAC;AACnD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AAExC,OAAO,EAAE,mBAAmB,EAAa,MAAM,YAAY,CAAC;AAE5D;;;;;;;;GAQG;AACH,MAAM,MAAM,gBAAgB,GACxB,QAAQ,GACR,MAAM,GACN,OAAO,GACP,OAAO,GACP,OAAO,GACP,OAAO,GACP,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,QAAQ,GACR,SAAS,GACT,SAAS,GACT,SAAS,GACT,SAAS,GACT,SAAS,GACT,SAAS,GACT,SAAS,GACT,CAAC,MAAM,GAAG,EAAE,CAAC,CAAC;AAElB;;;GAGG;AACH,eAAO,MAAM,oBAAoB,mJAe/B,CAAC;AAuBH;;;GAGG;AACH,eAAO,MAAM,8BAA8B,qlBASzC,CAAC;AAEH;;;;;;GAMG;AACH,eAAO,MAAM,sCAAsC,2QAoFjD,CAAC"}

package/lib/MySQL/MySQLClusterSize.js

@@ -0,0 +1,111 @@
+import * as ps from "@distilled.cloud/planetscale";
+import * as Effect from "effect/Effect";
+import * as Schedule from "effect/Schedule";
+import { PlanetscaleConflict, pollUntil } from "../Util.js";
+/**
+ * Polls keyspaces in a branch until the named keyspace reports
+ * `resizing === false` (i.e. any in-flight resize has completed).
+ */
+export const waitForKeyspaceReady = Effect.fn(function* (organization, database, branch, keyspace) {
+    yield* pollUntil(`keyspace "${keyspace}" not resizing`, ps.listKeyspaces({ organization, database, branch }), (page) => {
+        const ks = page.data.find((x) => x.name === keyspace);
+        // If keyspace is missing, treat as ready (caller will re-check)
+        return ks ? !ks.resizing : true;
+    });
+});
+/**
+ * Observes the default keyspace of a branch. The default keyspace usually
+ * shares the database's name, but a renamed database keeps its original
+ * keyspace name, so prefer the `default` flag and fall back to name
+ * matching.
+ */
+const observeDefaultKeyspace = Effect.fn(function* (organization, database, branch) {
+    const keyspaces = yield* ps.listKeyspaces({
+        organization,
+        database,
+        branch,
+        page: 1,
+        per_page: 100,
+    });
+    return keyspaces.data.find((x) => x.default) ?? keyspaces.data.find((x) => x.name === database);
+});
+/**
+ * Observes the total replica count of a branch's default keyspace, or
+ * `undefined` when the branch or keyspace does not exist (yet).
+ */
+export const observeDefaultKeyspaceReplicas = Effect.fn(function* (organization, database, branch) {
+    return yield* observeDefaultKeyspace(organization, database, branch).pipe(Effect.map((keyspace) => keyspace?.replicas), Effect.catchTag("NotFound", () => Effect.undefined));
+});
+/**
+ * Ensures the default keyspace of a MySQL production branch has the
+ * expected cluster size and (optionally) total replica count, driving
+ * PlanetScale's in-place keyspace resize lifecycle when it doesn't.
+ * Cluster sizes can only be configured on production branches. Returns
+ * the final observed keyspace.
+ */
+export const ensureMySQLProductionBranchClusterSize = Effect.fn(function* (organization, database, branch, expectedClusterSize, expectedReplicas) {
+    let keyspace = yield* observeDefaultKeyspace(organization, database, branch);
+    if (!keyspace) {
+        return yield* Effect.die(`No default keyspace found for branch ${branch}`);
+    }
+    yield* waitForKeyspaceReady(organization, database, branch, keyspace.name);
+    if (keyspace.cluster_name !== expectedClusterSize) {
+        yield* ps.updateBranchClusterConfig({
+            organization,
+            database,
+            branch,
+            cluster_size: expectedClusterSize,
+        });
+        yield* waitForKeyspaceReady(organization, database, branch, keyspace.name);
+        // Re-observe so the replica sync below diffs against the post-resize
+        // keyspace state.
+        keyspace = (yield* observeDefaultKeyspace(organization, database, branch)) ?? keyspace;
+    }
+    // Sync replicas — MySQL databases cannot configure replicas at
+    // creation time (the API rejects the `replicas` param for mysql), so
+    // the desired total replica count is converged in place via a keyspace
+    // resize request.
+    if (expectedReplicas !== undefined && keyspace.replicas !== expectedReplicas) {
+        // Each cluster size includes a fixed number of replicas (2 for
+        // production PS_* sizes); the resize API only accepts the count of
+        // additional replicas beyond that.
+        const includedReplicas = keyspace.replicas - keyspace.extra_replicas;
+        const extraReplicas = expectedReplicas - includedReplicas;
+        if (extraReplicas < 0) {
+            return yield* new PlanetscaleConflict({
+                message: `Cannot set replicas to ${expectedReplicas} on keyspace "${keyspace.name}": ` +
+                    `cluster size ${keyspace.cluster_name} always includes ${includedReplicas} replicas. ` +
+                    `Set replicas to ${includedReplicas} or more (or omit it).`,
+            });
+        }
+        const resize = yield* ps
+            .updateKeyspaceResizeRequest({
+            organization,
+            database,
+            branch,
+            keyspace: keyspace.name,
+            extra_replicas: extraReplicas,
+        })
+            .pipe(
+        // A prior resize (e.g. the cluster-size change above) can still
+        // be finalizing after the keyspace reports `resizing: false`;
+        // PlanetScale rejects new resize requests during that window.
+        Effect.retry({
+            while: (e) => e._tag === "UnprocessableEntity" && e.message.includes("resize in progress"),
+            schedule: Schedule.max([Schedule.spaced("5 seconds"), Schedule.recurs(120)]),
+        }));
+        yield* pollUntil(`keyspace "${keyspace.name}" resize completed`, ps.listKeyspaceResizeRequests({
+            organization,
+            database,
+            branch,
+            keyspace: keyspace.name,
+        }), (page) => {
+            const request = page.data.find((r) => r.id === resize.id);
+            // If the request is missing, treat as settled (caller re-observes).
+            return request ? request.state === "completed" : true;
+        });
+        keyspace = (yield* observeDefaultKeyspace(organization, database, branch)) ?? keyspace;
+    }
+    return keyspace;
+});
+//# sourceMappingURL=MySQLClusterSize.js.map

package/lib/MySQL/MySQLClusterSize.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"MySQLClusterSize.js","sourceRoot":"","sources":["../../src/MySQL/MySQLClusterSize.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,MAAM,8BAA8B,CAAC;AACnD,OAAO,KAAK,MAAM,MAAM,eAAe,CAAC;AACxC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAC5C,OAAO,EAAE,mBAAmB,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAiC5D;;;GAGG;AACH,MAAM,CAAC,MAAM,oBAAoB,GAAG,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EACrD,YAAoB,EACpB,QAAgB,EAChB,MAAc,EACd,QAAgB;IAEhB,KAAK,CAAC,CAAC,SAAS,CACd,aAAa,QAAQ,gBAAgB,EACrC,EAAE,CAAC,aAAa,CAAC,EAAE,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,EACpD,CAAC,IAAI,EAAE,EAAE;QACP,MAAM,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;QACtD,gEAAgE;QAChE,OAAO,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,QAAQ,CAAC,CAAC,CAAC,IAAI,CAAC;IAClC,CAAC,CACF,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH;;;;;GAKG;AACH,MAAM,sBAAsB,GAAG,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAChD,YAAoB,EACpB,QAAgB,EAChB,MAAc;IAEd,MAAM,SAAS,GAAG,KAAK,CAAC,CAAC,EAAE,CAAC,aAAa,CAAC;QACxC,YAAY;QACZ,QAAQ;QACR,MAAM;QACN,IAAI,EAAE,CAAC;QACP,QAAQ,EAAE,GAAG;KACd,CAAC,CAAC;IACH,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,QAAQ,CAAC,CAAC;AAClG,CAAC,CAAC,CAAC;AAEH;;;GAGG;AACH,MAAM,CAAC,MAAM,8BAA8B,GAAG,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EAC/D,YAAoB,EACpB,QAAgB,EAChB,MAAc;IAEd,OAAO,KAAK,CAAC,CAAC,sBAAsB,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,CACvE,MAAM,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAC5C,MAAM,CAAC,QAAQ,CAAC,UAAU,EAAE,GAAG,EAAE,CAAC,MAAM,CAAC,SAAS,CAAC,CACpD,CAAC;AACJ,CAAC,CAAC,CAAC;AAEH;;;;;;GAMG;AACH,MAAM,CAAC,MAAM,sCAAsC,GAAG,MAAM,CAAC,EAAE,CAAC,QAAQ,CAAC,EACvE,YAAoB,EACpB,QAAgB,EAChB,MAAc,EACd,mBAAqC,EACrC,gBAAyB;IAEzB,IAAI,QAAQ,GAAG,KAAK,CAAC,CAAC,sBAAsB,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC;IAC7E,IAAI,CAAC,QAAQ,EAAE,CAAC;QACd,OAAO,KAAK,CAAC,CAAC,MAAM,CAAC,GAAG,CAAC,wCAAwC,MAAM,EAAE,CAAC,CAAC;IAC7E,CAAC;IAED,KAAK,CAAC,CAAC,oBAAoB,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;IAE3E,IAAI,QAAQ,CAAC,YAAY,KAAK,mBAAmB,EAAE,CAAC;QAClD,KAAK,CAAC,CAAC,EAAE,CAAC,yBAAyB,CAAC;YAClC,YAAY;YACZ,QAAQ;YACR,MAAM;YACN,YAAY,EAAE,mBAAmB;SAClC,CAAC,CAAC;QACH,KAAK,CAAC,CAAC,oBAAoB,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC;QAC3E,qEAAqE;QACrE,kBAAkB;QAClB,QAAQ,GAAG,CAAC,KAAK,CAAC,CAAC,sBAAsB,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,QAAQ,CAAC;IACzF,CAAC;IAED,+DAA+D;IAC/D,qEAAqE;IACrE,uEAAuE;IACvE,kBAAkB;IAClB,IAAI,gBAAgB,KAAK,SAAS,IAAI,QAAQ,CAAC,QAAQ,KAAK,gBAAgB,EAAE,CAAC;QAC7E,+DAA+D;QAC/D,mEAAmE;QACnE,mCAAmC;QACnC,MAAM,gBAAgB,GAAG,QAAQ,CAAC,QAAQ,GAAG,QAAQ,CAAC,cAAc,CAAC;QACrE,MAAM,aAAa,GAAG,gBAAgB,GAAG,gBAAgB,CAAC;QAC1D,IAAI,aAAa,GAAG,CAAC,EAAE,CAAC;YACtB,OAAO,KAAK,CAAC,CAAC,IAAI,mBAAmB,CAAC;gBACpC,OAAO,EACL,0BAA0B,gBAAgB,iBAAiB,QAAQ,CAAC,IAAI,KAAK;oBAC7E,gBAAgB,QAAQ,CAAC,YAAY,oBAAoB,gBAAgB,aAAa;oBACtF,mBAAmB,gBAAgB,wBAAwB;aAC9D,CAAC,CAAC;QACL,CAAC;QAED,MAAM,MAAM,GAAG,KAAK,CAAC,CAAC,EAAE;aACrB,2BAA2B,CAAC;YAC3B,YAAY;YACZ,QAAQ;YACR,MAAM;YACN,QAAQ,EAAE,QAAQ,CAAC,IAAI;YACvB,cAAc,EAAE,aAAa;SAC9B,CAAC;aACD,IAAI;QACH,gEAAgE;QAChE,8DAA8D;QAC9D,8DAA8D;QAC9D,MAAM,CAAC,KAAK,CAAC;YACX,KAAK,EAAE,CAAC,CAAC,EAAW,EAAE,CACpB,CAAC,CAAC,IAAI,KAAK,qBAAqB,IAAI,CAAC,CAAC,OAAO,CAAC,QAAQ,CAAC,oBAAoB,CAAC;YAC9E,QAAQ,EAAE,QAAQ,CAAC,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,WAAW,CAAC,EAAE,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC;SAC7E,CAAC,CACH,CAAC;QAEJ,KAAK,CAAC,CAAC,SAAS,CACd,aAAa,QAAQ,CAAC,IAAI,oBAAoB,EAC9C,EAAE,CAAC,0BAA0B,CAAC;YAC5B,YAAY;YACZ,QAAQ;YACR,MAAM;YACN,QAAQ,EAAE,QAAQ,CAAC,IAAI;SACxB,CAAC,EACF,CAAC,IAAI,EAAE,EAAE;YACP,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,EAAE,KAAK,MAAM,CAAC,EAAE,CAAC,CAAC;YAC1D,oEAAoE;YACpE,OAAO,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,KAAK,WAAW,CAAC,CAAC,CAAC,IAAI,CAAC;QACxD,CAAC,CACF,CAAC;QAEF,QAAQ,GAAG,CAAC,KAAK,CAAC,CAAC,sBAAsB,CAAC,YAAY,EAAE,QAAQ,EAAE,MAAM,CAAC,CAAC,IAAI,QAAQ,CAAC;IACzF,CAAC;IAED,OAAO,QAAQ,CAAC;AAClB,CAAC,CAAC,CAAC"}

package/lib/MySQL/MySQLDatabase.d.ts

@@ -0,0 +1,141 @@
+import * as planetscale from "@distilled.cloud/planetscale";
+import * as Provider from "alchemy/Provider";
+import { Resource } from "alchemy/Resource";
+import type { BaseDatabaseAttributes, BaseDatabaseProps } from "../Database.ts";
+import type { Providers } from "../Providers.ts";
+import { type MySQLClusterSize } from "./MySQLClusterSize.ts";
+/**
+ * Properties for creating or updating a MySQL PlanetScale database.
+ */
+export interface MySQLDatabaseProps extends BaseDatabaseProps {
+    /**
+     * The MySQL database cluster size. Required.
+     * @see https://planetscale.com/docs/concepts/cluster-size
+     */
+    clusterSize: MySQLClusterSize;
+    /**
+     * Desired total number of replicas for the database's default keyspace.
+     * Each cluster size includes a fixed number of replicas (2 for
+     * production `PS_*` sizes); higher values add extra replicas. Changes
+     * are reconciled in place via PlanetScale's keyspace resize lifecycle —
+     * never by replacing the database.
+     * @see https://planetscale.com/docs/vitess/sharding/keyspaces
+     */
+    replicas?: number;
+    /**
+     * Whether to copy migration data to new branches and in deploy requests.
+     */
+    automaticMigrations?: boolean;
+    /**
+     * Migration framework to use on the database.
+     */
+    migrationFramework?: string;
+    /**
+     * Name of the migration table.
+     */
+    migrationTableName?: string;
+    /**
+     * Whether data branching is allowed on the database.
+     */
+    allowDataBranching?: boolean;
+    /**
+     * Whether foreign key constraints are allowed on the database.
+     */
+    allowForeignKeyConstraints?: boolean;
+    /**
+     * Whether full queries should be collected from the database.
+     */
+    insightsRawQueries?: boolean;
+}
+/**
+ * Output attributes of a deployed MySQL PlanetScale database.
+ */
+export interface MySQLDatabaseAttributes extends BaseDatabaseAttributes {
+    /**
+     * Observed total replica count of the default keyspace on the default
+     * branch, or `undefined` while the keyspace is still provisioning.
+     */
+    replicas: number | undefined;
+    /**
+     * Whether to copy migration data to new branches and in deploy requests.
+     */
+    automaticMigrations: boolean;
+    /**
+     * Migration framework to use on the database.
+     */
+    migrationFramework?: string;
+    /**
+     * Name of the migration table.
+     */
+    migrationTableName?: string;
+    /**
+     * Whether data branching is allowed on the database.
+     */
+    allowDataBranching: boolean;
+    /**
+     * Whether foreign key constraints are allowed on the database.
+     */
+    allowForeignKeyConstraints: boolean;
+    /**
+     * Whether full queries should be collected from the database.
+     */
+    insightsRawQueries: boolean;
+}
+/**
+ * A MySQL PlanetScale database (powered by Vitess). For PostgreSQL use
+ * {@link PostgresDatabase} instead.
+ *
+ * ### Creating a MySQL Database
+ * **Example:** Basic MySQL database
+ * ```typescript
+ * const db = yield* Planetscale.MySQLDatabase("MyDb", {
+ *   clusterSize: "PS_10",
+ * });
+ * ```
+ *
+ * **Example:** MySQL with Vitess migration tooling
+ * ```typescript
+ * const db = yield* Planetscale.MySQLDatabase("MyDb", {
+ *   clusterSize: "PS_10",
+ *   automaticMigrations: true,
+ *   migrationFramework: "rails",
+ *   migrationTableName: "schema_migrations",
+ *   allowDataBranching: true,
+ * });
+ * ```
+ *
+ * ### Migrations and seed data
+ * **Example:** Apply migrations and seed files
+ * ```typescript
+ * const db = yield* Planetscale.MySQLDatabase("MyDb", {
+ *   clusterSize: "PS_10",
+ *   migrationsDir: "./migrations/mysql",
+ *   importFiles: ["./seed/mysql.sql"],
+ * });
+ * ```
+ *
+ * ### Deletion protection
+ * **Example:** Refuse deletes of a production database
+ * ```typescript
+ * const db = yield* Planetscale.MySQLDatabase("MyDb", {
+ *   clusterSize: "PS_10",
+ *   deletionProtection: true,
+ * });
+ * ```
+ *
+ * ### Adoption
+ * **Example:** Adopting an existing database
+ * ```typescript
+ * import { adopt } from "alchemy/AdoptPolicy";
+ *
+ * const db = yield* Planetscale.MySQLDatabase("Existing", {
+ *   name: "existing-db",
+ *   clusterSize: "PS_10",
+ * }).pipe(adopt());
+ * ```
+ */
+export type MySQLDatabase = Resource<"Planetscale.MySQLDatabase", MySQLDatabaseProps, MySQLDatabaseAttributes, never, Providers>;
+/** @resource */
+export declare const MySQLDatabase: import("alchemy/Resource").ResourceClass<MySQLDatabase>;
+export declare const MySQLDatabaseProvider: () => import("effect/Layer").Layer<Provider.Provider<MySQLDatabase>, never, import("effect/FileSystem").FileSystem | import("effect/Path").Path | import("alchemy/Stack").Stack | import("alchemy/Stage").Stage | planetscale.PlanetScaleOpContext>;
+//# sourceMappingURL=MySQLDatabase.d.ts.map

package/lib/MySQL/MySQLDatabase.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"MySQLDatabase.d.ts","sourceRoot":"","sources":["../../src/MySQL/MySQLDatabase.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,WAAW,MAAM,8BAA8B,CAAC;AAI5D,OAAO,KAAK,QAAQ,MAAM,kBAAkB,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,kBAAkB,CAAC;AAI5C,OAAO,KAAK,EAAE,sBAAsB,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AAChF,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAQjD,OAAO,EAGL,KAAK,gBAAgB,EACtB,MAAM,uBAAuB,CAAC;AAG/B;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,iBAAiB;IAC3D;;;OAGG;IACH,WAAW,EAAE,gBAAgB,CAAC;IAE9B;;;;;;;OAOG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,mBAAmB,CAAC,EAAE,OAAO,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,0BAA0B,CAAC,EAAE,OAAO,CAAC;IAErC;;OAEG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,uBAAwB,SAAQ,sBAAsB;IACrE;;;OAGG;IACH,QAAQ,EAAE,MAAM,GAAG,SAAS,CAAC;IAE7B;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAC;IAE7B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;IAE5B;;OAEG;IACH,0BAA0B,EAAE,OAAO,CAAC;IAEpC;;OAEG;IACH,kBAAkB,EAAE,OAAO,CAAC;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAoDG;AACH,MAAM,MAAM,aAAa,GAAG,QAAQ,CAClC,2BAA2B,EAC3B,kBAAkB,EAClB,uBAAuB,EACvB,KAAK,EACL,SAAS,CACV,CAAC;AAEF,gBAAgB;AAChB,eAAO,MAAM,aAAa,yDAAuD,CAAC;AAElF,eAAO,MAAM,qBAAqB,qPAqU9B,CAAC"}