DataConnector | ComponentOne
ADO.NET provider for JSON / Caching
In This Topic
    Caching
    In This Topic

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

    The ADO.NET provider features an easy-to-use caching procedure that can also be shared by multiple connections. This article demonstrates the two types of caches that are currently supported:

    To enable the caching feature, necessary connection properties are available, such as:

    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#
    Copy Code 
    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 database as our cache doesn’t create a 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#
    Copy Code 
    static void ExternalCache()
{
    //Explicit MS SQL Cache Config
    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();
    }
}