Caching data offers several advantages that can improve overall process performance, including reduced API requests and faster data access.

The DataConnector features an easy-to-use caching procedure, which can also be shared by multiple connections. This article is going to demonstrate the two types of caches that are currently supported:

• Default cache: An internally managed database (in SQLite).
• Specified cache: An externally managed database (for now in SQL Server).

To enable the caching feature, necessary connection properties are available, e.g.:

• Cache Tolerance: The duration during which the cached data is considered as not needing to be updated with a more recent version from the source database (default is 600 seconds).
• Cache Location: The location of the cache in the underlying file system (default is %AppData%/C1DataConnector).

Internal caching

The following code demonstrates how to enable caching for a table by setting the UseCache property to True (by default, it is set to False). The cached data is stored in the file specified by the CacheLocation property in the connection string. For more information on Incremental Caching, refer to this topic.

static void LocalCache()
{
    //接続文字列を定義します。
    string connectionString = $@"Url = {urlDynamics}; Use Pool = true; Use Cache = true; Cache Tolerance = 6; 
           Cache Location='C:\temp\c1cache.db'; OAuth Client Id = {clientID}; Username = {username}; Password = {password}; 
           OAuth Token Endpoint = {tokenEnpoint}; OAuth Extend Properties = {extendProperties}; Max Page Size = 100;";
           
    Console.WriteLine("Start Time: " + DateTime.Now);

    using (var conn = new C1D365SConnection(connectionString))
    {
        conn.Open();
        var cmd = new C1D365SCommand(conn, "SELECT accountid, Name FROM Accounts LIMIT 12'");
        var reader = cmd.ExecuteReader();
        while (reader.Read())
        {
            Console.WriteLine("Read and cached the row with AccountId " + reader["AccountId"]);
        }
    }

    Console.WriteLine("End Time: " + DateTime.Now);
}

External caching

The ADO.NET provider for Dynamics 365 Sales supports external caching, allowing users to store cached data in a separate database. This external database serves as a constant repository and can be accessed by multiple connection objects simultaneously. It includes all tables exposed by the Dynamics 365 Sales provider and offers configuration options specific to the cache provider.

To utilize external caching, the provider supports a specified cache, such as SQL Server. You can specify the connection string using the UseCache, CacheProvider, and CacheConnection keys to enable external caching.

The following code example implements external caching, by setting Use Cache to True, and using 'Microsoft.Data.SqlClient' as the cache provider.

static void ExternalCache()
{
    // 明示的な MS SQL キャッシュ構成。
    string connectionString = $@"Url = {urlDynamics}; Use Cache = true; Cache provider = 'Microsoft.Data.SqlClient'; 
                        Cache connection = 'Server=yourserverid;Database=databasename;User Id=yourId;Password=yourpassword;' 
                        OAuth Client Id = {clientID}; Username = {username}; Password = {password}; OAuth Token Endpoint = {tokenEnpoint}; OAuth Extend Properties = {extendProperties}; Max Page Size = 100;";

    Console.WriteLine("Start Time: " + DateTime.Now);

    using (var con = new C1D365SConnection(connectionString))
    {
        con.Open();

        var cmd = new C1D365SCommand(connection,"SELECT accountid, Name FROM Accounts LIMIT 12");

        var rdr = cmd.ExecuteReader();
        while (rdr.Read())
        {
            Console.WriteLine("Read and cached the row with AccountId " + rdr["AccountId"]);
        }
    }

    Console.WriteLine("End Time: " + DateTime.Now);
}