FluentCommand 9.5.591

.NET 6.0 .NET Standard 2.0
dotnet add package FluentCommand --version 9.5.591
NuGet\Install-Package FluentCommand -Version 9.5.591
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="FluentCommand" Version="9.5.591" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FluentCommand --version 9.5.591
#r "nuget: FluentCommand, 9.5.591"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install FluentCommand as a Cake Addin
#addin nuget:?package=FluentCommand&version=9.5.591

// Install FluentCommand as a Cake Tool
#tool nuget:?package=FluentCommand&version=9.5.591

FluentCommand

Fluent Wrapper for DbCommand.

Build status

Coverage Status

Package Version
FluentCommand FluentCommand
FluentCommand.Dapper FluentCommand.Dapper
FluentCommand.SqlServer FluentCommand.SqlServer

Download

The FluentCommand library is available on nuget.org via package name FluentCommand.

To install FluentCommand, run the following command in the Package Manager Console

PM> Install-Package FluentCommand

More information about NuGet package avaliable at https://nuget.org/packages/FluentCommand

Development Builds

Development builds are available on the myget.org feed. A development build is promoted to the main NuGet feed when it's determined to be stable.

In your Package Manager settings add the following package source for development builds: http://www.myget.org/F/loresoft/

Features

  • Fluent wrapper over DbConnection and DbCommand
  • Callback for parameter return values
  • Automatic handling of connection state
  • Caching of results
  • Automatic creating of entity from DataReader via Dapper
  • Create Dynamic objects from DataReader via Dapper
  • Handles multiple result sets
  • Basic SQL query builder

Configuration

Configuration for SQL Server

IDataConfiguration dataConfiguration  = new DataConfiguration(
    SqlClientFactory.Instance, 
    ConnectionString
);

Example

Query all users with email domain. Entity is automaticly created from DataReader.

string email = "%@battlestar.com";
string sql = "select * from [User] where EmailAddress like @EmailAddress";

var session = configuration.CreateSession();
var user = await session
    .Sql(sql)
    .Parameter("@EmailAddress", email)
    .QuerySingleAsync(r => new User
    {
        Id = r.GetGuid("Id"),
        EmailAddress = r.GetString("EmailAddress"),
        IsEmailAddressConfirmed = r.GetBoolean("IsEmailAddressConfirmed"),
        DisplayName = r.GetString("DisplayName"),
        PasswordHash = r.GetString("PasswordHash"),
        ResetHash = r.GetString("ResetHash"),
        InviteHash = r.GetString("InviteHash"),
        AccessFailedCount = r.GetInt32("AccessFailedCount"),
        LockoutEnabled = r.GetBoolean("LockoutEnabled"),
        LockoutEnd = r.GetDateTimeOffsetNull("LockoutEnd"),
        LastLogin = r.GetDateTimeOffsetNull("LastLogin"),
        IsDeleted = r.GetBoolean("IsDeleted"),
        Created = r.GetDateTimeOffset("Created"),
        CreatedBy = r.GetString("CreatedBy"),
        Updated = r.GetDateTimeOffset("Updated"),
        UpdatedBy = r.GetString("UpdatedBy"),
        RowVersion = r.GetBytes("RowVersion"),
    });

Execute a stored procedure with out parameters

Guid userId = Guid.Empty;
int errorCode = -1;

var username = "test." + DateTime.Now.Ticks;
var email = username + "@email.com";

var session = configuration.CreateSession();
var result = session
    .StoredProcedure("[dbo].[aspnet_Membership_CreateUser]")
    .Parameter("@ApplicationName", "/")
    .Parameter("@UserName", username)
    .Parameter("@Password", "T@est" + DateTime.Now.Ticks)
    .Parameter("@Email", email)
    .Parameter("@PasswordSalt", "test salt")
    .Parameter<string>("@PasswordQuestion", null)
    .Parameter<string>("@PasswordAnswer", null)
    .Parameter("@IsApproved", true)
    .Parameter("@CurrentTimeUtc", DateTime.UtcNow)
    .Parameter("@UniqueEmail", 1)
    .Parameter("@PasswordFormat", 1)
    .ParameterOut<Guid>("@UserId", p => userId = p)
    .Return<int>(p => errorCode = p)
    .Execute();

Query for user by email address. Also return Role and Status entities.

string email = "kara.thrace@battlestar.com";
string sql = "select * from [User] where EmailAddress = @EmailAddress; " +
             "select * from [Status]; " +
             "select * from [Priority]; ";

User user = null;
List<Status> status = null;
List<Priority> priorities = null;

var session = configuration.CreateSession();
session
    .Sql(sql)
    .Parameter("@EmailAddress", email)
    .QueryMultiple(q =>
    {
        user = q.QuerySingle<User>();
        status = q.Query<Status>().ToList();
        priorities = q.Query<Priority>().ToList();
    });

Dapper

PM> Install-Package FluentCommand.Dapper

Use Dapper to materialize data reader to entities


string email = "kara.thrace@battlestar.com";
string sql = "select * from [User] where EmailAddress = @EmailAddress";

var session = configuration.CreateSession();
var user = await session
    .Sql(sql)
    .Parameter("@EmailAddress", email)
    .QuerySingleAsync<User>();

Query Builder

Build SQL statements with the query builder. Query builder uses the DataAnnotations Schema attributes to extract table and column information.

var session = configuration.CreateSession();

string email = "kara.thrace@battlestar.com";

var user = await session
    .Sql(builder => builder
        .Select<User>() // table name comes from type
        .Where(p => p.EmailAddress, email)
    )
    .QuerySingleAsync();

Count query

string email = "kara.thrace@battlestar.com";

var count = await session
    .Sql(builder => builder
        .Select<User>()
        .Count()
        .Where(p => p.EmailAddress, email)
    )
    .QueryValueAsync<int>();

Insert statement

var id = Guid.NewGuid();

var userId = await session
    .Sql(builder => builder
        .Insert<User>()
        .Value(p => p.Id, id)
        .Value(p => p.EmailAddress, $"{id}@email.com")
        .Value(p => p.DisplayName, "Last, First")
        .Value(p => p.FirstName, "First")
        .Value(p => p.LastName, "Last")
        .Output(p => p.Id) // return key as output value
        .Tag() // add comment tag to querey
    )
    .QueryValueAsync<Guid>();

Update statement

var updateId = await session
    .Sql(builder => builder
        .Update<User>()
        .Value(p => p.DisplayName, "Updated Name")
        .Output(p => p.Id)
        .Where(p => p.Id, id)
        .Tag()
    )
    .QueryValueAsync<Guid>();

Delete statement

var deleteId = await session
    .Sql(builder => builder
        .Delete<User>()
        .Output(p => p.Id)
        .Where(p => p.Id, id)
        .Tag()
    )
    .QueryValueAsync<Guid>();

SQL Server Features

PM> Install-Package FluentCommand.SqlServer

Bulk Copy

Using SQL Server bulk copy feature to import a lot of data.

using (var session = configuration.CreateSession())
{
    session.BulkCopy("[User]")
        .AutoMap()
        .Ignore("RowVersion")
        .WriteToServer(users);
}

Merge Data

Generate and merge data into a table

var users = generator.List<UserImport>(100);

int rows;
using (var session = configuration.CreateSession())
{
    rows = session
        .MergeData("dbo.User")
        .Map<UserImport>(m => m
            .AutoMap()
            .Column(p => p.EmailAddress).Key()
        )
        .Execute(users);
}
Product Versions
.NET net5.0 net5.0-windows net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows
.NET Core netcoreapp2.0 netcoreapp2.1 netcoreapp2.2 netcoreapp3.0 netcoreapp3.1
.NET Standard netstandard2.0 netstandard2.1
.NET Framework net461 net462 net463 net47 net471 net472 net48
MonoAndroid monoandroid
MonoMac monomac
MonoTouch monotouch
Tizen tizen40 tizen60
Xamarin.iOS xamarinios
Xamarin.Mac xamarinmac
Xamarin.TVOS xamarintvos
Xamarin.WatchOS xamarinwatchos
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on FluentCommand:

Package Downloads
FluentCommand.SqlServer

Fluent Wrapper for DbCommand

FluentCommand.EntityFactory

Fluent Wrapper for DbCommand

FluentCommand.Batch

Fluent Wrapper for DbCommand

FluentCommand.Json

Fluent Wrapper for DbCommand

FluentCommand.Dapper

Fluent Wrapper for DbCommand

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
9.5.591 334 11/9/2022
9.5.574 204 11/7/2022
9.5.570 246 11/6/2022
9.5.554 573 10/21/2022
9.5.553 445 10/20/2022
9.5.552 491 10/19/2022
9.5.551 441 10/19/2022
9.5.550 441 10/18/2022
9.5.549 441 10/18/2022
9.5.548 453 10/18/2022
9.5.547 416 10/17/2022
9.5.546 431 10/17/2022
9.5.545 526 10/16/2022
9.5.544 486 10/15/2022
9.5.540 511 10/15/2022
9.0.538 589 10/11/2022
9.0.537 503 10/10/2022
9.0.534 490 10/9/2022
9.0.533 481 10/7/2022
9.0.532 530 10/3/2022
9.0.530 504 10/2/2022
9.0.527 520 10/1/2022
9.0.526 492 10/1/2022
9.0.525 517 10/1/2022
9.0.524 519 9/30/2022
9.0.523 519 9/30/2022
9.0.522 522 9/30/2022
9.0.520 526 9/29/2022
9.0.519 525 9/29/2022
9.0.518 514 9/29/2022
9.0.514 478 9/29/2022
8.0.468 694 4/23/2022
8.0.430 486 12/22/2021
8.0.416 514 11/18/2021
7.0.0.393 627 10/21/2021
7.0.0.359 666 4/6/2021
7.0.0.335 654 2/15/2021
7.0.0.296 809 11/16/2020
7.0.0.293 799 11/12/2020
6.0.0.249 967 9/16/2020
6.0.0.240 860 9/5/2020
5.0.0.231 896 8/17/2020
5.0.0.230 829 8/12/2020
5.0.0.220 734 8/10/2020
4.1.0.202 751 6/25/2020
4.1.0.201 766 6/25/2020
4.1.0.186 787 6/15/2020
4.1.0.177 787 6/5/2020
4.1.0.176 773 6/5/2020
4.1.0.167 767 5/29/2020
4.1.0.166 783 5/27/2020
4.1.0.165 797 5/25/2020
4.0.0.148 815 4/11/2020
4.0.0.108 961 12/5/2019
4.0.0.85 789 11/30/2019
4.0.0.83 794 11/29/2019
3.0.0.49 919 5/20/2019
2.0.0.46 901 12/13/2018
1.0.0.8 1,430 10/28/2014