Dapper.SimpleCRUD.Core

Simple CRUD helpers for Dapper based on .NET Standard 1.3

Features

Dapper.SimpleCRUD.Core is a port of the excellent extension for Dapper created by Eric Coffman to .NET Standard 1.3.

See usage instructions in Eric Coffman's original project at https://github.com/ericdc1/Dapper.SimpleCRUD.

This version also includes the following changes and improvements:

1) Tests were migrated to Unit Tests (only SQL Server for now)

2) Possibility to use strings as primary keys

3) Possibility to exclude certain fields in the Get functions

The following functions have a new overload that accepts the 'string[] propertiesToBeIgnored' parameter, allowing you to define which fields you don't want to retrieve:

• Get<Type>(..., string[] propertiesToBeIgnored, ...)
• GetList<Type>(..., string[] propertiesToBeIgnored, ...)
• GetListPaged<Type>(..., string[] propertiesToBeIgnored, ...)

By using this parameter, you can specify which properties you don't want to retrieve from the database. This is useful to avoid reading large or sensitive fields.

4) New Update functions to update only non-null fields of an object

The following functions were added to allow updating only the non-null fields of an object.

public static int UpdateNonNullProps(this IDbConnection connection, TEntity entityToUpdate, IDbTransaction transaction = null, int? commandTimeout = null);
public static Task<int> UpdateNonNullPropsAsync<TEntity>(this IDbConnection connection, TEntity entityToUpdate, IDbTransaction transaction = null, int? commandTimeout = null, System.Threading.CancellationToken? token = null);

Example usage:

public class User
{
    public int Id { get; set; }
    public string Name { get; set; }
    public string Email { get; set; }
    public string Status { get; set; }
}
...
// change only the status of a user
connection.UpdateNonNullProps( new User{ Id=1, Status="inactive" });

This is useful when we only want to update certain properties of the object without needing to read the object from the database, change the properties, and then re-save it. This is more performant and also more thread-safe, as you only need one operation to update the object.

But be aware of non-nullable properties because these will always be updated.

5) Added a function to help manipulate entries in Many-to-Many tables.

public static void UpdateManyToManyRelations<ManyToManyTable>(this IDbConnection connection,
                                                              string parentEntityIdFieldName, object parentId,
                                                              string childEntityIdFieldName, IEnumerable<Guid> newChildIds,
                                                              IDbTransaction transaction = null, int? commandTimeout = null)

With this function you need only to provide the new list of items(newChildIds) to be linked with a parent object(parentEntityIdFieldName/parentId) in the <ManyToManyTable>