Sign in
Workflows

Create a workflow

post/organizations/{organization}/databases/{database}/workflows

Path parameters

organizationstring required

The name of the organization the workflow belongs to

databasestring required

The name of the database the workflow belongs to

Request body

namestring required

Name the workflow

source_keyspacestring required

Name of the source keyspace

target_keyspacestring required

Name of the target keyspace

global_keyspacestring

Name of the global sequence keyspace

defer_secondary_keysboolean

Defer secondary keys

on_ddl'IGNORE' | 'STOP' | 'EXEC' | 'EXEC_IGNORE'

The behavior when DDL changes during the workflow

tablesstring[] required

List of tables to move

Response

Returns the workflow

idstring required

The ID of the workflow

namestring required

The name of the workflow

numberinteger required

The sequence number of the workflow

state'pending' | 'copying' | 'running' | 'stopped' | 'verifying_data' | 'verified_data' | 'switching_replicas' | 'switched_replicas' | 'switching_primaries' | 'switched_primaries' | 'reversing_traffic' | 'reversing_traffic_for_cancel' | 'cutting_over' | 'cutover' | 'reversed_cutover' | 'completed' | 'cancelling' | 'cancelled' | 'error' required

The state of the workflow

created_atstring required

When the workflow was created

updated_atstring required

When the workflow was last updated

started_atstring nullable required

When the workflow was started

completed_atstring nullable required

When the workflow was completed

cancelled_atstring nullable required

When the workflow was cancelled

reversed_atstring nullable required

When the workflow was reversed

retried_atstring nullable required

When the workflow was retried

data_copy_completed_atstring nullable required

When the data copy was completed

cutover_atstring nullable required

When the cutover was completed

replicas_switchedboolean required

Whether or not the replicas have been switched

primaries_switchedboolean required

Whether or not the primaries have been switched

switch_replicas_atstring nullable required

When the replicas were switched

switch_primaries_atstring nullable required

When the primaries were switched

verify_data_atstring nullable required

When the data was verified

workflow_type'move_tables' required

The type of the workflow

workflow_subtypestring required

The subtype of the workflow

defer_secondary_keysboolean required

Whether or not secondary keys are deferred

on_ddl'IGNORE' | 'STOP' | 'EXEC' | 'EXEC_IGNORE' required

The behavior when DDL changes during the workflow

workflow_errorsstring required

The errors that occurred during the workflow

may_retryboolean required

Whether or not the workflow may be retried

may_restartboolean required

Whether or not the workflow may be restarted

verified_data_staleboolean required

Whether or not the verified data is stale

sequence_tables_appliedboolean required

Whether or not sequence tables have been created

Changes

Changed in 1 of the 24 revisions of this API.14

  • 72506953f36714See the full diff
    • ▲

      the response property branch/deleted_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property cancelled_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property completed_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property cutover_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property data_copy_completed_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property global_keyspace/deleted_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property retried_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property reversed_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property source_keyspace/deleted_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property started_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property switch_primaries_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property switch_replicas_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property target_keyspace/deleted_at became nullable for the status 201

      response-property-became-nullable

    • ▲

      the response property verify_data_at became nullable for the status 201

      response-property-became-nullable