Merge pull request #247 from planetscale/new-movetables-options

Add new optional Create workflow options

Author: notfelineit

planetscale/workflows.go

@@ -127,13 +127,16 @@ type GetWorkflowRequest struct {
 }
 
 type CreateWorkflowRequest struct {
-	Organization   string   `json:"-"`
-	Database       string   `json:"-"`
-	Branch         string   `json:"branch_name"`
-	Name           string   `json:"name"`
-	SourceKeyspace string   `json:"source_keyspace"`
-	TargetKeyspace string   `json:"target_keyspace"`
-	Tables         []string `json:"tables"`
+	Organization       string   `json:"-"`
+	Database           string   `json:"-"`
+	Branch             string   `json:"branch_name"`
+	Name               string   `json:"name"`
+	SourceKeyspace     string   `json:"source_keyspace"`
+	TargetKeyspace     string   `json:"target_keyspace"`
+	Tables             []string `json:"tables"`
+	GlobalKeyspace     *string  `json:"global_keyspace"`
+	DeferSecondaryKeys *bool    `json:"defer_secondary_keys"`
+	OnDDL              *string  `json:"on_ddl"`
 }
 
 // WorkflowsService is an interface for interacting with the workflow endpoints of the PlanetScale API

planetscale/workflows_test.go

@@ -2,6 +2,7 @@ package planetscale
 
 import (
 	"context"
+	"encoding/json"
 	"net/http"
 	"net/http/httptest"
 	"testing"
@@ -118,6 +119,63 @@ func TestWorkflows_Create(t *testing.T) {
 	c.Assert(len(workflow.Tables), qt.Equals, 2)
 }
 
+func TestWorkflows_CreateWithNewOptions(t *testing.T) {
+	c := qt.New(t)
+
+	ts := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
+		w.WriteHeader(200)
+		out := `{"id":"thisisanid","type":"Workflow","name":"shard-table","number":1,"state":"pending","created_at":"2025-03-18T17:21:55.546Z","updated_at":"2025-03-18T17:21:55.618Z","started_at":null,"completed_at":null,"cancelled_at":null,"reversed_at":null,"retried_at":null,"data_copy_completed_at":null,"cutover_at":null,"replicas_switched":false,"primaries_switched":false,"switch_replicas_at":null,"switch_primaries_at":null,"verify_data_at":null,"workflow_type":"move_tables","workflow_subtype":null,"may_retry":false,"verified_data_stale":false,"branch":{"id":"hjcq437nimp2","type":"Branch","name":"branch","created_at":"2025-03-18T17:21:55.194Z","updated_at":"2025-03-18T17:21:55.434Z","restore_checklist_completed_at":null,"schema_last_updated_at":"2025-03-18T17:21:55.360Z","mysql_address":"us-east.connect.psdb.cloud","mysql_provider_address":"aws.connect.psdb.cloud","schema_ready":true,"state":"ready","vtgate_size":"vg.c1.nano","vtgate_count":1,"cluster_rate_name":"PS_10","mysql_edge_address":"aws.connect.psdb.cloud","ready":true,"metal":false,"production":true,"safe_migrations":true,"sharded":true,"shard_count":4,"stale_schema":false,"index_usage_enabled":true,"actor":{"id":"55cloymikacf","type":"User","display_name":"[email protected]","avatar_url":"https://app.planetscale.com/gravatar-fallback.png"},"restored_from_branch":null,"private_connectivity":false,"private_edge_connectivity":false,"html_url":"http://app.pscaledev.com:3001/organization1/weathered-bush-4453/main","has_replicas":true,"has_read_only_replicas":false,"url":"http://api.pscaledev.com:3000/v1/organizations/organization1/databases/weathered-bush-4453/branches/main","region":{"id":"ps-region-id","type":"Region","provider":"AWS","enabled":true,"public_ip_addresses":[],"display_name":"AWS us-east-1","location":"Ashburn, Virginia","slug":"us-east","current_default":true},"parent_branch":null},"source_keyspace":{"id":"w7l4fekda4xg","type":"BranchKeyspace","name":"source-keyspace","shards":1,"sharded":false,"replicas":2,"extra_replicas":0,"created_at":"2025-03-18T17:21:55.284Z","updated_at":"2025-03-18T17:21:55.390Z","cluster_rate_name":"PS_10","cluster_rate_display_name":"PS-10","resizing":false,"ready":true,"metal":false,"vector_pool_allocation":null,"resize_pending":false},"target_keyspace":{"id":"65qnxzwehl6f","type":"BranchKeyspace","name":"target-keyspace","shards":4,"sharded":true,"replicas":2,"extra_replicas":0,"created_at":"2025-03-18T17:21:55.499Z","updated_at":"2025-03-18T17:21:55.499Z","cluster_rate_name":"PS_10","cluster_rate_display_name":"PS-10","resizing":false,"ready":true,"metal":false,"vector_pool_allocation":null,"resize_pending":false},"actor":{"id":"55cloymikacf","type":"User","display_name":"[email protected]","avatar_url":"https://app.planetscale.com/gravatar-fallback.png"},"verify_data_by":null,"reversed_by":null,"switch_replicas_by":null,"switch_primaries_by":null,"cancelled_by":null,"completed_by":null,"retried_by":null,"cutover_by":null,"reversed_cutover_by":null,"streams":[{"id":"z7orf7caq72o","type":"WorkflowStream","state":"copying","created_at":"2025-03-18T17:21:55.598Z","updated_at":"2025-03-18T17:21:55.598Z","vitess_id":1,"target_shard":"-80","source_shard":"-80","target_tablet_uid":"target-uid","target_tablet_cell":"target-cell","position":"position","stop_position":"stop-position","rows_copied":10,"component_throttled":null,"component_throttled_at":null,"primary_serving":false,"info":"important info"}],"tables":[{"id":"5lje0cf2dvdi","type":"WorkflowTable","name":"table-1","created_at":"2025-03-18T17:21:55.584Z","updated_at":"2025-03-18T17:21:55.584Z","rows_copied":10,"rows_total":100,"rows_percentage":10},{"name":"table-2"}],"vdiff":{"id":"n86yn5nr26zc","type":"WorkflowVDiff","state":"pending","created_at":"2025-03-18T17:21:55.614Z","updated_at":"2025-03-18T17:21:55.614Z","started_at":null,"completed_at":null,"has_mismatch":false,"progress_percentage":null,"eta_seconds":null,"table_reports":[{"id":"rw5saem6ltq0","type":"WorkflowVDiffTableReport","table_name":"users","shard":"-","mismatched_rows_count":0,"extra_source_rows_count":0,"extra_target_rows_count":0,"extra_source_rows":[],"extra_target_rows":[],"mismatched_rows":[],"sample_extra_source_rows_query":null,"sample_extra_target_rows_query":null,"sample_mismatched_rows_query":null,"created_at":"2025-03-18T17:21:55.624Z","updated_at":"2025-03-18T17:21:55.624Z"}]}}`
+		_, err := w.Write([]byte(out))
+		c.Assert(err, qt.IsNil)
+		c.Assert(r.Method, qt.Equals, http.MethodPost)
+		var request struct {
+			GlobalKeyspace     *string `json:"global_keyspace"`
+			DeferSecondaryKeys *bool   `json:"defer_secondary_keys"`
+			OnDDL              *string `json:"on_ddl"`
+		}
+		err = json.NewDecoder(r.Body).Decode(&request)
+		c.Assert(err, qt.IsNil)
+		c.Assert(r.URL.Path, qt.Equals, "/v1/organizations/foo/databases/bar/workflows")
+		c.Assert(*request.GlobalKeyspace, qt.Equals, "baz")
+		c.Assert(*request.DeferSecondaryKeys, qt.Equals, true)
+		c.Assert(*request.OnDDL, qt.Equals, "EXEC_IGNORE")
+	}))
+
+	client, err := NewClient(WithBaseURL(ts.URL))
+	c.Assert(err, qt.IsNil)
+
+	ctx := context.Background()
+	onDDL := "EXEC_IGNORE"
+	globalKeyspace := "baz"
+	deferSecondaryKeys := true
+
+	workflow, err := client.Workflows.Create(ctx, &CreateWorkflowRequest{
+		Organization:       "foo",
+		Database:           "bar",
+		Branch:             "branch",
+		Name:               "my-workflow",
+		SourceKeyspace:     "source-keyspace",
+		TargetKeyspace:     "target-keyspace",
+		Tables:             []string{"table1", "table2"},
+		OnDDL:              &onDDL,
+		GlobalKeyspace:     &globalKeyspace,
+		DeferSecondaryKeys: &deferSecondaryKeys,
+	})
+
+	wantID := "thisisanid"
+
+	c.Assert(err, qt.IsNil)
+	c.Assert(workflow.ID, qt.Equals, wantID)
+	c.Assert(workflow.Name, qt.Equals, "shard-table")
+	c.Assert(workflow.Number, qt.Equals, uint64(1))
+	c.Assert(workflow.SourceKeyspace.Name, qt.Equals, "source-keyspace")
+	c.Assert(workflow.TargetKeyspace.Name, qt.Equals, "target-keyspace")
+	c.Assert(workflow.Branch.Name, qt.Equals, "branch")
+	c.Assert(workflow.VDiff.State, qt.Equals, "pending")
+	c.Assert(len(workflow.Streams), qt.Equals, 1)
+	c.Assert(len(workflow.Tables), qt.Equals, 2)
+}
+
 func TestWorfklows_VerifyData(t *testing.T) {
 	c := qt.New(t)