Skip to content

Document EF Core 11 indexing enhancements#5380

Merged
AndriySvyryd merged 3 commits into
preview.6from
copilot/add-documentation-and-whats-new
Jun 10, 2026
Merged

Document EF Core 11 indexing enhancements#5380
AndriySvyryd merged 3 commits into
preview.6from
copilot/add-documentation-and-whats-new

Conversation

Copilot AI commented Jun 9, 2026

Copy link
Copy Markdown
Contributor

Adds documentation for EF Core 11 indexing changes from recent EF Core work: complex-property keys/indexes, SQL Server JSON indexes, and expanded Cosmos indexing policy support.

  • Complex type keys and indexes

    • Documented keys and indexes over scalar properties nested in complex types.
    • Added guidance for string-based paths and complex collection index paths.
  • SQL Server JSON indexes

    • Added provider documentation for JSON indexes over JSON-mapped complex types.
    • Mentioned scaffolding/migrations behavior and array path limitations.
  • Cosmos indexing policy

    • Documented HasAutomaticIndexing, indexing exclusions, explicit indexes, and complex collection paths.
  • What’s New

    • Added EF Core 11 entries linking to the detailed documentation.

Example:

modelBuilder.Entity<Customer>()
    .HasIndex("Contact.Address.City");

modelBuilder.Entity<Order>()
    .HasIndex(o => o.Items.Select(i => i.Sku));

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds EF Core 11 documentation for new indexing-related capabilities across complex types, SQL Server JSON indexes, and expanded Cosmos DB indexing policy support, and surfaces these additions in the EF Core 11 “What’s New” page.

Changes:

  • Documented keys and indexes over scalar properties inside complex (non-collection) types, including string-path configuration and complex collection path syntax.
  • Added SQL Server provider guidance for creating/scaffolding JSON indexes over JSON-mapped complex types.
  • Added Cosmos provider documentation for indexing policy emission/configuration, including automatic indexing control and path exclusions.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
entity-framework/core/what-is-new/ef-core-11.0/whatsnew.md Adds EF Core 11 release-note entries for complex-type keys/indexes, SQL Server JSON indexes, and Cosmos indexing policy with links to detailed docs.
entity-framework/core/providers/sql-server/index.md Introduces a new section documenting SQL Server JSON indexes and related configuration examples.
entity-framework/core/providers/cosmos/modeling.md Adds a new “Indexing policy” section describing Cosmos indexing policy configuration and complex-path indexing.
entity-framework/core/modeling/keys.md Documents key configuration over scalar properties nested in complex types, including string-based paths and limitations.
entity-framework/core/modeling/indexes.md Documents indexing over complex type properties (including JSON/collection paths) and complex-type included columns for SQL Server.

Comment thread entity-framework/core/providers/sql-server/index.md

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

Comment thread entity-framework/core/providers/sql-server/index.md
Comment thread entity-framework/core/modeling/indexes.md
Comment thread entity-framework/core/providers/cosmos/modeling.md Outdated
…dex, remove redundant HasAutomaticIndexing(false)
.Except("/InternalNotes/?");
```

To index only explicitly configured paths, disable automatic indexing and configure indexes with `HasIndex`:

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@copilot Explain that automatic indexing is disabled automatically in this case

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated the sentence to clarify that automatic indexing is disabled automatically as soon as any single-property index is defined, so calling HasAutomaticIndexing(false) explicitly is unnecessary.

@AndriySvyryd AndriySvyryd marked this pull request as ready for review June 10, 2026 01:19
@AndriySvyryd AndriySvyryd requested a review from SamMonoRT June 10, 2026 01:20
@AndriySvyryd AndriySvyryd merged commit c742ccc into preview.6 Jun 10, 2026
3 checks passed
@AndriySvyryd AndriySvyryd deleted the copilot/add-documentation-and-whats-new branch June 10, 2026 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants