Mondocks 0.4.8

.NET 5.0 .NET Standard 2.0
Install-Package Mondocks -Version 0.4.8
dotnet add package Mondocks --version 0.4.8
<PackageReference Include="Mondocks" Version="0.4.8" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Mondocks --version 0.4.8
The NuGet Team does not provide support for this client. Please contact its maintainers for support.
#r "nuget: Mondocks, 0.4.8"
#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 Mondocks as a Cake Addin
#addin nuget:?package=Mondocks&version=0.4.8

// Install Mondocks as a Cake Tool
#tool nuget:?package=Mondocks&version=0.4.8
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Mondocks

nuget Binder

dotnet add package Mondocks.Net
# or for fable/nodejs
dotnet add package Mondocks.Fable

This library is based on the mongodb extended json spec and mongodb manual reference

https://docs.mongodb.com/manual/reference/mongodb-extended-json/ > https://docs.mongodb.com/manual/reference/command/

This library provides a set of familiar tools if you work with mongo databases and can be a step into more F# goodies, it doesn't prevent you from using the usual MongoDB/.NET driver so you can use them side by side. It also can help you if you have a lot of flexible data inside your database as oposed to the usual strict schemas that F#/C# are used to from SQL tools, this provides a DSL that allow you to create MongoDB Commands (raw queries) leveraging the dynamism of anonymous records since they behave almost like javascript objects. Writing commands should be almost painless these commands produce a JSON string that can be utilized directly on your application or even copy/pasted into the mongo shell. Commands are kind of a version of raw sql queries but they allow you to do what you already know how to do without much changes to the objects you might be manipulating already. Ideally this library is meant to be used mostly with records and anonymous records to imitate mongodb queries

Sample Usage

Check out this quick sample of what you can do right now

You can also check this gist

open System
open MongoDB.Driver
open MongoDB.Bson
open Mondocks.Queries
open Mondocks.Types

type User = { _id: ObjectId; name: string; age: int }
let createUsers minAge maxAge =
    let random  = Random()
    insert "users" {
        documents
            [   // an anonymous object that does not include a null _id
                {| name = "Peter"; age = random.Next(minAge, maxAge); |}
                {| name = "Sandra"; age = random.Next(minAge, maxAge); |}
                {| name = "Mike"; age = random.Next(minAge, maxAge); |}
                {| name = "Perla"; age = random.Next(minAge, maxAge); |}
                {| name = "Updateme"; age = 1; |}
                {| name = "Deleteme"; age = 50; |}
            ]
    }
let getUsersOverAge (age: int) =
    find "users" {
        // equivalent to a mongo query filter
        // { age: { $gt: age } }
        filter {| age = {| ``$gt``= age |} |}
        limit 2
        skip 1
    }
let updateUser (name: string) (newName: string) =
    update "users" {
        updates
            [ { // you can do mongo queries like
                // {| ``$or`` = [] |} -> { $or: [] }
                q = {| name = name |}
                u = {| name = newName; age = 5 |}
                multi = Some false
                upsert = Some false
                collation = None
                arrayFilters = None
                hint = None }
            ]
    }
let deleteUser (name: string) =
    delete "users" {
        deletes
           [ { q = {| name = name |}
               limit = 1
               collation = None
               hint = None
               comment = None }
        ]
    }
[<EntryPoint>]
let main argv =
    let client = MongoClient("mongodb://localhost:27017")
    let db = client.GetDatabase("mondocks")

    let userscmd = createUsers 15 50
    let result = db.RunCommand<InsertResult>(JsonCommand userscmd)
    printfn $"InsertResult: %A{result}"

    let over20 = getUsersOverAge 20
    let result = db.RunCommand<FindResult<User>>(JsonCommand over20)
    printfn $"FindResult Ok: %f{result.ok}"
    result.cursor.firstBatch |> Seq.iter (fun value -> printfn $"%A{value}")

    let updatecmd = updateUser "Updateme" "Updated"
    let result = db.RunCommand<UpdateResult>(JsonCommand updatecmd)
    printfn $"UpdateResult: %A{result}"

    let deletecmd = deleteUser "Deleteme"
    let result = db.RunCommand<DeleteResult>(JsonCommand deletecmd)
    printfn $"DeleteResult: %A{result}"

    0

If you want to see what else is available check the samples directory

Documentation

Right now the documentation is provided via .NET Interactive notebooks. There are three ways ways to ineract with it

  • The Notebooks directory contains jupyter notebooks that you can download and open them with the VSCode Extension to interact with them in real time.

  • If you don't want to download anything you can still check the notebooks online, click on Binder to go to the binder website and check the notebooks online

  • If your editor supports doc comments, you should be able to see samples as well, part of the source code is documented that way, you should even see examples in the editor tooltips in some cases

Goals

Non Required Extras

  • provide helpers to write different syntax (e.g. filter (fun m -> m.prop = value), filter ("prop" gt 10))

Non Goals

  • Convert this into a document mapper
  • Provide 100% of the mongo commands
  • Provide a 100% F# idiomatic solution

This is a work in progress, you can help providing feedback about it's usage

Thanks for the early feedback in twitter from Isaac, Zaid, Alexey, Alexander, and the F# community you can follow it on the first issue

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

Showing the top 2 NuGet packages that depend on Mondocks:

Package Downloads
Mondocks.Net

Package Description

Mondocks.Fable

Package Description

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
0.4.8 136 2/14/2022
0.4.2 265 7/27/2021
0.3.18 225 12/23/2020
0.3.15 212 12/17/2020
0.2.0 206 12/7/2020
0.1.0 246 11/27/2020
0.1.0-beta3 184 11/23/2020
0.1.0-beta2 232 11/23/2020
0.1.0-beta1 168 11/22/2020