sailfork / t3code-github / .repos/ alchemy-effect/ packages/ gcp/ src/ Spanner/ GetDdl.ts

import type * as spanner from "@distilled.cloud/gcp/spanner_v1";
import * as Binding from "alchemy/Binding";
import type { RuntimeContext } from "alchemy/RuntimeContext";
import type * as Effect from "effect/Effect";
import type { Database } from "./Database.ts";

export interface GetDdlRequest extends Omit<
  spanner.GetDdlProjectsInstancesDatabasesRequest,
  "database"
> {}

/**
 * Runtime binding for Spanner `databases.getDdl`.
 *
 * Bind this operation to a {@link Database} in a Function/Action init
 * phase. Provide {@link GetDdlHttp}.
 *
 * ### Reading Schema
 * **Example:** Fetch live DDL
 * ```typescript
 * const getDdl = yield* GCP.Spanner.GetDdl(database);
 * const { statements } = yield* getDdl();
 * ```
 *
 * @binding
 * @category Spanner
 */
export interface GetDdl extends Binding.Service<
  GetDdl,
  "GCP.Spanner.GetDdl",
  (
    database: Database,
  ) => Effect.Effect<
    (
      request?: GetDdlRequest,
    ) => Effect.Effect<
      spanner.GetDatabaseDdlResponse,
      spanner.GetDdlProjectsInstancesDatabasesError,
      RuntimeContext
    >
  >
> {}

export const GetDdl = Binding.Service<GetDdl>("GCP.Spanner.GetDdl");