@warlock.js/cascade 4.0.59 → 4.0.88

package/esm/migration/migration.d.ts

@@ -0,0 +1,1143 @@
+import type { ForeignKeyDefinition, FullTextIndexOptions, GeoIndexOptions, IndexDefinition, MigrationDriverContract, VectorIndexOptions } from "../contracts/migration-driver.contract";
+import type { DataSource } from "../data-source/data-source";
+import type { ChildModel, Model } from "../model/model";
+import { ColumnBuilder } from "./column-builder";
+import { ForeignKeyBuilder } from "./foreign-key-builder";
+/**
+ * Contract for a migration class.
+ */
+export interface MigrationContract {
+    /**
+     * Table/collection name for this migration.
+     */
+    readonly table: string;
+    /**
+     * Optional data source override.
+     */
+    readonly dataSource?: string | DataSource;
+    /**
+     * Optional timestamp override.
+     */
+    readonly createdAt?: string;
+    /**
+     * Whether to wrap migration in a transaction.
+     */
+    readonly transactional?: boolean;
+    /**
+     * Define schema changes for the up migration.
+     */
+    up(): void | Promise<void>;
+    /**
+     * Define rollback operations for the down migration.
+     */
+    down(): void | Promise<void>;
+    /**
+     * Set the migration driver.
+     *
+     * @param driver - Migration driver instance
+     * @internal
+     */
+    setDriver(driver: MigrationDriverContract): void;
+    /**
+     * Get the migration driver.
+     *
+     * @returns The migration driver instance
+     */
+    getDriver(): MigrationDriverContract;
+    /**
+     * Execute all pending operations.
+     *
+     * @internal
+     */
+    execute(): Promise<void>;
+    /**
+     * Add a pending index definition.
+     *
+     * @param index - Index definition
+     * @internal
+     */
+    addPendingIndex(index: IndexDefinition): void;
+    /**
+     * Add a foreign key operation.
+     *
+     * @param fk - Foreign key definition
+     * @internal
+     */
+    addForeignKeyOperation(fk: ForeignKeyDefinition): void;
+    /**
+     * Create the table/collection.
+     */
+    createTable(): MigrationContract;
+    /**
+     * Create table if not exists
+     */
+    createTableIfNotExists(): MigrationContract;
+    /**
+     * Drop the table/collection.
+     */
+    dropTable(): MigrationContract;
+    /**
+     * Drop the table/collection if it exists.
+     */
+    dropTableIfExists(): MigrationContract;
+    /**
+     * Rename the table/collection.
+     *
+     * @param newName - New table name
+     */
+    renameTableTo(newName: string): MigrationContract;
+    /**
+     * Add a string/varchar column.
+     */
+    string(column: string, length?: number): ColumnBuilder;
+    /**
+     * Add a fixed-length char column.
+     */
+    char(column: string, length: number): ColumnBuilder;
+    /**
+     * Add a text column (unlimited length).
+     */
+    text(column: string): ColumnBuilder;
+    /**
+     * Add a medium text column.
+     */
+    mediumText(column: string): ColumnBuilder;
+    /**
+     * Add a long text column.
+     */
+    longText(column: string): ColumnBuilder;
+    /**
+     * Add an integer column.
+     */
+    integer(column: string): ColumnBuilder;
+    /**
+     * Alias for integer().
+     */
+    int(column: string): ColumnBuilder;
+    /**
+     * Add a small integer column.
+     */
+    smallInteger(column: string): ColumnBuilder;
+    /**
+     * Alias for smallInteger().
+     */
+    smallInt(column: string): ColumnBuilder;
+    /**
+     * Add a tiny integer column.
+     */
+    tinyInteger(column: string): ColumnBuilder;
+    /**
+     * Alias for tinyInteger().
+     */
+    tinyInt(column: string): ColumnBuilder;
+    /**
+     * Add a big integer column.
+     */
+    bigInteger(column: string): ColumnBuilder;
+    /**
+     * Alias for bigInteger().
+     */
+    bigInt(column: string): ColumnBuilder;
+    /**
+     * Add a float column.
+     */
+    float(column: string): ColumnBuilder;
+    /**
+     * Add a double precision column.
+     */
+    double(column: string): ColumnBuilder;
+    /**
+     * Add a decimal column with precision and scale.
+     */
+    decimal(column: string, precision?: number, scale?: number): ColumnBuilder;
+    /**
+     * Add a boolean column.
+     */
+    boolean(column: string): ColumnBuilder;
+    /**
+     * Alias for boolean().
+     */
+    bool(column: string): ColumnBuilder;
+    /**
+     * Add a date column (date only, no time).
+     */
+    date(column: string): ColumnBuilder;
+    /**
+     * Add a datetime column (date and time).
+     */
+    dateTime(column: string): ColumnBuilder;
+    /**
+     * Add a timestamp column.
+     */
+    timestamp(column: string): ColumnBuilder;
+    /**
+     * Add a time column (time only, no date).
+     */
+    time(column: string): ColumnBuilder;
+    /**
+     * Add a year column.
+     */
+    year(column: string): ColumnBuilder;
+    /**
+     * Add a JSON column.
+     */
+    json(column: string): ColumnBuilder;
+    /**
+     * Alias for json().
+     */
+    object(column: string): ColumnBuilder;
+    /**
+     * Add a binary/blob column.
+     */
+    binary(column: string): ColumnBuilder;
+    /**
+     * Alias for binary().
+     */
+    blob(column: string): ColumnBuilder;
+    /**
+     * Add a UUID column.
+     */
+    uuid(column: string): ColumnBuilder;
+    /**
+     * Add a ULID column.
+     */
+    ulid(column: string): ColumnBuilder;
+    /**
+     * Add an IP address column.
+     */
+    ipAddress(column: string): ColumnBuilder;
+    /**
+     * Add a MAC address column.
+     */
+    macAddress(column: string): ColumnBuilder;
+    /**
+     * Add a geo point column.
+     */
+    point(column: string): ColumnBuilder;
+    /**
+     * Add a polygon column.
+     */
+    polygon(column: string): ColumnBuilder;
+    /**
+     * Add a line string column.
+     */
+    lineString(column: string): ColumnBuilder;
+    /**
+     * Add a generic geometry column.
+     */
+    geometry(column: string): ColumnBuilder;
+    /**
+     * Add a vector column for AI embeddings.
+     */
+    vector(column: string, dimensions: number): ColumnBuilder;
+    /**
+     * Add an enum column with allowed values.
+     */
+    enum(column: string, values: string[]): ColumnBuilder;
+    /**
+     * Add a set column (multiple values from a set).
+     */
+    set(column: string, values: string[]): ColumnBuilder;
+    /**
+     * Add an auto-increment primary key column.
+     */
+    id(name?: string): ColumnBuilder;
+    /**
+     * Add a big integer auto-increment primary key column.
+     */
+    bigId(name?: string): ColumnBuilder;
+    /**
+     * Add a UUID primary key column.
+     */
+    uuidId(name?: string): ColumnBuilder;
+    /**
+     * Add createdAt and updatedAt timestamp columns.
+     */
+    timestamps(): MigrationContract;
+    /**
+     * Add a deletedAt column for soft deletes.
+     */
+    softDeletes(column?: string): ColumnBuilder;
+    /**
+     * Drop a column.
+     */
+    dropColumn(column: string): MigrationContract;
+    /**
+     * Drop multiple columns.
+     */
+    dropColumns(...columns: string[]): MigrationContract;
+    /**
+     * Rename a column.
+     */
+    renameColumn(from: string, to: string): MigrationContract;
+    /**
+     * Create an index on one or more columns.
+     */
+    index(columns: string | string[], name?: string): MigrationContract;
+    /**
+     * Drop an index by name or columns.
+     */
+    dropIndex(nameOrColumns: string | string[]): MigrationContract;
+    /**
+     * Create a unique constraint/index.
+     */
+    unique(columns: string | string[], name?: string): MigrationContract;
+    /**
+     * Drop a unique constraint/index.
+     */
+    dropUnique(columns: string | string[]): MigrationContract;
+    /**
+     * Create a full-text search index.
+     */
+    fullText(columns: string | string[], options?: FullTextIndexOptions): MigrationContract;
+    /**
+     * Drop a full-text search index.
+     */
+    dropFullText(name: string): MigrationContract;
+    /**
+     * Create a geo-spatial index.
+     */
+    geoIndex(column: string, options?: GeoIndexOptions): MigrationContract;
+    /**
+     * Drop a geo-spatial index.
+     */
+    dropGeoIndex(column: string): MigrationContract;
+    /**
+     * Create a vector search index for AI embeddings.
+     */
+    vectorIndex(column: string, options: VectorIndexOptions): MigrationContract;
+    /**
+     * Drop a vector search index.
+     */
+    dropVectorIndex(column: string): MigrationContract;
+    /**
+     * Create a TTL (time-to-live) index for automatic document expiration.
+     */
+    ttlIndex(column: string, expireAfterSeconds: number): MigrationContract;
+    /**
+     * Drop a TTL index.
+     */
+    dropTTLIndex(column: string): MigrationContract;
+    /**
+     * Add a composite primary key.
+     */
+    primaryKey(columns: string[]): MigrationContract;
+    /**
+     * Drop the primary key constraint.
+     */
+    dropPrimaryKey(): MigrationContract;
+    /**
+     * Start building a foreign key constraint.
+     */
+    foreign(column: string): ForeignKeyBuilder;
+    /**
+     * Drop a foreign key constraint by name.
+     */
+    dropForeign(name: string): MigrationContract;
+    /**
+     * Set JSON schema validation rules on the collection.
+     */
+    schemaValidation(schema: object): MigrationContract;
+    /**
+     * Remove schema validation rules from the collection.
+     */
+    dropSchemaValidation(): MigrationContract;
+    /**
+     * Execute raw operations with direct driver access.
+     */
+    raw<T>(callback: (connection: unknown) => Promise<T>): Promise<T>;
+}
+/**
+ * Constructor for the migration class.
+ */
+export interface MigrationConstructor {
+    new (): MigrationContract;
+    migrationName?: string;
+    createdAt?: string;
+    transactional?: boolean;
+    order?: number;
+}
+/**
+ * Base class for all database migrations.
+ *
+ * Provides a fluent API for defining schema changes that work across
+ * both SQL and NoSQL databases. The migration driver handles translating
+ * operations to native database commands.
+ *
+ * Migrations are executed in order based on their `createdAt` timestamp,
+ * which is typically extracted from the filename (e.g., `2024-01-15_create-users`).
+ *
+ * @example
+ * ```typescript
+ * // Using Migration.for() to bind to a model
+ * export default class extends Migration.for(User) {
+ *   public up(): void {
+ *     this.string("email").unique();
+ *     this.integer("age").nullable();
+ *     this.geoIndex("location");
+ *   }
+ *
+ *   public down(): void {
+ *     this.dropColumn("email");
+ *     this.dropColumn("age");
+ *     this.dropGeoIndex("location");
+ *   }
+ * }
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Manual table migration (without model binding)
+ * export default class CreateUsersTable extends Migration {
+ *   public readonly table = "users";
+ *
+ *   public up(): void {
+ *     this.createTable();
+ *     this.id();
+ *     this.string("name");
+ *     this.string("email").unique();
+ *     this.timestamps();
+ *   }
+ *
+ *   public down(): void {
+ *     this.dropTable();
+ *   }
+ * }
+ * ```
+ */
+export declare abstract class Migration implements MigrationContract {
+    /**
+     * Migration name that will be labeled with
+     * If record is enabled in migration, it will be stored as migration name
+     * in database
+     *
+     * @example
+     * ```typescript
+     * "2024-01-15_create-users";
+     * ```
+     */
+    static migrationName?: string;
+    /**
+     * Table/collection name for this migration.
+     *
+     * Must be defined by each migration class (either directly or via `Migration.for()`).
+     */
+    readonly table: string;
+    /**
+     * Sort order
+     * If not provided, it will be ordered alphabetically
+     */
+    static readonly order?: number;
+    /**
+     * Optional data source override.
+     *
+     * If specified, this migration will use a specific data source
+     * instead of the default one. Can be a string name or DataSource instance.
+     */
+    readonly dataSource?: string | DataSource;
+    /**
+     * Optional timestamp override.
+     *
+     * By default, the migration runner extracts this from the filename.
+     * Set explicitly to override the execution order.
+     *
+     * Format: ISO 8601 or any parseable date string.
+     */
+    readonly createdAt?: string;
+    /**
+     * Whether to wrap migration in a transaction.
+     *
+     * Defaults to `true` for SQL databases that support DDL transactions.
+     * Set to `false` for operations that cannot be transactional.
+     *
+     * Note: MongoDB does not support transactions for most DDL operations.
+     */
+    readonly transactional?: boolean;
+    /**
+     * Migration driver instance (injected by the runner).
+     */
+    protected driver: MigrationDriverContract;
+    /**
+     * Queued operations to execute.
+     */
+    private readonly pendingOperations;
+    /**
+     * Pending indexes from column builders.
+     */
+    private readonly pendingIndexes;
+    /**
+     * Define schema changes for the up migration.
+     *
+     * Called when running migrations forward. Add columns, indexes,
+     * constraints, etc. in this method.
+     */
+    abstract up(): void | Promise<void>;
+    /**
+     * Define rollback operations for the down migration.
+     *
+     * Called when rolling back migrations. Drop columns, indexes,
+     * and undo any changes made in `up()`.
+     */
+    abstract down(): void | Promise<void>;
+    /**
+     * Create a migration class bound to a specific model.
+     *
+     * Automatically inherits the model's table name and data source,
+     * reducing boilerplate and ensuring consistency.
+     *
+     * @param model - Model class to bind
+     * @returns Abstract migration class bound to the model
+     *
+     * @example
+     * ```typescript
+     * export default class extends Migration.for(User) {
+     *   public up(): void {
+     *     this.string("avatar").nullable();
+     *   }
+     *
+     *   public down(): void {
+     *     this.dropColumn("avatar");
+     *   }
+     * }
+     * ```
+     */
+    static for<T extends ChildModel<Model>>(model: T): MigrationConstructor;
+    /**
+     * Set the migration driver.
+     *
+     * Called by the migration runner before executing up/down.
+     *
+     * @param driver - Migration driver instance
+     * @internal
+     */
+    setDriver(driver: MigrationDriverContract): void;
+    /**
+     * Get the migration driver.
+     *
+     * @returns The migration driver instance
+     */
+    getDriver(): MigrationDriverContract;
+    /**
+     * Execute all pending operations.
+     *
+     * Called by the migration runner after up() or down() completes.
+     * Executes operations in the order they were defined.
+     *
+     * @internal
+     */
+    execute(): Promise<void>;
+    /**
+     * Execute a single pending operation.
+     */
+    private executeOperation;
+    /**
+     * Add a pending index definition.
+     *
+     * Called by ColumnBuilder when .unique() or .index() is chained.
+     *
+     * @param index - Index definition
+     * @internal
+     */
+    addPendingIndex(index: IndexDefinition): void;
+    /**
+     * Add a foreign key operation.
+     *
+     * Called by ForeignKeyBuilder when .add() is called.
+     *
+     * @param fk - Foreign key definition
+     * @internal
+     */
+    addForeignKeyOperation(fk: ForeignKeyDefinition): void;
+    /**
+     * Create the table/collection.
+     *
+     * For SQL, this creates an empty table.
+     * For MongoDB, this creates the collection.
+     *
+     * @returns This migration for chaining
+     */
+    createTable(): this;
+    /**
+     * Create table if not exists
+     */
+    createTableIfNotExists(): this;
+    /**
+     * Drop the table/collection.
+     *
+     * @returns This migration for chaining
+     */
+    dropTable(): this;
+    /**
+     * Drop the table/collection if it exists.
+     *
+     * No error is thrown if the table doesn't exist.
+     *
+     * @returns This migration for chaining
+     */
+    dropTableIfExists(): this;
+    /**
+     * Rename the table/collection.
+     *
+     * @param newName - New table name
+     * @returns This migration for chaining
+     */
+    renameTableTo(newName: string): this;
+    /**
+     * Add a string/varchar column.
+     *
+     * @param column - Column name
+     * @param length - Max length (default: 255)
+     * @returns Column builder for chaining modifiers
+     *
+     * @example
+     * ```typescript
+     * this.string("name"); // VARCHAR(255)
+     * this.string("code", 10); // VARCHAR(10)
+     * ```
+     */
+    string(column: string, length?: number): ColumnBuilder;
+    /**
+     * Add a fixed-length char column.
+     *
+     * @param column - Column name
+     * @param length - Exact length
+     * @returns Column builder for chaining modifiers
+     */
+    char(column: string, length: number): ColumnBuilder;
+    /**
+     * Add a text column (unlimited length).
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    text(column: string): ColumnBuilder;
+    /**
+     * Add a medium text column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    mediumText(column: string): ColumnBuilder;
+    /**
+     * Add a long text column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    longText(column: string): ColumnBuilder;
+    /**
+     * Add an integer column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    integer(column: string): ColumnBuilder;
+    /**
+     * Alias for integer().
+     */
+    int(column: string): ColumnBuilder;
+    /**
+     * Add a small integer column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    smallInteger(column: string): ColumnBuilder;
+    /**
+     * Alias for smallInteger().
+     */
+    smallInt(column: string): ColumnBuilder;
+    /**
+     * Add a tiny integer column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    tinyInteger(column: string): ColumnBuilder;
+    /**
+     * Alias for tinyInteger().
+     */
+    tinyInt(column: string): ColumnBuilder;
+    /**
+     * Add a big integer column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    bigInteger(column: string): ColumnBuilder;
+    /**
+     * Alias for bigInteger().
+     */
+    bigInt(column: string): ColumnBuilder;
+    /**
+     * Add a float column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    float(column: string): ColumnBuilder;
+    /**
+     * Add a double precision column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    double(column: string): ColumnBuilder;
+    /**
+     * Add a decimal column with precision and scale.
+     *
+     * @param column - Column name
+     * @param precision - Total digits (default: 8)
+     * @param scale - Decimal places (default: 2)
+     * @returns Column builder for chaining modifiers
+     *
+     * @example
+     * ```typescript
+     * this.decimal("price", 10, 2); // DECIMAL(10,2) - up to 99999999.99
+     * ```
+     */
+    decimal(column: string, precision?: number, scale?: number): ColumnBuilder;
+    /**
+     * Add a boolean column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    boolean(column: string): ColumnBuilder;
+    /**
+     * Alias for boolean().
+     */
+    bool(column: string): ColumnBuilder;
+    /**
+     * Add a date column (date only, no time).
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    date(column: string): ColumnBuilder;
+    /**
+     * Add a datetime column (date and time).
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    dateTime(column: string): ColumnBuilder;
+    /**
+     * Add a timestamp column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    timestamp(column: string): ColumnBuilder;
+    /**
+     * Add a time column (time only, no date).
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    time(column: string): ColumnBuilder;
+    /**
+     * Add a year column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    year(column: string): ColumnBuilder;
+    /**
+     * Add a JSON column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    json(column: string): ColumnBuilder;
+    /**
+     * Alias for json().
+     */
+    object(column: string): ColumnBuilder;
+    /**
+     * Add a binary/blob column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    binary(column: string): ColumnBuilder;
+    /**
+     * Alias for binary().
+     */
+    blob(column: string): ColumnBuilder;
+    /**
+     * Add a UUID column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    uuid(column: string): ColumnBuilder;
+    /**
+     * Add a ULID column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    ulid(column: string): ColumnBuilder;
+    /**
+     * Add an IP address column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    ipAddress(column: string): ColumnBuilder;
+    /**
+     * Add a MAC address column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    macAddress(column: string): ColumnBuilder;
+    /**
+     * Add a geo point column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    point(column: string): ColumnBuilder;
+    /**
+     * Add a polygon column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    polygon(column: string): ColumnBuilder;
+    /**
+     * Add a line string column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    lineString(column: string): ColumnBuilder;
+    /**
+     * Add a generic geometry column.
+     *
+     * @param column - Column name
+     * @returns Column builder for chaining modifiers
+     */
+    geometry(column: string): ColumnBuilder;
+    /**
+     * Add a vector column for AI embeddings.
+     *
+     * Used for storing and searching ML embeddings (e.g., OpenAI, Cohere).
+     *
+     * @param column - Column name
+     * @param dimensions - Vector dimensions (e.g., 1536 for OpenAI ada-002)
+     * @returns Column builder for chaining modifiers
+     *
+     * @example
+     * ```typescript
+     * this.vector("embedding", 1536); // OpenAI ada-002
+     * this.vector("embedding", 384);  // Sentence Transformers
+     * ```
+     */
+    vector(column: string, dimensions: number): ColumnBuilder;
+    /**
+     * Add an enum column with allowed values.
+     *
+     * @param column - Column name
+     * @param values - Allowed enum values
+     * @returns Column builder for chaining modifiers
+     *
+     * @example
+     * ```typescript
+     * this.enum("status", ["pending", "active", "archived"]);
+     * ```
+     */
+    enum(column: string, values: string[]): ColumnBuilder;
+    /**
+     * Add a set column (multiple values from a set).
+     *
+     * @param column - Column name
+     * @param values - Allowed set values
+     * @returns Column builder for chaining modifiers
+     */
+    set(column: string, values: string[]): ColumnBuilder;
+    /**
+     * Add an auto-increment primary key column.
+     *
+     * Creates an unsigned integer with primary key and auto-increment.
+     *
+     * @param name - Column name (default: "id")
+     * @returns Column builder for chaining modifiers
+     *
+     * @example
+     * ```typescript
+     * this.id(); // Creates "id" column
+     * this.id("userId"); // Creates "userId" column
+     * ```
+     */
+    id(name?: string): ColumnBuilder;
+    /**
+     * Add a big integer auto-increment primary key column.
+     *
+     * @param name - Column name (default: "id")
+     * @returns Column builder for chaining modifiers
+     */
+    bigId(name?: string): ColumnBuilder;
+    /**
+     * Add a UUID primary key column.
+     *
+     * @param name - Column name (default: "id")
+     * @returns Column builder for chaining modifiers
+     */
+    uuidId(name?: string): ColumnBuilder;
+    /**
+     * Add createdAt and updatedAt timestamp columns.
+     *
+     * @returns This migration for chaining
+     *
+     * @example
+     * ```typescript
+     * this.timestamps(); // Creates createdAt and updatedAt
+     * ```
+     */
+    timestamps(): this;
+    /**
+     * Add a deletedAt column for soft deletes.
+     *
+     * @param column - Column name (default: "deletedAt")
+     * @returns Column builder for chaining modifiers
+     */
+    softDeletes(column?: string): ColumnBuilder;
+    /**
+     * Drop a column.
+     *
+     * @param column - Column name to drop
+     * @returns This migration for chaining
+     */
+    dropColumn(column: string): this;
+    /**
+     * Drop multiple columns.
+     *
+     * @param columns - Column names to drop
+     * @returns This migration for chaining
+     */
+    dropColumns(...columns: string[]): this;
+    /**
+     * Rename a column.
+     *
+     * @param from - Current column name
+     * @param to - New column name
+     * @returns This migration for chaining
+     */
+    renameColumn(from: string, to: string): this;
+    /**
+     * Create an index on one or more columns.
+     *
+     * @param columns - Column(s) to index
+     * @param name - Optional index name
+     * @returns This migration for chaining
+     *
+     * @example
+     * ```typescript
+     * this.index("email");
+     * this.index(["firstName", "lastName"], "name_idx");
+     * ```
+     */
+    index(columns: string | string[], name?: string): this;
+    /**
+     * Drop an index by name or columns.
+     *
+     * @param nameOrColumns - Index name (string) or columns array
+     * @returns This migration for chaining
+     *
+     * @example
+     * ```typescript
+     * this.dropIndex("email_idx"); // Drop by name
+     * this.dropIndex(["firstName", "lastName"]); // Drop by columns
+     * ```
+     */
+    dropIndex(nameOrColumns: string | string[]): this;
+    /**
+     * Create a unique constraint/index.
+     *
+     * @param columns - Column(s) to make unique
+     * @param name - Optional constraint name
+     * @returns This migration for chaining
+     */
+    unique(columns: string | string[], name?: string): this;
+    /**
+     * Drop a unique constraint/index.
+     *
+     * @param columns - Columns in the unique constraint
+     * @returns This migration for chaining
+     */
+    dropUnique(columns: string | string[]): this;
+    /**
+     * Create a full-text search index.
+     *
+     * @param columns - Column(s) to index
+     * @param options - Full-text options
+     * @returns This migration for chaining
+     */
+    fullText(columns: string | string[], options?: FullTextIndexOptions): this;
+    /**
+     * Drop a full-text search index.
+     *
+     * @param name - Index name
+     * @returns This migration for chaining
+     */
+    dropFullText(name: string): this;
+    /**
+     * Create a geo-spatial index.
+     *
+     * @param column - Geo column
+     * @param options - Geo index options
+     * @returns This migration for chaining
+     *
+     * @example
+     * ```typescript
+     * this.geoIndex("location"); // 2dsphere index
+     * this.geoIndex("coordinates", { type: "2d" }); // 2d index
+     * ```
+     */
+    geoIndex(column: string, options?: GeoIndexOptions): this;
+    /**
+     * Drop a geo-spatial index.
+     *
+     * @param column - Geo column
+     * @returns This migration for chaining
+     */
+    dropGeoIndex(column: string): this;
+    /**
+     * Create a vector search index for AI embeddings.
+     *
+     * @param column - Vector column
+     * @param options - Vector index options
+     * @returns This migration for chaining
+     *
+     * @example
+     * ```typescript
+     * this.vectorIndex("embedding", {
+     *   dimensions: 1536,
+     *   similarity: "cosine",
+     * });
+     * ```
+     */
+    vectorIndex(column: string, options: VectorIndexOptions): this;
+    /**
+     * Drop a vector search index.
+     *
+     * @param column - Vector column
+     * @returns This migration for chaining
+     */
+    dropVectorIndex(column: string): this;
+    /**
+     * Create a TTL (time-to-live) index for automatic document expiration.
+     *
+     * Primarily for MongoDB. Documents are automatically deleted after the
+     * specified time has passed since the date in the column.
+     *
+     * @param column - Date column to check for expiration
+     * @param expireAfterSeconds - Seconds after which documents expire
+     * @returns This migration for chaining
+     *
+     * @example
+     * ```typescript
+     * // Delete sessions 24 hours after createdAt
+     * this.ttlIndex("createdAt", 86400);
+     * ```
+     */
+    ttlIndex(column: string, expireAfterSeconds: number): this;
+    /**
+     * Drop a TTL index.
+     *
+     * @param column - Column with TTL
+     * @returns This migration for chaining
+     */
+    dropTTLIndex(column: string): this;
+    /**
+     * Add a composite primary key.
+     *
+     * @param columns - Columns to include in the primary key
+     * @returns This migration for chaining
+     */
+    primaryKey(columns: string[]): this;
+    /**
+     * Drop the primary key constraint.
+     *
+     * @returns This migration for chaining
+     */
+    dropPrimaryKey(): this;
+    /**
+     * Start building a foreign key constraint.
+     *
+     * SQL-only feature; NoSQL drivers ignore foreign keys.
+     *
+     * @param column - Local column that references another table
+     * @returns Foreign key builder for chaining
+     *
+     * @example
+     * ```typescript
+     * this.foreign("user_id")
+     *   .references("users", "id")
+     *   .onDelete("cascade")
+     *   .add();
+     * ```
+     */
+    foreign(column: string): ForeignKeyBuilder;
+    /**
+     * Drop a foreign key constraint by name.
+     *
+     * @param name - Constraint name
+     * @returns This migration for chaining
+     */
+    dropForeign(name: string): this;
+    /**
+     * Set JSON schema validation rules on the collection.
+     *
+     * MongoDB-only feature. SQL databases ignore this.
+     *
+     * @param schema - JSON Schema object
+     * @returns This migration for chaining
+     *
+     * @example
+     * ```typescript
+     * this.schemaValidation({
+     *   bsonType: "object",
+     *   required: ["name", "email"],
+     *   properties: {
+     *     name: { bsonType: "string" },
+     *     email: { bsonType: "string" },
+     *   },
+     * });
+     * ```
+     */
+    schemaValidation(schema: object): this;
+    /**
+     * Remove schema validation rules from the collection.
+     *
+     * @returns This migration for chaining
+     */
+    dropSchemaValidation(): this;
+    /**
+     * Execute raw operations with direct driver access.
+     *
+     * Use this for database-specific operations not covered by the API.
+     *
+     * @param callback - Callback receiving the native connection
+     * @returns Result from callback
+     *
+     * @example
+     * ```typescript
+     * await this.raw(async (db) => {
+     *   await db.collection("users").updateMany({}, { $set: { active: true } });
+     * });
+     * ```
+     */
+    raw<T>(callback: (connection: unknown) => Promise<T>): Promise<T>;
+}
+export declare function migrate(model: ChildModel<Model<any>>, options?: {
+    createdAt?: string;
+    name?: string;
+    up?: (this: MigrationContract) => void;
+    down?: (this: MigrationContract) => void;
+    transactional?: boolean;
+}): MigrationConstructor;
+//# sourceMappingURL=migration.d.ts.map