schema.d.cts 842 B

123456789101112131415161718192021222324
  1. import { entityKind } from "../entity.cjs";
  2. import { type MySqlTableFn } from "./table.cjs";
  3. import { type mysqlView } from "./view.cjs";
  4. export declare class MySqlSchema<TName extends string = string> {
  5. readonly schemaName: TName;
  6. static readonly [entityKind]: string;
  7. constructor(schemaName: TName);
  8. table: MySqlTableFn<TName>;
  9. view: typeof mysqlView;
  10. }
  11. /** @deprecated - use `instanceof MySqlSchema` */
  12. export declare function isMySqlSchema(obj: unknown): obj is MySqlSchema;
  13. /**
  14. * Create a MySQL schema.
  15. * https://dev.mysql.com/doc/refman/8.0/en/create-database.html
  16. *
  17. * @param name mysql use schema name
  18. * @returns MySQL schema
  19. */
  20. export declare function mysqlDatabase<TName extends string>(name: TName): MySqlSchema<TName>;
  21. /**
  22. * @see mysqlDatabase
  23. */
  24. export declare const mysqlSchema: typeof mysqlDatabase;