session.d.cts 3.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. import type { OPSQLiteConnection, QueryResult } from '@op-engineering/op-sqlite';
  2. import { type Cache } from "../cache/core/index.cjs";
  3. import type { WithCacheConfig } from "../cache/core/types.cjs";
  4. import { entityKind } from "../entity.cjs";
  5. import type { Logger } from "../logger.cjs";
  6. import type { RelationalSchemaConfig, TablesRelationalConfig } from "../relations.cjs";
  7. import { type Query } from "../sql/sql.cjs";
  8. import type { SQLiteAsyncDialect } from "../sqlite-core/dialect.cjs";
  9. import { SQLiteTransaction } from "../sqlite-core/index.cjs";
  10. import type { SelectedFieldsOrdered } from "../sqlite-core/query-builders/select.types.cjs";
  11. import { type PreparedQueryConfig as PreparedQueryConfigBase, type SQLiteExecuteMethod, SQLitePreparedQuery, SQLiteSession, type SQLiteTransactionConfig } from "../sqlite-core/session.cjs";
  12. export interface OPSQLiteSessionOptions {
  13. logger?: Logger;
  14. cache?: Cache;
  15. }
  16. type PreparedQueryConfig = Omit<PreparedQueryConfigBase, 'statement' | 'run'>;
  17. export declare class OPSQLiteSession<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends SQLiteSession<'async', QueryResult, TFullSchema, TSchema> {
  18. private client;
  19. private schema;
  20. static readonly [entityKind]: string;
  21. private logger;
  22. private cache;
  23. constructor(client: OPSQLiteConnection, dialect: SQLiteAsyncDialect, schema: RelationalSchemaConfig<TSchema> | undefined, options?: OPSQLiteSessionOptions);
  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): OPSQLitePreparedQuery<T>;
  28. transaction<T>(transaction: (tx: OPSQLiteTransaction<TFullSchema, TSchema>) => T, config?: SQLiteTransactionConfig): T;
  29. }
  30. export declare class OPSQLiteTransaction<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends SQLiteTransaction<'async', QueryResult, TFullSchema, TSchema> {
  31. static readonly [entityKind]: string;
  32. transaction<T>(transaction: (tx: OPSQLiteTransaction<TFullSchema, TSchema>) => T): T;
  33. }
  34. export declare class OPSQLitePreparedQuery<T extends PreparedQueryConfig = PreparedQueryConfig> extends SQLitePreparedQuery<{
  35. type: 'async';
  36. run: QueryResult;
  37. all: T['all'];
  38. get: T['get'];
  39. values: T['values'];
  40. execute: T['execute'];
  41. }> {
  42. private client;
  43. private logger;
  44. private fields;
  45. private _isResponseInArrayMode;
  46. private customResultMapper?;
  47. static readonly [entityKind]: string;
  48. constructor(client: OPSQLiteConnection, 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>): Promise<QueryResult>;
  53. all(placeholderValues?: Record<string, unknown>): Promise<T['all']>;
  54. get(placeholderValues?: Record<string, unknown>): Promise<T['get']>;
  55. values(placeholderValues?: Record<string, unknown>): Promise<T['values']>;
  56. }
  57. export {};