driver.d.ts 2.4 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849
  1. import type { HTTPQueryOptions, HTTPTransactionOptions, NeonQueryFunction } from '@neondatabase/serverless';
  2. import type { BatchItem, BatchResponse } from "../batch.js";
  3. import type { Cache } from "../cache/core/cache.js";
  4. import { entityKind } from "../entity.js";
  5. import type { Logger } from "../logger.js";
  6. import { PgDatabase } from "../pg-core/db.js";
  7. import { PgDialect } from "../pg-core/dialect.js";
  8. import type { RelationalSchemaConfig, TablesRelationalConfig } from "../relations.js";
  9. import { type DrizzleConfig } from "../utils.js";
  10. import { type NeonHttpClient, type NeonHttpQueryResultHKT, NeonHttpSession } from "./session.js";
  11. export interface NeonDriverOptions {
  12. logger?: Logger;
  13. cache?: Cache;
  14. }
  15. export declare class NeonHttpDriver {
  16. private client;
  17. private dialect;
  18. private options;
  19. static readonly [entityKind]: string;
  20. constructor(client: NeonHttpClient, dialect: PgDialect, options?: NeonDriverOptions);
  21. createSession(schema: RelationalSchemaConfig<TablesRelationalConfig> | undefined): NeonHttpSession<Record<string, unknown>, TablesRelationalConfig>;
  22. initMappers(): void;
  23. }
  24. export declare class NeonHttpDatabase<TSchema extends Record<string, unknown> = Record<string, never>> extends PgDatabase<NeonHttpQueryResultHKT, TSchema> {
  25. static readonly [entityKind]: string;
  26. $withAuth(token: Exclude<HTTPQueryOptions<true, true>['authToken'], undefined>): Omit<this, Exclude<keyof this, '$count' | 'delete' | 'select' | 'selectDistinct' | 'selectDistinctOn' | 'update' | 'insert' | 'with' | 'query' | 'execute' | 'refreshMaterializedView'>>;
  27. batch<U extends BatchItem<'pg'>, T extends Readonly<[U, ...U[]]>>(batch: T): Promise<BatchResponse<T>>;
  28. }
  29. export declare function drizzle<TSchema extends Record<string, unknown> = Record<string, never>, TClient extends NeonQueryFunction<any, any> = NeonQueryFunction<false, false>>(...params: [
  30. TClient | string
  31. ] | [
  32. TClient | string,
  33. DrizzleConfig<TSchema>
  34. ] | [
  35. (DrizzleConfig<TSchema> & ({
  36. connection: string | ({
  37. connectionString: string;
  38. } & HTTPTransactionOptions<boolean, boolean>);
  39. } | {
  40. client: TClient;
  41. }))
  42. ]): NeonHttpDatabase<TSchema> & {
  43. $client: TClient;
  44. };
  45. export declare namespace drizzle {
  46. function mock<TSchema extends Record<string, unknown> = Record<string, never>>(config?: DrizzleConfig<TSchema>): NeonHttpDatabase<TSchema> & {
  47. $client: '$client is not available on drizzle.mock()';
  48. };
  49. }