session.d.ts 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. import type { Database, RunResult, Statement } from 'better-sqlite3';
  2. import { type Cache } from "../cache/core/index.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 { RelationalSchemaConfig, TablesRelationalConfig } from "../relations.js";
  7. import { type Query } from "../sql/sql.js";
  8. import type { SQLiteSyncDialect } from "../sqlite-core/dialect.js";
  9. import { SQLiteTransaction } from "../sqlite-core/index.js";
  10. import type { SelectedFieldsOrdered } from "../sqlite-core/query-builders/select.types.js";
  11. import { type PreparedQueryConfig as PreparedQueryConfigBase, type SQLiteExecuteMethod, SQLitePreparedQuery as PreparedQueryBase, SQLiteSession, type SQLiteTransactionConfig } from "../sqlite-core/session.js";
  12. export interface BetterSQLiteSessionOptions {
  13. logger?: Logger;
  14. cache?: Cache;
  15. }
  16. type PreparedQueryConfig = Omit<PreparedQueryConfigBase, 'statement' | 'run'>;
  17. export declare class BetterSQLiteSession<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends SQLiteSession<'sync', RunResult, TFullSchema, TSchema> {
  18. private client;
  19. private schema;
  20. static readonly [entityKind]: string;
  21. private logger;
  22. private cache;
  23. constructor(client: Database, dialect: SQLiteSyncDialect, schema: RelationalSchemaConfig<TSchema> | undefined, options?: BetterSQLiteSessionOptions);
  24. prepareQuery<T extends Omit<PreparedQueryConfig, 'run'>>(query: Query, fields: SelectedFieldsOrdered | undefined, executeMethod: SQLiteExecuteMethod, isResponseInArrayMode: boolean, customResultMapper?: (rows: unknown[][]) => unknown, queryMetadata?: {
  25. type: 'select' | 'update' | 'delete' | 'insert';
  26. tables: string[];
  27. }, cacheConfig?: WithCacheConfig): PreparedQuery<T>;
  28. transaction<T>(transaction: (tx: BetterSQLiteTransaction<TFullSchema, TSchema>) => T, config?: SQLiteTransactionConfig): T;
  29. }
  30. export declare class BetterSQLiteTransaction<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends SQLiteTransaction<'sync', RunResult, TFullSchema, TSchema> {
  31. static readonly [entityKind]: string;
  32. transaction<T>(transaction: (tx: BetterSQLiteTransaction<TFullSchema, TSchema>) => T): T;
  33. }
  34. export declare class PreparedQuery<T extends PreparedQueryConfig = PreparedQueryConfig> extends PreparedQueryBase<{
  35. type: 'sync';
  36. run: RunResult;
  37. all: T['all'];
  38. get: T['get'];
  39. values: T['values'];
  40. execute: T['execute'];
  41. }> {
  42. private stmt;
  43. private logger;
  44. private fields;
  45. private _isResponseInArrayMode;
  46. private customResultMapper?;
  47. static readonly [entityKind]: string;
  48. constructor(stmt: Statement, query: Query, logger: Logger, cache: Cache, queryMetadata: {
  49. type: 'select' | 'update' | 'delete' | 'insert';
  50. tables: string[];
  51. } | undefined, cacheConfig: WithCacheConfig | undefined, fields: SelectedFieldsOrdered | undefined, executeMethod: SQLiteExecuteMethod, _isResponseInArrayMode: boolean, customResultMapper?: ((rows: unknown[][]) => unknown) | undefined);
  52. run(placeholderValues?: Record<string, unknown>): RunResult;
  53. all(placeholderValues?: Record<string, unknown>): T['all'];
  54. get(placeholderValues?: Record<string, unknown>): T['get'];
  55. values(placeholderValues?: Record<string, unknown>): T['values'];
  56. }
  57. export {};