view.d.cts 2.9 KB

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