sailfork / t3code-github / .repos/ alchemy-effect/ packages/ aws/ src/ Athena/ ListTableMetadata.ts

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

/**
 * Runtime binding for `athena:ListTableMetadata`.
 *
 * Lists table metadata for a database in the bound data catalog — the
 * catalog name is injected automatically; `Expression` filters table names.
 * Provide the implementation with
 * `Effect.provide(AWS.Athena.ListTableMetadataHttp)`.
 * ### Browsing Catalog Metadata
 * **Example:** List a Database's Tables
 * ```typescript
 * // init — bind the operation to the data catalog
 * const listTableMetadata = yield* AWS.Athena.ListTableMetadata(catalog);
 *
 * // runtime
 * const res = yield* listTableMetadata({ DatabaseName: "analytics" });
 * console.log(res.TableMetadataList?.map((t) => t.Name));
 * ```
 *
 * @binding
 */
export interface ListTableMetadata extends Binding.Service<
  ListTableMetadata,
  "AWS.Athena.ListTableMetadata",
  (
    catalog: DataCatalog,
  ) => Effect.Effect<
    (
      request: Omit<athena.ListTableMetadataInput, "CatalogName">,
    ) => Effect.Effect<athena.ListTableMetadataOutput, athena.ListTableMetadataError>
  >
> {}

export const ListTableMetadata = Binding.Service<ListTableMetadata>("AWS.Athena.ListTableMetadata");