session.d.ts 3.7 KB

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