P41.NoSQLite 0.1.0-beta.8

NoSQLite: NoSQL on top of SQLite

A thin wrapper above sqlite to use it as a nosql database.

Getting Started

All you need is an instance of NoSQLiteConnection. The instance requires a string that is a fully qualified path to the database file and you can also optionally provide your own JsonSerializerOptions to configure the JSON serialization/deserialization.

NoSQLiteConnection creates and opens a connection when initialized so keep in mind that you will have to dispose it when you are done. Use the Dispose method of the IDisposable interface.

In most scenarios you will create it and store it for use until you shutdown your application.

The sqlite database is configured with journal_mode set to WAL.

How It Works

It works by taking advantage of the JSON1 through the SQLitePCLRaw.bundle_e_sqlite3 nuget package that forces the correct version of sqlite to manipulate the documents, create indexes and more in the future!

Document Management

Example class that will be used below:

public class Person
{
    public string Name { get; set; }
    public string Surname { get; set; }
    public string? Description { get; set; }
}

and the same connection:

var db = new NoSQLiteConnection("path to database file", "json options or null");

Create/Update documents.

Creating or Updating a document happens from the same insert method, keep in mind that this always replaces the document with the new one.

var panos = new Person
{
    Name = "panoukos",
    Surname = "41",
    Description = "C# dev"
}

db.Insert("panos", panos); // If it exists it is now replaced/updated.

Get documents.

var doc = db.Get<Person>("panos");

Delete documents.

db.Remove("panos"); // Will remove the document.
db.Remove("panos"); // Will still succeed even if the document doesn't exist.

Build

To build this project .NET 7 is needed.

Contribute

Contributions are welcome and appreciated, before you create a pull request please open a GitHub Issue to discuss what needs changing and or fixing if the issue doesn't exist!