session.d.ts 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. import type { FieldPacket, ResultSetHeader } from 'mysql2/promise';
  2. import { entityKind } from "../entity.js";
  3. import type { Logger } from "../logger.js";
  4. import type { RelationalSchemaConfig, TablesRelationalConfig } from "../relations.js";
  5. import type { SingleStoreDialect } from "../singlestore-core/dialect.js";
  6. import { SingleStoreTransaction } from "../singlestore-core/index.js";
  7. import type { SelectedFieldsOrdered } from "../singlestore-core/query-builders/select.types.js";
  8. import type { PreparedQueryKind, SingleStorePreparedQueryConfig, SingleStorePreparedQueryHKT, SingleStoreQueryResultHKT, SingleStoreTransactionConfig } from "../singlestore-core/session.js";
  9. import { SingleStorePreparedQuery as PreparedQueryBase, SingleStoreSession } from "../singlestore-core/session.js";
  10. import type { Query, SQL } from "../sql/sql.js";
  11. import { type Assume } from "../utils.js";
  12. import type { RemoteCallback } from "./driver.js";
  13. export type SingleStoreRawQueryResult = [ResultSetHeader, FieldPacket[]];
  14. export interface SingleStoreRemoteSessionOptions {
  15. logger?: Logger;
  16. }
  17. export declare class SingleStoreRemoteSession<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends SingleStoreSession<SingleStoreRemoteQueryResultHKT, SingleStoreRemotePreparedQueryHKT, TFullSchema, TSchema> {
  18. private client;
  19. private schema;
  20. static readonly [entityKind]: string;
  21. private logger;
  22. constructor(client: RemoteCallback, dialect: SingleStoreDialect, schema: RelationalSchemaConfig<TSchema> | undefined, options: SingleStoreRemoteSessionOptions);
  23. prepareQuery<T extends SingleStorePreparedQueryConfig>(query: Query, fields: SelectedFieldsOrdered | undefined, customResultMapper?: (rows: unknown[][]) => T['execute'], generatedIds?: Record<string, unknown>[], returningIds?: SelectedFieldsOrdered): PreparedQueryKind<SingleStoreRemotePreparedQueryHKT, T>;
  24. all<T = unknown>(query: SQL): Promise<T[]>;
  25. transaction<T>(_transaction: (tx: SingleStoreProxyTransaction<TFullSchema, TSchema>) => Promise<T>, _config?: SingleStoreTransactionConfig): Promise<T>;
  26. }
  27. export declare class SingleStoreProxyTransaction<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends SingleStoreTransaction<SingleStoreRemoteQueryResultHKT, SingleStoreRemotePreparedQueryHKT, TFullSchema, TSchema> {
  28. static readonly [entityKind]: string;
  29. transaction<T>(_transaction: (tx: SingleStoreProxyTransaction<TFullSchema, TSchema>) => Promise<T>): Promise<T>;
  30. }
  31. export declare class PreparedQuery<T extends SingleStorePreparedQueryConfig> extends PreparedQueryBase<T> {
  32. private client;
  33. private queryString;
  34. private params;
  35. private logger;
  36. private fields;
  37. private customResultMapper?;
  38. private generatedIds?;
  39. private returningIds?;
  40. static readonly [entityKind]: string;
  41. constructor(client: RemoteCallback, queryString: string, params: unknown[], logger: Logger, fields: SelectedFieldsOrdered | undefined, customResultMapper?: ((rows: unknown[][]) => T["execute"]) | undefined, generatedIds?: Record<string, unknown>[] | undefined, returningIds?: SelectedFieldsOrdered | undefined);
  42. execute(placeholderValues?: Record<string, unknown> | undefined): Promise<T['execute']>;
  43. iterator(_placeholderValues?: Record<string, unknown>): AsyncGenerator<T['iterator']>;
  44. }
  45. export interface SingleStoreRemoteQueryResultHKT extends SingleStoreQueryResultHKT {
  46. type: SingleStoreRawQueryResult;
  47. }
  48. export interface SingleStoreRemotePreparedQueryHKT extends SingleStorePreparedQueryHKT {
  49. type: PreparedQuery<Assume<this['config'], SingleStorePreparedQueryConfig>>;
  50. }