BitBadger.Npgsql.FSharp.Documents 1.0.0

.NET 6.0 This package targets .NET 6.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet add package BitBadger.Npgsql.FSharp.Documents --version 1.0.0                

                    
                

            
NuGet\Install-Package BitBadger.Npgsql.FSharp.Documents -Version 1.0.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="BitBadger.Npgsql.FSharp.Documents" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
paket add BitBadger.Npgsql.FSharp.Documents --version 1.0.0                

                    
                

            
#r "nuget: BitBadger.Npgsql.FSharp.Documents, 1.0.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 BitBadger.Npgsql.FSharp.Documents as a Cake Addin
#addin nuget:?package=BitBadger.Npgsql.FSharp.Documents&version=1.0.0

// Install BitBadger.Npgsql.FSharp.Documents as a Cake Tool
#tool nuget:?package=BitBadger.Npgsql.FSharp.Documents&version=1.0.0

This package provides a set of functions that provide a document database interface to a data store backed by PostgreSQL. This library is targeted toward F# usage; for C#, see BitBadger.Npgsql.Documents.

Features

  • Select, insert, update, save (upsert), delete, count, and check existence of documents, and create tables and indexes for these documents
  • Addresses documents via ID; via equality on any property by using JSON containment queries; or via condition on any property using JSON Path queries
  • Accesses documents as your domain models (<abbr title="Plain Old CLR Objects">POCO</abbr>s)
  • Uses Task-based async for all data access functions
  • Uses building blocks for more complex queries

Getting Started

The main step is to set the data source with which the library will create connections. Construct an NpgsqlDataSource instance, and provide it to the library:

open BitBadger.Npgsql.FSharp.Documents

// ...
let dataSource = // ....

Configuration.useDataSource dataSource
// ...

By default, the library uses a System.Text.Json-based serializer configured to use the FSharp.SystemTextJson converter. To provide a different serializer (different options, more converters, etc.), construct it to implement IDocumentSerializer and provide it via Configuration.useSerializer.

Using

Retrieve all customers:

// parameter is table name
// returns Task<Customer list>
let! customers = all<Customer> "customer"

Select a customer by ID:

// parameters are table name and ID
// returns Task<Customer option>
let! customer = Find.byId<Customer> "customer" "123"

Count customers in Atlanta:

// parameters are table name and object used for JSON containment query
// return Task<int>
let! customerCount = Count.byContains "customer" {| City = "Atlanta" |}

Delete customers in Chicago: (no offense, Second City; just an example...)

// parameters are table name and JSON Path expression
do! Delete.byJsonPath "customer" """$.City ? (@ == "Chicago")"""

More Information

The project site has full details on how to use this library.

Product Compatible and additional computed target framework versions.
.NET 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. 
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 BitBadger.Npgsql.FSharp.Documents:

Package Downloads
BitBadger.Npgsql.Documents

Lightweight functions to use PostgreSQL as a document store (best for C#)

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.0 385 12/2/2023
1.0.0 294 10/12/2023
1.0.0-beta3 323 6/28/2023
1.0.0-beta2 284 2/24/2023
1.0.0-beta 270 2/20/2023

Initial production release