session.d.cts 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960
  1. import type { Connection, FullResult, Tx } from '@tidbcloud/serverless';
  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 { MySqlDialect } from "../mysql-core/dialect.cjs";
  7. import type { SelectedFieldsOrdered } from "../mysql-core/query-builders/select.types.cjs";
  8. import { MySqlPreparedQuery, type MySqlPreparedQueryConfig, type MySqlPreparedQueryHKT, type MySqlQueryResultHKT, MySqlSession, MySqlTransaction } from "../mysql-core/session.cjs";
  9. import type { RelationalSchemaConfig, TablesRelationalConfig } from "../relations.cjs";
  10. import { type Query, type SQL } from "../sql/sql.cjs";
  11. import { type Assume } from "../utils.cjs";
  12. export declare class TiDBServerlessPreparedQuery<T extends MySqlPreparedQueryConfig> extends MySqlPreparedQuery<T> {
  13. private client;
  14. private queryString;
  15. private params;
  16. private logger;
  17. private fields;
  18. private customResultMapper?;
  19. private generatedIds?;
  20. private returningIds?;
  21. static readonly [entityKind]: string;
  22. constructor(client: Tx | Connection, queryString: string, params: unknown[], logger: Logger, cache: Cache, queryMetadata: {
  23. type: 'select' | 'update' | 'delete' | 'insert';
  24. tables: string[];
  25. } | undefined, cacheConfig: WithCacheConfig | undefined, fields: SelectedFieldsOrdered | undefined, customResultMapper?: ((rows: unknown[][]) => T["execute"]) | undefined, generatedIds?: Record<string, unknown>[] | undefined, returningIds?: SelectedFieldsOrdered | undefined);
  26. execute(placeholderValues?: Record<string, unknown> | undefined): Promise<T['execute']>;
  27. iterator(_placeholderValues?: Record<string, unknown>): AsyncGenerator<T['iterator']>;
  28. }
  29. export interface TiDBServerlessSessionOptions {
  30. logger?: Logger;
  31. cache?: Cache;
  32. }
  33. export declare class TiDBServerlessSession<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends MySqlSession<TiDBServerlessQueryResultHKT, TiDBServerlessPreparedQueryHKT, TFullSchema, TSchema> {
  34. private baseClient;
  35. private schema;
  36. private options;
  37. static readonly [entityKind]: string;
  38. private logger;
  39. private client;
  40. private cache;
  41. constructor(baseClient: Connection, dialect: MySqlDialect, tx: Tx | undefined, schema: RelationalSchemaConfig<TSchema> | undefined, options?: TiDBServerlessSessionOptions);
  42. prepareQuery<T extends MySqlPreparedQueryConfig = MySqlPreparedQueryConfig>(query: Query, fields: SelectedFieldsOrdered | undefined, customResultMapper?: (rows: unknown[][]) => T['execute'], generatedIds?: Record<string, unknown>[], returningIds?: SelectedFieldsOrdered, queryMetadata?: {
  43. type: 'select' | 'update' | 'delete' | 'insert';
  44. tables: string[];
  45. }, cacheConfig?: WithCacheConfig): MySqlPreparedQuery<T>;
  46. all<T = unknown>(query: SQL): Promise<T[]>;
  47. count(sql: SQL): Promise<number>;
  48. transaction<T>(transaction: (tx: TiDBServerlessTransaction<TFullSchema, TSchema>) => Promise<T>): Promise<T>;
  49. }
  50. export declare class TiDBServerlessTransaction<TFullSchema extends Record<string, unknown>, TSchema extends TablesRelationalConfig> extends MySqlTransaction<TiDBServerlessQueryResultHKT, TiDBServerlessPreparedQueryHKT, TFullSchema, TSchema> {
  51. static readonly [entityKind]: string;
  52. constructor(dialect: MySqlDialect, session: MySqlSession, schema: RelationalSchemaConfig<TSchema> | undefined, nestedIndex?: number);
  53. transaction<T>(transaction: (tx: TiDBServerlessTransaction<TFullSchema, TSchema>) => Promise<T>): Promise<T>;
  54. }
  55. export interface TiDBServerlessQueryResultHKT extends MySqlQueryResultHKT {
  56. type: FullResult;
  57. }
  58. export interface TiDBServerlessPreparedQueryHKT extends MySqlPreparedQueryHKT {
  59. type: TiDBServerlessPreparedQuery<Assume<this['config'], MySqlPreparedQueryConfig>>;
  60. }