view.d.ts 3.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465
  1. import type { BuildColumns } from "../column-builder.js";
  2. import { entityKind } from "../entity.js";
  3. import type { TypedQueryBuilder } from "../query-builders/query-builder.js";
  4. import type { AddAliasToSelection } from "../query-builders/select.types.js";
  5. import type { ColumnsSelection, SQL } from "../sql/sql.js";
  6. import type { SingleStoreColumnBuilderBase } from "./columns/index.js";
  7. import { QueryBuilder } from "./query-builders/query-builder.js";
  8. import type { SelectedFields } from "./query-builders/select.types.js";
  9. import { SingleStoreViewBase } from "./view-base.js";
  10. import { SingleStoreViewConfig } from "./view-common.js";
  11. export interface ViewBuilderConfig {
  12. algorithm?: 'undefined' | 'merge' | 'temptable';
  13. definer?: string;
  14. sqlSecurity?: 'definer' | 'invoker';
  15. withCheckOption?: 'cascaded' | 'local';
  16. }
  17. export declare class ViewBuilderCore<TConfig extends {
  18. name: string;
  19. columns?: unknown;
  20. }> {
  21. protected name: TConfig['name'];
  22. protected schema: string | undefined;
  23. static readonly [entityKind]: string;
  24. readonly _: {
  25. readonly name: TConfig['name'];
  26. readonly columns: TConfig['columns'];
  27. };
  28. constructor(name: TConfig['name'], schema: string | undefined);
  29. protected config: ViewBuilderConfig;
  30. algorithm(algorithm: Exclude<ViewBuilderConfig['algorithm'], undefined>): this;
  31. definer(definer: Exclude<ViewBuilderConfig['definer'], undefined>): this;
  32. sqlSecurity(sqlSecurity: Exclude<ViewBuilderConfig['sqlSecurity'], undefined>): this;
  33. withCheckOption(withCheckOption?: Exclude<ViewBuilderConfig['withCheckOption'], undefined>): this;
  34. }
  35. export declare class ViewBuilder<TName extends string = string> extends ViewBuilderCore<{
  36. name: TName;
  37. }> {
  38. static readonly [entityKind]: string;
  39. as<TSelectedFields extends SelectedFields>(qb: TypedQueryBuilder<TSelectedFields> | ((qb: QueryBuilder) => TypedQueryBuilder<TSelectedFields>)): SingleStoreViewWithSelection<TName, false, AddAliasToSelection<TSelectedFields, TName, 'singlestore'>>;
  40. }
  41. export declare class ManualViewBuilder<TName extends string = string, TColumns extends Record<string, SingleStoreColumnBuilderBase> = Record<string, SingleStoreColumnBuilderBase>> extends ViewBuilderCore<{
  42. name: TName;
  43. columns: TColumns;
  44. }> {
  45. static readonly [entityKind]: string;
  46. private columns;
  47. constructor(name: TName, columns: TColumns, schema: string | undefined);
  48. existing(): SingleStoreViewWithSelection<TName, true, BuildColumns<TName, TColumns, 'singlestore'>>;
  49. as(query: SQL): SingleStoreViewWithSelection<TName, false, BuildColumns<TName, TColumns, 'singlestore'>>;
  50. }
  51. export declare class SingleStoreView<TName extends string = string, TExisting extends boolean = boolean, TSelectedFields extends ColumnsSelection = ColumnsSelection> extends SingleStoreViewBase<TName, TExisting, TSelectedFields> {
  52. static readonly [entityKind]: string;
  53. protected $SingleStoreViewBrand: 'SingleStoreView';
  54. [SingleStoreViewConfig]: ViewBuilderConfig | undefined;
  55. constructor({ singlestoreConfig, config }: {
  56. singlestoreConfig: ViewBuilderConfig | undefined;
  57. config: {
  58. name: TName;
  59. schema: string | undefined;
  60. selectedFields: SelectedFields;
  61. query: SQL | undefined;
  62. };
  63. });
  64. }
  65. export type SingleStoreViewWithSelection<TName extends string, TExisting extends boolean, TSelectedFields extends ColumnsSelection> = SingleStoreView<TName, TExisting, TSelectedFields> & TSelectedFields;