idxtype: add idxtype package

Add new sql/sem/idxtype package that defines an index type enum with values
like forward, inverted, and vector. Code across SQL needs to check the index
type and previously it used multiple different enums and bools. This commit
continues the process of unifying these mechanisms (future commits will do
even more).

Epic: CRDB-42943

Release note: None

pkg/BUILD.bazel

@@ -2211,6 +2211,8 @@ GO_TARGETS = [
     "//pkg/sql/sem/eval/eval_test:eval_test_test",
     "//pkg/sql/sem/eval:eval",
     "//pkg/sql/sem/eval:eval_test",
+    "//pkg/sql/sem/idxtype:idxtype",
+    "//pkg/sql/sem/idxtype:idxtypepb",
     "//pkg/sql/sem/normalize:normalize",
     "//pkg/sql/sem/normalize:normalize_test",
     "//pkg/sql/sem/plpgsqltree/utils:utils",

pkg/crosscluster/logical/BUILD.bazel

@@ -156,6 +156,7 @@ go_test(
         "//pkg/sql/randgen",
         "//pkg/sql/rowenc",
         "//pkg/sql/sem/eval",
+        "//pkg/sql/sem/idxtype",
         "//pkg/sql/sem/tree",
         "//pkg/sql/stats",
         "//pkg/testutils",

pkg/crosscluster/logical/logical_replication_job_test.go

@@ -34,14 +34,14 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/security/username"
 	"github.com/cockroachdb/cockroach/pkg/sql"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog"
-	"github.com/cockroachdb/cockroach/pkg/sql/catalog/descpb"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/desctestutils"
 	"github.com/cockroachdb/cockroach/pkg/sql/execinfra"
 	"github.com/cockroachdb/cockroach/pkg/sql/isql"
 	"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgcode"
 	"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror"
 	"github.com/cockroachdb/cockroach/pkg/sql/randgen"
 	"github.com/cockroachdb/cockroach/pkg/sql/rowenc"
+	"github.com/cockroachdb/cockroach/pkg/sql/sem/idxtype"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
 	"github.com/cockroachdb/cockroach/pkg/sql/stats"
 	"github.com/cockroachdb/cockroach/pkg/testutils"
@@ -1491,7 +1491,7 @@ func compareReplicatedTables(
 	descB := desctestutils.TestingGetPublicTableDescriptor(s.DB(), s.Codec(), dbB, tableName)
 
 	for _, indexA := range descA.AllIndexes() {
-		if indexA.GetType() == descpb.IndexDescriptor_INVERTED {
+		if indexA.GetType() == idxtype.INVERTED {
 			t.Logf("skipping fingerprinting of inverted index %s", indexA.GetName())
 			continue
 		}

pkg/gen/protobuf.bzl

@@ -70,6 +70,7 @@ PROTOBUF_SRCS = [
     "//pkg/sql/protoreflect/test:protoreflecttest_go_proto",
     "//pkg/sql/rowenc/rowencpb:rowencpb_go_proto",
     "//pkg/sql/schemachanger/scpb:scpb_go_proto",
+    "//pkg/sql/sem/idxtype:idxtype_go_proto",
     "//pkg/sql/sem/semenumpb:semenumpb_go_proto",
     "//pkg/sql/sessiondatapb:sessiondatapb_go_proto",
     "//pkg/sql/sqlstats/insights:insights_go_proto",

pkg/internal/sqlsmith/BUILD.bazel

@@ -29,6 +29,7 @@ go_library(
         "//pkg/sql/sem/cast",
         "//pkg/sql/sem/catid",
         "//pkg/sql/sem/eval",
+        "//pkg/sql/sem/idxtype",
         "//pkg/sql/sem/plpgsqltree",
         "//pkg/sql/sem/tree",
         "//pkg/sql/sem/tree/treebin",

pkg/internal/sqlsmith/alter.go

@@ -13,6 +13,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/colinfo"
 	"github.com/cockroachdb/cockroach/pkg/sql/randgen"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/cast"
+	"github.com/cockroachdb/cockroach/pkg/sql/sem/idxtype"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree/treebin"
 	"github.com/cockroachdb/cockroach/pkg/sql/types"
@@ -340,7 +341,7 @@ func makeCreateIndex(s *Smither) (tree.Statement, bool) {
 	}
 	var cols tree.IndexElemList
 	seen := map[tree.Name]bool{}
-	indexType := tree.IndexTypeForward
+	indexType := idxtype.FORWARD
 	unique := s.coin()
 	for len(cols) < 1 || s.coin() {
 		col := tableRef.Columns[s.rnd.Intn(len(tableRef.Columns))]
@@ -351,7 +352,7 @@ func makeCreateIndex(s *Smither) (tree.Statement, bool) {
 		// If this is the first column and it's invertible (i.e., JSONB), make an inverted index.
 		if len(cols) == 0 &&
 			colinfo.ColumnTypeIsOnlyInvertedIndexable(tree.MustBeStaticallyKnownType(col.Type)) {
-			indexType = tree.IndexTypeInverted
+			indexType = idxtype.INVERTED
 			unique = false
 			cols = append(cols, tree.IndexElem{
 				Column: col.Name,
@@ -366,7 +367,7 @@ func makeCreateIndex(s *Smither) (tree.Statement, bool) {
 		}
 	}
 	var storing tree.NameList
-	for indexType == tree.IndexTypeForward && s.coin() {
+	for idxtype.SupportsStoring(indexType) && s.coin() {
 		col := tableRef.Columns[s.rnd.Intn(len(tableRef.Columns))]
 		if seen[col.Name] {
 			continue
@@ -390,7 +391,7 @@ func makeCreateIndex(s *Smither) (tree.Statement, bool) {
 		Unique:       unique,
 		Columns:      cols,
 		Storing:      storing,
-		Type:         indexType,
+		Type:         tree.IndexType(indexType),
 		Concurrently: s.coin(),
 		Invisibility: invisibility,
 	}, true

pkg/internal/sqlsmith/schema.go

@@ -18,6 +18,7 @@ import (
 	_ "github.com/cockroachdb/cockroach/pkg/sql/sem/builtins"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/catid"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/eval"
+	"github.com/cockroachdb/cockroach/pkg/sql/sem/idxtype"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree/treebin"
 	"github.com/cockroachdb/cockroach/pkg/sql/types"
@@ -499,14 +500,14 @@ func (s *Smither) extractIndexes(
 				return nil, err
 			}
 			if _, ok := indexes[idx]; !ok {
-				indexType := tree.IndexTypeForward
+				indexType := idxtype.FORWARD
 				if inverted {
-					indexType = tree.IndexTypeInverted
+					indexType = idxtype.INVERTED
 				}
 				indexes[idx] = &tree.CreateIndex{
 					Name:  idx,
 					Table: *t.TableName,
-					Type:  indexType,
+					Type:  tree.IndexType(indexType),
 				}
 			}
 			create := indexes[idx]

pkg/protos.bzl

@@ -35,6 +35,7 @@ SERVER_PROTOS = [
     "//pkg/sql/contentionpb:contentionpb_proto",
     "//pkg/sql/lex:lex_proto",
     "//pkg/sql/schemachanger/scpb:scpb_proto",
+    "//pkg/sql/sem/idxtype:idxtype_proto",
     "//pkg/sql/sem/semenumpb:semenumpb_proto",
     "//pkg/sql/sessiondatapb:sessiondatapb_proto",
     "//pkg/sql/sqlstats/insights:insights_proto",
@@ -123,6 +124,7 @@ PROTO_FILES = [
     "//pkg/sql/lex:encode.proto",
     "//pkg/sql/schemachanger/scpb:elements.proto",
     "//pkg/sql/schemachanger/scpb:scpb.proto",
+    "//pkg/sql/sem/idxtype:idxtype.proto",
     "//pkg/sql/sem/semenumpb:constraint.proto",
     "//pkg/sql/sem/semenumpb:trigger.proto",
     "//pkg/sql/sessiondatapb:local_only_session_data.proto",

pkg/sql/BUILD.bazel

@@ -497,6 +497,7 @@ go_library(
         "//pkg/sql/sem/catconstants",
         "//pkg/sql/sem/catid",
         "//pkg/sql/sem/eval",
+        "//pkg/sql/sem/idxtype",
         "//pkg/sql/sem/plpgsqltree",
         "//pkg/sql/sem/semenumpb",
         "//pkg/sql/sem/transform",
@@ -878,6 +879,7 @@ go_test(
         "//pkg/sql/sem/catconstants",
         "//pkg/sql/sem/catid",
         "//pkg/sql/sem/eval",
+        "//pkg/sql/sem/idxtype",
         "//pkg/sql/sem/tree",
         "//pkg/sql/sessiondata",
         "//pkg/sql/sessiondatapb",

pkg/sql/alter_primary_key.go

@@ -23,6 +23,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgcode"
 	"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror"
 	"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgnotice"
+	"github.com/cockroachdb/cockroach/pkg/sql/sem/idxtype"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
 	"github.com/cockroachdb/cockroach/pkg/sql/sqlerrors"
 	"github.com/cockroachdb/cockroach/pkg/sql/sqltelemetry"
@@ -178,7 +179,7 @@ func (p *planner) AlterPrimaryKey(
 		Unique:            true,
 		CreatedExplicitly: true,
 		EncodingType:      catenumpb.PrimaryIndexEncoding,
-		Type:              descpb.IndexDescriptor_FORWARD,
+		Type:              idxtype.FORWARD,
 		// TODO(postamar): bump version to LatestIndexDescriptorVersion in 22.2
 		// This is not possible until then because of a limitation in 21.2 which
 		// affects mixed-21.2-22.1-version clusters (issue #78426).
@@ -433,7 +434,7 @@ func (p *planner) AlterPrimaryKey(
 			return true, nil
 		}
 
-		return !idx.IsUnique() || idx.GetType() == descpb.IndexDescriptor_INVERTED, nil
+		return !idx.IsUnique() || idx.GetType() == idxtype.INVERTED, nil
 	}
 	var indexesToRewrite []catalog.Index
 	for _, idx := range tableDesc.PublicNonPrimaryIndexes() {
@@ -809,7 +810,7 @@ func setKeySuffixAndStoredColumnIDsFromPrimary(
 	// Second, determine the key suffix columns: add all primary key columns
 	// which have not already been in the key columns in the secondary index.
 	toAdd.KeySuffixColumnIDs = nil
-	invIdx := toAdd.Type == descpb.IndexDescriptor_INVERTED
+	invIdx := toAdd.Type == idxtype.INVERTED
 	for _, colID := range primary.KeyColumnIDs {
 		if !idxColIDs.Contains(colID) {
 			toAdd.KeySuffixColumnIDs = append(toAdd.KeySuffixColumnIDs, colID)

pkg/sql/backfill.go

@@ -39,6 +39,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/sql/schemachanger/scexec"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/catconstants"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/eval"
+	"github.com/cockroachdb/cockroach/pkg/sql/sem/idxtype"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
 	"github.com/cockroachdb/cockroach/pkg/sql/sessiondata"
 	"github.com/cockroachdb/cockroach/pkg/sql/sqlerrors"
@@ -1466,9 +1467,9 @@ func (sc *SchemaChanger) validateIndexes(ctx context.Context) error {
 			continue
 		}
 		switch idx.GetType() {
-		case descpb.IndexDescriptor_FORWARD:
+		case idxtype.FORWARD:
 			forwardIndexes = append(forwardIndexes, idx)
-		case descpb.IndexDescriptor_INVERTED:
+		case idxtype.INVERTED:
 			invertedIndexes = append(invertedIndexes, idx)
 		}
 	}

pkg/sql/backfill/BUILD.bazel

@@ -33,6 +33,7 @@ go_library(
         "//pkg/sql/rowinfra",
         "//pkg/sql/sem/catid",
         "//pkg/sql/sem/eval",
+        "//pkg/sql/sem/idxtype",
         "//pkg/sql/sem/transform",
         "//pkg/sql/sem/tree",
         "//pkg/sql/sqlerrors",

pkg/sql/backfill/backfill.go

@@ -29,6 +29,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/sql/rowinfra"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/catid"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/eval"
+	"github.com/cockroachdb/cockroach/pkg/sql/sem/idxtype"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/transform"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
 	"github.com/cockroachdb/cockroach/pkg/sql/sqlerrors"
@@ -486,7 +487,7 @@ type IndexBackfiller struct {
 // ContainsInvertedIndex returns true if backfilling an inverted index.
 func (ib *IndexBackfiller) ContainsInvertedIndex() bool {
 	for _, idx := range ib.added {
-		if idx.GetType() == descpb.IndexDescriptor_INVERTED {
+		if idx.GetType() == idxtype.INVERTED {
 			return true
 		}
 	}

pkg/sql/catalog/BUILD.bazel

@@ -40,6 +40,7 @@ go_library(
         "//pkg/sql/privilege",
         "//pkg/sql/schemachanger/scpb",
         "//pkg/sql/sem/catconstants",
+        "//pkg/sql/sem/idxtype",
         "//pkg/sql/sem/semenumpb",
         "//pkg/sql/sem/tree",
         "//pkg/sql/sessiondatapb",

pkg/sql/catalog/catformat/BUILD.bazel

@@ -13,6 +13,7 @@ go_library(
         "//pkg/sql/catalog/descpb",
         "//pkg/sql/catalog/schemaexpr",
         "//pkg/sql/sem/eval",
+        "//pkg/sql/sem/idxtype",
         "//pkg/sql/sem/tree",
         "//pkg/sql/sessiondata",
         "@com_github_cockroachdb_errors//:errors",
@@ -31,6 +32,7 @@ go_test(
         "//pkg/sql/catalog/tabledesc",
         "//pkg/sql/sem/catconstants",
         "//pkg/sql/sem/eval",
+        "//pkg/sql/sem/idxtype",
         "//pkg/sql/sem/tree",
         "//pkg/sql/sessiondata",
         "//pkg/sql/types",

pkg/sql/catalog/catformat/index.go

@@ -17,6 +17,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/descpb"
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/schemaexpr"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/eval"
+	"github.com/cockroachdb/cockroach/pkg/sql/sem/idxtype"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
 	"github.com/cockroachdb/cockroach/pkg/sql/sessiondata"
 	"github.com/cockroachdb/errors"
@@ -101,7 +102,7 @@ func indexForDisplay(
 	if index.Unique {
 		f.WriteString("UNIQUE ")
 	}
-	if !f.HasFlags(tree.FmtPGCatalog) && index.Type == descpb.IndexDescriptor_INVERTED {
+	if !f.HasFlags(tree.FmtPGCatalog) && index.Type == idxtype.INVERTED {
 		f.WriteString("INVERTED ")
 	}
 	f.WriteString("INDEX ")
@@ -113,7 +114,7 @@ func indexForDisplay(
 
 	if f.HasFlags(tree.FmtPGCatalog) {
 		f.WriteString(" USING")
-		if index.Type == descpb.IndexDescriptor_INVERTED {
+		if index.Type == idxtype.INVERTED {
 			f.WriteString(" gin")
 		} else {
 			f.WriteString(" btree")
@@ -239,7 +240,7 @@ func FormatIndexElements(
 		} else {
 			f.FormatNameP(&index.KeyColumnNames[i])
 		}
-		if index.Type == descpb.IndexDescriptor_INVERTED &&
+		if index.Type == idxtype.INVERTED &&
 			col.GetID() == index.InvertedColumnID() && len(index.InvertedColumnKinds) > 0 {
 			switch index.InvertedColumnKinds[0] {
 			case catpb.InvertedIndexColumnKind_TRIGRAM:
@@ -249,7 +250,7 @@ func FormatIndexElements(
 		// The last column of an inverted index cannot have a DESC direction.
 		// Since the default direction is ASC, we omit the direction entirely
 		// for inverted index columns.
-		if i < n-1 || index.Type != descpb.IndexDescriptor_INVERTED {
+		if i < n-1 || index.Type != idxtype.INVERTED {
 			f.WriteByte(' ')
 			f.WriteString(index.KeyColumnDirections[i].String())
 		}

pkg/sql/catalog/catformat/index_test.go

@@ -16,6 +16,7 @@ import (
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/tabledesc"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/catconstants"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/eval"
+	"github.com/cockroachdb/cockroach/pkg/sql/sem/idxtype"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
 	"github.com/cockroachdb/cockroach/pkg/sql/sessiondata"
 	"github.com/cockroachdb/cockroach/pkg/sql/types"
@@ -81,7 +82,7 @@ func TestIndexForDisplay(t *testing.T) {
 
 	// JSONB INVERTED INDEX baz (a)
 	jsonbInvertedIndex := baseIndex
-	jsonbInvertedIndex.Type = descpb.IndexDescriptor_INVERTED
+	jsonbInvertedIndex.Type = idxtype.INVERTED
 	jsonbInvertedIndex.KeyColumnNames = []string{"a"}
 	jsonbInvertedIndex.KeyColumnIDs = descpb.ColumnIDs{1}
 

pkg/sql/catalog/descpb/BUILD.bazel

@@ -26,6 +26,7 @@ go_library(
         "//pkg/sql/protoreflect",
         "//pkg/sql/sem/catconstants",
         "//pkg/sql/sem/catid",
+        "//pkg/sql/sem/idxtype",
         "//pkg/sql/sem/tree",
         "//pkg/sql/types",
         "//pkg/util/errorutil/unimplemented",
@@ -60,6 +61,7 @@ proto_library(
         "//pkg/sql/catalog/catenumpb:catenumpb_proto",
         "//pkg/sql/catalog/catpb:catpb_proto",
         "//pkg/sql/schemachanger/scpb:scpb_proto",
+        "//pkg/sql/sem/idxtype:idxtype_proto",
         "//pkg/sql/sem/semenumpb:semenumpb_proto",
         "//pkg/sql/types:types_proto",
         "//pkg/util/hlc:hlc_proto",
@@ -80,6 +82,7 @@ go_proto_library(
         "//pkg/sql/catalog/catenumpb",
         "//pkg/sql/catalog/catpb",
         "//pkg/sql/schemachanger/scpb",
+        "//pkg/sql/sem/idxtype",
         "//pkg/sql/sem/semenumpb",
         "//pkg/sql/types",
         "//pkg/util/hlc",

pkg/sql/catalog/descpb/index.go

@@ -9,6 +9,7 @@ import (
 	"fmt"
 
 	"github.com/cockroachdb/cockroach/pkg/sql/catalog/catenumpb"
+	"github.com/cockroachdb/cockroach/pkg/sql/sem/idxtype"
 	"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
 	"github.com/cockroachdb/cockroach/pkg/sql/types"
 	"github.com/cockroachdb/errors"
@@ -99,7 +100,7 @@ func (desc *IndexDescriptor) GetName() string {
 // index. This is always the last column in ColumnIDs. Panics if the index is
 // not inverted.
 func (desc *IndexDescriptor) InvertedColumnID() ColumnID {
-	if desc.Type != IndexDescriptor_INVERTED {
+	if desc.Type != idxtype.INVERTED {
 		panic(errors.AssertionFailedf("index is not inverted"))
 	}
 	return desc.KeyColumnIDs[len(desc.KeyColumnIDs)-1]
@@ -109,7 +110,7 @@ func (desc *IndexDescriptor) InvertedColumnID() ColumnID {
 // index. This is always the last column in KeyColumnNames. Panics if the index is
 // not inverted.
 func (desc *IndexDescriptor) InvertedColumnName() string {
-	if desc.Type != IndexDescriptor_INVERTED {
+	if desc.Type != idxtype.INVERTED {
 		panic(errors.AssertionFailedf("index is not inverted"))
 	}
 	return desc.KeyColumnNames[len(desc.KeyColumnNames)-1]
@@ -120,7 +121,7 @@ func (desc *IndexDescriptor) InvertedColumnName() string {
 //
 // Panics if the index is not inverted.
 func (desc *IndexDescriptor) InvertedColumnKeyType() *types.T {
-	if desc.Type != IndexDescriptor_INVERTED {
+	if desc.Type != idxtype.INVERTED {
 		panic(errors.AssertionFailedf("index is not inverted"))
 	}
 	return types.EncodedKey