dialect.d.ts 3.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364
  1. import { entityKind } from "../entity.js";
  2. import type { MigrationConfig, MigrationMeta } from "../migrator.js";
  3. import { type BuildRelationalQueryResult, type DBQueryConfig, type Relation, type TableRelationalConfig, type TablesRelationalConfig } from "../relations.js";
  4. import type { QueryWithTypings } from "../sql/sql.js";
  5. import { SQL } from "../sql/sql.js";
  6. import { type Casing, type UpdateSet } from "../utils.js";
  7. import { SingleStoreColumn } from "./columns/common.js";
  8. import type { SingleStoreDeleteConfig } from "./query-builders/delete.js";
  9. import type { SingleStoreInsertConfig } from "./query-builders/insert.js";
  10. import type { SingleStoreSelectConfig } from "./query-builders/select.types.js";
  11. import type { SingleStoreUpdateConfig } from "./query-builders/update.js";
  12. import type { SingleStoreSession } from "./session.js";
  13. import { SingleStoreTable } from "./table.js";
  14. export interface SingleStoreDialectConfig {
  15. casing?: Casing;
  16. }
  17. export declare class SingleStoreDialect {
  18. static readonly [entityKind]: string;
  19. constructor(config?: SingleStoreDialectConfig);
  20. migrate(migrations: MigrationMeta[], session: SingleStoreSession, config: Omit<MigrationConfig, 'migrationsSchema'>): Promise<void>;
  21. escapeName(name: string): string;
  22. escapeParam(_num: number): string;
  23. escapeString(str: string): string;
  24. private buildWithCTE;
  25. buildDeleteQuery({ table, where, returning, withList, limit, orderBy, }: SingleStoreDeleteConfig): SQL;
  26. buildUpdateSet(table: SingleStoreTable, set: UpdateSet): SQL;
  27. buildUpdateQuery({ table, set, where, returning, withList, limit, orderBy, }: SingleStoreUpdateConfig): SQL;
  28. /**
  29. * Builds selection SQL with provided fields/expressions
  30. *
  31. * Examples:
  32. *
  33. * `select <selection> from`
  34. *
  35. * `insert ... returning <selection>`
  36. *
  37. * If `isSingleTable` is true, then columns won't be prefixed with table name
  38. */
  39. private buildSelection;
  40. private buildLimit;
  41. private buildOrderBy;
  42. buildSelectQuery({ withList, fields, fieldsFlat, where, having, table, joins, orderBy, groupBy, limit, offset, lockingClause, distinct, setOperators, }: SingleStoreSelectConfig): SQL;
  43. buildSetOperations(leftSelect: SQL, setOperators: SingleStoreSelectConfig['setOperators']): SQL;
  44. buildSetOperationQuery({ leftSelect, setOperator: { type, isAll, rightSelect, limit, orderBy, offset }, }: {
  45. leftSelect: SQL;
  46. setOperator: SingleStoreSelectConfig['setOperators'][number];
  47. }): SQL;
  48. buildInsertQuery({ table, values, ignore, onConflict, }: SingleStoreInsertConfig): {
  49. sql: SQL;
  50. generatedIds: Record<string, unknown>[];
  51. };
  52. sqlToQuery(sql: SQL, invokeSource?: 'indexes' | undefined): QueryWithTypings;
  53. buildRelationalQuery({ fullSchema, schema, tableNamesMap, table, tableConfig, queryConfig: config, tableAlias, nestedQueryRelation, joinOn, }: {
  54. fullSchema: Record<string, unknown>;
  55. schema: TablesRelationalConfig;
  56. tableNamesMap: Record<string, string>;
  57. table: SingleStoreTable;
  58. tableConfig: TableRelationalConfig;
  59. queryConfig: true | DBQueryConfig<'many', true>;
  60. tableAlias: string;
  61. nestedQueryRelation?: Relation;
  62. joinOn?: SQL;
  63. }): BuildRelationalQueryResult<SingleStoreTable, SingleStoreColumn>;
  64. }