session.d.cts 3.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. import { type Cache } from "../cache/core/cache.cjs";
  2. import type { WithCacheConfig } from "../cache/core/types.cjs";
  3. import { entityKind } from "../entity.cjs";
  4. import type { TablesRelationalConfig } from "../relations.cjs";
  5. import type { PreparedQuery } from "../session.cjs";
  6. import type { Query, SQL } from "../sql/index.cjs";
  7. import type { NeonAuthToken } from "../utils.cjs";
  8. import { GelDatabase } from "./db.cjs";
  9. import type { GelDialect } from "./dialect.cjs";
  10. import type { SelectedFieldsOrdered } from "./query-builders/select.types.cjs";
  11. export interface PreparedQueryConfig {
  12. execute: unknown;
  13. all: unknown;
  14. values: unknown;
  15. }
  16. export declare abstract class GelPreparedQuery<T extends PreparedQueryConfig> implements PreparedQuery {
  17. protected query: Query;
  18. private cache?;
  19. private queryMetadata?;
  20. private cacheConfig?;
  21. constructor(query: Query, cache?: Cache | undefined, queryMetadata?: {
  22. type: 'select' | 'update' | 'delete' | 'insert';
  23. tables: string[];
  24. } | undefined, cacheConfig?: WithCacheConfig | undefined);
  25. protected authToken?: NeonAuthToken;
  26. getQuery(): Query;
  27. mapResult(response: unknown, _isFromBatch?: boolean): unknown;
  28. static readonly [entityKind]: string;
  29. abstract execute(placeholderValues?: Record<string, unknown>): Promise<T['execute']>;
  30. }
  31. export declare abstract class GelSession<TQueryResult extends GelQueryResultHKT = any, // TO
  32. TFullSchema extends Record<string, unknown> = Record<string, never>, TSchema extends TablesRelationalConfig = Record<string, never>> {
  33. protected dialect: GelDialect;
  34. static readonly [entityKind]: string;
  35. constructor(dialect: GelDialect);
  36. abstract prepareQuery<T extends PreparedQueryConfig = PreparedQueryConfig>(query: Query, fields: SelectedFieldsOrdered | undefined, name: string | undefined, isResponseInArrayMode: boolean, customResultMapper?: (rows: unknown[][], mapColumnValue?: (value: unknown) => unknown) => T['execute'], queryMetadata?: {
  37. type: 'select' | 'update' | 'delete' | 'insert';
  38. tables: string[];
  39. }, cacheConfig?: WithCacheConfig): GelPreparedQuery<T>;
  40. execute<T>(query: SQL): Promise<T>;
  41. all<T = unknown>(query: SQL): Promise<T[]>;
  42. count(sql: SQL): Promise<number>;
  43. abstract transaction<T>(transaction: (tx: GelTransaction<TQueryResult, TFullSchema, TSchema>) => Promise<T>): Promise<T>;
  44. }
  45. export declare abstract class GelTransaction<TQueryResult extends GelQueryResultHKT, TFullSchema extends Record<string, unknown> = Record<string, never>, TSchema extends TablesRelationalConfig = Record<string, never>> extends GelDatabase<TQueryResult, TFullSchema, TSchema> {
  46. protected schema: {
  47. fullSchema: Record<string, unknown>;
  48. schema: TSchema;
  49. tableNamesMap: Record<string, string>;
  50. } | undefined;
  51. static readonly [entityKind]: string;
  52. constructor(dialect: GelDialect, session: GelSession<any, any, any>, schema: {
  53. fullSchema: Record<string, unknown>;
  54. schema: TSchema;
  55. tableNamesMap: Record<string, string>;
  56. } | undefined);
  57. rollback(): never;
  58. abstract transaction<T>(transaction: (tx: GelTransaction<TQueryResult, TFullSchema, TSchema>) => Promise<T>): Promise<T>;
  59. }
  60. export interface GelQueryResultHKT {
  61. readonly $brand: 'GelQueryResultHKT';
  62. readonly row: unknown;
  63. readonly type: unknown;
  64. }
  65. export type GelQueryResultKind<TKind extends GelQueryResultHKT, TRow> = (TKind & {
  66. readonly row: TRow;
  67. })['type'];