Entity Framework (EF) Caching Configuration File
This feature is only available in NCache Enterprise Edition.
This file is located at
%NCHOME%/config in Windows or
opt\ncache\config in Linux.
Entity Framework Caching Config file, efcaching.ncconf configuration contains cache and caching policy related information used by NCache Entity Framework caching provider. Some changes are required in efcaching.ncconf to run the Entity Framework application with NCache.
You can configure the following through efcaching.ncconf:
- EF integration modes
- Database synchronization
- Cache item expiration
<configuration> <app-config app-id="EFCachingDemo" mode="analysis|caching"> <analysis-policy log-path="" analysis-time="1min" cache-enable-threshold="1" default-expiration-type="Sliding" default-expiration-time="180sec" dbsyncdependency="false"/> <cache-policy-configuration database="none|sqlserver|oracle" cache-id="mycache"> <!--sql-query = "SELECT [Extent1].[CustomerID] AS [CustomerID],= @param_0"--> <query> <cache-query querytext="SELECT [Extent1].[OrderID] AS [OrderID], < @param_0"/> <cache-policy vary-by-cache-param="param_0" expiration-type="Sliding" enabled="True" expiration-time="180sec" dbsyncdependency="False"> </query> </cache-policy-configuration> </app-config> </configuration>
||This ID is same as defined in app/web configuration file of application.|
||NCache Entity Framework Caching provider works under two modes. It can either be in "Caching" or in "Analysis" mode.
Analysis Mode is used for monitoring the number of times each query executes and then it generates a report. Report contains the query text and the call count for each query. No caching is done at this mode.
||Query attribute including user-configurable list of queries that should be cached with their results. A particular query can be configured with its cache policy defined in cache policy tag. Cache query and Cache policy are separated by dedicated tags. User can easily change policies from cache-policy tag without facing any XML parsing error.|
||For cache query, this tag is auto generated by Entity Framework Caching Provider when the application is running in analysis mode. For ease of understanding, commented SQL-query tag is added so that the user can read the query.
||When mode is selected as Caching, only those query results will be cached for which caching is enabled. The user can also specify caching policies for all queries.
A sample query with parameters:
SQL Dependency will be registered only for those SQL queries that satisfy all the conditions for SQL Notification Registration as described in the Microsoft documentation.
InProc client cache stores items in object form, therefore if object is modified by the application, it should be updated back to the cache so that other remote clustered cache and other client caches have no data integrity issue.