Scaffold index operators and included (covered) index columns

src/EFCore.PG/Scaffolding/Internal/NpgsqlDatabaseModelFactory.cs

@@ -412,15 +412,25 @@ static void GetIndexes(
  [NotNull] List<uint> constraintIndexes,
  [NotNull] IDiagnosticsLogger<DbLoggerCategory.Scaffolding> logger)
  {
+ // Load the pg_opclass table (https://www.postgresql.org/docs/current/catalog-pg-opclass.html),
+ // which is referenced by the indices we'll load below
+ var opClasses = new Dictionary<uint, (string Name, bool IsDefault)>();
+ using (var command = new NpgsqlCommand("SELECT oid, opcname, opcdefault FROM pg_opclass", connection))
+ using (var reader = command.ExecuteReader())
+ foreach (var opClass in reader.Cast<DbDataRecord>())
+ opClasses[opClass.GetValueOrDefault<uint>("oid")] = (opClass.GetValueOrDefault<string>("opcname"), opClass.GetValueOrDefault<bool>("opcdefault"));
+
  var commandText = $@"
 SELECT
  idxcls.oid AS idx_oid,
  nspname,
  cls.relname AS cls_relname,
  idxcls.relname AS idx_relname,
  indisunique,
+ {(connection.PostgreSqlVersion >= new Version(11, 0) ? "indnkeyatts" : "indnatts AS indnkeyatts")},
  indkey,
  amname,
+ indclass,
  CASE
  WHEN indexprs IS NULL THEN NULL
  ELSE pg_get_expr(indexprs, cls.oid)
@@ -469,7 +479,10 @@ NOT indisprimary AND
  IsUnique = record.GetValueOrDefault<bool>("indisunique")
  };
 
+ var numKeyColumns = record.GetValueOrDefault<short>("indnkeyatts");
  var columnIndices = record.GetValueOrDefault<short[]>("indkey");
+ var tableColumns = (List<DatabaseColumn>)table.Columns;
+
  if (columnIndices.Any(i => i == 0))
  {
  // Expression index, not supported
@@ -484,19 +497,36 @@ NOT indisprimary AND
  */
  }
 
-var columns = (List<DatabaseColumn>)table.Columns;
- foreach (var i in columnIndices)
+// Key columns come before non-key (included) columns, process them first
+ foreach (var i in columnIndices.Take(numKeyColumns))
  {
- if (columns[i - 1] is DatabaseColumn indexColumn)
- index.Columns.Add(indexColumn);
-
+ if (tableColumns[i - 1] is DatabaseColumn indexKeyColumn)
+ index.Columns.Add(indexKeyColumn);
  else
  {
  logger.UnsupportedColumnIndexSkippedWarning(index.Name, DisplayName(tableSchema, tableName));
  goto IndexEnd;
  }
  }
 
+ // Now go over non-key (included columns) if any are present
+ if (columnIndices.Length > numKeyColumns)
+ {
+ var nonKeyColumns = new List<string>();
+ foreach (var i in columnIndices.Skip(numKeyColumns))
+ {
+ if (tableColumns[i - 1] is DatabaseColumn indexKeyColumn)
+ nonKeyColumns.Add(indexKeyColumn.Name);
+ else
+ {
+ logger.UnsupportedColumnIndexSkippedWarning(index.Name, DisplayName(tableSchema, tableName));
+ goto IndexEnd;
+ }
+ }
+
+ index[NpgsqlAnnotationNames.IndexInclude] = nonKeyColumns.ToArray();
+ }
+
  if (record.GetValueOrDefault<string>("pred") is string predicate)
  index.Filter = predicate;
 
@@ -508,6 +538,14 @@ NOT indisprimary AND
  if (record.GetValueOrDefault<string>("amname") is string indexMethod && indexMethod != "btree")
  index[NpgsqlAnnotationNames.IndexMethod] = indexMethod;
 
+ // Handle index operator classes, which we pre-loaded
+ var opClassNames = record
+ .GetValueOrDefault<uint[]>("indclass")
+ .Select(oid => opClasses.TryGetValue(oid, out var opc) && !opc.IsDefault ? opc.Name : null)
+ .ToArray();
+ if (opClassNames.Any(op => op != null))
+ index[NpgsqlAnnotationNames.IndexOperators] = opClassNames;
+
  table.Indexes.Add(index);
 
  IndexEnd: ;

test/EFCore.PG.FunctionalTests/Scaffolding/NpgsqlDatabaseModelFactoryTest.cs

@@ -1532,6 +1532,58 @@ public void Index_method()
  @"DROP TABLE ""IndexMethod""");
  }
 
+ [Fact]
+ public void Index_operators()
+ {
+ Test(
+ @"
+CREATE TABLE ""IndexOperators"" (a text, b text);
+CREATE INDEX ix_with ON ""IndexOperators"" (a, b varchar_pattern_ops);
+CREATE INDEX ix_without ON ""IndexOperators"" (a, b);",
+ Enumerable.Empty<string>(),
+ Enumerable.Empty<string>(),
+ dbModel =>
+ {
+ var table = dbModel.Tables.Single();
+
+ var indexWith = table.Indexes.Single(i => i.Name == "ix_with");
+ Assert.Equal(new[] { null, "varchar_pattern_ops" }, indexWith.FindAnnotation(NpgsqlAnnotationNames.IndexOperators).Value);
+
+ var indexWithout = table.Indexes.Single(i => i.Name == "ix_without");
+ Assert.Null(indexWithout.FindAnnotation(NpgsqlAnnotationNames.IndexOperators));
+ },
+ @"DROP TABLE ""IndexOperators""");
+ }
+
+ [Fact]
+ public void Index_covering()
+ {
+ if (Fixture.TestStore.GetPostgresVersion() < new Version(11, 0))
+ return;
+
+ Test(
+ @"
+CREATE TABLE ""IndexCovering"" (a text, b text, c text);
+CREATE INDEX ix_with ON ""IndexCovering"" (a) INCLUDE (b, c);
+CREATE INDEX ix_without ON ""IndexCovering"" (a, b, c);",
+ Enumerable.Empty<string>(),
+ Enumerable.Empty<string>(),
+ dbModel =>
+ {
+ var table = dbModel.Tables.Single();
+
+ var indexWith = table.Indexes.Single(i => i.Name == "ix_with");
+ Assert.Equal("a", indexWith.Columns.Single().Name);
+ Assert.Equal(new[] { "b", "c" }, indexWith.FindAnnotation(NpgsqlAnnotationNames.IndexInclude).Value);
+
+ var indexWithout = table.Indexes.Single(i => i.Name == "ix_without");
+ Assert.Equal(new[] { "a", "b", "c" }, indexWithout.Columns.Select(i => i.Name).ToArray());
+ Assert.Null(indexWithout.FindAnnotation(NpgsqlAnnotationNames.IndexInclude));
+
+ },
+ @"DROP TABLE ""IndexCovering""");
+ }
+
  [Fact]
  public void Comments()
  {

test/EFCore.PG.FunctionalTests/TestUtilities/NpgsqlTestStore.cs

@@ -416,6 +416,26 @@ private static DbCommand CreateCommand(
  return command;
  }
 
+ public Version GetPostgresVersion()
+ {
+ var opened = false;
+ if (Connection.State == ConnectionState.Closed)
+ {
+ Connection.Open();
+ opened = true;
+ }
+
+ try
+ {
+ return ((NpgsqlConnection)Connection).PostgreSqlVersion;
+ }
+ finally
+ {
+ if (opened)
+ Connection.Close();
+ }
+ }
+
  public override void Dispose()
  {
  base.Dispose();