[release-18.0] Rename Foreign Key enum values in VSchema and drop `FK…

…_` prefix (#14274) (#14299) Signed-off-by: Manan Gupta <[email protected]> Co-authored-by: Manan Gupta <[email protected]> Co-authored-by: Manan Gupta <[email protected]>
vitessio · Oct 18, 2023 · e0f96d3 · e0f96d3
1 parent fe27a3f
commit e0f96d3
Show file tree

Hide file tree

Showing 23 changed files with 186 additions and 186 deletions.
diff --git a/changelog/18.0/18.0.0/release_notes.md b/changelog/18.0/18.0.0/release_notes.md
@@ -85,14 +85,14 @@ It is disabled by default.
 A new field `foreignKeyMode` has been added to the VSchema. This field can be provided for each keyspace. The VTGate flag `--foreign_key_mode` has been deprecated in favour of this field.
 
 There are 3 foreign key modes now supported in Vitess -
-1. `FK_UNMANAGED` -
+1. `unmanaged` -
    This mode represents the default behaviour in Vitess, where it does not manage foreign keys column references. Users are responsible for configuring foreign keys in MySQL in such a way that related rows, as determined by foreign keys, reside within the same shard.
-2. `FK_MANAGED` [EXPERIMENTAL] -
+2. `managed` [EXPERIMENTAL] -
    In this experimental mode, Vitess is fully aware of foreign key relationships and actively tracks foreign key constraints using the schema tracker. Vitess takes charge of handling DML operations with foreign keys cascading updates, deletes and verifying restrict. It will also validate parent row existence.
    This ensures that all the operations are logged in binary logs, unlike MySQL implementation of foreign keys.
    This enables seamless integration of VReplication with foreign keys.
    For more details on what operations Vitess takes please refer to the [design document for foreign keys](https://github.com/vitessio/vitess/issues/12967).
-3. `FK_DISALLOW` -
+3. `disallow` -
    In this mode Vitess explicitly disallows any DDL statements that try to create a foreign key constraint. This mode is equivalent to running VTGate with the flag `--foreign_key_mode=disallow`.
 
 #### Upgrade process

diff --git a/changelog/18.0/18.0.0/summary.md b/changelog/18.0/18.0.0/summary.md
@@ -85,14 +85,14 @@ It is disabled by default.
 A new field `foreignKeyMode` has been added to the VSchema. This field can be provided for each keyspace. The VTGate flag `--foreign_key_mode` has been deprecated in favour of this field.
 
 There are 3 foreign key modes now supported in Vitess -
-1. `FK_UNMANAGED` -
+1. `unmanaged` -
    This mode represents the default behaviour in Vitess, where it does not manage foreign keys column references. Users are responsible for configuring foreign keys in MySQL in such a way that related rows, as determined by foreign keys, reside within the same shard.
-2. `FK_MANAGED` [EXPERIMENTAL] -
+2. `managed` [EXPERIMENTAL] -
    In this experimental mode, Vitess is fully aware of foreign key relationships and actively tracks foreign key constraints using the schema tracker. Vitess takes charge of handling DML operations with foreign keys cascading updates, deletes and verifying restrict. It will also validate parent row existence.
    This ensures that all the operations are logged in binary logs, unlike MySQL implementation of foreign keys.
    This enables seamless integration of VReplication with foreign keys.
    For more details on what operations Vitess takes please refer to the [design document for foreign keys](https://github.com/vitessio/vitess/issues/12967).
-3. `FK_DISALLOW` -
+3. `disallow` -
    In this mode Vitess explicitly disallows any DDL statements that try to create a foreign key constraint. This mode is equivalent to running VTGate with the flag `--foreign_key_mode=disallow`.
 
 #### Upgrade process

diff --git a/go/test/endtoend/vtgate/foreignkey/sharded_vschema.json b/go/test/endtoend/vtgate/foreignkey/sharded_vschema.json
@@ -1,6 +1,6 @@
 {
   "sharded": true,
-  "foreignKeyMode": "FK_MANAGED",
+  "foreignKeyMode": "managed",
   "vindexes": {
     "xxhash": {
       "type": "xxhash"

diff --git a/go/test/endtoend/vtgate/foreignkey/stress/fk_stress_test.go b/go/test/endtoend/vtgate/foreignkey/stress/fk_stress_test.go
@@ -323,7 +323,7 @@ func TestMain(m *testing.M) {
 			Name: keyspaceName,
 			VSchema: `{
 				"sharded": false,
-				"foreignKeyMode": "FK_MANAGED"
+				"foreignKeyMode": "managed"
 			}`,
 		}
 

diff --git a/go/test/endtoend/vtgate/foreignkey/unsharded_vschema.json b/go/test/endtoend/vtgate/foreignkey/unsharded_vschema.json
@@ -1,6 +1,6 @@
 {
   "sharded": false,
-  "foreignKeyMode": "FK_MANAGED",
+  "foreignKeyMode": "managed",
   "tables": {
     "u_t1": {},
     "u_t2": {},

diff --git a/go/test/vschemawrapper/vschema_wrapper.go b/go/test/vschemawrapper/vschema_wrapper.go
@@ -129,8 +129,8 @@ func (vw *VSchemaWrapper) PlannerWarning(_ string) {
 }
 
 func (vw *VSchemaWrapper) ForeignKeyMode(keyspace string) (vschemapb.Keyspace_ForeignKeyMode, error) {
-	defaultFkMode := vschemapb.Keyspace_FK_UNMANAGED
-	if vw.V.Keyspaces[keyspace] != nil && vw.V.Keyspaces[keyspace].ForeignKeyMode != vschemapb.Keyspace_FK_DEFAULT {
+	defaultFkMode := vschemapb.Keyspace_unmanaged
+	if vw.V.Keyspaces[keyspace] != nil && vw.V.Keyspaces[keyspace].ForeignKeyMode != vschemapb.Keyspace_unspecified {
 		return vw.V.Keyspaces[keyspace].ForeignKeyMode, nil
 	}
 	return defaultFkMode, nil

diff --git a/go/vt/proto/vschema/vschema.pb.go b/go/vt/proto/vschema/vschema.pb.go
diff --git a/go/vt/vtgate/planbuilder/ddl.go b/go/vt/vtgate/planbuilder/ddl.go
@@ -155,7 +155,7 @@ func checkFKError(vschema plancontext.VSchema, ddlStatement sqlparser.DDLStateme
 	if err != nil {
 		return err
 	}
-	if fkMode == vschemapb.Keyspace_FK_DISALLOW {
+	if fkMode == vschemapb.Keyspace_disallow {
 		fk := &fkContraint{}
 		_ = sqlparser.Walk(fk.FkWalk, ddlStatement)
 		if fk.found {

diff --git a/go/vt/vtgate/planbuilder/delete.go b/go/vt/vtgate/planbuilder/delete.go
@@ -100,7 +100,7 @@ func fkManagementNotRequired(ctx *plancontext.PlanningContext, vschema planconte
 		if err != nil {
 			return false
 		}
-		if ksMode != vschemapb.Keyspace_FK_MANAGED {
+		if ksMode != vschemapb.Keyspace_managed {
 			continue
 		}
 		childFks := vTable.ChildFKsNeedsHandling(ctx.VerifyAllFKs, vindexes.DeleteAction)

diff --git a/go/vt/vtgate/planbuilder/insert.go b/go/vt/vtgate/planbuilder/insert.go
@@ -107,7 +107,7 @@ func errOutIfPlanCannotBeConstructed(ctx *plancontext.PlanningContext, vTbl *vin
 // TODO: Handle all this in semantic analysis.
 func fkManagementRequiredForInsert(ctx *plancontext.PlanningContext, vTbl *vindexes.Table, updateExprs sqlparser.UpdateExprs, replace bool) bool {
 	ksMode, err := ctx.VSchema.ForeignKeyMode(vTbl.Keyspace.Name)
-	if err != nil || ksMode != vschemapb.Keyspace_FK_MANAGED {
+	if err != nil || ksMode != vschemapb.Keyspace_managed {
 		return false
 	}
 

diff --git a/go/vt/vtgate/planbuilder/operators/delete.go b/go/vt/vtgate/planbuilder/operators/delete.go
@@ -99,7 +99,7 @@ func createOperatorFromDelete(ctx *plancontext.PlanningContext, deleteStmt *sqlp
 	}
 
 	// Unmanaged foreign-key-mode, we don't need to do anything.
-	if ksMode != vschemapb.Keyspace_FK_MANAGED {
+	if ksMode != vschemapb.Keyspace_managed {
 		return delOp, nil
 	}
 

diff --git a/go/vt/vtgate/planbuilder/operators/insert.go b/go/vt/vtgate/planbuilder/operators/insert.go
@@ -149,7 +149,7 @@ func createOperatorFromInsert(ctx *plancontext.PlanningContext, ins *sqlparser.I
 	if err != nil {
 		return nil, err
 	}
-	if ksMode != vschemapb.Keyspace_FK_MANAGED {
+	if ksMode != vschemapb.Keyspace_managed {
 		return insOp, nil
 	}
 

diff --git a/go/vt/vtgate/planbuilder/operators/update.go b/go/vt/vtgate/planbuilder/operators/update.go
@@ -120,7 +120,7 @@ func createOperatorFromUpdate(ctx *plancontext.PlanningContext, updStmt *sqlpars
 		return nil, err
 	}
 	// Unmanaged foreign-key-mode, we don't need to do anything.
-	if ksMode != vschemapb.Keyspace_FK_MANAGED {
+	if ksMode != vschemapb.Keyspace_managed {
 		return updOp, nil
 	}
 

diff --git a/go/vt/vtgate/planbuilder/testdata/vschemas/schema.json b/go/vt/vtgate/planbuilder/testdata/vschemas/schema.json
@@ -605,7 +605,7 @@
     },
     "sharded_fk_allow": {
       "sharded": true,
-      "foreignKeyMode": "FK_MANAGED",
+      "foreignKeyMode": "managed",
       "vindexes": {
         "hash_vin": {
           "type": "hash_test"
@@ -746,7 +746,7 @@
       }
     },
     "unsharded_fk_allow": {
-      "foreignKeyMode": "FK_MANAGED",
+      "foreignKeyMode": "managed",
       "tables": {
         "u_tbl1": {},
         "u_tbl2": {},

diff --git a/go/vt/vtgate/planbuilder/update.go b/go/vt/vtgate/planbuilder/update.go
@@ -95,7 +95,7 @@ func fkManagementNotRequiredForUpdate(ctx *plancontext.PlanningContext, vTables
 		if err != nil {
 			return false
 		}
-		if ksMode != vschemapb.Keyspace_FK_MANAGED {
+		if ksMode != vschemapb.Keyspace_managed {
 			continue
 		}
 		childFks := vTable.ChildFKsNeedsHandling(ctx.VerifyAllFKs, vindexes.UpdateAction)

diff --git a/go/vt/vtgate/vcursor_impl.go b/go/vt/vtgate/vcursor_impl.go
@@ -1027,7 +1027,7 @@ func (vc *vcursorImpl) PlannerWarning(message string) {
 // ForeignKeyMode implements the VCursor interface
 func (vc *vcursorImpl) ForeignKeyMode(keyspace string) (vschemapb.Keyspace_ForeignKeyMode, error) {
 	if strings.ToLower(foreignKeyMode) == "disallow" {
-		return vschemapb.Keyspace_FK_DISALLOW, nil
+		return vschemapb.Keyspace_disallow, nil
 	}
 	ks := vc.vschema.Keyspaces[keyspace]
 	if ks == nil {

diff --git a/go/vt/vtgate/vindexes/vschema.go b/go/vt/vtgate/vindexes/vschema.go
@@ -326,7 +326,7 @@ func buildKeyspaces(source *vschemapb.SrvVSchema, vschema *VSchema) {
 				Name:    ksname,
 				Sharded: ks.Sharded,
 			},
-			ForeignKeyMode: replaceDefaultForeignKeyMode(ks.ForeignKeyMode),
+			ForeignKeyMode: replaceUnspecifiedForeignKeyMode(ks.ForeignKeyMode),
 			Tables:         make(map[string]*Table),
 			Vindexes:       make(map[string]Vindex),
 		}
@@ -335,10 +335,10 @@ func buildKeyspaces(source *vschemapb.SrvVSchema, vschema *VSchema) {
 	}
 }
 
-// replaceDefaultForeignKeyMode replaces the default value of the foreign key mode enum with the default we want to keep.
-func replaceDefaultForeignKeyMode(fkMode vschemapb.Keyspace_ForeignKeyMode) vschemapb.Keyspace_ForeignKeyMode {
-	if fkMode == vschemapb.Keyspace_FK_DEFAULT {
-		return vschemapb.Keyspace_FK_UNMANAGED
+// replaceUnspecifiedForeignKeyMode replaces the default value of the foreign key mode enum with the default we want to keep.
+func replaceUnspecifiedForeignKeyMode(fkMode vschemapb.Keyspace_ForeignKeyMode) vschemapb.Keyspace_ForeignKeyMode {
+	if fkMode == vschemapb.Keyspace_unspecified {
+		return vschemapb.Keyspace_unmanaged
 	}
 	return fkMode
 }