uql-orm 0.9.5 → 0.10.2

package/dist/migrate/schemaGenerator.d.ts

@@ -0,0 +1,142 @@
+import { type AbstractDialect, AbstractSqlDialect } from '../dialect/index.js';
+import type { CanonicalType, ColumnNode, ForeignKeyAction, IndexNode, TableNode } from '../schema/types.js';
+import type { ColumnSchema, DialectFeatures, EntityMeta, FieldOptions, IndexSchema, NamingStrategy, SchemaDiff, SchemaGenerator, Type } from '../type/index.js';
+import type { FullColumnDefinition, TableDefinition, TableForeignKeyDefinition } from './builder/types.js';
+/**
+ * Unified SQL schema generator.
+ * Parameterized by dialect to handle Postgres, MySQL, MariaDB, and SQLite.
+ */
+export declare class SqlSchemaGenerator implements SchemaGenerator {
+    protected readonly dialect: AbstractSqlDialect;
+    protected readonly defaultForeignKeyAction: ForeignKeyAction;
+    constructor(dialect: AbstractSqlDialect, defaultForeignKeyAction?: ForeignKeyAction);
+    get namingStrategy(): NamingStrategy | undefined;
+    get features(): DialectFeatures;
+    resolveTableName<E>(entity: Type<E>, meta: EntityMeta<E>): string;
+    resolveColumnName(key: string, field: FieldOptions): string;
+    /**
+     * Escape an identifier (table name, column name, etc.)
+     */
+    protected escapeId(identifier: string): string;
+    /**
+     * Primary key type for auto-increment integer IDs
+     */
+    protected get serialPrimaryKeyType(): string;
+    /**
+     * Convert FieldOptions to CanonicalType using the unified type system.
+     */
+    protected getCanonicalType(field: FieldOptions, fieldType?: unknown): CanonicalType;
+    /**
+     * Convert CanonicalType to SQL type string for this dialect.
+     * Also handles legacy string types for backward compatibility.
+     */
+    protected canonicalTypeToSql(type: CanonicalType | string): string;
+    generateCreateTable<E>(entity: Type<E>, options?: {
+        ifNotExists?: boolean;
+    }): string[];
+    generateDropTable<E>(entity: Type<E>): string;
+    generateAlterTable(diff: SchemaDiff): string[];
+    generateAlterTableDown(diff: SchemaDiff): string[];
+    generateCreateIndex(tableName: string, index: IndexSchema, options?: {
+        ifNotExists?: boolean;
+    }): string;
+    generateDropIndex(tableName: string, indexName: string): string;
+    /**
+     * Generate column definition from a ColumnSchema object
+     */
+    generateColumnDefinitionFromSchema(column: ColumnSchema, options?: {
+        includePrimaryKey?: boolean;
+        includeUnique?: boolean;
+    }): string;
+    getSqlType(field: FieldOptions, fieldType?: unknown): string;
+    /**
+     * Get the boolean type for this database
+     */
+    getBooleanType(): string;
+    /**
+     * Generate ALTER COLUMN statements (database-specific)
+     */
+    generateAlterColumnStatements(tableName: string, column: ColumnSchema, newDefinition: string): string[];
+    /**
+     * Get table options (e.g., ENGINE for MySQL)
+     */
+    getTableOptions<E>(_meta: EntityMeta<E>): string;
+    /**
+     * Generate column comment clause (if supported)
+     */
+    generateColumnComment(columnName: string, comment: string): string;
+    /**
+     * Format a default value for SQL
+     */
+    formatDefaultValue(value: unknown): string;
+    /**
+     * Compare an entity with a database table node and return the differences.
+     */
+    diffSchema<E>(entity: Type<E>, currentTable: TableNode | undefined): SchemaDiff | undefined;
+    private columnNodeToSchema;
+    /**
+     * Convert field options to ColumnSchema
+     */
+    protected fieldToColumnSchema<E>(fieldKey: string, field: FieldOptions, meta: EntityMeta<E>): ColumnSchema;
+    /**
+     * Check if two columns differ enough to require alteration
+     */
+    protected columnsNeedAlteration(current: ColumnSchema, desired: ColumnSchema): boolean;
+    /**
+     * Compare two column types for equality using the canonical type system
+     */
+    protected isTypeEqual(current: ColumnSchema, desired: ColumnSchema): boolean;
+    /**
+     * Compare two default values for equality
+     */
+    protected isDefaultValueEqual(current: unknown, desired: unknown): boolean;
+    generateCreateTableFromNode(table: TableNode, options?: {
+        ifNotExists?: boolean;
+    }): string[];
+    /**
+     * Generate a column definition from a ColumnNode.
+     */
+    protected generateColumnFromNode(col: ColumnNode): string;
+    /**
+     * Generate an inline VECTOR INDEX clause for use inside CREATE TABLE.
+     * Syntax: `VECTOR INDEX (col) M=n DISTANCE=metric`
+     */
+    private generateInlineVectorIndex;
+    /**
+     * Generate CREATE INDEX SQL from an IndexNode.
+     * Delegates to `generateCreateIndex` for unified SQL assembly.
+     */
+    generateCreateIndexFromNode(index: IndexNode, options?: {
+        ifNotExists: boolean;
+    }): string;
+    /**
+     * Generate DROP TABLE SQL from a TableNode.
+     */
+    generateDropTableFromNode(table: TableNode, options?: {
+        ifExists?: boolean;
+    }): string;
+    generateCreateTableFromDefinition(table: TableDefinition, options?: {
+        ifNotExists?: boolean;
+    }): string[];
+    generateDropTableSql(tableName: string, options?: {
+        ifExists?: boolean;
+        cascade?: boolean;
+    }): string;
+    generateRenameTableSql(oldName: string, newName: string): string;
+    generateAddColumnSql(tableName: string, column: FullColumnDefinition): string;
+    generateAlterColumnSql(tableName: string, columnName: string, column: FullColumnDefinition): string;
+    generateDropColumnSql(tableName: string, columnName: string): string;
+    generateRenameColumnSql(tableName: string, oldName: string, newName: string): string;
+    generateCreateIndexSql(tableName: string, index: IndexSchema): string;
+    generateDropIndexSql(tableName: string, indexName: string): string;
+    generateAddForeignKeySql(tableName: string, foreignKey: TableForeignKeyDefinition): string;
+    generateDropForeignKeySql(tableName: string, constraintName: string): string;
+    private tableDefinitionToNode;
+    private fullColumnDefinitionToNode;
+}
+/**
+ * Synchronous factory for SQL schema generators only.
+ * For MongoDB, use `createSchemaGeneratorAsync` from `./schemaGeneratorAsync.js` so the optional `mongodb` peer is not loaded at import time.
+ */
+export declare function createSchemaGenerator(dialect: AbstractDialect, namingStrategy?: NamingStrategy, defaultForeignKeyAction?: ForeignKeyAction): SchemaGenerator | undefined;
+//# sourceMappingURL=schemaGenerator.d.ts.map

package/dist/migrate/schemaGenerator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"schemaGenerator.d.ts","sourceRoot":"","sources":["../../src/migrate/schemaGenerator.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,eAAe,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAC;AAU/E,OAAO,KAAK,EACV,aAAa,EACb,UAAU,EACV,gBAAgB,EAChB,SAAS,EAET,SAAS,EACV,MAAM,oBAAoB,CAAC;AAC5B,OAAO,KAAK,EACV,YAAY,EACZ,eAAe,EACf,UAAU,EAEV,YAAY,EACZ,WAAW,EACX,cAAc,EACd,UAAU,EACV,eAAe,EACf,IAAI,EAEL,MAAM,kBAAkB,CAAC;AAG1B,OAAO,KAAK,EAAE,oBAAoB,EAAE,eAAe,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAK3G;;;GAGG;AACH,qBAAa,kBAAmB,YAAW,eAAe;IAEtD,SAAS,CAAC,QAAQ,CAAC,OAAO,EAAE,kBAAkB;IAC9C,SAAS,CAAC,QAAQ,CAAC,uBAAuB,EAAE,gBAAgB;gBADzC,OAAO,EAAE,kBAAkB,EAC3B,uBAAuB,GAAE,gBAA8B;IAG5E,IAAI,cAAc,IAAI,cAAc,GAAG,SAAS,CAE/C;IAED,IAAI,QAAQ,IAAI,eAAe,CAE9B;IAED,gBAAgB,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,MAAM;IAIjE,iBAAiB,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,GAAG,MAAM;IAI3D;;OAEG;IACH,SAAS,CAAC,QAAQ,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM;IAI9C;;OAEG;IACH,SAAS,KAAK,oBAAoB,IAAI,MAAM,CAE3C;IAMD;;OAEG;IACH,SAAS,CAAC,gBAAgB,CAAC,KAAK,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,aAAa;IAInF;;;OAGG;IACH,SAAS,CAAC,kBAAkB,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,GAAG,MAAM;IAYlE,mBAAmB,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,OAAO,GAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,MAAM,EAAE;IAO1F,iBAAiB,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,GAAG,MAAM;IAM7C,kBAAkB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,EAAE;IA6C9C,sBAAsB,CAAC,IAAI,EAAE,UAAU,GAAG,MAAM,EAAE;IAkClD,mBAAmB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,GAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,MAAM;IAiC3G,iBAAiB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;IAO/D;;OAEG;IACI,kCAAkC,CACvC,MAAM,EAAE,YAAY,EACpB,OAAO,GAAE;QAAE,iBAAiB,CAAC,EAAE,OAAO,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAA;KAAO,GACrE,MAAM;IA8CF,UAAU,CAAC,KAAK,EAAE,YAAY,EAAE,SAAS,CAAC,EAAE,OAAO,GAAG,MAAM;IAuBnE;;OAEG;IACI,cAAc,IAAI,MAAM;IAI/B;;OAEG;IACI,6BAA6B,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,aAAa,EAAE,MAAM,GAAG,MAAM,EAAE;IAmC9G;;OAEG;IACI,eAAe,CAAC,CAAC,EAAE,KAAK,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,MAAM;IAIvD;;OAEG;IACI,qBAAqB,CAAC,UAAU,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM;IAQzE;;OAEG;IACI,kBAAkB,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM;IAOjD;;OAEG;IACH,UAAU,CAAC,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,SAAS,GAAG,SAAS,GAAG,UAAU,GAAG,SAAS;IAqD3F,OAAO,CAAC,kBAAkB;IAa1B;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,CAAC,EAAE,QAAQ,EAAE,MAAM,EAAE,KAAK,EAAE,YAAY,EAAE,IAAI,EAAE,UAAU,CAAC,CAAC,CAAC,GAAG,YAAY;IAkB1G;;OAEG;IACH,SAAS,CAAC,qBAAqB,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,YAAY,GAAG,OAAO;IAetF;;OAEG;IACH,SAAS,CAAC,WAAW,CAAC,OAAO,EAAE,YAAY,EAAE,OAAO,EAAE,YAAY,GAAG,OAAO;IAM5E;;OAEG;IACH,SAAS,CAAC,mBAAmB,CAAC,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,GAAG,OAAO;IAsB1E,2BAA2B,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,GAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,MAAM,EAAE;IAkEhG;;OAEG;IACH,SAAS,CAAC,sBAAsB,CAAC,GAAG,EAAE,UAAU,GAAG,MAAM;IAiCzD;;;OAGG;IACH,OAAO,CAAC,yBAAyB;IAgBjC;;;OAGG;IACH,2BAA2B,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,GAAE;QAAE,WAAW,EAAE,OAAO,CAAA;KAA2B,GAAG,MAAM;IAiBjH;;OAEG;IACH,yBAAyB,CAAC,KAAK,EAAE,SAAS,EAAE,OAAO,GAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,MAAM;IASzF,iCAAiC,CAAC,KAAK,EAAE,eAAe,EAAE,OAAO,GAAE;QAAE,WAAW,CAAC,EAAE,OAAO,CAAA;KAAO,GAAG,MAAM,EAAE;IAK5G,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,OAAO,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,MAAM;IAOpG,sBAAsB,CAAC,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM;IAOhE,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,GAAG,MAAM;IAK7E,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,EAAE,oBAAoB,GAAG,MAAM;IAOnG,qBAAqB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,MAAM,GAAG,MAAM;IAIpE,uBAAuB,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM;IAIpF,sBAAsB,CAAC,SAAS,EAAE,MAAM,EAAE,KAAK,EAAE,WAAW,GAAG,MAAM;IAIrE,oBAAoB,CAAC,SAAS,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,GAAG,MAAM;IAIlE,wBAAwB,CAAC,SAAS,EAAE,MAAM,EAAE,UAAU,EAAE,yBAAyB,GAAG,MAAM;IAkB1F,yBAAyB,CAAC,SAAS,EAAE,MAAM,EAAE,cAAc,EAAE,MAAM,GAAG,MAAM;IAI5E,OAAO,CAAC,qBAAqB;IA6D7B,OAAO,CAAC,0BAA0B;CA2BnC;AAED;;;GAGG;AACH,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,eAAe,EACxB,cAAc,CAAC,EAAE,cAAc,EAC/B,uBAAuB,CAAC,EAAE,gBAAgB,GACzC,eAAe,GAAG,SAAS,CAK7B"}