FluentCommand.EntityFactory 10.2.0

Suggested Alternatives

FluentCommand

dotnet add package FluentCommand.EntityFactory --version 10.2.0                
NuGet\Install-Package FluentCommand.EntityFactory -Version 10.2.0                
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.EntityFactory" Version="10.2.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add FluentCommand.EntityFactory --version 10.2.0                
#r "nuget: FluentCommand.EntityFactory, 10.2.0"                
#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.
// Install FluentCommand.EntityFactory as a Cake Addin
#addin nuget:?package=FluentCommand.EntityFactory&version=10.2.0

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

FluentCommand

Fluent Wrapper for DbCommand.

Build status

Coverage Status

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

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

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
  • Source Generate DataReader

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>();

Source Generator

The project supports generating a DbDataReader from a class via an attribute. Add the GenerateDataReaderAttribute to a class to generate the needed extension methods.

[GenerateDataReader]
[Table("Status", Schema = "dbo")]
public class Status
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Description { get; set; }
    public int DisplayOrder { get; set; }
    public bool IsActive { get; set; }
    public DateTimeOffset Created { get; set; }
    public string CreatedBy { get; set; }
    public DateTimeOffset Updated { get; set; }
    public string UpdatedBy { get; set; }

    [ConcurrencyCheck]
    [DatabaseGenerated(DatabaseGeneratedOption.Computed)]
    [DataFieldConverter(typeof(ConcurrencyTokenHandler))]
    public ConcurrencyToken RowVersion { get; set; }

    [NotMapped]
    public virtual ICollection<Task> Tasks { get; set; } = new List<Task>();
}

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 is compatible.  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. 
.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 (1)

Showing the top 1 NuGet packages that depend on FluentCommand.EntityFactory:

Package Downloads
FluentCommand.Batch

Fluent Wrapper for DbCommand

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
10.2.0 279 8/9/2023 10.2.0 is deprecated because it is no longer maintained.
10.1.6 187 7/28/2023
10.1.5 185 7/6/2023
10.0.707 347 3/13/2023
10.0.702 383 2/23/2023
10.0.701 370 2/23/2023
10.0.664 414 1/31/2023
10.0.659 422 1/25/2023
10.0.637 443 12/28/2022
10.0.636 450 12/27/2022
10.0.632 452 12/19/2022
10.0.625 434 12/13/2022
10.0.619 474 12/7/2022
10.0.616 470 12/6/2022
10.0.610 512 11/30/2022
9.5.591 570 11/9/2022
9.5.574 523 11/7/2022
9.5.570 543 11/6/2022
9.5.554 631 10/21/2022
9.5.553 595 10/20/2022
9.5.552 640 10/19/2022
9.5.551 592 10/19/2022
9.5.550 599 10/18/2022
9.5.549 621 10/18/2022
9.5.548 593 10/18/2022
9.5.547 580 10/17/2022
9.5.546 587 10/17/2022
9.5.545 615 10/16/2022
9.5.544 618 10/15/2022
9.5.540 602 10/15/2022
9.0.538 626 10/11/2022
9.0.537 612 10/10/2022
9.0.534 648 10/9/2022
9.0.533 623 10/7/2022
9.0.532 607 10/3/2022
9.0.530 673 10/2/2022
9.0.527 648 10/1/2022
9.0.526 644 10/1/2022
9.0.525 669 10/1/2022
9.0.524 639 9/30/2022
9.0.523 666 9/30/2022
9.0.522 684 9/30/2022
9.0.520 646 9/29/2022
9.0.519 701 9/29/2022
9.0.518 656 9/29/2022
9.0.514 675 9/29/2022
8.0.468 757 4/23/2022
8.0.430 444 12/22/2021
8.0.416 485 11/18/2021
7.0.0.393 543 10/21/2021
7.0.0.359 558 4/6/2021
7.0.0.335 584 2/15/2021
7.0.0.296 654 11/16/2020
7.0.0.293 711 11/12/2020
6.0.0.249 754 9/16/2020
6.0.0.240 733 9/5/2020
5.0.0.231 785 8/17/2020
5.0.0.230 790 8/12/2020
5.0.0.220 696 8/10/2020
4.1.0.202 712 6/25/2020
4.1.0.201 707 6/25/2020
4.1.0.186 746 6/15/2020
4.1.0.177 703 6/5/2020
4.1.0.176 701 6/5/2020
4.1.0.167 745 5/29/2020
4.1.0.166 715 5/27/2020
4.1.0.165 782 5/25/2020
4.0.0.148 744 4/11/2020
4.0.0.108 790 12/5/2019
4.0.0.85 729 11/30/2019
4.0.0.83 772 11/29/2019
3.0.0.49 830 5/20/2019
2.0.0.46 947 12/13/2018