session.d.cts 4.3 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. import type { Connection, FieldPacket, OkPacket, Pool, ResultSetHeader, RowDataPacket } from 'mysql2/promise';
  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 { SingleStoreDialect } from "../singlestore-core/dialect.cjs";
  8. import type { SelectedFieldsOrdered } from "../singlestore-core/query-builders/select.types.cjs";
  9. import { type PreparedQueryKind, SingleStorePreparedQuery, type SingleStorePreparedQueryConfig, type SingleStorePreparedQueryHKT, type SingleStoreQueryResultHKT, SingleStoreSession, SingleStoreTransaction, type SingleStoreTransactionConfig } from "../singlestore-core/session.cjs";
  10. import type { Query, SQL } from "../sql/sql.cjs";
  11. import { type Assume } from "../utils.cjs";
  12. export type SingleStoreDriverClient = Pool | Connection;
  13. export type SingleStoreRawQueryResult = [ResultSetHeader, FieldPacket[]];
  14. export type SingleStoreQueryResultType = RowDataPacket[][] | RowDataPacket[] | OkPacket | OkPacket[] | ResultSetHeader;
  15. export type SingleStoreQueryResult<T = any> = [T extends ResultSetHeader ? T : T[], FieldPacket[]];
  16. export declare class SingleStoreDriverPreparedQuery<T extends SingleStorePreparedQueryConfig> extends SingleStorePreparedQuery<T> {
  17. private client;
  18. private params;
  19. private logger;
  20. private fields;
  21. private customResultMapper?;
  22. private generatedIds?;
  23. private returningIds?;
  24. static readonly [entityKind]: string;
  25. private rawQuery;
  26. private query;
  27. constructor(client: SingleStoreDriverClient, queryString: string, params: unknown[], logger: Logger, cache: Cache, queryMetadata: {
  28. type: 'select' | 'update' | 'delete' | 'insert';
  29. tables: string[];
  30. } | undefined, cacheConfig: WithCacheConfig | undefined, fields: SelectedFieldsOrdered | undefined, customResultMapper?: ((rows: unknown[][]) => T["execute"]) | undefined, generatedIds?: Record<string, unknown>[] | undefined, returningIds?: SelectedFieldsOrdered | undefined);
  31. execute(placeholderValues?: Record<string, unknown>): Promise<T['execute']>;
  32. iterator(placeholderValues?: Record<string, unknown>): AsyncGenerator<T['execute'] extends any[] ? T['execute'][number] : T['execute']>;
  33. }
  34. export interface SingleStoreDriverSessionOptions {
  35. logger?: Logger;
  36. cache?: Cache;
  37. }
  38. export declare class SingleStoreDriverSession<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends SingleStoreSession<SingleStoreQueryResultHKT, SingleStoreDriverPreparedQueryHKT, TFullSchema, TSchema> {
  39. private client;
  40. private schema;
  41. private options;
  42. static readonly [entityKind]: string;
  43. private logger;
  44. private cache;
  45. constructor(client: SingleStoreDriverClient, dialect: SingleStoreDialect, schema: RelationalSchemaConfig<TSchema> | undefined, options: SingleStoreDriverSessionOptions);
  46. prepareQuery<T extends SingleStorePreparedQueryConfig>(query: Query, fields: SelectedFieldsOrdered | undefined, customResultMapper?: (rows: unknown[][]) => T['execute'], generatedIds?: Record<string, unknown>[], returningIds?: SelectedFieldsOrdered, queryMetadata?: {
  47. type: 'select' | 'update' | 'delete' | 'insert';
  48. tables: string[];
  49. }, cacheConfig?: WithCacheConfig): PreparedQueryKind<SingleStoreDriverPreparedQueryHKT, T>;
  50. all<T = unknown>(query: SQL): Promise<T[]>;
  51. transaction<T>(transaction: (tx: SingleStoreDriverTransaction<TFullSchema, TSchema>) => Promise<T>, config?: SingleStoreTransactionConfig): Promise<T>;
  52. }
  53. export declare class SingleStoreDriverTransaction<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends SingleStoreTransaction<SingleStoreDriverQueryResultHKT, SingleStoreDriverPreparedQueryHKT, TFullSchema, TSchema> {
  54. static readonly [entityKind]: string;
  55. transaction<T>(transaction: (tx: SingleStoreDriverTransaction<TFullSchema, TSchema>) => Promise<T>): Promise<T>;
  56. }
  57. export interface SingleStoreDriverQueryResultHKT extends SingleStoreQueryResultHKT {
  58. type: SingleStoreRawQueryResult;
  59. }
  60. export interface SingleStoreDriverPreparedQueryHKT extends SingleStorePreparedQueryHKT {
  61. type: SingleStoreDriverPreparedQuery<Assume<this['config'], SingleStorePreparedQueryConfig>>;
  62. }