session.d.cts 3.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. import type { FullQueryResults, NeonQueryFunction } from '@neondatabase/serverless';
  2. import type { BatchItem } from "../batch.cjs";
  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 { Logger } from "../logger.cjs";
  7. import type { PgDialect } from "../pg-core/dialect.cjs";
  8. import { PgTransaction } from "../pg-core/index.cjs";
  9. import type { SelectedFieldsOrdered } from "../pg-core/query-builders/select.types.cjs";
  10. import type { PgQueryResultHKT, PgTransactionConfig, PreparedQueryConfig } from "../pg-core/session.cjs";
  11. import { PgPreparedQuery as PgPreparedQuery, PgSession } from "../pg-core/session.cjs";
  12. import type { RelationalSchemaConfig, TablesRelationalConfig } from "../relations.cjs";
  13. import { type Query, type SQL } from "../sql/sql.cjs";
  14. export type NeonHttpClient = NeonQueryFunction<any, any>;
  15. export declare class NeonHttpPreparedQuery<T extends PreparedQueryConfig> extends PgPreparedQuery<T> {
  16. private client;
  17. private logger;
  18. private fields;
  19. private _isResponseInArrayMode;
  20. private customResultMapper?;
  21. static readonly [entityKind]: string;
  22. private clientQuery;
  23. constructor(client: NeonHttpClient, query: Query, 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);
  27. execute(placeholderValues: Record<string, unknown> | undefined): Promise<T['execute']>;
  28. mapResult(result: unknown): unknown;
  29. all(placeholderValues?: Record<string, unknown> | undefined): Promise<T['all']>;
  30. values(placeholderValues: Record<string, unknown> | undefined): Promise<T['values']>;
  31. }
  32. export interface NeonHttpSessionOptions {
  33. logger?: Logger;
  34. cache?: Cache;
  35. }
  36. export declare class NeonHttpSession<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends PgSession<NeonHttpQueryResultHKT, TFullSchema, TSchema> {
  37. private client;
  38. private schema;
  39. private options;
  40. static readonly [entityKind]: string;
  41. private clientQuery;
  42. private logger;
  43. private cache;
  44. constructor(client: NeonHttpClient, dialect: PgDialect, schema: RelationalSchemaConfig<TSchema> | undefined, options?: NeonHttpSessionOptions);
  45. prepareQuery<T extends PreparedQueryConfig = PreparedQueryConfig>(query: Query, fields: SelectedFieldsOrdered | undefined, name: string | undefined, isResponseInArrayMode: boolean, customResultMapper?: (rows: unknown[][]) => T['execute'], queryMetadata?: {
  46. type: 'select' | 'update' | 'delete' | 'insert';
  47. tables: string[];
  48. }, cacheConfig?: WithCacheConfig): PgPreparedQuery<T>;
  49. batch<U extends BatchItem<'pg'>, T extends Readonly<[U, ...U[]]>>(queries: T): Promise<any>;
  50. query(query: string, params: unknown[]): Promise<FullQueryResults<true>>;
  51. queryObjects(query: string, params: unknown[]): Promise<FullQueryResults<false>>;
  52. count(sql: SQL): Promise<number>;
  53. transaction<T>(_transaction: (tx: NeonTransaction<TFullSchema, TSchema>) => Promise<T>, _config?: PgTransactionConfig): Promise<T>;
  54. }
  55. export declare class NeonTransaction<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends PgTransaction<NeonHttpQueryResultHKT, TFullSchema, TSchema> {
  56. static readonly [entityKind]: string;
  57. transaction<T>(_transaction: (tx: NeonTransaction<TFullSchema, TSchema>) => Promise<T>): Promise<T>;
  58. }
  59. export type NeonHttpQueryResult<T> = Omit<FullQueryResults<false>, 'rows'> & {
  60. rows: T[];
  61. };
  62. export interface NeonHttpQueryResultHKT extends PgQueryResultHKT {
  63. type: NeonHttpQueryResult<this['row']>;
  64. }