sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ FinSpace/ GetKxDataview.ts

import type * as SVC from "@distilled.cloud/aws/finspace";
import * as Binding from "alchemy/Binding";
import type * as Effect from "effect/Effect";
import type { KxEnvironment } from "./KxEnvironment.ts";

/**
 * Runtime binding for `finspace:GetKxDataview` — reads one dataview of a kdb database in the bound environment — status, active versions, and segment configurations.
 * Provide the implementation with
 * `Effect.provide(AWS.FinSpace.GetKxDataviewHttp)`.
 * ### Managing Dataviews
 * **Example:** Poll a Dataview
 * ```typescript
 * const getDataview = yield* AWS.FinSpace.GetKxDataview(kdb);
 *
 * const { status } = yield* getDataview({
 *   databaseName: "ticks",
 *   dataviewName: "latest",
 * });
 * ```
 *
 * @binding
 */
export interface GetKxDataview extends Binding.Service<
  GetKxDataview,
  "AWS.FinSpace.GetKxDataview",
  <K extends KxEnvironment>(
    environment: K,
  ) => Effect.Effect<
    (
      request: Omit<SVC.GetKxDataviewRequest, "environmentId">,
    ) => Effect.Effect<SVC.GetKxDataviewResponse, SVC.GetKxDataviewError>
  >
> {}
export const GetKxDataview = Binding.Service<GetKxDataview>("AWS.FinSpace.GetKxDataview");