driver.d.ts 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. import { RDSDataClient, type RDSDataClientConfig } from '@aws-sdk/client-rds-data';
  2. import { entityKind } from "../../entity.js";
  3. import type { Logger } from "../../logger.js";
  4. import { PgDatabase } from "../../pg-core/db.js";
  5. import { PgDialect } from "../../pg-core/dialect.js";
  6. import type { PgInsertConfig, PgTable, TableConfig } from "../../pg-core/index.js";
  7. import type { PgRaw } from "../../pg-core/query-builders/raw.js";
  8. import { type SQL, type SQLWrapper } from "../../sql/sql.js";
  9. import type { DrizzleConfig, UpdateSet } from "../../utils.js";
  10. import type { AwsDataApiClient, AwsDataApiPgQueryResult, AwsDataApiPgQueryResultHKT } from "./session.js";
  11. export interface PgDriverOptions {
  12. logger?: Logger;
  13. cache?: Cache;
  14. database: string;
  15. resourceArn: string;
  16. secretArn: string;
  17. }
  18. export interface DrizzleAwsDataApiPgConfig<TSchema extends Record<string, unknown> = Record<string, never>> extends DrizzleConfig<TSchema> {
  19. database: string;
  20. resourceArn: string;
  21. secretArn: string;
  22. }
  23. export declare class AwsDataApiPgDatabase<TSchema extends Record<string, unknown> = Record<string, never>> extends PgDatabase<AwsDataApiPgQueryResultHKT, TSchema> {
  24. static readonly [entityKind]: string;
  25. execute<TRow extends Record<string, unknown> = Record<string, unknown>>(query: SQLWrapper | string): PgRaw<AwsDataApiPgQueryResult<TRow>>;
  26. }
  27. export declare class AwsPgDialect extends PgDialect {
  28. static readonly [entityKind]: string;
  29. escapeParam(num: number): string;
  30. buildInsertQuery({ table, values, onConflict, returning, select, withList }: PgInsertConfig<PgTable<TableConfig>>): SQL<unknown>;
  31. buildUpdateSet(table: PgTable<TableConfig>, set: UpdateSet): SQL<unknown>;
  32. }
  33. export declare function drizzle<TSchema extends Record<string, unknown> = Record<string, never>, TClient extends AwsDataApiClient = RDSDataClient>(...params: [
  34. TClient,
  35. DrizzleAwsDataApiPgConfig<TSchema>
  36. ] | [
  37. ((DrizzleConfig<TSchema> & {
  38. connection: RDSDataClientConfig & Omit<DrizzleAwsDataApiPgConfig, keyof DrizzleConfig>;
  39. }) | (DrizzleAwsDataApiPgConfig<TSchema> & {
  40. client: TClient;
  41. }))
  42. ]): AwsDataApiPgDatabase<TSchema> & {
  43. $client: TClient;
  44. };
  45. export declare namespace drizzle {
  46. function mock<TSchema extends Record<string, unknown> = Record<string, never>>(config: DrizzleAwsDataApiPgConfig<TSchema>): AwsDataApiPgDatabase<TSchema> & {
  47. $client: '$client is not available on drizzle.mock()';
  48. };
  49. }