session.d.cts 3.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. import type { Client } from 'gel';
  2. import type { Transaction } from 'gel/dist/transaction';
  3. import { type Cache } from "../cache/core/index.cjs";
  4. import type { WithCacheConfig } from "../cache/core/types.cjs";
  5. import { entityKind } from "../entity.cjs";
  6. import type { GelDialect } from "../gel-core/dialect.cjs";
  7. import type { SelectedFieldsOrdered } from "../gel-core/query-builders/select.types.cjs";
  8. import { GelPreparedQuery, GelSession, GelTransaction, type PreparedQueryConfig } from "../gel-core/session.cjs";
  9. import { type Logger } from "../logger.cjs";
  10. import type { RelationalSchemaConfig, TablesRelationalConfig } from "../relations.cjs";
  11. import { type Query, type SQL } from "../sql/sql.cjs";
  12. export type GelClient = Client | Transaction;
  13. export declare class GelDbPreparedQuery<T extends PreparedQueryConfig> extends GelPreparedQuery<T> {
  14. private client;
  15. private queryString;
  16. private params;
  17. private logger;
  18. private fields;
  19. private _isResponseInArrayMode;
  20. private customResultMapper?;
  21. private transaction;
  22. static readonly [entityKind]: string;
  23. constructor(client: GelClient, queryString: string, params: unknown[], logger: Logger, cache: Cache, queryMetadata: {
  24. type: 'select' | 'update' | 'delete' | 'insert';
  25. tables: string[];
  26. } | undefined, cacheConfig: WithCacheConfig | undefined, fields: SelectedFieldsOrdered | undefined, _isResponseInArrayMode: boolean, customResultMapper?: ((rows: unknown[][]) => T["execute"]) | undefined, transaction?: boolean);
  27. execute(placeholderValues?: Record<string, unknown> | undefined): Promise<T['execute']>;
  28. all(placeholderValues?: Record<string, unknown> | undefined): Promise<T['all']>;
  29. }
  30. export interface GelSessionOptions {
  31. logger?: Logger;
  32. cache?: Cache;
  33. }
  34. export declare class GelDbSession<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends GelSession<GelQueryResultHKT, TFullSchema, TSchema> {
  35. private client;
  36. private schema;
  37. private options;
  38. static readonly [entityKind]: string;
  39. private logger;
  40. private cache;
  41. constructor(client: GelClient, dialect: GelDialect, schema: RelationalSchemaConfig<TSchema> | undefined, options?: GelSessionOptions);
  42. prepareQuery<T extends PreparedQueryConfig = PreparedQueryConfig>(query: Query, fields: SelectedFieldsOrdered | undefined, name: string | undefined, isResponseInArrayMode: boolean, customResultMapper?: (rows: unknown[][]) => T['execute'], queryMetadata?: {
  43. type: 'select' | 'update' | 'delete' | 'insert';
  44. tables: string[];
  45. }, cacheConfig?: WithCacheConfig): GelDbPreparedQuery<T>;
  46. transaction<T>(transaction: (tx: GelTransaction<GelQueryResultHKT, TFullSchema, TSchema>) => Promise<T>): Promise<T>;
  47. count(sql: SQL): Promise<number>;
  48. }
  49. export declare class GelDbTransaction<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends GelTransaction<GelQueryResultHKT, TFullSchema, TSchema> {
  50. static readonly [entityKind]: string;
  51. transaction<T>(transaction: (tx: GelDbTransaction<TFullSchema, TSchema>) => Promise<T>): Promise<T>;
  52. }
  53. export interface GelQueryResultHKT {
  54. readonly $brand: 'GelQueryResultHKT';
  55. readonly row: unknown;
  56. readonly type: unknown;
  57. }