BitBadger.Documents.Common 4.1.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. 
dotnet add package BitBadger.Documents.Common --version 4.1.0
                    


                    

                
NuGet\Install-Package BitBadger.Documents.Common -Version 4.1.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.Documents.Common" Version="4.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="BitBadger.Documents.Common" Version="4.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="BitBadger.Documents.Common" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add BitBadger.Documents.Common --version 4.1.0
                    


                    

                
#r "nuget: BitBadger.Documents.Common, 4.1.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. 
#:package BitBadger.Documents.Common@4.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=BitBadger.Documents.Common&version=4.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=BitBadger.Documents.Common&version=4.1.0
                    


                            Install as a Cake Tool

BitBadger.Documents.Common

This package provides common definitions and functionality for BitBadger.Documents implementations. These libraries provide a document storage view over relational databases, while also providing convenience functions for relational usage as well. This enables a hybrid approach to data storage, allowing the user to use documents where they make sense, while streamlining traditional ADO.NET functionality where relational data is required.

  • BitBadger.Documents.Postgres (NuGet) provides a PostgreSQL implementation.
  • BitBadger.Documents.Sqlite (NuGet) provides a SQLite implementation

Features

  • Select, insert, update, save (upsert), delete, count, and check existence of documents, and create tables and indexes for these documents
  • Automatically generate IDs for documents (numeric IDs, GUIDs, or random strings)
  • Address documents via ID and via comparison on any field (for PostgreSQL, also via equality on any property by using JSON containment, or via condition on any property using JSON Path queries)
  • Access documents as your domain models (<abbr title="Plain Old CLR Objects">POCO</abbr>s), as JSON strings, or as JSON written directly to a PipeWriter
  • Use Task-based async for all data access functions
  • Use building blocks for more complex queries

Getting Started

Install the library of your choice and follow its README; also, the project site has complete documentation.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  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 is compatible.  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.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on BitBadger.Documents.Common:

Package Downloads
BitBadger.Documents.Sqlite

Use SQLite as a document database
BitBadger.Documents.Postgres

Use PostgreSQL as a document database

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
4.1.0 119 4/19/2025
4.0.1 126 12/30/2024
4.0.0 124 12/18/2024
4.0.0-rc5 138 9/18/2024
4.0.0-rc4 141 9/17/2024
4.0.0-rc3 166 8/23/2024
4.0.0-rc2 166 8/22/2024
4.0.0-rc1 154 8/19/2024
3.1.0 206 6/6/2024
3.0.0 183 4/21/2024
3.0.0-rc-2 278 1/24/2024
3.0.0-rc-1 193 12/31/2023

Add JSON retrieval and pipe-writing functions; update project URL to site with public API docs