- Add `Json` module to return JSON strings and write JSON as it's read to a `PipeWriter` - Add `docfx`-based documentation to allow how-to docs and API docs to be generated on the same site Reviewed-on: #11
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 (POCOs), 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.