OllieDay / Daffer

Functional wrapper for Dapper

Daffer

Functional wrapper for Dapper.

• Provides a set of F# friendly functions for Dapper
• Makes passing parameters less noisy using ["name" => value]
• Converts IEnumerable<'T> to 'T list
• Converts Task<'T> to Async<'T>
• Provides alternatives to QueryFirstOrDefault<'T> and QuerySingleOrDefault<'T> that returns 'T option
• Handles conversion of primitives to and from 'T option

Getting started

Install the NuGet package into your application.

Package manager

Install-Package Daffer

.NET CLI

dotnet add package Daffer

Usage

let user = query<User> connection "SELECT * FROM Users WHERE Id = @Id" ["Id" => 1]

Maybe functions

Functions returning null have a counterpart that returns 'T option instead.

null	'T option
queryFirstOrDefault<'T>	queryFirstMaybe<'T>
queryFirstOrDefaultAsync<'T>	queryFirstMaybeAsync<'T>
querySingleOrDefault<'T>	querySingleMaybe<'T>
querySingleOrDefaultAsync<'T>	querySingleMaybeAsync<'T>

Converting primitives to and from 'T option

The following primitive types can be automatically converted to and from 'T option by calling addOptionHandlers on application initialization.

• bool
• byte
• sbyte
• char
• single
• double
• decimal
• int8
• uint8
• int16
• uint16
• int32
• uint32
• int64
• uint64
• string
• Guid
• DateTime

Optional arguments

The Builder module can be used for calling the underlying Dapper methods with optional arguments such as:

• transaction
• commandTimeout
• commandType
• buffered

let user =
    Builder.create ()
        |> Builder.addTransaction transaction
        |> Builder.addCommandTimeout 1000
        |> Builder.addCommandType CommandType.StoredProcedure
        |> Builder.addBuffered false
        |> Builder.query<User> connection "SELECT * FROM Users WHERE Id = @Id" ["id" => 1]

Definitions

type Parameter = string * obj

(=>)                          : string -> obj -> Parameter

addOptionHandlers             : unit -> unit

execute                       : IDbConnection -> string -> Parameter list -> int
executeAsync                  : IDbConnection -> string -> Parameter list -> Async<int>
executeReader                 : IDbConnection -> string -> Parameter list -> IDataReader
executeReaderAsync            : IDbConnection -> string -> Parameter list -> Async<IDataReader>
executeScalar<'T>             : IDbConnection -> string -> Parameter list -> 'T
executeScalarAsync<'T>        : IDbConnection -> string -> Parameter list -> Async<'T>
query<'T>                     : IDbConnection -> string -> Parameter list -> 'T list
queryAsync<'T>                : IDbConnection -> string -> Parameter list -> Async<'T list>
queryFirst<'T>                : IDbConnection -> string -> Parameter list -> 'T
queryFirstAsync<'T>           : IDbConnection -> string -> Parameter list -> Async<'T>
queryFirstOrDefault<'T>       : IDbConnection -> string -> Parameter list -> 'T
queryFirstOrDefaultAsync<'T>  : IDbConnection -> string -> Parameter list -> Async<'T>
queryMultiple                 : IDbConnection -> string -> Parameter list -> SqlMapper.GridReader
queryMultipleAsync            : IDbConnection -> string -> Parameter list -> Async<SqlMapper.GridReader>
querySingle<'T>               : IDbConnection -> string -> Parameter list -> 'T
querySingleAsync<'T>          : IDbConnection -> string -> Parameter list -> Async<'T>
querySingleOrDefault<'T>      : IDbConnection -> string -> Parameter list -> 'T
querySingleOrDefaultAsync<'T> : IDbConnection -> string -> Parameter list -> Async<'T>
queryFirstMaybe<'T>           : IDbConnection -> string -> Parameter list -> 'T option
queryFirstMaybeAsync<'T>      : IDbConnection -> string -> Parameter list -> Async<'T option>
querySingleMaybe<'T>          : IDbConnection -> string -> Parameter list -> 'T option
querySingleMaybeAsync<'T>     : IDbConnection -> string -> Parameter list -> Async<'T option>

Builder definitions

type Build = {
    Transaction : IDbTransaction option
    CommandTimeout : int option
    CommandType : CommandType option
    Buffered : bool option
}

create                        : unit -> Build

addTransaction                : IDbTransaction -> Build -> Build
addCommandTimeout             : int -> Build -> Build
addCommandType                : CommandType -> Build -> Build
addBuffered                   : bool -> Build -> Build

execute                       : IDbConnection -> string -> Parameter list -> Build -> int
executeAsync                  : IDbConnection -> string -> Parameter list -> Build -> Async<int>
executeReader                 : IDbConnection -> string -> Parameter list -> Build -> IDataReader
executeReaderAsync            : IDbConnection -> string -> Parameter list -> Build -> Async<IDataReader>
executeScalar<'T>             : IDbConnection -> string -> Parameter list -> Build -> 'T
executeScalarAsync<'T>        : IDbConnection -> string -> Parameter list -> Build -> Async<'T>
query<'T>                     : IDbConnection -> string -> Parameter list -> Build -> 'T list
queryAsync<'T>                : IDbConnection -> string -> Parameter list -> Build -> Async<'T list>
queryFirst<'T>                : IDbConnection -> string -> Parameter list -> Build -> 'T
queryFirstAsync<'T>           : IDbConnection -> string -> Parameter list -> Build -> Async<'T>
queryFirstOrDefault<'T>       : IDbConnection -> string -> Parameter list -> Build -> 'T
queryFirstOrDefaultAsync<'T>  : IDbConnection -> string -> Parameter list -> Build -> Async<'T>
queryMultiple                 : IDbConnection -> string -> Parameter list -> Build -> SqlMapper.GridReader
queryMultipleAsync            : IDbConnection -> string -> Parameter list -> Build -> Async<SqlMapper.GridReader>
querySingle<'T>               : IDbConnection -> string -> Parameter list -> Build -> 'T
querySingleAsync<'T>          : IDbConnection -> string -> Parameter list -> Build -> Async<'T>
querySingleOrDefault<'T>      : IDbConnection -> string -> Parameter list -> Build -> 'T
querySingleOrDefaultAsync<'T> : IDbConnection -> string -> Parameter list -> Build -> Async<'T>
queryFirstMaybe<'T>           : IDbConnection -> string -> Parameter list -> Build -> 'T option
queryFirstMaybeAsync<'T>      : IDbConnection -> string -> Parameter list -> Build -> Async<'T option>
querySingleMaybe<'T>          : IDbConnection -> string -> Parameter list -> Build -> 'T option
querySingleMaybeAsync<'T>     : IDbConnection -> string -> Parameter list -> Build -> Async<'T option>