Querying Single Row With Dapper

Dapper provides several methods for selecting a single row of data, depending on how you want to work with the data you retrieve.

Dapper QuerySingle

Dapper allows developers to easily select a single row of data from the database by using its QuerySingle method. This method takes the SQL query and any associated parameters as arguments and returns an instance of the specified type.

• The QuerySingle and QuerySingle<T> methods are designed to be used when you expect only one row to match the criteria specified in the query.
• The difference between QuerySingle and QuerySingle<T> is that QuerySingle returns results as a dynamic type whereas QuerySingle<T> returns an instance of the type represented by T type argument.

The following examples query the Products table from the Microsoft Northwind sample database. The schema of the table is as follows:

The first example returns dynamic types:

using (var connection = new SqlConnection(connectionString))
{
    var sql = "SELECT * FROM Products WHERE ProductID = 1";
    var product = connection.QuerySingle(sql);
	
    Console.WriteLine($"{product.ProductID} {product.ProductName}");
}

The next example works with a Product type, which has the following definition based on the table schema:

public class Product
{
    public int ProductID { get; set; }
    public string ProductName { get; set; }
    public int? SupplierId { get; set; }
    public int? CategoryId { get; set; }
    public string QuantityPerUnit { get; set; }
    public decimal UnitPrice { get; set; }
    public short? UnitsInStock { get; set; }
    public short? UnitsOnOrder { get; set; }
    public short? ReorderLevel { get; set; }
    public bool Discontinued { get; set; }
    public DateTime? DiscontinuedDate { get; set; }

    public Category Category { get; set; }
    public Supplier Supplier { get; set; }
    public ICollection<OrderDetail> OrderDetails { get; set; } = new HashSet<OrderDetail>();
}

The following example is identical to the first one except for the presence of the <Product> type parameter:

using (var connection = new SqlConnection(connectionString))
{
    var sql = "SELECT * FROM Products WHERE ProductID = 1";
    var product = connection.QuerySingle<Product>(sql);
	
    Console.WriteLine($"{product.ProductID} {product.ProductName}");
}

No matter what type of data you select from your database, Dapper's QuerySingle method can help make the process much simpler. With its simple syntax and parameterized queries, you'll easily select single rows of data from your database.

Dapper QuerySingleAsync

The QuerySingleAsync is an asynchronous version of QuerySingle, that executes the query asynchronously and returns the single row in the result set returned by the query.

using (var connection = new SqlConnection(connectionString))
{
    var sql = "SELECT * FROM Customers WHERE CustomerID = 1";
    var customer = await connection.QuerySingleAsync(sql);
    
    Console.WriteLine($"{customer.CustomerID} {customer.CompanyName}");
}

The asynchronous version of the QuerySingle<T> method is QuerySingleAsync<T>:

using (var connection = new SqlConnection(connectionString))
{
    var sql = "SELECT * FROM Customers WHERE CustomerID = 1";
    var customer = await connection.QuerySingleAsync<Customer>(sql);
    
    Console.WriteLine($"{customer.CustomerID} {customer.CompanyName}");
}

Dapper QueryFirst

Dapper QueryFirst allows you to collect the first result from a query. That is especially useful when you need only one row of data, such as when querying for an ID value or other single-row returns. QueryFirst can accept any type of SQL query and will return the result accordingly.

string sql = "SELECT * FROM Customers WHERE id=2";

using (var connection = new SqlConnection(connectionString))
{
    var customer = connection.QueryFirst<Customer>(sql);

    Console.WriteLine(person.FirstName);
    Console.WriteLine(person.LastName);
}

Dapper QueryFirstAsync

The asynchronous version of the QueryFirst method is QueryFirstAsync:

using (var connection = new SqlConnection(connectionString))
{
    var sql = "SELECT * FROM Customers WHERE CustomerID = 1";
    var customer = await connection.QueryFirstAsync<Customer>(sql);
    
    Console.WriteLine($"{customer.CustomerID} {customer.CompanyName}");
    Console.ReadLine();
}

Conclusion

In the above examples, we have used Dapper QuerySingle and QueryFirst methods to query a database and return only one row from the result set. That is useful when you know only one record will be returned, and you don't need to loop through all records in the result set. We can also access the values of the object returned from QueryFirst by specifying the name of each column. That provides a powerful and fast way to query a database with Dapper.

Related Articles

• Querying
• Stored Procedure
• Using Parameters