Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Sep 26, 2025

Summary

This PR adds comprehensive documentation for EF Core's memory caching configuration options, specifically EnableServiceProviderCaching and UseMemoryCache. The documentation explains where these features are used, what the defaults are, and when to customize them.

What's Documented

EnableServiceProviderCaching

  • Purpose: Controls whether EF Core caches internal service providers for improved performance
  • Default behavior: Enabled by default (true) - service providers are cached and reused across DbContext instances with the same configuration
  • When to disable: For testing environments to ensure each test gets a fresh service provider when DbContext configurations change test-to-test
  • Performance impact: Better performance and lower memory overhead for applications that create many DbContext instances

UseMemoryCache / Memory Cache Integration

  • Purpose: Configures the IMemoryCache used by EF Core for internal caching operations like query compilation and model building
  • Default configuration: EF Core automatically configures IMemoryCache with a default size limit of 10240
  • Cache sizing: Compiled queries have a cache size of 10, built models have a cache size of 100
  • Customization: Call AddMemoryCache if you need to change the default size limits
  • Clarification: IMemoryCache is not used for internal service provider caching (separate feature)

Documentation Changes

Updated Files

  • entity-framework/core/dbcontext-configuration/index.md
    • Added both EnableServiceProviderCaching and UseMemoryCache to the DbContext configuration options table
    • Created new ## EnableServiceProviderCaching section with complete explanation of service provider caching
    • Created new ## Memory Cache Integration section explaining IMemoryCache configuration
    • Included code examples for both ASP.NET Core DI scenarios
    • All content passes markdown linting rules

Documentation Structure

  • Two main sections at ## heading level for clear organization
  • Configuration options table updated with links to both sections
  • Focused, accurate technical content based on reviewer feedback
  • Clean formatting with proper list handling and paragraph flow

Key Technical Details

  • Service provider caching is enabled by default (important for developers to know)
  • Default memory cache size limit is 10240
  • Memory cache and service provider caching are separate, independent features
  • Proper guidance on when to customize each setting

Fixes #4855

Original prompt

This section details on the original issue you should resolve

<issue_title>Document UseMemoryCache</issue_title>
<issue_description>Explain where it's used and what are the defaults</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #4855

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits September 26, 2025 20:21
Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>
Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>
Copilot AI changed the title [WIP] Document UseMemoryCache Document UseMemoryCache and service provider caching in EF Core Sep 26, 2025
Copilot AI requested a review from AndriySvyryd September 26, 2025 20:25
Copilot finished work on behalf of AndriySvyryd September 26, 2025 20:25
Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>
Copilot AI changed the title Document UseMemoryCache and service provider caching in EF Core Document EnableServiceProviderCaching and IMemoryCache configuration in EF Core Sep 27, 2025
Copilot AI requested a review from AndriySvyryd September 27, 2025 00:53
Copilot finished work on behalf of AndriySvyryd September 27, 2025 00:53
Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>
Copilot AI changed the title Document EnableServiceProviderCaching and IMemoryCache configuration in EF Core Document EnableServiceProviderCaching and UseMemoryCache configuration in EF Core Sep 27, 2025
Copilot AI requested a review from AndriySvyryd September 27, 2025 02:01
Copilot finished work on behalf of AndriySvyryd September 27, 2025 02:01
Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>
Copilot AI requested a review from AndriySvyryd September 27, 2025 02:09
Copilot finished work on behalf of AndriySvyryd September 27, 2025 02:09
…arios

Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>
Copilot finished work on behalf of AndriySvyryd September 29, 2025 21:14
Copilot AI requested a review from AndriySvyryd September 29, 2025 21:14
@AndriySvyryd
Copy link
Member

@copilot Update the PR description with a summary of the changes

Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Sep 29, 2025

@copilot Update the PR description with a summary of the changes

Updated the PR description with a comprehensive summary of the changes, including what was documented, the technical details, and the documentation structure.

- Better performance for applications that create many `DbContext` instances
- Lower memory overhead when multiple contexts share configurations

**When to disable caching**: You might want to disable service provider caching (`false`) for testing environments to ensure each test gets a fresh service provider, or when `DbContext` configurations change dynamically at runtime.
Copy link
Member

Choose a reason for hiding this comment

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

@copilot

Suggested change
**When to disable caching**: You might want to disable service provider caching (`false`) for testing environments to ensure each test gets a fresh service provider, or when `DbContext` configurations change dynamically at runtime.
**When to disable caching**: You might want to disable service provider caching (`false`) for testing environments to ensure each test gets a fresh service provider when `DbContext` configurations change test-to-test.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Updated the guidance in commit 705ef58 to focus on testing environments where DbContext configurations change test-to-test.

@AndriySvyryd AndriySvyryd marked this pull request as ready for review September 29, 2025 22:47
Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>
Copilot AI requested a review from AndriySvyryd September 29, 2025 22:49
Copilot finished work on behalf of AndriySvyryd September 29, 2025 22:49
Co-authored-by: AndriySvyryd <6539701+AndriySvyryd@users.noreply.github.com>
Copilot finished work on behalf of AndriySvyryd September 30, 2025 19:25
Copilot AI requested a review from AndriySvyryd September 30, 2025 19:25
services.AddDbContext<ApplicationDbContext>(options =>
options
.UseSqlServer(connectionString)
.EnableServiceProviderCaching(true)); // Default, but shown for clarity
Copy link
Member

Choose a reason for hiding this comment

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

This is a duplicate snippet of the one shown just above, but with true instead of false. It's also out of context - the true snippet is shown right after the sentence about how to disable caching (the opposite).


Using dependency injection, this can be achieved by either registering the context as scoped, and creating scopes (using `IServiceScopeFactory`) for each thread, or by registering the `DbContext` as transient (using the overload of `AddDbContext` which takes a `ServiceLifetime` parameter).

## EnableServiceProviderCaching
Copy link
Member

Choose a reason for hiding this comment

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

I'm conflicted about this sort of documentation. Yes, we have EnableServiceProviderCaching() as a public API, but this is something that I think we'd never recommend users ever actually use

So I'm not sure whether (and why) we should actually be documenting this - it runs the risk of pushing people towards an API they shouldn't use, it makes this doc page less useful (since it gets bloated with a non-useful API), and it creates more work for us (writing/reviewing the docs).

If we believe there are legitimate reasons for users to use this (I'm not really aware of any), then these should be documented here. There's just one sentence below: "for testing environments to ensure each test gets a fresh service provider when DbContext configurations change test-to-test", but I'm unclear as to when users would actually run into this: most settings don't require a different service provider, and those that do generally should be singleton options, so a new service provider is created anyway.

public void ConfigureServices(IServiceCollection services)
{
services.AddMemoryCache(options =>
{
Copy link
Member

Choose a reason for hiding this comment

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

nit: remove unneeded curlies

}
```

## Memory Cache Integration
Copy link
Member

Choose a reason for hiding this comment

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

This feels like it belongs in the advanced performance topics page, not here. We should ideally be documenting by concern (modeling, performance, querying...).

@cincuranet cincuranet changed the base branch from live to main October 30, 2025 18:52
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.

Document UseMemoryCache

3 participants