session.d.ts 3.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859
  1. import type { Client, PoolClient, QueryResult, QueryResultRow } from 'pg';
  2. import pg from 'pg';
  3. import { type Cache } from "../cache/core/index.js";
  4. import type { WithCacheConfig } from "../cache/core/types.js";
  5. import { entityKind } from "../entity.js";
  6. import { type Logger } from "../logger.js";
  7. import type { PgDialect } from "../pg-core/dialect.js";
  8. import { PgTransaction } from "../pg-core/index.js";
  9. import type { SelectedFieldsOrdered } from "../pg-core/query-builders/select.types.js";
  10. import type { PgQueryResultHKT, PgTransactionConfig, PreparedQueryConfig } from "../pg-core/session.js";
  11. import { PgPreparedQuery, PgSession } from "../pg-core/session.js";
  12. import type { RelationalSchemaConfig, TablesRelationalConfig } from "../relations.js";
  13. import { type Query, type SQL } from "../sql/sql.js";
  14. import { type Assume } from "../utils.js";
  15. export type NodePgClient = pg.Pool | PoolClient | Client;
  16. export declare class NodePgPreparedQuery<T extends PreparedQueryConfig> extends PgPreparedQuery<T> {
  17. private client;
  18. private queryString;
  19. private params;
  20. private logger;
  21. private fields;
  22. private _isResponseInArrayMode;
  23. private customResultMapper?;
  24. static readonly [entityKind]: string;
  25. private rawQueryConfig;
  26. private queryConfig;
  27. constructor(client: NodePgClient, queryString: string, params: unknown[], logger: Logger, cache: Cache, queryMetadata: {
  28. type: 'select' | 'update' | 'delete' | 'insert';
  29. tables: string[];
  30. } | undefined, cacheConfig: WithCacheConfig | undefined, fields: SelectedFieldsOrdered | undefined, name: string | undefined, _isResponseInArrayMode: boolean, customResultMapper?: ((rows: unknown[][]) => T["execute"]) | undefined);
  31. execute(placeholderValues?: Record<string, unknown> | undefined): Promise<T['execute']>;
  32. all(placeholderValues?: Record<string, unknown> | undefined): Promise<T['all']>;
  33. }
  34. export interface NodePgSessionOptions {
  35. logger?: Logger;
  36. cache?: Cache;
  37. }
  38. export declare class NodePgSession<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends PgSession<NodePgQueryResultHKT, TFullSchema, TSchema> {
  39. private client;
  40. private schema;
  41. private options;
  42. static readonly [entityKind]: string;
  43. private logger;
  44. private cache;
  45. constructor(client: NodePgClient, dialect: PgDialect, schema: RelationalSchemaConfig<TSchema> | undefined, options?: NodePgSessionOptions);
  46. prepareQuery<T extends PreparedQueryConfig = PreparedQueryConfig>(query: Query, fields: SelectedFieldsOrdered | undefined, name: string | undefined, isResponseInArrayMode: boolean, customResultMapper?: (rows: unknown[][]) => T['execute'], queryMetadata?: {
  47. type: 'select' | 'update' | 'delete' | 'insert';
  48. tables: string[];
  49. }, cacheConfig?: WithCacheConfig): PgPreparedQuery<T>;
  50. transaction<T>(transaction: (tx: NodePgTransaction<TFullSchema, TSchema>) => Promise<T>, config?: PgTransactionConfig | undefined): Promise<T>;
  51. count(sql: SQL): Promise<number>;
  52. }
  53. export declare class NodePgTransaction<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends PgTransaction<NodePgQueryResultHKT, TFullSchema, TSchema> {
  54. static readonly [entityKind]: string;
  55. transaction<T>(transaction: (tx: NodePgTransaction<TFullSchema, TSchema>) => Promise<T>): Promise<T>;
  56. }
  57. export interface NodePgQueryResultHKT extends PgQueryResultHKT {
  58. type: QueryResult<Assume<this['row'], QueryResultRow>>;
  59. }