driver.d.cts 1.3 KB

123456789101112131415161718192021222324252627282930313233
  1. import type { Config } from '@planetscale/database';
  2. import { Client } from '@planetscale/database';
  3. import { entityKind } from "../entity.cjs";
  4. import type { Logger } from "../logger.cjs";
  5. import { MySqlDatabase } from "../mysql-core/db.cjs";
  6. import { type DrizzleConfig } from "../utils.cjs";
  7. import type { PlanetScalePreparedQueryHKT, PlanetscaleQueryResultHKT } from "./session.cjs";
  8. export interface PlanetscaleSDriverOptions {
  9. logger?: Logger;
  10. cache?: Cache;
  11. }
  12. export declare class PlanetScaleDatabase<TSchema extends Record<string, unknown> = Record<string, never>> extends MySqlDatabase<PlanetscaleQueryResultHKT, PlanetScalePreparedQueryHKT, TSchema> {
  13. static readonly [entityKind]: string;
  14. }
  15. export declare function drizzle<TSchema extends Record<string, unknown> = Record<string, never>, TClient extends Client = Client>(...params: [
  16. TClient | string
  17. ] | [
  18. TClient | string,
  19. DrizzleConfig<TSchema>
  20. ] | [
  21. (DrizzleConfig<TSchema> & ({
  22. connection: string | Config;
  23. } | {
  24. client: TClient;
  25. }))
  26. ]): PlanetScaleDatabase<TSchema> & {
  27. $client: TClient;
  28. };
  29. export declare namespace drizzle {
  30. function mock<TSchema extends Record<string, unknown> = Record<string, never>>(config?: DrizzleConfig<TSchema>): PlanetScaleDatabase<TSchema> & {
  31. $client: '$client is not available on drizzle.mock()';
  32. };
  33. }