sqlparser: normalize IndexInfo (#14177)

Signed-off-by: Vicent Marti <[email protected]>
vitessio · Oct 5, 2023 · d84f6d7 · d84f6d7
1 parent e73ce91
commit d84f6d7
Show file tree

Hide file tree

Showing 21 changed files with 285 additions and 205 deletions.
diff --git a/go/test/endtoend/vreplication/helper_test.go b/go/test/endtoend/vreplication/helper_test.go
@@ -386,7 +386,7 @@ func confirmTablesHaveSecondaryKeys(t *testing.T, tablets []*cluster.VttabletPro
 			require.NotNil(t, createTable)
 			require.NotNil(t, createTable.GetTableSpec())
 			for _, index := range createTable.GetTableSpec().Indexes {
-				if !index.Info.Primary {
+				if index.Info.Type != sqlparser.IndexTypePrimary {
 					secondaryKeys++
 				}
 			}

diff --git a/go/vt/schemadiff/diff_test.go b/go/vt/schemadiff/diff_test.go
@@ -477,10 +477,10 @@ func TestDiffSchemas(t *testing.T) {
 			from: "create table t1 (id mediumint unsigned NOT NULL, deleted_at timestamp, primary key (id), unique key deleted_check (id, (if((deleted_at is null),0,NULL))))",
 			to:   "create table t1 (id mediumint unsigned NOT NULL, deleted_at timestamp, primary key (id), unique key deleted_check (id, (if((deleted_at is not null),0,NULL))))",
 			diffs: []string{
-				"alter table t1 drop key deleted_check, add unique key deleted_check (id, (if(deleted_at is not null, 0, null)))",
+				"alter table t1 drop key deleted_check, add unique index deleted_check (id, (if(deleted_at is not null, 0, null)))",
 			},
 			cdiffs: []string{
-				"ALTER TABLE `t1` DROP KEY `deleted_check`, ADD UNIQUE KEY `deleted_check` (`id`, (if(`deleted_at` IS NOT NULL, 0, NULL)))",
+				"ALTER TABLE `t1` DROP KEY `deleted_check`, ADD UNIQUE INDEX `deleted_check` (`id`, (if(`deleted_at` IS NOT NULL, 0, NULL)))",
 			},
 		},
 		{
@@ -656,13 +656,13 @@ func TestDiffSchemas(t *testing.T) {
 			to:   "create table t7(id int primary key); create table t5 (id int primary key, i int, constraint f5 foreign key (i) references t7(id)); create table t4 (id int primary key, i int, constraint f4 foreign key (i) references t7(id));",
 			diffs: []string{
 				"create table t7 (\n\tid int,\n\tprimary key (id)\n)",
-				"create table t4 (\n\tid int,\n\ti int,\n\tprimary key (id),\n\tkey f4 (i),\n\tconstraint f4 foreign key (i) references t7 (id)\n)",
-				"create table t5 (\n\tid int,\n\ti int,\n\tprimary key (id),\n\tkey f5 (i),\n\tconstraint f5 foreign key (i) references t7 (id)\n)",
+				"create table t4 (\n\tid int,\n\ti int,\n\tprimary key (id),\n\tindex f4 (i),\n\tconstraint f4 foreign key (i) references t7 (id)\n)",
+				"create table t5 (\n\tid int,\n\ti int,\n\tprimary key (id),\n\tindex f5 (i),\n\tconstraint f5 foreign key (i) references t7 (id)\n)",
 			},
 			cdiffs: []string{
 				"CREATE TABLE `t7` (\n\t`id` int,\n\tPRIMARY KEY (`id`)\n)",
-				"CREATE TABLE `t4` (\n\t`id` int,\n\t`i` int,\n\tPRIMARY KEY (`id`),\n\tKEY `f4` (`i`),\n\tCONSTRAINT `f4` FOREIGN KEY (`i`) REFERENCES `t7` (`id`)\n)",
-				"CREATE TABLE `t5` (\n\t`id` int,\n\t`i` int,\n\tPRIMARY KEY (`id`),\n\tKEY `f5` (`i`),\n\tCONSTRAINT `f5` FOREIGN KEY (`i`) REFERENCES `t7` (`id`)\n)",
+				"CREATE TABLE `t4` (\n\t`id` int,\n\t`i` int,\n\tPRIMARY KEY (`id`),\n\tINDEX `f4` (`i`),\n\tCONSTRAINT `f4` FOREIGN KEY (`i`) REFERENCES `t7` (`id`)\n)",
+				"CREATE TABLE `t5` (\n\t`id` int,\n\t`i` int,\n\tPRIMARY KEY (`id`),\n\tINDEX `f5` (`i`),\n\tCONSTRAINT `f5` FOREIGN KEY (`i`) REFERENCES `t7` (`id`)\n)",
 			},
 		},
 		{

diff --git a/go/vt/schemadiff/table.go b/go/vt/schemadiff/table.go
@@ -583,9 +583,6 @@ func (c *CreateTableEntity) normalizeColumnOptions() {
 
 func (c *CreateTableEntity) normalizeIndexOptions() {
 	for _, idx := range c.CreateTable.TableSpec.Indexes {
-		// This name is taking straight from the input string
-		// so we want to normalize this to always lowercase.
-		idx.Info.Type = strings.ToLower(idx.Info.Type)
 		for _, opt := range idx.Options {
 			opt.Name = strings.ToLower(opt.Name)
 			opt.String = strings.ToLower(opt.String)
@@ -617,10 +614,8 @@ func (c *CreateTableEntity) normalizePartitionOptions() {
 func newPrimaryKeyIndexDefinitionSingleColumn(name sqlparser.IdentifierCI) *sqlparser.IndexDefinition {
 	index := &sqlparser.IndexDefinition{
 		Info: &sqlparser.IndexInfo{
-			Name:    sqlparser.NewIdentifierCI("PRIMARY"),
-			Type:    "PRIMARY KEY",
-			Primary: true,
-			Unique:  true,
+			Name: sqlparser.NewIdentifierCI("PRIMARY"),
+			Type: sqlparser.IndexTypePrimary,
 		},
 		Columns: []*sqlparser.IndexColumn{{Column: name}},
 	}
@@ -653,10 +648,6 @@ func (c *CreateTableEntity) normalizeKeys() {
 		}
 	}
 	for _, key := range c.CreateTable.TableSpec.Indexes {
-		// Normalize to KEY which matches MySQL behavior for the type.
-		if key.Info.Type == sqlparser.KeywordString(sqlparser.INDEX) {
-			key.Info.Type = sqlparser.KeywordString(sqlparser.KEY)
-		}
 		// now, let's look at keys that do not have names, and assign them new names
 		if name := key.Info.Name.String(); name == "" {
 			// we know there must be at least one column covered by this key
@@ -747,7 +738,6 @@ func (c *CreateTableEntity) normalizeForeignKeyIndexes() {
 			// - or, a standard auto-generated index name, if the constraint name is not provided
 			indexDefinition := &sqlparser.IndexDefinition{
 				Info: &sqlparser.IndexInfo{
-					Type: "key",
 					Name: constraint.Name, // if name is empty, then the name is later auto populated
 				},
 			}
@@ -1366,7 +1356,7 @@ func (c *CreateTableEntity) diffKeys(alterTable *sqlparser.AlterTable,
 
 	dropKeyStatement := func(info *sqlparser.IndexInfo) *sqlparser.DropKey {
 		dropKey := &sqlparser.DropKey{}
-		if strings.EqualFold(info.Type, sqlparser.PrimaryKeyTypeStr) {
+		if info.Type == sqlparser.IndexTypePrimary {
 			dropKey.Type = sqlparser.PrimaryKeyType
 		} else {
 			dropKey.Type = sqlparser.NormalKeyType
@@ -1417,7 +1407,7 @@ func (c *CreateTableEntity) diffKeys(alterTable *sqlparser.AlterTable,
 				IndexDefinition: t2Key,
 			}
 			addedAsSuperfluousStatement := false
-			if t2Key.Info.Fulltext {
+			if t2Key.Info.Type == sqlparser.IndexTypeFullText {
 				if addedFulltextKeys > 0 && hints.FullTextKeyStrategy == FullTextKeyDistinctStatements {
 					// Special case: MySQL does not support multiple ADD FULLTEXT KEY statements in a single ALTER
 					superfluousFulltextKeys = append(superfluousFulltextKeys, addKey)
@@ -1703,7 +1693,7 @@ func heuristicallyDetectColumnRenames(
 // a PRIMARY KEY
 func (c *CreateTableEntity) primaryKeyColumns() []*sqlparser.IndexColumn {
 	for _, existingIndex := range c.CreateTable.TableSpec.Indexes {
-		if existingIndex.Info.Primary {
+		if existingIndex.Info.Type == sqlparser.IndexTypePrimary {
 			return existingIndex.Columns
 		}
 	}
@@ -1874,7 +1864,7 @@ func (c *CreateTableEntity) apply(diff *AlterTableEntityDiff) error {
 			switch opt.Type {
 			case sqlparser.PrimaryKeyType:
 				for i, idx := range c.TableSpec.Indexes {
-					if strings.EqualFold(idx.Info.Type, sqlparser.PrimaryKeyTypeStr) {
+					if idx.Info.Type == sqlparser.IndexTypePrimary {
 						found = true
 						c.TableSpec.Indexes = append(c.TableSpec.Indexes[0:i], c.TableSpec.Indexes[i+1:]...)
 						break
@@ -2435,7 +2425,7 @@ func (c *CreateTableEntity) validate() error {
 
 			// Validate all unique keys include this column:
 			for _, key := range c.CreateTable.TableSpec.Indexes {
-				if !key.Info.Unique {
+				if !key.Info.IsUnique() {
 					continue
 				}
 				colFound := false