session.d.cts 3.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273
  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, type SQL } from "../sql/index.cjs";
  7. import type { NeonAuthToken } from "../utils.cjs";
  8. import { PgDatabase } from "./db.cjs";
  9. import type { PgDialect } 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 PgPreparedQuery<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 interface PgTransactionConfig {
  32. isolationLevel?: 'read uncommitted' | 'read committed' | 'repeatable read' | 'serializable';
  33. accessMode?: 'read only' | 'read write';
  34. deferrable?: boolean;
  35. }
  36. export declare abstract class PgSession<TQueryResult extends PgQueryResultHKT = PgQueryResultHKT, TFullSchema extends Record<string, unknown> = Record<string, never>, TSchema extends TablesRelationalConfig = Record<string, never>> {
  37. protected dialect: PgDialect;
  38. static readonly [entityKind]: string;
  39. constructor(dialect: PgDialect);
  40. 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?: {
  41. type: 'select' | 'update' | 'delete' | 'insert';
  42. tables: string[];
  43. }, cacheConfig?: WithCacheConfig): PgPreparedQuery<T>;
  44. execute<T>(query: SQL): Promise<T>;
  45. all<T = unknown>(query: SQL): Promise<T[]>;
  46. count(sql: SQL): Promise<number>;
  47. abstract transaction<T>(transaction: (tx: PgTransaction<TQueryResult, TFullSchema, TSchema>) => Promise<T>, config?: PgTransactionConfig): Promise<T>;
  48. }
  49. export declare abstract class PgTransaction<TQueryResult extends PgQueryResultHKT, TFullSchema extends Record<string, unknown> = Record<string, never>, TSchema extends TablesRelationalConfig = Record<string, never>> extends PgDatabase<TQueryResult, TFullSchema, TSchema> {
  50. protected schema: {
  51. fullSchema: Record<string, unknown>;
  52. schema: TSchema;
  53. tableNamesMap: Record<string, string>;
  54. } | undefined;
  55. protected readonly nestedIndex: number;
  56. static readonly [entityKind]: string;
  57. constructor(dialect: PgDialect, session: PgSession<any, any, any>, schema: {
  58. fullSchema: Record<string, unknown>;
  59. schema: TSchema;
  60. tableNamesMap: Record<string, string>;
  61. } | undefined, nestedIndex?: number);
  62. rollback(): never;
  63. setTransaction(config: PgTransactionConfig): Promise<void>;
  64. abstract transaction<T>(transaction: (tx: PgTransaction<TQueryResult, TFullSchema, TSchema>) => Promise<T>): Promise<T>;
  65. }
  66. export interface PgQueryResultHKT {
  67. readonly $brand: 'PgQueryResultHKT';
  68. readonly row: unknown;
  69. readonly type: unknown;
  70. }
  71. export type PgQueryResultKind<TKind extends PgQueryResultHKT, TRow> = (TKind & {
  72. readonly row: TRow;
  73. })['type'];