FluentCommand 9.0.526

There is a newer version of this package available.
See the version list below for details.
dotnet add package FluentCommand --version 9.0.526
                    
NuGet\Install-Package FluentCommand -Version 9.0.526
                    
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.0.526" />
                    
For projects that support PackageReference, copy this XML node into the project file to reference the package.
<PackageVersion Include="FluentCommand" Version="9.0.526" />
                    
Directory.Packages.props
<PackageReference Include="FluentCommand" />
                    
Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package.
paket add FluentCommand --version 9.0.526
                    
#r "nuget: FluentCommand, 9.0.526"
                    
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
#addin nuget:?package=FluentCommand&version=9.0.526
                    
Install FluentCommand as a Cake Addin
#tool nuget:?package=FluentCommand&version=9.0.526
                    
Install FluentCommand as a Cake Tool

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

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 Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 was computed. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (7)

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
13.1.0 2,951 2/16/2025
13.0.0 1,421 11/13/2024
12.13.2 437 9/21/2024
12.13.1 230 9/19/2024
12.13.0 281 9/16/2024
12.12.0 351 9/7/2024
12.11.0 566 8/9/2024
12.10.8 276 8/8/2024
12.10.7 390 7/17/2024
12.10.6 388 7/9/2024
12.10.5 253 7/9/2024
12.10.4 269 6/7/2024
12.10.3 303 5/14/2024
12.10.2 606 5/10/2024
12.10.1 286 5/6/2024
12.10.0 287 5/6/2024
12.9.1 258 5/3/2024
12.9.0 310 4/26/2024
12.8.0 303 4/17/2024
12.7.0 394 3/19/2024
12.6.0 353 2/4/2024
12.5.0 1,345 11/24/2023
12.4.2 283 10/28/2023
12.4.1 319 10/12/2023
12.4.0 291 10/12/2023
12.3.0 6,395 9/14/2023
12.2.0 279 9/14/2023
12.1.0 254 9/13/2023
12.0.0 250 9/12/2023
12.0.0-beta.1 94 9/11/2023
11.0.0 370 8/16/2023
10.2.0 4,825 8/9/2023
10.1.6 373 7/28/2023
10.1.5 360 7/6/2023
10.0.707 1,436 3/13/2023
10.0.702 1,551 2/23/2023
10.0.701 848 2/23/2023
10.0.664 1,376 1/31/2023
10.0.659 1,025 1/25/2023
10.0.637 1,337 12/28/2022
10.0.636 1,114 12/27/2022
10.0.632 1,223 12/19/2022
10.0.625 1,174 12/13/2022
10.0.619 1,303 12/7/2022
10.0.616 1,220 12/6/2022
10.0.610 1,285 11/30/2022
9.5.591 10,497 11/9/2022
9.5.574 1,387 11/7/2022
9.5.570 1,432 11/6/2022
9.5.554 1,739 10/21/2022
9.5.553 1,615 10/20/2022
9.5.552 1,679 10/19/2022
9.5.551 1,605 10/19/2022
9.5.550 1,618 10/18/2022
9.5.549 1,576 10/18/2022
9.5.548 1,606 10/18/2022
9.5.547 1,578 10/17/2022
9.5.546 1,624 10/17/2022
9.5.545 1,667 10/16/2022
9.5.544 1,630 10/15/2022
9.5.540 1,661 10/15/2022
9.0.538 1,764 10/11/2022
9.0.537 1,660 10/10/2022
9.0.534 1,662 10/9/2022
9.0.533 1,656 10/7/2022
9.0.532 1,705 10/3/2022
9.0.530 1,702 10/2/2022
9.0.527 1,696 10/1/2022
9.0.526 1,655 10/1/2022
9.0.525 1,704 10/1/2022
9.0.524 1,637 9/30/2022
9.0.523 1,653 9/30/2022
9.0.522 1,721 9/30/2022
9.0.520 1,658 9/29/2022
9.0.519 1,739 9/29/2022
9.0.518 1,685 9/29/2022
9.0.514 1,505 9/29/2022
8.0.468 1,694 4/23/2022
8.0.430 925 12/22/2021
8.0.416 920 11/18/2021
7.0.0.393 1,053 10/21/2021
7.0.0.359 1,287 4/6/2021
7.0.0.335 1,077 2/15/2021
7.0.0.296 1,266 11/16/2020
7.0.0.293 1,273 11/12/2020
6.0.0.249 1,390 9/16/2020
6.0.0.240 1,285 9/5/2020
5.0.0.231 1,366 8/17/2020
5.0.0.230 1,219 8/12/2020
5.0.0.220 1,152 8/10/2020
4.1.0.202 1,149 6/25/2020
4.1.0.201 1,149 6/25/2020
4.1.0.186 1,190 6/15/2020
4.1.0.177 1,165 6/5/2020
4.1.0.176 1,124 6/5/2020
4.1.0.167 1,152 5/29/2020
4.1.0.166 1,172 5/27/2020
4.1.0.165 1,173 5/25/2020
4.0.0.148 1,221 4/11/2020
4.0.0.108 1,353 12/5/2019
4.0.0.85 1,160 11/30/2019
4.0.0.83 1,182 11/29/2019
3.0.0.49 1,311 5/20/2019
2.0.0.46 1,260 12/13/2018
1.0.0.8 2,311 10/28/2014