Databricks SDK for JavaScript
    Preparing search index...
    Index

    Constructors

    Methods

    • Approves migration execution at the MIGRATION_REVIEW gate, advancing to execution.

      Valid only when the migration is in MIGRATION_REVIEW. If supplied, the etag must match the current server value.

      Returns NOT_FOUND if the migration does not exist. Returns FAILED_PRECONDITION if the migration is not in MIGRATION_REVIEW. Returns ABORTED if the etag does not match the current resource version.

      Parameters

      Returns Promise<Migration>

    • Approves the working copy at the TRANSLATION_READY gate. If the migration was created with run_validation, the working copy is then run to verify it executes successfully before the migration is presented for execution review; otherwise it advances straight to MIGRATION_REVIEW.

      Valid only when the migration is in TRANSLATION_READY. If supplied, the etag must match the current server value.

      Returns NOT_FOUND if the migration does not exist. Returns FAILED_PRECONDITION if the migration is not in TRANSLATION_READY. Returns ABORTED if the etag does not match the current resource version.

      Parameters

      Returns Promise<Migration>

    • Cancels the migration, transitioning it to CANCELLED.

      Valid from any non-terminal state, unlike the review-gate transitions, which each require a specific state. Any in-flight agent work is abandoned and the migration stops advancing. The resource is retained for auditability.

      Returns NOT_FOUND if the migration does not exist. Returns FAILED_PRECONDITION if the migration is already in a terminal state. Returns ABORTED if the etag does not match the current resource version.

      Parameters

      Returns Promise<Migration>

    • Creates a new migration for a Classic compute asset.

      The migration is created in PLANNING_PENDING and advances through the state machine as planning work is scheduled. The caller must have appropriate permissions: workspace admin for infrastructure-scoped migrations, job owner/admin for individual workload migrations.

      At most one migration may hold an asset. Returns ALREADY_EXISTS if the asset has a migration in flight, or one that already migrated it successfully; a migration that ended without succeeding, or was deleted, releases the asset so it can be migrated again. Returns INVALID_PARAMETER_VALUE if the asset is not eligible for migration.

      Parameters

      Returns Promise<Migration>

    • Deletes a migration (soft-delete).

      Allowed from any state. Deleting a migration marks the record deleted only — it does not roll back a migration that already ran, and resources created during the migration are not cleaned up. The migration resource is retained for auditability. To stop an in-flight migration (agent teardown, transition to CANCELLED), use CancelMigration instead.

      Returns NOT_FOUND if the migration does not exist, or was already deleted: a deleted migration is hidden from every method (Get, Update, List, and Delete), so it cannot be deleted again. Returns ABORTED if a supplied nonempty request etag does not match the resource version.

      Parameters

      Returns Promise<Migration>

    • Retrieves a migration by its ID.

      Returns the current state, configuration, and output artifacts of the migration. Use this to poll migration progress or inspect artifacts after state transitions. Returns NOT_FOUND if the migration does not exist in the caller's workspace.

      Parameters

      Returns Promise<Migration>

    • Rejects migration execution at the MIGRATION_REVIEW gate, sending the migration to REVISION_PENDING to loop back for re-planning.

      Valid only when the migration is in MIGRATION_REVIEW. If supplied, the etag must match the current server value.

      Returns NOT_FOUND if the migration does not exist. Returns FAILED_PRECONDITION if the migration is not in MIGRATION_REVIEW. Returns ABORTED if the etag does not match the current resource version.

      Parameters

      Returns Promise<Migration>

    • Rejects the working copy at the TRANSLATION_READY gate, sending the migration to REVISION_PENDING to loop back for re-planning.

      Valid only when the migration is in TRANSLATION_READY. If supplied, the etag must match the current server value.

      Returns NOT_FOUND if the migration does not exist. Returns FAILED_PRECONDITION if the migration is not in TRANSLATION_READY. Returns ABORTED if the etag does not match the current resource version.

      Parameters

      Returns Promise<Migration>