Merge pull request #2385 from josephschorr/additional-crdb-index

Add additional forced CRDB index in special case of no object IDs

Author: josephschorr

internal/datastore/crdb/schema/indexes.go

@@ -88,6 +88,19 @@ func IndexingHintForQueryShape(schema common.SchemaInformation, qs queryshape.Sh
 
 // IndexForFilter returns the index to use for a given relationships filter or nil if no index is forced.
 func IndexForFilter(schema common.SchemaInformation, filter datastore.RelationshipsFilter) *common.IndexDefinition {
+	// Special case: if the filter specifies the resource type and relation and the subject type and relation, then
+	// the schema diff index can be used.
+	if filter.OptionalResourceType != "" &&
+		filter.OptionalResourceRelation != "" &&
+		len(filter.OptionalSubjectsSelectors) == 1 &&
+		filter.OptionalSubjectsSelectors[0].OptionalSubjectType != "" &&
+		filter.OptionalSubjectsSelectors[0].RelationFilter.NonEllipsisRelation != "" &&
+		!filter.OptionalSubjectsSelectors[0].RelationFilter.IncludeEllipsisRelation &&
+		!filter.OptionalSubjectsSelectors[0].RelationFilter.OnlyNonEllipsisRelations {
+		return &IndexRelationshipBySubjectRelation
+	}
+
+	// Otherwise, determine an index based on whether the filter has a larger match on the resources or subject.
 	resourceFieldDepth := 0
 	if filter.OptionalResourceType != "" {
 		resourceFieldDepth = 1

internal/datastore/crdb/schema/indexes_test.go

@@ -118,6 +118,82 @@ func TestIndexForFilter(t *testing.T) {
 			},
 			expected: "",
 		},
+		{
+			name: "filter by resource type, relation and subject type and relation",
+			filter: datastore.RelationshipsFilter{
+				OptionalResourceType:     "foo",
+				OptionalResourceRelation: "bar",
+				OptionalSubjectsSelectors: []datastore.SubjectsSelector{
+					{
+						OptionalSubjectType: "foo",
+						RelationFilter: datastore.SubjectRelationFilter{
+							NonEllipsisRelation: "baz",
+						},
+					},
+				},
+			},
+			expected: "ix_relation_tuple_by_subject_relation",
+		},
+		{
+			name: "filter by resource type, relation and subject type",
+			filter: datastore.RelationshipsFilter{
+				OptionalResourceType:     "foo",
+				OptionalResourceRelation: "bar",
+				OptionalSubjectsSelectors: []datastore.SubjectsSelector{
+					{
+						OptionalSubjectType: "foo",
+					},
+				},
+			},
+			expected: "pk_relation_tuple",
+		},
+		{
+			name: "filter by resource type, relation and subject relation",
+			filter: datastore.RelationshipsFilter{
+				OptionalResourceType:     "foo",
+				OptionalResourceRelation: "bar",
+				OptionalSubjectsSelectors: []datastore.SubjectsSelector{
+					{
+						RelationFilter: datastore.SubjectRelationFilter{
+							NonEllipsisRelation: "baz",
+						},
+					},
+				},
+			},
+			expected: "pk_relation_tuple",
+		},
+		{
+			name: "filter by resource relation and subject type and relation",
+			filter: datastore.RelationshipsFilter{
+				OptionalResourceRelation: "bar",
+				OptionalSubjectsSelectors: []datastore.SubjectsSelector{
+					{
+						OptionalSubjectType: "foo",
+						RelationFilter: datastore.SubjectRelationFilter{
+							NonEllipsisRelation: "baz",
+						},
+					},
+				},
+			},
+			expected: "",
+		},
+		{
+			name: "filter by resource type, relation and subject type and relation, include ellipsis",
+			filter: datastore.RelationshipsFilter{
+				OptionalResourceType:     "foo",
+				OptionalResourceRelation: "bar",
+				OptionalSubjectsSelectors: []datastore.SubjectsSelector{
+					{
+						OptionalSubjectType: "foo",
+						RelationFilter: datastore.SubjectRelationFilter{
+							IncludeEllipsisRelation: true,
+							NonEllipsisRelation:     "baz",
+						},
+					},
+				},
+			},
+			expected: "pk_relation_tuple",
+		},
 	}
 
 	schema := Schema(common.ColumnOptimizationOptionNone, false, false)