In this article I will explain with an example, how to use
Output Parameter with
Stored Procedure using
Dapper library in ASP.Net Core MVC.
Installing Dapper package using Nuget
Database
I have made use of the following table Customers with the schema as follows.
Note: You can download the database table SQL by clicking the download link below.
Stored Procedure
This
Stored Procedure accepts following parameters which are used to
insert the records:
Name – This is an INPUT Parameter to pass the Name of the Customer.
Country – This is an INPUT Parameter to pass the Country of the Customer.
CustomerId – This is an OUTPUT Parameter to get the last inserted CustomerId.
Note: Output Parameter is identified by the keyword OUTPUT.
CREATE PROCEDURE [Customers_InsertCustomer_Output]
@Name VARCHAR(100),
@Country VARCHAR(50),
@CustomerId INT OUTPUT
AS
BEGIN
INSERT INTO [Customers]
([Name]
,[Country])
VALUES
(@Name
,@Country)
SELECT @CustomerId = SCOPE_IDENTITY()
END
Model
The Model class consists of following properties.
public class CustomerModel
{
public int CustomerId { get; set; }
public string Name { get; set; }
public string Country { get; set; }
}
Namespaces
You will need to import the following namespaces.
using Dapper;
using System.Data;
using System.Data.SqlClient;
Controller
The Controller consists of following Action methods.
Action method for handling GET operation
Inside this Action method, simply the View is returned.
Action method for handling POST operation
This method accepts Customer class object as a parameter.
An object of DynamicParameters is created and CustomerId is added as parameter with its Data Type specified and its Direction is set to Output since by default the Direction of all parameter is Input.
The Name and Country values are also added as parameter.
Then, the
Execute method of
Dapper library is used to fetch
CustomerId of the inserted record from the
Customers Table.
Finally, the CustomerId of the inserted record is set and the Customer class object is returned to the View.
public class HomeController : Controller
{
public IConfiguration Configuration { get; set; }
public HomeController(IConfiguration _configuration)
{
this.Configuration = _configuration;
}
public IActionResult Index()
{
return View();
}
[HttpPost]
public IActionResult Index(CustomerModel customer)
{
string spName = "Customers_InsertCustomer_Output";
string constr = this.Configuration.GetSection("ConnectionStrings")["MyConn"];
using (SqlConnection con = new SqlConnection(constr))
{
DynamicParameters dynamicParameters = new DynamicParameters();
// Adding Input parameters.
dynamicParameters.Add("@Name", customer.Name);
dynamicParameters.Add("@Country", customer.Country);
// Adding Output parameter.
dynamicParameters.Add("@CustomerId", DbType.Int32, direction: ParameterDirection.Output);
con.Execute(spName, dynamicParameters, commandType: CommandType.StoredProcedure);
customer.CustomerId = dynamicParameters.Get<int>("@CustomerId");
}
return View(customer);
}
}
View
Inside the View, in the very first line the CustomerModel class is declared as Model for the View.
The View consists of an HTML Form which has been created using the following TagHelpers attributes.
asp-action – Name of the Action. In this case the name is Index.
asp-controller – Name of the Controller. In this case the name is Home.
method – It specifies the Form Method i.e. GET or POST. In this case it will be set to POST.
The View also consists of an HTML Table, which consists of an HTML INPUT TextBox and HTML SELECT (DropDownList) and a Submit Button.
Inside the View, the following
jQuery script file is inherited.
1. jquery.min.js
Submitting Form
When the
Submit button is clicked the Form is submitted and finally, the
Model is checked for NULL and if it is not NULL then, the
CustomerId is displayed using
JavaScript Alert Message Box.
@model Dapper_Output_Parameter_SP_Core.CustomerModel
@addTagHelper*, Microsoft.AspNetCore.Mvc.TagHelpers
@{
Layout = null;
}
<!DOCTYPE html>
<html>
<head>
<meta name="viewport" content="width=device-width" />
<title>Index</title>
</head>
<body>
<form method="post" asp-controller="Home" asp-action="Index">
<table cellpadding="0" cellspacing="0">
<tr>
<td>Name: </td>
<td><input type="text" asp-for="Name" />td>
</tr>
<tr>
<td>Country: </td>
<td>
<select asp-for="Country">
<option value="Please select">Please select</option>
<option value="United States">United States</option>
<option value="India">India</option>
<option value="France">France</option>
<option value="Russia">Russia</option>
</select>
</td>
</tr>
<tr>
<td></td>
<td><input type="submit" value="Submit" /></td>
</tr>
</table>
</form>
<script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.7.1/jquery.min.js"></script>
@if (Model != null)
{
<script type="text/javascript">
$(function () {
alert("Inserted Customer ID: " + @Model.CustomerId);
});
</script>
}
</body>
</html>
Screenshots
The Form
Record after Insert in database
Downloads