diff --git a/ej2-asp-core-mvc/grid/EJ2_ASP.NETCORE/connecting-to-database/sqlite-server.md b/ej2-asp-core-mvc/grid/EJ2_ASP.NETCORE/connecting-to-database/sqlite-server.md new file mode 100644 index 0000000000..00878a7244 --- /dev/null +++ b/ej2-asp-core-mvc/grid/EJ2_ASP.NETCORE/connecting-to-database/sqlite-server.md @@ -0,0 +1,1818 @@ +--- +layout: post +title: Bind SQLite Server Data in Syncfusion ##Platform_Name## Grid +description: Learn how to consume data from SQLite Server, bind it to Syncfusion ##Platform_Name## Grid, and perform CRUD operations. +control: grid +platform: ej2-asp-core-mvc +keywords: adaptors, customadaptor, urladaptor, sqlite, remotedata +documentation: ug +domainurl: ##DomainURL## +--- + +# Connecting SQLite Server data to Syncfusion ASP.NET Core Grid + +This section describes how to connect and retrieve data from a SQLite Server database using [Microsoft.Data.Sqlite](https://www.nuget.org/packages/Microsoft.Data.Sqlite) and bind it to the Syncfusion ASP.NET Core Grid. + +SQLite Server database can be bound to the Grid in different ways (i.e.) using [dataSource](https://help.syncfusion.com/cr/aspnetcore-js2/syncfusion.ej2.grids.grid.html#Syncfusion_EJ2_Grids_Grid_DataSource) property, custom adaptor and remote data binding using various adaptors. In this documentation, two approaches will be examined to connect a SQLite Server database to a Grid. Both the approaches have capability to handle data and CRUD operations with built-in methods as well as can be customized as per your own. + +* **Using UrlAdaptor** + +The [UrlAdaptor](https://ej2.syncfusion.com/aspnetcore/documentation/grid/connecting-to-adaptors/url-adaptor) serves as the base adaptor for facilitating communication between remote data services and an UI component. It enables the remote binding of data to the Syncfusion ASP.NET Core Grid by connecting to an existing pre-configured API service linked to the SQLite Server database. While the Grid supports various adaptors to fulfill this requirement, including [Web API](https://ej2.syncfusion.com/aspnetcore/documentation/grid/connecting-to-adaptors/web-api-adaptor), [ODataV4](https://ej2.syncfusion.com/aspnetcore/documentation/grid/connecting-to-adaptors/odatav4-adaptor), [UrlAdaptor](https://ej2.syncfusion.com/aspnetcore/documentation/grid/connecting-to-adaptors/url-adaptor), and `GraphQL`, the `UrlAdaptor` is particularly useful for the scenarios where a custom API service with unique logic for handling data and CRUD operations is in place. This approach allows for custom handling of data and CRUD operations, and the resultant data returned in the `result` and `count` format for display in the Grid. + +* **Using CustomAdaptor** + +The [CustomAdaptor](https://ej2.syncfusion.com/aspnetcore/documentation/grid/connecting-to-adaptors/custom-adaptor) serves as a mediator between the UI component and the database for data binding. While the data source from the database can be directly bound to the Syncfusion ASP.NET Core Grid locally using the `dataSource` property, the `CustomAdaptor` approach is preferred as it allows for customization of both data operations and CRUD operations according to specific requirements. In this approach, for every action in the Grid, a corresponding request with action details is sent to the `CustomAdaptor`. The Grid provides predefined methods to perform data operations such as **searching**, **filtering**, **sorting**, **aggregation**, **paging** and **grouping**. Alternatively, your own custom methods can be employed to execute operations and return the data in the `result` and `count` format for displaying in the Grid. Additionally, for CRUD operations, predefined methods can be overridden to provide custom functionality. Further details on this can be found in the latter part of the documentation. + +## Binding data from SQLite Server using an API service + +This section describes step by step process how to retrieve data from a SQLite Server using an API service and bind it to the Grid. + +### Creating an API service + +**Step 1:** Open Visual Studio and create an ASP.NET Core project named **Grid_SQLite**. To create an ASP.NET Core application, follow the documentation [link](https://learn.microsoft.com/en-us/aspnet/core/tutorials/razor-pages/razor-pages-start?view=aspnetcore-8.0&tabs=visual-studio#create-a-razor-pages-web-app) for detailed steps. + +**2.** To connect a SQLite Server database using the SQLite driver in your application, you need to install the [Microsoft.Data.Sqlite](https://www.nuget.org/packages/Microsoft.Data.Sqlite/) NuGet package. To add **Microsoft.Data.Sqlite** in the app, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search and install it. + +**3.** Create an API controller (aka, GridController.cs) file under **Controllers** folder that helps to establish data communication with the Grid. + +**4.** In an API controller (aka, GridController), connect to SQLite Server. In the **GetOrderData()** method **SqliteConnection** helps to connect the SQLite Server database. Next, the **SqliteCommand** is used to retrieve the desired collection from the database. Then populate the data collection from the **SqliteCommand** into a list using the **Read** method of **SqliteDataReader** as shown in the following code snippet. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +using Microsoft.AspNetCore.Mvc; +using System.ComponentModel.DataAnnotations; +using System.Data; +using Syncfusion.EJ2.Base; +using Microsoft.Data.Sqlite; + +namespace Grid_SQLite.Server.Controllers +{ + [ApiController] + public class GridController : ControllerBase + { + string ConnectionString = @""; + + /// + /// Processes the DataManager request to perform searching, filtering, sorting, and paging operations. + /// + /// Contains the details of the data operation requested. + /// Returns a JSON object along with the total record count. + [HttpPost] + [Route("api/[controller]")] + public object Post([FromBody] DataManagerRequest DataManagerRequest) + { + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = GetOrderData().AsQueryable(); + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return new { result = DataSource, count = totalRecordsCount }; + } + + /// + /// Retrieves the order data from the database. + /// + /// Returns a list of orders fetched from the database. + [HttpGet] + [Route("api/[controller]")] + public List GetOrderData() + { + // SQL query to fetch all records from the orders table and sort them by OrderID. + string queryStr = "SELECT * FROM Orders ORDER BY OrderID;"; + + // Creates an empty list to store the retrieved orders from the database. + List DataSource = new List(); + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to enable SQL queries. + Connection.Open(); + + //Using SqliteCommand and query create connection with database. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + // Execute the SQLite command and retrieve data using SqliteDataReader. + using (SqliteDataReader reader = Command.ExecuteReader()) + { + while (reader.Read()) + { + Orders order = new Orders + { + OrderID = reader.GetInt32(reader.GetOrdinal("OrderID")), + CustomerID = reader.GetString(reader.GetOrdinal("CustomerID")), + EmployeeID = reader.GetInt32(reader.GetOrdinal("EmployeeID")), + ShipCity = reader.GetString(reader.GetOrdinal("ShipCity")), + Freight = reader.GetDecimal(reader.GetOrdinal("Freight")) + }; + DataSource.Add(order); + } + } + return DataSource; + } + + public class Orders + { + [Key] + public int? OrderID { get; set; } + public string? CustomerID { get; set; } + public int? EmployeeID { get; set; } + public decimal? Freight { get; set; } + public string? ShipCity { get; set; } + } + } +} + +{% endhighlight %} +{% endtabs %} + +**5.** Run the application and it will be hosted within the URL `https://localhost:xxxx`. + +**6.** Finally, the retrieved data from SQLite Server database which is in the form of list can be found in an API controller available in the URL link `https://localhost:xxxx/api/Grid`, as shown in the browser page below. + +![Hosted API URL](../images/Ms-Sql-data.png) + +### Connecting Syncfusion ASP.NET Core Grid to an API service + +To integrate the Syncfusion ASP.NET Core Grid into your ASP.NET Core and ASP.NET Core project using Visual Studio, follow the below steps: + +**Step 1: Install the Syncfusion ASP.NET Core Package:** + +To add `ASP.NET Core` in the application, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search for [Syncfusion.EJ2.AspNet.Core](https://www.nuget.org/packages/Syncfusion.EJ2.AspNet.Core) and install it. +Alternatively, you can install it using the following Package Manager Console command: + +{% tabs %} +{% highlight C# tabtitle="Package Manager" %} + +Install-Package Syncfusion.EJ2.AspNet.Core -Version {{ site.releaseversion }} + +{% endhighlight %} +{% endtabs %} + +**Step 2: Add Syncfusion ASP.NET Core Tag Helper** + +Open `~/Pages/_ViewImports.cshtml` file and import the `Syncfusion.EJ2` TagHelper. + +{% tabs %} +{% highlight C# tabtitle="~/_ViewImports.cshtml" %} + +@addTagHelper *, Syncfusion.EJ2 + +{% endhighlight %} +{% endtabs %} + +**Step 3: Add Stylesheets and Script Resources** + +To include the required styles and scripts, add the following references inside the `` of `~/Pages/Shared/_Layout.cshtml` file: + +{% tabs %} +{% highlight cshtml tabtitle="~/_Layout.cshtml" %} + + + ... + + + + + + +{% endhighlight %} +{% endtabs %} + +**Step 4: Register Syncfusion Script Manager:** + +To ensure proper script execution, register the Syncfusion Script Manager `` at the end of the `` tag in your ASP.NET Core application as follows: + +{% tabs %} +{% highlight cshtml tabtitle="~/_Layout.cshtml" %} + + + ... + + + + +{% endhighlight %} +{% endtabs %} + +**Step 5:** Configure the server: + +In the `Program.cs` file of your project, configure the server to serve static file and handle API requests by adding the following code: + +```cs +builder.Services.AddControllers(); +var app = builder.Build(); +app.MapControllers(); +``` + +**Step 7:** In your **~/Pages/Index.cshtml** file, create an `` element or a `DataManager` instance specifying the URL of your API endpoint (https://localhost:xxxx/api/Grid) using the `url` property and set the `adaptor` to **UrlAdaptor**. + +**Step 8:** The `DataManager` offers multiple adaptor options to connect with remote database based on an API service. Below is an example of the `UrlAdaptor` configuration where an API service are set up to return the resulting data in the `result` and `count` format. + +**Step 9:** The `UrlAdaptor` acts as the base adaptor for interacting with remote data service. Most of the built-in adaptors are derived from the `UrlAdaptor`. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +using Microsoft.AspNetCore.Mvc; +using System.ComponentModel.DataAnnotations; +using System.Data; +using Syncfusion.EJ2.Base; +using Microsoft.Data.Sqlite; + +namespace Grid_SQLite.Server.Controllers +{ + [ApiController] + public class GridController : ControllerBase + { + string ConnectionString = @""; + + /// + /// Processes the DataManager request to perform searching, filtering, sorting, and paging operations. + /// + /// Contains the details of the data operation requested. + /// Returns a JSON object along with the total record count. + [HttpPost] + [Route("api/[controller]")] + public object Post([FromBody] DataManagerRequest DataManagerRequest) + { + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = GetOrderData().AsQueryable(); + + // Return data based on the request. + return new { result = DataSource, count = totalRecordsCount }; + } + + /// + /// Retrieves the order data from the database. + /// + /// Returns a list of orders fetched from the database. + [HttpGet] + [Route("api/[controller]")] + public List GetOrderData() + { + // SQL query to fetch all records from the orders table and sort them by OrderID. + string queryStr = "SELECT * FROM Orders ORDER BY OrderID;"; + + // Creates an empty list to store the retrieved orders from the database. + List DataSource = new List(); + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to enable SQL queries. + Connection.Open(); + + //Using SqliteCommand and query create connection with database. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + // Execute the SQLite command and retrieve data using SqliteDataReader. + using (SqliteDataReader reader = Command.ExecuteReader()) + { + while (reader.Read()) + { + Orders order = new Orders + { + OrderID = reader.GetInt32(reader.GetOrdinal("OrderID")), + CustomerID = reader.GetString(reader.GetOrdinal("CustomerID")), + EmployeeID = reader.GetInt32(reader.GetOrdinal("EmployeeID")), + ShipCity = reader.GetString(reader.GetOrdinal("ShipCity")), + Freight = reader.GetDecimal(reader.GetOrdinal("Freight")) + }; + DataSource.Add(order); + } + } + return DataSource; + } + + public class Orders + { + [Key] + public int? OrderID { get; set; } + public string? CustomerID { get; set; } + public int? EmployeeID { get; set; } + public decimal? Freight { get; set; } + public string? ShipCity { get; set; } + } + } +} + +{% endhighlight %} +{% endtabs %} + + +> Replace https://localhost:xxxx/api/Grid with the actual **URL** of your API endpoint that provides the data in a consumable format (e.g., JSON). + +**Step 10:** Run the application in Visual Studio. It will be accessible via a URL like **https://localhost:xxxx**. + +> * The Syncfusion ASP.NET Core Grid provides built-in support for handling various data operations such as searching, sorting, filtering, aggregate and paging on the server-side. These operations can be handled using methods such as `PerformSearching`, `PerformFiltering`, `PerformSorting`, `PerformTake` and `PerformSkip` available in the [Syncfusion.EJ2.AspNet.Core](https://www.nuget.org/packages/Syncfusion.EJ2.AspNet.Core/) package. Let’s explore how to manage these data operations using the `UrlAdaptor`. +> * In an API service project, add `Syncfusion.EJ2.AspNet.Core` by opening the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search and install it. +> * To access `DataManagerRequest` and `QueryableOperation`, import `Syncfusion.EJ2.Base` in `GridController.cs` file. + +### Handling searching operation + +To handle searching operation, ensure that your API endpoint supports custom searching criteria. Implement the searching logic on the server-side using the `PerformSearching` method from the `QueryableOperation` class. This allows the custom data source to undergo searching based on the criteria specified in the incoming `DataManagerRequest` object. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform searching operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the searched data along with the total record count. +[HttpPost] +[Route("api/[controller]")] +public object Post([FromBody] DataManagerRequest DataManagerRequest) +{ + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = GetOrderData().AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling searching operation. + if (DataManagerRequest.Search != null && DataManagerRequest.Search.Count > 0) + { + DataSource = queryableOperation.PerformSearching(DataSource, DataManagerRequest.Search); + //Add custom logic here if needed and remove above method. + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return new { result = DataSource, count = totalRecordsCount }; +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + +{% endhighlight %} +{% endtabs %} + +### Handling filtering operation + +To handle filtering operation, ensure that your API endpoint supports custom filtering criteria. Implement the filtering logic on the server-side using the `PerformFiltering` method from the `QueryableOperation` class. This allows the custom data source to undergo filtering based on the criteria specified in the incoming `DataManagerRequest` object. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform filtering operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the filtered data along with the total record count. +[HttpPost] +[Route("api/[controller]")] +public object Post([FromBody] DataManagerRequest DataManagerRequest) +{ + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = GetOrderData().AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling filtering operation. + if (DataManagerRequest.Where != null && DataManagerRequest.Where.Count > 0) + { + foreach (WhereFilter condition in DataManagerRequest.Where) + { + foreach (WhereFilter predicate in condition.predicates) + { + DataSource = queryableOperation.PerformFiltering(DataSource, DataManagerRequest.Where, predicate.Operator); + //Add custom logic here if needed and remove above method. + } + } + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return new { result = DataSource, count = totalRecordsCount }; +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + +{% endhighlight %} +{% endtabs %} + +### Handling sorting operation + +To handle sorting operation, ensure that your API endpoint supports custom sorting criteria. Implement the sorting logic on the server-side using the `PerformSorting` method from the `QueryableOperation` class. This allows the custom data source to undergo sorting based on the criteria specified in the incoming `DataManagerRequest` object. + + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform sorting operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the sorted data along with the total record count. +[HttpPost] +[Route("api/[controller]")] +public object Post([FromBody] DataManagerRequest DataManagerRequest) +{ + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = GetOrderData().AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling sorting operation. + if (DataManagerRequest.Sorted != null && DataManagerRequest.Sorted.Count > 0) + { + DataSource = queryableOperation.PerformSorting(DataSource, DataManagerRequest.Sorted); + //Add custom logic here if needed and remove above method. + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return new { result = DataSource, count = totalRecordsCount }; +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + +{% endhighlight %} +{% endtabs %} + +### Handling paging operation + +To handle paging operation, ensure that your API endpoint supports custom paging criteria. Implement the paging logic on the server-side using the `PerformTake` and `PerformSkip`method from the `QueryableOperation` class. This allows the custom data source to undergo paging based on the criteria specified in the incoming `DataManagerRequest` object. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform paging operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the paginated data along with the total record count. +[HttpPost] +[Route("api/[controller]")] +public object Post([FromBody] DataManagerRequest DataManagerRequest) +{ + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = GetOrderData().AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Handling paging operation. + if (DataManagerRequest.Skip != 0) + { + DataSource = queryableOperation.PerformSkip(DataSource, DataManagerRequest.Skip); + //Add custom logic here if needed and remove above method. + } + if (DataManagerRequest.Take != 0) + { + DataSource = queryableOperation.PerformTake(DataSource, DataManagerRequest.Take); + //Add custom logic here if needed and remove above method. + } + + // Return data based on the request. + return new { result = DataSource, count = totalRecordsCount }; +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + +{% endhighlight %} +{% endtabs %} + +### Handling CRUD operations + +The Syncfusion ASP.NET Core Grid seamlessly integrates CRUD (Create, Read, Update, and Delete) operations with server-side controller actions through specific properties: `insertUrl`, `removeUrl`, `updateUrl` and `batchUrl`. These properties enable the Grid to communicate with the data service for every Grid action, facilitating server-side operations. + +**CRUD Operations Mapping** + +CRUD operations within the Grid can be mapped to server-side controller actions using specific properties: + +1. **insertUrl**: Specifies the URL for inserting new data. +2. **removeUrl**: Specifies the URL for removing existing data. +3. **updateUrl**: Specifies the URL for updating existing data. +4. **batchUrl**: Specifies the URL for batch editing. + +To enable editing in Grid, refer to the editing [documentation](https://ej2.syncfusion.com/aspnetcore/documentation/grid/editing/edit). In the below example, the inline edit [mode](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusion.EJ2.Grids.GridEditSettings.html#Syncfusion_EJ2_Grids_GridEditSettings_Mode) is enabled and [toolbar](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusion.EJ2.Grids.Grid.html#Syncfusion_EJ2_Grids_Grid_Toolbar) property is configured to display toolbar items for editing purposes. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + + +{% endhighlight %} +{% endtabs %} + +> * Normal/Inline editing is the default edit [mode](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusion.EJ2.Grids.GridEditSettings.html#Syncfusion_EJ2_Grids_GridEditSettings_Mode) for the Grid. To enable CRUD operations, ensure that the `isPrimaryKey` property is set to **true** for a specific Grid column, ensuring that its value is unique. +> * If database has an auto generated column, ensure to define `isIdentity` property of Grid column to disable them during adding or editing operations. + +**Insert Operation:** + +To insert a new row, simply click the **Add** toolbar button. The new record edit form will be displayed as shown below. Upon clicking the **Update** toolbar button, record will inserted into the **Orders** table by calling the following **POST** method of an API. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Inserts a new data item into the data collection. +/// +/// It contains the new record detail which is need to be inserted. +/// Returns void. +[HttpPost] +[Route("api/[controller]/Insert")] +public void Insert([FromBody] CRUDModel value) +{ + //Create query to insert the specific into the database by accessing its properties. + string queryStr = $"Insert into Orders(CustomerID,Freight,ShipCity,EmployeeID) values('{value.value.CustomerID}','{value.value.Freight}','{value.value.ShipCity}','{value.value.EmployeeID}')"; + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to execute queries. + Connection.Open(); + + //Execute the SQLite command. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + //Execute this code to reflect the changes into the database. + Command.ExecuteNonQuery(); + + // Close the database connection after executing the query. + Connection.Close(); + + //Add custom logic here if needed and remove above method. +} + +public class CRUDModel where T : class +{ + public string? action { get; set; } + public string? keyColumn { get; set; } + public object? key { get; set; } + public T? value { get; set; } + public List? added { get; set; } + public List? changed { get; set; } + public List? deleted { get; set; } + public IDictionary? @params { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +**Update Operation:** + +To edit a row, first select desired row and click the **Edit** toolbar button. The edit form will be displayed and proceed to modify any column value as per your requirement. Clicking the **Update** toolbar button will update the edit record in the **Orders** table by involving the following **Post** method of an API. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Update a existing data item from the data collection. +/// +/// It contains the updated record detail which is need to be updated. +/// Returns void. +[HttpPost] +[Route("api/[controller]/Update")] +public void Update([FromBody] CRUDModel value) +{ + //Create query to update the changes into the database by accessing its properties. + string queryStr = $"Update Orders set CustomerID='{value.value.CustomerID}', Freight='{value.value.Freight}',EmployeeID='{value.value.EmployeeID}',ShipCity='{value.value.ShipCity}' where OrderID='{value.value.OrderID}'"; + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to execute queries. + Connection.Open(); + + //Execute the SQLite command. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + //Execute this code to reflect the changes into the database. + Command.ExecuteNonQuery(); + + // Close the database connection after executing the query. + Connection.Close(); + + //Add custom logic here if needed and remove above method. +} + +public class CRUDModel where T : class +{ + public string? action { get; set; } + public string? keyColumn { get; set; } + public object? key { get; set; } + public T? value { get; set; } + public List? added { get; set; } + public List? changed { get; set; } + public List? deleted { get; set; } + public IDictionary? @params { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +**Delete Operation:** + +To delete a row, simply select the desired row and click the **Delete** toolbar button. This action will trigger a **DELETE** request to an API, containing the primary key value of the selected record. As a result corresponding record will be removed from the **Orders** table. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Remove a specific data item from the data collection. +/// +/// It contains the specific record detail which is need to be removed. +/// Returns void. +[HttpPost] +[Route("api/[controller]/Remove")] +public void Remove([FromBody] CRUDModel value) +{ + //Create query to remove the specific from database by passing the primary key column value. + string queryStr = $"Delete from Orders where OrderID={value.key}"; + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to execute queries. + Connection.Open(); + + //Execute the SQLite command. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + //Execute this code to reflect the changes into the database. + Command.ExecuteNonQuery(); + + // Close the database connection after executing the query. + Connection.Close(); + + //Add custom logic here if needed and remove above method. +} + +public class CRUDModel where T : class +{ + public string? action { get; set; } + public string? keyColumn { get; set; } + public object? key { get; set; } + public T? value { get; set; } + public List? added { get; set; } + public List? changed { get; set; } + public List? deleted { get; set; } + public IDictionary? @params { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +**Batch Operation:** + +To perform batch operation, define the edit [mode](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusion.EJ2.Grids.GridEditSettings.html#Syncfusion_EJ2_Grids_GridEditSettings_Mode) as **Batch** and specify the `batchUrl` property in the `DataManager`. Use the **Add** toolbar button to insert new row in batch editing mode. To edit a cell, double-click the desired cell and update the value as required. To delete a record, simply select the record and press the **Delete** toolbar button. Now, all CRUD operations will be executed in batch editing mode. Clicking the **Update** toolbar button will update the newly added, edited, or deleted records from the **Orders** table using a single API **POST** request. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Batch update (Insert, Update, and Delete) a collection of data items from the data collection. +/// +/// The set of information along with details about the CRUD actions to be executed from the database. +/// Returns void. +[HttpPost] +[Route("api/[controller]/BatchUpdate")] +public IActionResult BatchUpdate([FromBody] CRUDModel value) +{ + if (value.changed != null && value.changed.Count > 0) + { + foreach (Orders Record in (IEnumerable)value.changed) + { + //Create query to update the changes into the database by accessing its properties. + string queryStr = $"Update Orders set CustomerID='{Record.CustomerID}', Freight='{Record.Freight}',EmployeeID='{Record.EmployeeID}',ShipCity='{Record.ShipCity}' where OrderID='{Record.OrderID}'"; + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to execute queries. + Connection.Open(); + + //Execute the SQLite command. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + //Execute this code to reflect the changes into the database. + Command.ExecuteNonQuery(); + + // Close the database connection after executing the query. + Connection.Close(); + + //Add custom logic here if needed and remove above method. + } + } + if (value.added != null && value.added.Count > 0) + { + foreach (Orders Record in (IEnumerable)value.added) + { + //Create query to insert the specific into the database by accessing its properties. + string queryStr = $"Insert into Orders(CustomerID,Freight,ShipCity,EmployeeID) values('{Record.CustomerID}','{Record.Freight}','{Record.ShipCity}','{Record.EmployeeID}')"; + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to execute queries. + Connection.Open(); + + //Execute the SQLite command. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + //Execute this code to reflect the changes into the database. + Command.ExecuteNonQuery(); + + // Close the database connection after executing the query. + Connection.Close(); + + //Add custom logic here if needed and remove above method. + } + } + if (value.deleted != null && value.deleted.Count > 0) + { + foreach (Orders Record in (IEnumerable)value.deleted) + { + //Create query to remove the specific from database by passing the primary key column value. + string queryStr = $"Delete from Orders where OrderID={Record.OrderID}"; + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to execute queries. + Connection.Open(); + + //Execute the SQLite command. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + //Execute this code to reflect the changes into the database. + Command.ExecuteNonQuery(); + + // Close the database connection after executing the query. + Connection.Close(); + + //Add custom logic here if needed and remove above method. + } + } + return new JsonResult(value); +} + +public class CRUDModel where T : class +{ + public string? action { get; set; } + public string? keyColumn { get; set; } + public object? key { get; set; } + public T? value { get; set; } + public List? added { get; set; } + public List? changed { get; set; } + public List? deleted { get; set; } + public IDictionary? @params { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +When you run the application, the resultant Grid will look like this + +![Syncfusion ASP.NET Core Grid bound with Microsoft SQL Server data](../images/connecting-micro-curd.gif) + +## Binding data from SQLite Server using CustomAdaptor + +This section describes step by step process how to retrieve data from a SQLite Server using [CustomAdaptor](https://ej2.syncfusion.com/aspnetcore/documentation/grid/connecting-to-adaptors/custom-adaptor) and bind it to the Syncfusion ASP.NET Core Grid. + +**1.** To create a simple Grid, the procedure is explained in the above-mentioned topic on [Connecting Syncfusion ASP.NET Core Grid to an API service](#connecting-syncfusion-aspnet-core-grid-to-an-api-service) + +**2.** To connect a SQLite Server database using the SQLite driver in your application, you need to install the [Microsoft.Data.Sqlite](https://www.nuget.org/packages/Microsoft.Data.Sqlite/) NuGet package. To add **Microsoft.Data.Sqlite** in the app, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search and install it. + +**3.** If you intend to inject your own service into the `CustomAdaptor` and utilize it, you can achieve this as follows: + + * Create a `CustomAdaptor` that extends the `UrlAdaptor` class. + * Override the `processResponse` method to process server responses. + +**4.** Within the `processResponse` method of `CustomAdaptor`, fetch data by calling the **GetOrderData** method. + + + * In this **GetOrderData** method, the SQLite Server database data is fetch by using the **SqliteDataReader** class. + * Employ the `processResponse` method to asynchronously iterate over the results retrieved by executing the SQL query with **ExecuteReaderAsync** method, gathering the data into a list. + * Finally, return the response as a `result` and `count` pair object in the `processResponse` method to bind the data to the Grid. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +using Microsoft.AspNetCore.Mvc; +using System.ComponentModel.DataAnnotations; +using System.Data; +using Syncfusion.EJ2.Base; +using Microsoft.Data.Sqlite; + +namespace Grid_SQLite.Server.Controllers +{ + [ApiController] + public class GridController : ControllerBase + { + string ConnectionString = @""; + + /// + /// Processes the DataManager request to perform searching, filtering, sorting, and paging operations. + /// + /// Contains the details of the data operation requested. + /// Returns a JSON object along with the total record count. + [HttpPost] + [Route("api/[controller]")] + public object Post([FromBody] DataManagerRequest DataManagerRequest) + { + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = GetOrderData().AsQueryable(); + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return new { result = DataSource, count = totalRecordsCount }; + } + + /// + /// Retrieves the order data from the database. + /// + /// Returns a list of orders fetched from the database. + [HttpGet] + [Route("api/[controller]")] + public List GetOrderData() + { + // SQL query to fetch all records from the orders table and sort them by OrderID. + string queryStr = "SELECT * FROM Orders ORDER BY OrderID;"; + + // Creates an empty list to store the retrieved orders from the database. + List DataSource = new List(); + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to enable SQL queries. + Connection.Open(); + + //Using SqliteCommand and query create connection with database. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + // Execute the SQLite command and retrieve data using SqliteDataReader. + using (SqliteDataReader reader = Command.ExecuteReader()) + { + while (reader.Read()) + { + Orders order = new Orders + { + OrderID = reader.GetInt32(reader.GetOrdinal("OrderID")), + CustomerID = reader.GetString(reader.GetOrdinal("CustomerID")), + EmployeeID = reader.GetInt32(reader.GetOrdinal("EmployeeID")), + ShipCity = reader.GetString(reader.GetOrdinal("ShipCity")), + Freight = reader.GetDecimal(reader.GetOrdinal("Freight")) + }; + DataSource.Add(order); + } + } + return DataSource; + } + + public class Orders + { + [Key] + public int? OrderID { get; set; } + public string? CustomerID { get; set; } + public int? EmployeeID { get; set; } + public decimal? Freight { get; set; } + public string? ShipCity { get; set; } + } + } +} + +{% endhighlight %} +{% endtabs %} + +> * The `DataManagerRequest` encompasses details about the Grid actions such as searching, filtering, sorting, aggregate, paging and grouping. + +### Handling searching operation + +When utilizing the `CustomAdaptor` in ASP.NET Core, managing the searching operation involves overriding the `processResponse` method of the `UrlAdaptor` class. + +In the code example below, searching a custom data source can be accomplished by employing the built-in `PerformSearching` method of the `QueryableOperation` class. Alternatively, you can implement your own method for searching operation and bind the resultant data to the Grid. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform searching operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the searched data along with the total record count. +[HttpPost] +[Route("api/[controller]")] +public object Post([FromBody] DataManagerRequest DataManagerRequest) +{ + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = GetOrderData().AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling searching operation. + if (DataManagerRequest.Search != null && DataManagerRequest.Search.Count > 0) + { + DataSource = queryableOperation.PerformSearching(DataSource, DataManagerRequest.Search); + //Add custom logic here if needed and remove above method. + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return new { result = DataSource, count = totalRecordsCount }; +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + + +{% endhighlight %} +{% endtabs %} + +### Handling filtering operation + +When utilizing the `CustomAdaptor` in ASP.NET Core, managing the filtering operation involves overriding the `processResponse` method of the `UrlAdaptor` class. + +In the code example below, filtering a custom data source can be achieved by utilizing the built-in `PerformFiltering` method of the `QueryableOperation` class. Alternatively, you can implement your own method for filtering operation and bind the resulting data to the Grid. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform filtering operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the filtered data along with the total record count. +[HttpPost] +[Route("api/[controller]")] +public object Post([FromBody] DataManagerRequest DataManagerRequest) +{ + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = GetOrderData().AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling filtering operation. + if (DataManagerRequest.Where != null && DataManagerRequest.Where.Count > 0) + { + foreach (WhereFilter condition in DataManagerRequest.Where) + { + foreach (WhereFilter predicate in condition.predicates) + { + DataSource = queryableOperation.PerformFiltering(DataSource, DataManagerRequest.Where, predicate.Operator); + //Add custom logic here if needed and remove above method. + } + } + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return new { result = DataSource, count = totalRecordsCount }; +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + + +{% endhighlight %} +{% endtabs %} + +### Handling sorting operation + +When utilizing the `CustomAdaptor` in ASP.NET Core, managing the sorting operation involves overriding the `processResponse` method of the `UrlAdaptor` class. + +In the code example below, sorting a custom data source can be accomplished by employing the built-in `PerformSorting` method of the `QueryableOperation` class. Alternatively, you can implement your own method for sorting operation and bind the resulting data to the Grid. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform sorting operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the sorted data along with the total record count. +[HttpPost] +[Route("api/[controller]")] +public object Post([FromBody] DataManagerRequest DataManagerRequest) +{ + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = GetOrderData().AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Handling sorting operation. + if (DataManagerRequest.Sorted != null && DataManagerRequest.Sorted.Count > 0) + { + DataSource = queryableOperation.PerformSorting(DataSource, DataManagerRequest.Sorted); + //Add custom logic here if needed and remove above method. + } + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Return data based on the request. + return new { result = DataSource, count = totalRecordsCount }; +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + + +{% endhighlight %} +{% endtabs %} + +### Handling paging operation + +When utilizing the `CustomAdaptor` in ASP.NET Core, managing the paging operation involves overriding the `processResponse` method of the `UrlAdaptor` class. + +In the code example below, paging a custom data source can be achieved by utilizing the built-in `PerformTake` and `PerformSkip` method of the `QueryableOperation` class. Alternatively, you can use your own method for paging operation and bind the resulting data to the Grid. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Processes the DataManager request to perform paging operation. +/// +/// Contains the details of the data operation requested. +/// Returns a JSON object with the paginated data along with the total record count. +[HttpPost] +[Route("api/[controller]")] +public object Post([FromBody] DataManagerRequest DataManagerRequest) +{ + // Retrieve data from the data source (e.g., database). + IQueryable DataSource = GetOrderData().AsQueryable(); + + // Initialize QueryableOperation instance. + QueryableOperation queryableOperation = new QueryableOperation(); + + // Get the total count of records. + int totalRecordsCount = DataSource.Count(); + + // Handling paging operation. + if (DataManagerRequest.Skip != 0) + { + DataSource = queryableOperation.PerformSkip(DataSource, DataManagerRequest.Skip); + //Add custom logic here if needed and remove above method. + } + if (DataManagerRequest.Take != 0) + { + DataSource = queryableOperation.PerformTake(DataSource, DataManagerRequest.Take); + //Add custom logic here if needed and remove above method. + } + + // Return data based on the request. + return new { result = DataSource, count = totalRecordsCount }; +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + + +{% endhighlight %} +{% endtabs %} + +### Handling CRUD operations + +To enable editing in the Syncfusion ASP.NET Core Grid, utilize the [editSettings](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusion.EJ2.Grids.GridEditSettings.html) property. The Grid offers multiple edit modes including the **Inline/Normal**, **Dialog** and **Batch** editing. For more details, refer to the Grid [editing](https://ej2.syncfusion.com/aspnetcore/documentation/grid/editing/edit) documentation. + +In this scenario, the inline edit `mode` and [toolbar](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusion.EJ2.Grids.Grid.html#Syncfusion_EJ2_Grids_Grid_Toolbar) property configured to display toolbar items for editing purpose. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + +{% endhighlight %} +{% endtabs %} + +> * Normal/Inline editing is the default edit [mode](https://help.syncfusion.com/cr/aspnetcore-js2/Syncfusion.EJ2.Grids.GridEditSettings.html#Syncfusion_EJ2_Grids_GridEditSettings_Mode) for the Grid. To enable CRUD operations, ensure that the `isPrimaryKey` property is set to **true** for a specific Grid column, ensuring that its value is unique. +> * If database has an auto generated column, ensure to define `isIdentity` property of Grid column to disable them during adding or editing operations. + +The CRUD operations can be performed and customized on our own by overriding the following CRUD methods of the `UrlAdaptor` + +* insert +* remove +* update +* batchRequest + +Let’s see how to perform CRUD operation using SQLite Server data with Grid. + +**Insert Operation:** + +To execute the insert operation, you will need to override the `insert` method of the `CustomAdaptor`. Then, integrate the following code snippet into the `CustomAdaptor` class. The below code snippet demonstrated how to handle the insertion of new records within the `insert` method of `CustomAdaptor`. Modify the logic within this method according to the requirements of your application. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + + + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Inserts a new data item into the data collection. +/// +/// It contains the new record detail which is need to be inserted. +/// Returns void. +[HttpPost] +[Route("api/[controller]/Insert")] +public void Insert([FromBody] CRUDModel value) +{ + //Create query to insert the specific into the database by accessing its properties. + string queryStr = $"Insert into Orders(CustomerID,Freight,ShipCity,EmployeeID) values('{value.value.CustomerID}','{value.value.Freight}','{value.value.ShipCity}','{value.value.EmployeeID}')"; + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to execute queries. + Connection.Open(); + + //Execute the SQLite command. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + //Execute this code to reflect the changes into the database. + Command.ExecuteNonQuery(); + + // Close the database connection after executing the query. + Connection.Close(); + + //Add custom logic here if needed and remove above method. +} + +public class CRUDModel where T : class +{ + public string? action { get; set; } + public string? keyColumn { get; set; } + public object? key { get; set; } + public T? value { get; set; } + public List? added { get; set; } + public List? changed { get; set; } + public List? deleted { get; set; } + public IDictionary? @params { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +**Update Operation:** + +To execute the update operation, override the `update` method of the `CustomAdaptor`. Then, integrate the following code snippet into the `CustomAdaptor` class. The below code snippet demonstrated how to handle the updating of existing records within the `update` method of the `CustomAdaptor`. Modify the logic within this method according to the requirements of your application. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + + + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Update a existing data item from the data collection. +/// +/// It contains the updated record detail which is need to be updated. +/// Returns void. +[HttpPost] +[Route("api/[controller]/Update")] +public void Update([FromBody] CRUDModel value) +{ + //Create query to update the changes into the database by accessing its properties. + string queryStr = $"Update Orders set CustomerID='{value.value.CustomerID}', Freight='{value.value.Freight}',EmployeeID='{value.value.EmployeeID}',ShipCity='{value.value.ShipCity}' where OrderID='{value.value.OrderID}'"; + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to execute queries. + Connection.Open(); + + //Execute the SQLite command. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + //Execute this code to reflect the changes into the database. + Command.ExecuteNonQuery(); + + // Close the database connection after executing the query. + Connection.Close(); + + //Add custom logic here if needed and remove above method. +} + +public class CRUDModel where T : class +{ + public string? action { get; set; } + public string? keyColumn { get; set; } + public object? key { get; set; } + public T? value { get; set; } + public List? added { get; set; } + public List? changed { get; set; } + public List? deleted { get; set; } + public IDictionary? @params { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +**Delete Operation:** + +To perform the delete operation, you need to override the `remove` method of the `CustomAdaptor`. Below is the code snippet that you can add to `CustomAdaptor` class. The below code snippet demonstrated how to handle the deletion of existing records within the `remove` method of `CustomAdaptor`. Modify the logic within this method according to the requirements of your application. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + + + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Remove a specific data item from the data collection. +/// +/// It contains the specific record detail which is need to be removed. +/// Returns void. +[HttpPost] +[Route("api/[controller]/Remove")] +public void Remove([FromBody] CRUDModel value) +{ + //Create query to remove the specific from database by passing the primary key column value. + string queryStr = $"Delete from Orders where OrderID={value.key}"; + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to execute queries. + Connection.Open(); + + //Execute the SQLite command. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + //Execute this code to reflect the changes into the database. + Command.ExecuteNonQuery(); + + // Close the database connection after executing the query. + Connection.Close(); + + //Add custom logic here if needed and remove above method. +} + +public class CRUDModel where T : class +{ + public string? action { get; set; } + public string? keyColumn { get; set; } + public object? key { get; set; } + public T? value { get; set; } + public List? added { get; set; } + public List? changed { get; set; } + public List? deleted { get; set; } + public IDictionary? @params { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +## Batch Operation: + +To perform the batch operation, override the **batchRequest** method of the `CustomAdaptor` and add the following code in the `CustomAdaptor`. The below code snippet demonstrated how to handle the batch update request within the **batchRequest** method of `CustomAdaptor`. Modify the logic within this method according to the requirements of your application. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + + + + + + + + + + + + + + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +/// +/// Batch update (Insert, Update, and Delete) a collection of data items from the data collection. +/// +/// The set of information along with details about the CRUD actions to be executed from the database. +/// Returns void. +[HttpPost] +[Route("api/[controller]/BatchUpdate")] +public IActionResult BatchUpdate([FromBody] CRUDModel value) +{ + if (value.changed != null && value.changed.Count > 0) + { + foreach (Orders Record in (IEnumerable)value.changed) + { + //Create query to update the changes into the database by accessing its properties. + string queryStr = $"Update Orders set CustomerID='{Record.CustomerID}', Freight='{Record.Freight}',EmployeeID='{Record.EmployeeID}',ShipCity='{Record.ShipCity}' where OrderID='{Record.OrderID}'"; + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to execute queries. + Connection.Open(); + + //Execute the SQLite command. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + //Execute this code to reflect the changes into the database. + Command.ExecuteNonQuery(); + + // Close the database connection after executing the query. + Connection.Close(); + + //Add custom logic here if needed and remove above method. + } + } + if (value.added != null && value.added.Count > 0) + { + foreach (Orders Record in (IEnumerable)value.added) + { + //Create query to insert the specific into the database by accessing its properties. + string queryStr = $"Insert into Orders(CustomerID,Freight,ShipCity,EmployeeID) values('{Record.CustomerID}','{Record.Freight}','{Record.ShipCity}','{Record.EmployeeID}')"; + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to execute queries. + Connection.Open(); + + //Execute the SQLite command. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + //Execute this code to reflect the changes into the database. + Command.ExecuteNonQuery(); + + // Close the database connection after executing the query. + Connection.Close(); + + //Add custom logic here if needed and remove above method. + } + } + if (value.deleted != null && value.deleted.Count > 0) + { + foreach (Orders Record in (IEnumerable)value.deleted) + { + //Create query to remove the specific from database by passing the primary key column value. + string queryStr = $"Delete from Orders where OrderID={Record.OrderID}"; + + // Establishes a connection to the SQLite database using the provided connection string. + SqliteConnection Connection = new SqliteConnection(ConnectionString); + + // Opens the database connection to execute queries. + Connection.Open(); + + //Execute the SQLite command. + SqliteCommand Command = new SqliteCommand(queryStr, Connection); + + //Execute this code to reflect the changes into the database. + Command.ExecuteNonQuery(); + + // Close the database connection after executing the query. + Connection.Close(); + + //Add custom logic here if needed and remove above method. + } + } + return new JsonResult(value); +} + +public class CRUDModel where T : class +{ + public string? action { get; set; } + public string? keyColumn { get; set; } + public object? key { get; set; } + public T? value { get; set; } + public List? added { get; set; } + public List? changed { get; set; } + public List? deleted { get; set; } + public IDictionary? @params { get; set; } +} + +{% endhighlight %} +{% endtabs %} + +![Syncfusion ASP.NET Core Grid bound with SQLite Server data](../images/connecting-micro-curd.gif) \ No newline at end of file diff --git a/ej2-asp-core-mvc/grid/images/Ms-Sql-data.png b/ej2-asp-core-mvc/grid/images/Ms-Sql-data.png new file mode 100644 index 0000000000..384aff3a2c Binary files /dev/null and b/ej2-asp-core-mvc/grid/images/Ms-Sql-data.png differ diff --git a/ej2-asp-core-mvc/grid/images/connecting-micro-curd.gif b/ej2-asp-core-mvc/grid/images/connecting-micro-curd.gif new file mode 100644 index 0000000000..99eb32c8f7 Binary files /dev/null and b/ej2-asp-core-mvc/grid/images/connecting-micro-curd.gif differ diff --git a/ej2-asp-core-toc.html b/ej2-asp-core-toc.html index beaa349adf..598c824c27 100644 --- a/ej2-asp-core-toc.html +++ b/ej2-asp-core-toc.html @@ -1310,6 +1310,11 @@
  • Custom Adaptor
    • +
  • Connecting to Database + +
  • Data Annotation
  • Adaptive View
  • Performance Best Practices