キャッシング

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 (in SQL Server).

For details, see External Caching.

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

Cache Tolerance: The amount of time (in seconds) the cached data won't be updated by the provider. If this interval has expired, the cached data will be updated with new items from the data source (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.

C#	コードのコピー
static void LocalCache() { static string documentConnectionString = $"Data Model=Document;Uri='json_bookstore.json';Json Path='$.bookstore.books';Use Pool= false; Use Cache = true; Cache Location = ‘C:/Temp/Cache.db’"; Console.WriteLine("Query all Accounts..."); using (var con = new C1JsonConnection(documentConnectionString)) { con.Open(); var table = con.GetSchema("columns", new string[] { "books" }); ShowDataTable(table); var cmd = con.CreateCommand(); cmd.CommandText = "Select * From books"; var reader = cmd.ExecuteReader(); } } static void ShowDataTable(DataTable table, int length = 25) { foreach (DataColumn col in table.Columns) { Console.Write("{0,-" + length + "}", col.ColumnName); } Console.WriteLine(); foreach (DataRow row in table.Rows) { foreach (DataColumn col in table.Columns) { if (col.DataType.Equals(typeof(DateTime))) Console.Write("{0,-" + length + ":d}", row[col]); else if (col.DataType.Equals(typeof(decimal))) Console.Write("{0,-" + length + ":C}", row[col]); else Console.Write("{0,-" + length + "}", row[col]); } Console.WriteLine(); } }

コードのコピー

static void LocalCache()
{
    static string documentConnectionString = $"Data Model=Document;Uri='json_bookstore.json';Json Path='$.bookstore.books';Use Pool= false; Use Cache = true; Cache Location = ‘C:/Temp/Cache.db’";
        
    Console.WriteLine("Query all Accounts...");
    using (var con = new C1JsonConnection(documentConnectionString))
    {
        con.Open();

        var table = con.GetSchema("columns", new string[] { "books" });
        ShowDataTable(table);

        var cmd = con.CreateCommand();
        cmd.CommandText = "Select * From books";
        var reader = cmd.ExecuteReader();
    }
}       
static void ShowDataTable(DataTable table, int length = 25)
{
    foreach (DataColumn col in table.Columns)
    {
        Console.Write("{0,-" + length + "}", col.ColumnName);
    }
    Console.WriteLine();

    foreach (DataRow row in table.Rows)
    {
        foreach (DataColumn col in table.Columns)
        {
            if (col.DataType.Equals(typeof(DateTime)))
                Console.Write("{0,-" + length + ":d}", row[col]);
            else if (col.DataType.Equals(typeof(decimal)))
                Console.Write("{0,-" + length + ":C}", row[col]);
            else
                Console.Write("{0,-" + length + "}", row[col]);
        }
        Console.WriteLine();
    }
}

External Caching

The ADO.NET provider for JSON support 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 JSON 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.

Note: With SQL Server, Cache Provider = ‘Microsoft.Data.SqlClient’ is mandatory so you must create your own database as our cache doesn’t create new Database.

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

C#	コードのコピー
static void ExternalCache() { //明示的な MS SQL キャッシュ構成。 static string documentConnectionString = $"Data Model=Document;Uri='json_bookstore.json';Json Path='$.bookstore.books';Use Pool= false; Use Cache = true; Cache provider='Microsoft.Data.SqlClient'; Cache connection='Server= yourserverid; Database= databasename; User Id= yourId; Password= yourpassword;'"; Console.WriteLine("Query all Accounts..."); using (var con = new C1JsonConnection(documentConnectionString)) { con.Open(); var table = con.GetSchema("columns", new string[] { "books" }); ShowDataTable(table); var cmd = con.CreateCommand(); cmd.CommandText = "Select * From books"; var reader = cmd.ExecuteReader(); } } static void ShowDataTable(DataTable table, int length = 25) { foreach (DataColumn col in table.Columns) { Console.Write("{0,-" + length + "}", col.ColumnName); } Console.WriteLine(); foreach (DataRow row in table.Rows) { foreach (DataColumn col in table.Columns) { if (col.DataType.Equals(typeof(DateTime))) Console.Write("{0,-" + length + ":d}", row[col]); else if (col.DataType.Equals(typeof(decimal))) Console.Write("{0,-" + length + ":C}", row[col]); else Console.Write("{0,-" + length + "}", row[col]); } Console.WriteLine(); } }

コードのコピー

static void ExternalCache()
{
    //明示的な MS SQL キャッシュ構成。
    static string documentConnectionString = $"Data Model=Document;Uri='json_bookstore.json';Json Path='$.bookstore.books';Use Pool= false; Use Cache = true; 
                          Cache provider='Microsoft.Data.SqlClient'; Cache connection='Server= yourserverid; Database= databasename; User Id= yourId; Password= yourpassword;'";

   Console.WriteLine("Query all Accounts...");
   using (var con = new C1JsonConnection(documentConnectionString))
    {
        con.Open();

        var table = con.GetSchema("columns", new string[] { "books" });
        ShowDataTable(table);

        var cmd = con.CreateCommand();
        cmd.CommandText = "Select * From books";
        var reader = cmd.ExecuteReader();
    }
}     
static void ShowDataTable(DataTable table, int length = 25)
{
    foreach (DataColumn col in table.Columns)
    {
        Console.Write("{0,-" + length + "}", col.ColumnName);
    }
    Console.WriteLine();

    foreach (DataRow row in table.Rows)
    {
        foreach (DataColumn col in table.Columns)
        {
            if (col.DataType.Equals(typeof(DateTime)))
                Console.Write("{0,-" + length + ":d}", row[col]);
            else if (col.DataType.Equals(typeof(decimal)))
                Console.Write("{0,-" + length + ":C}", row[col]);
            else
                Console.Write("{0,-" + length + "}", row[col]);
        }
        Console.WriteLine();
    }
}