DataStoreDataExtensions.ImportJson(this IDataStoreBase dataStore, string text, DwBuffer dwbuffer, int startRow, int endRow, int startColumn, int endColumn) Method

.NET Standard 2.x

Inserts data from a JSON string into the specified buffer of DataStore. You can specify the starting and ending positions in the JSON array, and you can specify the number of the first key value and the number of the last key value in the JSON object to be imported. Data that are out of this range will not be imported into the DataStore.

Namespace: DWNet.Data

Assembly: DWNet.Data.dll

Syntax

   public static int ImportJson(this IDataStoreBase dataStore, string text, DwBuffer dwbuffer, int startRow, int endRow, int startColumn, int endColumn);

Parameters

text System.String

A string specifying the JSON data.

The JSON string must comply with the plain-format JSON or DataWindow JSON.

dwbuffer DWNet.Data.DwBuffer

The specified buffer of the DataStore.

A value of the DwBuffer enumerated datatype identifying the DataWindow buffer into which you want to import the data.

For plain-format JSON: Imports the JSON data to the specified buffer.

For DataWindow JSON: Imports data from the specified buffer from the JSON string to the corresponding buffer.

startRow System.Int32

The zero-based number of the first detail object in the JSON array that you want to import. If it is negative, 0 is used.

endRow System.Int32

The zero-based number of the last detail object in the JSON array that you want to import. If it is negative, it indicates the rest of rows.

startColumn System.Int32

The zero-based number of the first key value in the JSON object that you want to import. If it is negative, 0 is used.

endColumn System.Int32

The zero-based number of the last key value in the JSON object that you want to import. If it is negative, it indicates the rest of columns.

Returns

System.Int32

Returns the number of rows that were imported if it succeeds.

Examples

The following code example demonstrates how to import the department data from a range of rows and a range of columns in a JSON string to the specified buffer.

using DWNet.Data;
using System;
using System.IO;

namespace Appeon.ApiDoc.DataStoreDataExtensionsExamples
{
    public class ImportJsonExample
    {
        private readonly SchoolContext _context;

        public ImportJsonExample(SchoolContext dataContext)
        {
            // Sets the data context
            _context = dataContext;
        }

        public void Example6()
        {
            // Instantiates the datastore with datawindow: d_department2.
            // d_department2 has no departmentID column
            var datastore = new DataStore("d_department2", _context);

            // Gets the JSON file. ImportJson8.json contains 4 records.
            string path = Path.Combine(AppContext.BaseDirectory,
                                @"Jsons\IDatastore\ImportJson8.json");
            string json = File.ReadAllText(path);

            // Imports data from JSON to the DataStore primary buffer
            // from the first row through the end.
            // Imports data starting from the second column and imports only one column, 
            // so only the second column is imported.
            datastore.ImportJson(json, DwBuffer.Primary, 0, 3, 1, 1);

            Console.WriteLine("Rowcount:{0}", datastore.RowCount);

            for (int row = 0, rowcount = datastore.RowCount; row < rowcount; row++)
            {
                Console.WriteLine("Name:{0}; Budget:{1}",
                                  datastore.GetItem<string>(row, "name"),
                                  datastore.GetItem<decimal>(row, "budget"));
            }

            datastore.Reset();

            // Imports data from the second and third rows of the JSON string to the primary buffer
            // Imports data starting from the second column and imports only one column. 
            // So the first column will not be imported, and only the second column is imported.
            datastore.ImportJson(json, DwBuffer.Primary, 1, 2, 1, 1);

            Console.WriteLine("Rowcount: {0}", datastore.RowCount);

            for (int row = 0, rowcount = datastore.RowCount; row < rowcount; row++)
            {
                Console.WriteLine("Name: {0}; Budget: {1}",
                                  datastore.GetItem<string>(row, "name"),
                                  datastore.GetItem<decimal>(row, "budget"));
            }

            /*This code produces the following output:

            Rowcount: 4
            Name: Engineering; Budget: 0
            Name: English; Budget: 0
            Name: Economics; Budget: 0
            Name: Mathematics; Budget: 0
            Rowcount: 2
            Name: English; Budget: 0
            Name: Economics; Budget: 0
           */
        }
    }
}

Example Refer To

Model Class: D_Department2
JSON File: ImportJson8
DataWindow File: d_department2

Applies to

.NET Standard

2.x