Databricks SDK for JavaScript
    Preparing search index...

    Interface Migration

    A managed migration of PostgreSQL databases into a Lakebase branch.

    interface Migration {
        createTime?: Instant;
        databaseMappings?: DatabaseMapping[];
        deleteTime?: Instant;
        error?: MigrationError;
        migrationType?: MigrationType;
        name?: string;
        purgeTime?: Instant;
        sourceConnection?: string;
        state?: MigrationState;
        targetBranch?: string;
        updateTime?: Instant;
    }
    Index

    Properties

    createTime? databaseMappings? deleteTime? error? migrationType? name? purgeTime? sourceConnection? state? targetBranch? updateTime?

    Properties

    createTime?: Instant

    Output-only. The time when the migration was created.

    databaseMappings?: DatabaseMapping[]

    Required. Mappings from source databases to target databases.

    deleteTime?: Instant

    Output-only. The time when the migration was soft-deleted. Empty if the migration is active.

    error?: MigrationError

    Output-only. The current error preventing migration progress, if any.

    migrationType?: MigrationType

    Required. Immutable. The intended migration mode, selected when the migration is created.

    name?: string

    The migration resource name, in the format migrations/{migration}.

    purgeTime?: Instant

    Output-only. The time when the soft-deleted migration is scheduled for permanent deletion. Empty if the migration is active or permanent deletion is not scheduled.

    sourceConnection?: string

    Required. The name of the Unity Catalog connection (a UC securable name, such as my_postgres_connection) used to connect to the source PostgreSQL server.

    state?: MigrationState

    Output-only. The authoritative migration lifecycle state.

    targetBranch?: string

    The Lakebase branch receiving the migrated databases, in the format projects/{project_id}/branches/{branch_id}. May be omitted during assessment, but must be set before the migration starts, and may be changed until then.

    updateTime?: Instant

    Output-only. The time when the migration was last updated.

    Settings

    Member Visibility

    On This Page

    Properties