diff --git a/ej2-asp-core-mvc/grid/EJ2_ASP.MVC/connecting-to-database/mysql-server.md b/ej2-asp-core-mvc/grid/EJ2_ASP.MVC/connecting-to-database/mysql-server.md new file mode 100644 index 0000000000..461c641218 --- /dev/null +++ b/ej2-asp-core-mvc/grid/EJ2_ASP.MVC/connecting-to-database/mysql-server.md @@ -0,0 +1,1835 @@ +--- +layout: post +title: MySQL Server Data Binding in Syncfusion ##Platform_Name## Grid +description: Learn how to consume data from SQL Server using MySQL Client, bind it to Syncfusion Grid, and perform CRUD operations. +platform: ej2-asp-core-mvc +control: grid +keywords: adaptors, customadaptor, urladaptor, remotedata, mysql +documentation: ug +domainurl: ##DomainURL## +--- + +# Connecting MySQL Server data to Syncfusion ASP.NET MVC Grid + +This section describes how to connect and retrieve data from a MySQL Server database using [MySQL data](https://www.nuget.org/packages/MySql.Data) and bind it to the Syncfusion ASP.NET MVC Grid. + +MySQL Server database can be bound to the Grid in different ways (i.e.) using [DataSource](https://help.syncfusion.com/cr/aspnetmvc-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 MySQL 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. + +**1. Using UrlAdaptor** + +The [UrlAdaptor](https://ej2.syncfusion.com/aspnetmvc/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 MVC Grid by connecting to an existing pre-configured API service linked to the MySQL Server database. While the Grid supports various adaptors to fulfill this requirement, including [Web API](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/web-api-adaptor), [ODataV4](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/odatav4-adaptor), [UrlAdaptor](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/url-adaptor), [Web Method](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/connecting-to-adaptors/web-method-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. + +**2. Using CustomAdaptor** + +The [CustomAdaptor](https://ej2.syncfusion.com/aspnetmvc/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 MVC 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 MySQL Server using an API service + +This section describes step by step process how to retrieve data from a MySQL Server using an API service and bind it to the Syncfusion ASP.NET MVC Grid. + +### Creating an API Service + +To configure a server with Syncfusion ASP.NET MVC Grid, follow the below steps: + +**1.** Open Visual Studio and create an ASP.NET MVC project named **MyWebService**. To create an ASP.NET MVC application, follow the documentation [link](https://learn.microsoft.com/en-us/aspnet/mvc/overview/getting-started/introduction/getting-started#create-your-first-app) for detailed steps. + +**2.** To connect a MySQL Server database using the MySQL driver in your application, you need to install the [MySQL.Data](https://www.nuget.org/packages/MySql.Data) NuGet package. To add **MySQL.Data** 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 MySQL Server. In the **GetOrderData()** method **MySqlConnection** helps to connect the MySQL Server database. Next, using **MySqlCommand** and **MySqlDataAdapter** you can process the desired MySQL query string and retrieve data from the database. The **Fill** method of the **DataAdapter** is used to populate the MySQL data into a **DataTable** as shown in the following code snippet. + +{% tabs %} +{% highlight cs tabtitle="GridController.cs" %} + +using MySql.Data.MySqlClient; +using Syncfusion.EJ2.Base; +using System; +using System.Collections.Generic; +using System.ComponentModel.DataAnnotations; +using System.Data; +using System.Linq; +using System.Web.Http; + +namespace MyWebService.Controllers +{ + public class GridController : ApiController + { + /// + /// Processes the DataManager request to perform searching, filtering, sorting, and paging operations. + /// + /// Contains the details of the data operation requested. + /// Returns a JSON object with the filtered, sorted, and paginated data along with the total record count. + [HttpPost] + public object Post(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] + public List GetOrderData() + { + // Create a list to store orders. + List orders = new List(); + + // Establish a connection to the MySQL database. + using (MySqlConnection sqlConnection = new MySqlConnection(ConnectionString)) + { + // Define the SQL query to retrieve all orders sorted by OrderID. + string query = "SELECT * FROM orders ORDER BY OrderID"; + + // Create a MySQL command to execute the query. + using (MySqlCommand sqlCommand = new MySqlCommand(query, sqlConnection)) + { + // Open the database connection. + sqlConnection.Open(); + + // Use a data adapter to execute the query and fetch data. + using (MySqlDataAdapter dataAdapter = new MySqlDataAdapter(sqlCommand)) + { + // Create a DataTable to store retrieved data. + DataTable dataTable = new DataTable(); + + // Fill the DataTable with data from the database. + dataAdapter.Fill(dataTable); + + // Convert DataTable rows into a list of orders objects. + orders = (from DataRow row in dataTable.Rows + select new Orders() + { + OrderID = row["OrderID"] != DBNull.Value ? Convert.ToInt32(row["OrderID"]) : (int?)null, + CustomerID = row["CustomerID"]?.ToString(), + EmployeeID = row["EmployeeID"] != DBNull.Value ? Convert.ToInt32(row["EmployeeID"]) : (int?)null, + ShipCity = row["ShipCity"]?.ToString(), + Freight = row["Freight"] != DBNull.Value ? Convert.ToDecimal(row["Freight"]) : (decimal?)null + }).ToList(); + } + } + } + + // Return the list of orders. + return orders; + } + 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/api/Grid`. + +**6.** Finally, the retrieved data from MySQL 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/database/db-data.png) + +### Connecting Syncfusion ASP.NET MVC Grid to an API Service + +To integrate the Syncfusion ASP.NET MVC Grid into your ASP.NET MVC project using Visual Studio, follow these steps: + +**Step 1:** Install the Syncfusion ASP.NET MVC Package: + +To add `ASP.NET MVC` in the application, open the NuGet package manager in Visual Studio (Tools → NuGet Package Manager → Manage NuGet Packages for Solution), search for [Syncfusion.EJ2.MVC5](https://www.nuget.org/packages/Syncfusion.EJ2.MVC5) 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.MVC5 -Version {{ site.releaseversion }} + +{% endhighlight %} +{% endtabs %} + +**Step 2:** Add Syncfusion ASP.NET MVC namespace + +Add `Syncfusion.EJ2` namespace reference in `Web.config` under `Views` folder. + +```cs + + + +``` + +**Step 3:** Add stylesheet 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 `EJS().ScriptManager()` at the end of `` in the `~/Pages/Shared/_Layout.cshtml` file as follows. + +{% tabs %} +{% highlight cshtml tabtitle="~/_Layout.cshtml" %} + + +... + + @Html.EJS().ScriptManager() + + +{% endhighlight %} +{% endtabs %} + +**Step 5:** Add the Syncfusion ASP.NET MVC Grid + +Now, add the Syncfusion ASP.NET MVC Grid tag helper in `~/Views/Home/Index.cshtml` file. + +{% tabs %} +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace xxxx with your actual port number. +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/api/Grid").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).Render() + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +public class GridController : ApiController +{ + /// + /// Processes the DataManager request to perform searching, filtering, sorting, and paging operations. + /// + /// Contains the details of the data operation requested. + /// Returns a JSON object with the filtered, sorted, and paginated data along with the total record count. + [HttpPost] + public object Post(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] + public List GetOrderData() + { + // Create a list to store orders. + List orders = new List(); + + // Establish a connection to the MySQL database. + using (MySqlConnection sqlConnection = new MySqlConnection(ConnectionString)) + { + // Define the SQL query to retrieve all orders sorted by OrderID. + string query = "SELECT * FROM orders ORDER BY OrderID"; + + // Create a MySQL command to execute the query. + using (MySqlCommand sqlCommand = new MySqlCommand(query, sqlConnection)) + { + // Open the database connection. + sqlConnection.Open(); + + // Use a data adapter to execute the query and fetch data. + using (MySqlDataAdapter dataAdapter = new MySqlDataAdapter(sqlCommand)) + { + // Create a DataTable to store retrieved data. + DataTable dataTable = new DataTable(); + + // Fill the DataTable with data from the database. + dataAdapter.Fill(dataTable); + + // Convert DataTable rows into a list of orders objects. + orders = (from DataRow row in dataTable.Rows + select new Orders() + { + OrderID = row["OrderID"] != DBNull.Value ? Convert.ToInt32(row["OrderID"]) : (int?)null, + CustomerID = row["CustomerID"]?.ToString(), + EmployeeID = row["EmployeeID"] != DBNull.Value ? Convert.ToInt32(row["EmployeeID"]) : (int?)null, + ShipCity = row["ShipCity"]?.ToString(), + Freight = row["Freight"] != DBNull.Value ? Convert.ToDecimal(row["Freight"]) : (decimal?)null + }).ToList(); + } + } + } + + // Return the list of orders. + return orders; + } + 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 %} + +**Step 6:** Run the Project + +Run the project in Visual Studio, and the Syncfusion ASP.NET MVC Grid will successfully fetch data from the API service. + +> * The Syncfusion ASP.NET MVC 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.MVC5](https://www.nuget.org/packages/Syncfusion.EJ2.MVC5) package. Let’s explore how to manage these data operations using the `UrlAdaptor`. +> * In an API service project, add `Syncfusion.EJ2.MVC5` 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](https://www.npmjs.com/package/@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] +public object UrlDataSource(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?.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 Json(new { result = dataSource, count = totalRecordsCount }); +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/api/Grid").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).Toolbar(new List() { "Search" }).Render() + +{% 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] +public object Post(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?.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 Json(new { result = dataSource, count = totalRecordsCount }, JsonRequestBehavior.AllowGet); +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/api/Grid").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).AllowFiltering().Render() + +{% 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] +public object Post(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?.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 Json(new { result = dataSource, count = totalRecordsCount }, JsonRequestBehavior.AllowGet); +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/api/Grid").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).AllowSorting().Render() + +{% 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] +public object Post(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); + } + if (DataManagerRequest.Take > 0) + { + dataSource = queryableOperation.PerformTake(dataSource, DataManagerRequest.Take); + } + + // Return data based on the request. + return Json(new { result = dataSource, count = totalRecordsCount }, JsonRequestBehavior.AllowGet); +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/api/Grid").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).AllowPaging().Render() + +{% endhighlight %} +{% endtabs %} + +### Handling CRUD operations + +The Syncfusion Angular 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. **CrudUrl**: Specifies a single URL for all CRUD operations. +5. **BatchUrl**: Specifies the URL for batch editing. + +To enable editing in ASP.NET MVC Grid, refer to the editing [Documentation](https://ej2.syncfusion.com/aspnetmvc/documentation/grid/editing/edit). In the below example, the inline edit `Mode` is enabled and [Toolbar](https://help.syncfusion.com/cr/aspnetmvc-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" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/api/Grid") + .UpdateUrl("https://localhost:xxxx/api/Grid/Update") + .InsertUrl("https://localhost:xxxx/api/Grid/Insert") + .RemoveUrl("https://localhost:xxxx/api/Grid/Remove").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).IsPrimaryKey(true).IsIdentity(true).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").ValidationRules(new { required = "true" }).Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).ValidationRules(new { required = "true", number = true}).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").ValidationRules(new { required = "true", min=1, max=1000 }).Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").ValidationRules(new { required = "true" }).Add(); +}).EditSettings(edit => { edit.AllowAdding(true).AllowEditing(true).AllowDeleting(true).Mode(Syncfusion.EJ2.Grids.EditMode.Normal); }).Toolbar(new List() { "Add", "Edit", "Delete", "Update", "Cancel" }).Render() + +{% endhighlight %} +{% endtabs %} + +> * Normal/Inline editing is the default edit `Mode` for the Grid. To enable CRUD operations, ensure that the [IsPrimaryKey](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Grids.GridColumn.html#Syncfusion_EJ2_Grids_GridColumn_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](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Grids.GridColumn.html#Syncfusion_EJ2_Grids_GridColumn_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 order record into the database using parameterized queries. +/// +/// It contains the new record detail which is need to be inserted. +/// Returns a JSON result indicating success. +[HttpPost] +[Route("api/Grid/Insert")] +public IHttpActionResult Insert(CRUDModel newRecord) +{ + // Check if the request data is null or invalid. + if (newRecord?.value == null) + return BadRequest("Invalid request: No data received."); + + // Establish a connection to the MySQL database. + using (MySqlConnection Connection = new MySqlConnection(ConnectionString)) + { + // Open the database connection. + Connection.Open(); + + // Define the SQL query to insert a new record into the orders table. + string queryStr = "INSERT INTO Orders (CustomerID, Freight, ShipCity, EmployeeID, OrderDate) VALUES (@CustomerID, @Freight, @ShipCity, @EmployeeID, @OrderDate)"; + + // Create a MySQL command with the query and connection. + using (MySqlCommand Command = new MySqlCommand(queryStr, Connection)) + { + // Add parameters to prevent SQL injection and handle null values. + Command.Parameters.AddWithValue("@CustomerID", newRecord.value.CustomerID); + Command.Parameters.AddWithValue("@Freight", newRecord.value.Freight ?? (object)DBNull.Value); + Command.Parameters.AddWithValue("@ShipCity", newRecord.value.ShipCity); + Command.Parameters.AddWithValue("@EmployeeID", newRecord.value.EmployeeID ?? (object)DBNull.Value); + Command.Parameters.AddWithValue("@OrderDate", DateTime.Now); // Explicitly setting OrderDate. + + // Execute the SQL query and insert the record. + int rowsAffected = Command.ExecuteNonQuery(); + + // Return a success message if the insertion is successful. + return Ok(new { message = "Record inserted successfully" }); + } + } +} +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 a JSON result indicating success or failure. +[HttpPost] +[Route("api/Grid/Update")] +public IHttpActionResult Update(CRUDModel value) +{ + // Check if the request data is null or invalid. + if (value?.value == null) + return BadRequest("Invalid request: No data received."); + + // Establish a connection to the MySQL database. + using (MySqlConnection Connection = new MySqlConnection(ConnectionString)) + { + // Open the database connection. + Connection.Open(); + + // Define the SQL query to update an existing record in the orders table. + string queryStr = "UPDATE Orders SET CustomerID=@CustomerID, Freight=@Freight, ShipCity=@ShipCity, EmployeeID=@EmployeeID WHERE OrderID=@OrderID"; + + // Create a MySQL command with the query and connection. + using (MySqlCommand Command = new MySqlCommand(queryStr, Connection)) + { + // Add parameters to prevent SQL injection and handle null values. + Command.Parameters.AddWithValue("@OrderID", value.value.OrderID); + Command.Parameters.AddWithValue("@CustomerID", value.value.CustomerID); + Command.Parameters.AddWithValue("@Freight", value.value.Freight ?? (object)DBNull.Value); + Command.Parameters.AddWithValue("@ShipCity", value.value.ShipCity); + Command.Parameters.AddWithValue("@EmployeeID", value.value.EmployeeID ?? (object)DBNull.Value); + Command.Parameters.AddWithValue("@OrderDate", DateTime.Now); + + // Execute the SQL query and update the record. + int rowsAffected = Command.ExecuteNonQuery(); + + // Return a success message if the update is successful. + return Ok(new { message = "Record updated successfully" }); + } + } +} +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 a JSON result indicating success or failure. +[HttpPost] +[Route("api/Grid/Remove")] +public IHttpActionResult Remove(CRUDModel value) +{ + // Check if the request contains a valid OrderID. + if (value?.key == null) + return BadRequest("Invalid request: No key received."); + + // Establish a connection to the MySQL database. + using (MySqlConnection Connection = new MySqlConnection(ConnectionString)) + { + // Open the database connection. + Connection.Open(); + + // Define the SQL query to delete the order record with the specified OrderID. + string queryStr = "DELETE FROM Orders WHERE OrderID=@OrderID"; + + // Create a MySQL command with the query and connection. + using (MySqlCommand Command = new MySqlCommand(queryStr, Connection)) + { + // Add the OrderID parameter to the query to prevent SQL injection. + Command.Parameters.AddWithValue("@OrderID", value.key); + + // Execute the SQL query and delete the record. + int rowsAffected = Command.ExecuteNonQuery(); + + // Return a success message if the deletion is successful. + return Ok(new { message = "Record deleted successfully" }); + } + } +} +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` 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 single request. 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 a JSON response with success or error message. +[HttpPost] +[Route("api/Grid/BatchUpdate")] +public IHttpActionResult BatchUpdate(CRUDModel value) +{ + // Establish a connection to the MySQL database. + using (MySqlConnection connection = new MySqlConnection(ConnectionString)) + { + // Open the database connection. + connection.Open(); + + // Process the list of updated records. + if (value.changed != null && value.changed.Count > 0) + { + // Define an SQL query to update records in the orders table. + string updateQuery = "UPDATE Orders SET CustomerID=@CustomerID, Freight=@Freight, EmployeeID=@EmployeeID, ShipCity=@ShipCity WHERE OrderID=@OrderID"; + + // Create a MySQL command object to execute the update query. + using (MySqlCommand command = new MySqlCommand(updateQuery, connection)) + { + // Iterate through the list of changed records and update each one. + foreach (Orders record in value.changed) + { + // Add parameters for updating the order details. + command.Parameters.AddWithValue("@OrderID", record.OrderID); + command.Parameters.AddWithValue("@CustomerID", record.CustomerID); + command.Parameters.AddWithValue("@Freight", record.Freight ?? (object)DBNull.Value); + command.Parameters.AddWithValue("@EmployeeID", record.EmployeeID ?? (object)DBNull.Value); + command.Parameters.AddWithValue("@ShipCity", record.ShipCity); + + // Execute the update query for the current record. + command.ExecuteNonQuery(); + } + } + } + + // Process the list of newly added records. + if (value.added != null && value.added.Count > 0) + { + // Define an SQL query to insert new records into the orders table. + string insertQuery = "INSERT INTO Orders (CustomerID, Freight, ShipCity, EmployeeID, OrderDate) VALUES (@CustomerID, @Freight, @ShipCity, @EmployeeID, @OrderDate)"; + + // Create a MySQL command object to execute the insert query. + using (MySqlCommand command = new MySqlCommand(insertQuery, connection)) + { + // Iterate through the list of added records and insert each one. + foreach (Orders record in value.added) + { + // Add parameters for inserting new order details. + command.Parameters.AddWithValue("@CustomerID", record.CustomerID); + command.Parameters.AddWithValue("@Freight", record.Freight ?? (object)DBNull.Value); + command.Parameters.AddWithValue("@EmployeeID", record.EmployeeID ?? (object)DBNull.Value); + command.Parameters.AddWithValue("@ShipCity", record.ShipCity); + command.Parameters.AddWithValue("@OrderDate", DateTime.Now); // Set current date as the order date. + + // Execute the insert query for the current record. + command.ExecuteNonQuery(); + } + } + } + + // Process the list of deleted records. + if (value.deleted != null && value.deleted.Count > 0) + { + // Define an SQL query to delete records from the orders table based on OrderID. + string deleteQuery = "DELETE FROM Orders WHERE OrderID=@OrderID"; + + // Create a MySQL command object to execute the delete query. + using (MySqlCommand command = new MySqlCommand(deleteQuery, connection)) + { + // Iterate through the list of deleted records and remove each one. + foreach (Orders record in value.deleted) + { + // Add the OrderID parameter to delete the corresponding record. + command.Parameters.AddWithValue("@OrderID", record.OrderID); + + // Execute the delete query for the current record. + command.ExecuteNonQuery(); + } + } + } + } + + // Return a success message after completing all batch operations. + return Ok(new { message = "Batch update completed successfully." }); +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").DataSource(ds => ds.Url("https://localhost:xxxx/api/Grid").BatchUrl("https://localhost:xxxx/Grid/BatchUpdate").Adaptor("UrlAdaptor")).Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).IsPrimaryKey(true).IsIdentity(true).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").ValidationRules(new { required = "true" }).Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).ValidationRules(new { required = "true", number = true}).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").ValidationRules(new { required = "true", min=1, max=1000 }).Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").ValidationRules(new { required = "true" }).Add(); +}).AllowPaging().EditSettings(edit => { edit.AllowAdding(true).AllowEditing(true).AllowDeleting(true).Mode(Syncfusion.EJ2.Grids.EditMode.Batch); }).Toolbar(new List() { "Add", "Edit", "Delete", "Update", "Cancel" }).Render() + +{% endhighlight %} +{% endtabs %} + +When you run the application, the resultant Syncfusion ASP.NET MVC Grid will look like this + +![Syncfusion ASP.NET MVC Grid bound with MySQL Server data](../images/database/db-crud.gif) + +## Binding data from MySQL Server using CustomAdaptor + +This section describes step by step process how to retrieve data from a MySQL Server using `CustomAdaptor` and bind it to the Syncfusion ASP.NET MVC Grid. + +**1.** To create a simple Grid, the procedure is explained in the above-mentioned topic on [Connecting Syncfusion ASP.NET MVC Grid to an API service](##connecting-syncfusion-aspnet-mvc-grid-to-an-api-service) + +**2.** To connect a MySQL Server database using the MySQL driver in your application, you need to install the [MySQL.Data](https://www.nuget.org/packages/MySql.Data) NuGet package. To add **MySQL.Data** 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 MySQL Server database data is fetch by using the **MySqlDataAdapter** class. + + * Employ the **Fill** method of the **DataAdapter** to populate a **DataSet** with the results of the `Select` command of the **DataAdapter**, followed by conversion of the **DataSet** 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" %} + +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).Render() + + + +{% endhighlight %} + +{% highlight cs tabtitle="GridController.cs" %} + +using MySql.Data.MySqlClient; +using Syncfusion.EJ2.Base; +using System; +using System.Collections.Generic; +using System.ComponentModel.DataAnnotations; +using System.Data; +using System.Linq; +using System.Web.Http; + +namespace MyWebService.Controllers +{ + public class GridController : ApiController + { + /// + /// Processes the DataManager request to perform searching, filtering, sorting, and paging operations. + /// + /// Contains the details of the data operation requested. + /// Returns a JSON object with the filtered, sorted, and paginated data along with the total record count. + [HttpPost] + public object Post(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] + public List GetOrderData() + { + // Create a list to store orders. + List orders = new List(); + + // Establish a connection to the MySQL database. + using (MySqlConnection sqlConnection = new MySqlConnection(ConnectionString)) + { + // Define the SQL query to retrieve all orders sorted by OrderID. + string query = "SELECT * FROM orders ORDER BY OrderID"; + + // Create a MySQL command to execute the query. + using (MySqlCommand sqlCommand = new MySqlCommand(query, sqlConnection)) + { + // Open the database connection. + sqlConnection.Open(); + + // Use a data adapter to execute the query and fetch data. + using (MySqlDataAdapter dataAdapter = new MySqlDataAdapter(sqlCommand)) + { + // Create a DataTable to store retrieved data. + DataTable dataTable = new DataTable(); + + // Fill the DataTable with data from the database. + dataAdapter.Fill(dataTable); + + // Convert DataTable rows into a list of orders objects. + orders = (from DataRow row in dataTable.Rows + select new Orders() + { + OrderID = row["OrderID"] != DBNull.Value ? Convert.ToInt32(row["OrderID"]) : (int?)null, + CustomerID = row["CustomerID"]?.ToString(), + EmployeeID = row["EmployeeID"] != DBNull.Value ? Convert.ToInt32(row["EmployeeID"]) : (int?)null, + ShipCity = row["ShipCity"]?.ToString(), + Freight = row["Freight"] != DBNull.Value ? Convert.ToDecimal(row["Freight"]) : (decimal?)null + }).ToList(); + } + } + } + + // Return the list of orders. + return orders; + } + 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 MVC, 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 Syncfusion ASP.NET MVC 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] +public object UrlDataSource(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?.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 Json(new { result = dataSource, count = totalRecordsCount }); +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).Toolbar(new List() { "Search" }).Render() + + + +{% endhighlight %} +{% endtabs %} + +### Handling filtering operation + +When utilizing the `CustomAdaptor` in ASP.NET MVC, 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] +public object Post(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?.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 Json(new { result = dataSource, count = totalRecordsCount }, JsonRequestBehavior.AllowGet); +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).AllowFiltering().Render() + + + +{% endhighlight %} +{% endtabs %} + +### Handling sorting operation + +When utilizing the `CustomAdaptor` in ASP.NET MVC, 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] +public object Post(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?.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 Json(new { result = dataSource, count = totalRecordsCount }, JsonRequestBehavior.AllowGet); +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).AllowSorting().Render() + + + +{% endhighlight %} +{% endtabs %} + +### Handling paging operation + +When utilizing the `CustomAdaptor` in ASP.NET MVC, 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] +public object Post(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); + } + if (DataManagerRequest.Take > 0) + { + dataSource = queryableOperation.PerformTake(dataSource, DataManagerRequest.Take); + } + + // Return data based on the request. + return Json(new { result = dataSource, count = totalRecordsCount }, JsonRequestBehavior.AllowGet); +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").Add(); +}).AllowPaging().Render() + + + +{% endhighlight %} +{% endtabs %} + +### Handling CRUD operations + +To enable editing in the Syncfusion ASP.NET MVC Grid, utilize the [GridEditSettings](https://help.syncfusion.com/cr/aspnetmvc-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/aspnetmvc/documentation/grid/editing/edit) documentation. + +In this scenario, the inline edit `Mode` and [Toolbar](https://help.syncfusion.com/cr/aspnetmvc-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" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).IsPrimaryKey(true).IsIdentity(true).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").ValidationRules(new { required = "true" }).Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).ValidationRules(new { required = "true", number = true}).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").ValidationRules(new { required = "true", min=1, max=1000 }).Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").ValidationRules(new { required = "true" }).Add(); +}).EditSettings(edit => { edit.AllowAdding(true).AllowEditing(true).AllowDeleting(true).Mode(Syncfusion.EJ2.Grids.EditMode.Normal); }).Toolbar(new List() { "Add", "Edit", "Delete", "Update", "Cancel" }).Render() + + + +{% endhighlight %} +{% endtabs %} + +> * Normal/Inline editing is the default edit `Mode` for the Grid. To enable CRUD operations, ensure that the [IsPrimaryKey](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Grids.GridColumn.html#Syncfusion_EJ2_Grids_GridColumn_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](https://help.syncfusion.com/cr/aspnetmvc-js2/Syncfusion.EJ2.Grids.GridColumn.html#Syncfusion_EJ2_Grids_GridColumn_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 MySQL 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 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 a JSON result indicating success. +[HttpPost] +[Route("api/Grid/Insert")] +public IHttpActionResult Insert(CRUDModel newRecord) +{ + // Check if the request data is null or invalid. + if (newRecord?.value == null) + return BadRequest("Invalid request: No data received."); + + // Establish a connection to the MySQL database. + using (MySqlConnection Connection = new MySqlConnection(ConnectionString)) + { + // Open the database connection. + Connection.Open(); + + // Define the SQL query to insert a new record into the orders table. + string queryStr = "INSERT INTO Orders (CustomerID, Freight, ShipCity, EmployeeID, OrderDate) VALUES (@CustomerID, @Freight, @ShipCity, @EmployeeID, @OrderDate)"; + + // Create a MySQL command with the query and connection. + using (MySqlCommand Command = new MySqlCommand(queryStr, Connection)) + { + // Add parameters to prevent SQL injection and handle null values. + Command.Parameters.AddWithValue("@CustomerID", newRecord.value.CustomerID); + Command.Parameters.AddWithValue("@Freight", newRecord.value.Freight ?? (object)DBNull.Value); + Command.Parameters.AddWithValue("@ShipCity", newRecord.value.ShipCity); + Command.Parameters.AddWithValue("@EmployeeID", newRecord.value.EmployeeID ?? (object)DBNull.Value); + Command.Parameters.AddWithValue("@OrderDate", DateTime.Now); // Explicitly setting OrderDate. + + // Execute the SQL query and insert the record. + int rowsAffected = Command.ExecuteNonQuery(); + + // Return a success message if the insertion is successful. + return Ok(new { message = "Record inserted successfully" }); + } + } +} +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 %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + + + +{% 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. Modify the logic within this method according to the requirements of your application. + +{% 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 a JSON result indicating success or failure. +[HttpPost] +[Route("api/Grid/Update")] +public IHttpActionResult Update(CRUDModel value) +{ + // Check if the request data is null or invalid. + if (value?.value == null) + return BadRequest("Invalid request: No data received."); + + // Establish a connection to the MySQL database. + using (MySqlConnection Connection = new MySqlConnection(ConnectionString)) + { + // Open the database connection. + Connection.Open(); + + // Define the SQL query to update an existing record in the orders table. + string queryStr = "UPDATE Orders SET CustomerID=@CustomerID, Freight=@Freight, ShipCity=@ShipCity, EmployeeID=@EmployeeID WHERE OrderID=@OrderID"; + + // Create a MySQL command with the query and connection. + using (MySqlCommand Command = new MySqlCommand(queryStr, Connection)) + { + // Add parameters to prevent SQL injection and handle null values. + Command.Parameters.AddWithValue("@OrderID", value.value.OrderID); + Command.Parameters.AddWithValue("@CustomerID", value.value.CustomerID); + Command.Parameters.AddWithValue("@Freight", value.value.Freight ?? (object)DBNull.Value); + Command.Parameters.AddWithValue("@ShipCity", value.value.ShipCity); + Command.Parameters.AddWithValue("@EmployeeID", value.value.EmployeeID ?? (object)DBNull.Value); + Command.Parameters.AddWithValue("@OrderDate", DateTime.Now); + + // Execute the SQL query and update the record. + int rowsAffected = Command.ExecuteNonQuery(); + + // Return a success message if the update is successful. + return Ok(new { message = "Record updated successfully" }); + } + } +} +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 %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + + + +{% 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 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 a JSON result indicating success. +public JsonResult Remove(CRUDModel model) +{ + using (SqlCommand sqlConnection = new SqlConnection(ConnectionString)) + { + // Define the SQL query to delete the order based on OrderID. + string query = "DELETE FROM Orders WHERE OrderID=@OrderID"; + + using (SqlCommand sqlCommand = new SqlCommand(query, sqlConnection)) + { + // Add parameter to ensure data integrity and prevent SQL injection. + sqlCommand.Parameters.AddWithValue("@OrderID", model.key ?? (object)DBNull.Value); + + // Open the database connection and execute the delete command. + sqlConnection.Open(); + sqlCommand.ExecuteNonQuery(); + } + } + + // Return a JSON response indicating success. + return Json(new { success = true }); +} +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 %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + + + +{% 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 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 a JSON response with success or error message. +[HttpPost] +[Route("api/Grid/BatchUpdate")] +public IHttpActionResult BatchUpdate(CRUDModel value) +{ + // Establish a connection to the MySQL database. + using (MySqlConnection connection = new MySqlConnection(ConnectionString)) + { + // Open the database connection. + connection.Open(); + + // Process the list of updated records. + if (value.changed != null && value.changed.Count > 0) + { + // Define an SQL query to update records in the orders table. + string updateQuery = "UPDATE Orders SET CustomerID=@CustomerID, Freight=@Freight, EmployeeID=@EmployeeID, ShipCity=@ShipCity WHERE OrderID=@OrderID"; + + // Create a MySQL command object to execute the update query. + using (MySqlCommand command = new MySqlCommand(updateQuery, connection)) + { + // Iterate through the list of changed records and update each one. + foreach (Orders record in value.changed) + { + // Add parameters for updating the order details. + command.Parameters.AddWithValue("@OrderID", record.OrderID); + command.Parameters.AddWithValue("@CustomerID", record.CustomerID); + command.Parameters.AddWithValue("@Freight", record.Freight ?? (object)DBNull.Value); + command.Parameters.AddWithValue("@EmployeeID", record.EmployeeID ?? (object)DBNull.Value); + command.Parameters.AddWithValue("@ShipCity", record.ShipCity); + + // Execute the update query for the current record. + command.ExecuteNonQuery(); + } + } + } + + // Process the list of newly added records. + if (value.added != null && value.added.Count > 0) + { + // Define an SQL query to insert new records into the orders table. + string insertQuery = "INSERT INTO Orders (CustomerID, Freight, ShipCity, EmployeeID, OrderDate) VALUES (@CustomerID, @Freight, @ShipCity, @EmployeeID, @OrderDate)"; + + // Create a MySQL command object to execute the insert query. + using (MySqlCommand command = new MySqlCommand(insertQuery, connection)) + { + // Iterate through the list of added records and insert each one. + foreach (Orders record in value.added) + { + // Add parameters for inserting new order details. + command.Parameters.AddWithValue("@CustomerID", record.CustomerID); + command.Parameters.AddWithValue("@Freight", record.Freight ?? (object)DBNull.Value); + command.Parameters.AddWithValue("@EmployeeID", record.EmployeeID ?? (object)DBNull.Value); + command.Parameters.AddWithValue("@ShipCity", record.ShipCity); + command.Parameters.AddWithValue("@OrderDate", DateTime.Now); // Set current date as the order date. + + // Execute the insert query for the current record. + command.ExecuteNonQuery(); + } + } + } + + // Process the list of deleted records. + if (value.deleted != null && value.deleted.Count > 0) + { + // Define an SQL query to delete records from the orders table based on OrderID. + string deleteQuery = "DELETE FROM Orders WHERE OrderID=@OrderID"; + + // Create a MySQL command object to execute the delete query. + using (MySqlCommand command = new MySqlCommand(deleteQuery, connection)) + { + // Iterate through the list of deleted records and remove each one. + foreach (Orders record in value.deleted) + { + // Add the OrderID parameter to delete the corresponding record. + command.Parameters.AddWithValue("@OrderID", record.OrderID); + + // Execute the delete query for the current record. + command.ExecuteNonQuery(); + } + } + } + } + + // Return a success message after completing all batch operations. + return Ok(new { message = "Batch update completed successfully." }); +} + +{% endhighlight %} + +{% highlight cshtml tabtitle="Index.cshtml" %} + +// Replace `xxxx` with your actual localhost port number. +@Html.EJS().Grid("Grid").Columns(col => +{ + col.Field("OrderID").HeaderText("Order ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).IsPrimaryKey(true).IsIdentity(true).Add(); + col.Field("CustomerID").HeaderText("Customer Name").Width("100").ValidationRules(new { required = "true" }).Add(); + col.Field("EmployeeID").HeaderText("Employee ID").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).ValidationRules(new { required = "true", number = true}).Add(); + col.Field("Freight").HeaderText("Freight").Width("100").TextAlign(Syncfusion.EJ2.Grids.TextAlign.Right).Format("C2").ValidationRules(new { required = "true", min=1, max=1000 }).Add(); + col.Field("ShipCity").HeaderText("Ship City").Width("120").ValidationRules(new { required = "true" }).Add(); +}).AllowPaging().EditSettings(edit => { edit.AllowAdding(true).AllowEditing(true).AllowDeleting(true).Mode(Syncfusion.EJ2.Grids.EditMode.Batch); }).Toolbar(new List() { "Add", "Edit", "Delete", "Update", "Cancel" }).Render() + + + +{% endhighlight %} +{% endtabs %} + +When you run the application, the resultant Syncfusion ASP.NET MVC Grid will look like this + +![Syncfusion ASP.NET MVC Grid bound with MySQL Server data](../images/database/db-batch.gif) \ No newline at end of file diff --git a/ej2-asp-core-mvc/grid/images/database/db-batch.gif b/ej2-asp-core-mvc/grid/images/database/db-batch.gif new file mode 100644 index 0000000000..708a257d25 Binary files /dev/null and b/ej2-asp-core-mvc/grid/images/database/db-batch.gif differ diff --git a/ej2-asp-core-mvc/grid/images/database/db-crud.gif b/ej2-asp-core-mvc/grid/images/database/db-crud.gif new file mode 100644 index 0000000000..86f5d222f1 Binary files /dev/null and b/ej2-asp-core-mvc/grid/images/database/db-crud.gif differ diff --git a/ej2-asp-core-mvc/grid/images/database/db-data.png b/ej2-asp-core-mvc/grid/images/database/db-data.png new file mode 100644 index 0000000000..2095b65563 Binary files /dev/null and b/ej2-asp-core-mvc/grid/images/database/db-data.png differ diff --git a/ej2-asp-mvc-toc.html b/ej2-asp-mvc-toc.html index 63cf92f3eb..b860e37150 100644 --- a/ej2-asp-mvc-toc.html +++ b/ej2-asp-mvc-toc.html @@ -1259,6 +1259,11 @@
  • Custom Adaptor
    • +
  • Connecting to Databases + +
  • Data Annotation
  • Adaptive View
  • Columns