SoloDB

SoloDB is an embedded database solution that seamlessly integrates the capabilities of NoSQL and SQL, built on top of SQLite and utilizing the JSONB data type. This innovative database system caters to .NET developers looking for a reliable, fast, and lightweight database without the need for server management.

Key Features

• Core Technology: Built on SQLite, providing a robust foundation.
• Serverless Architecture: Operates as a .NET library, eliminating the need for a server setup.
• Intuitive API: Leverages a simple API reminiscent of MongoDB, making it straightforward to use.
• Thread Safety: Implements a connection pool ensuring thread-safe operations.
• ACID Compliance: Fully supports ACID transactions for maintaining data integrity.
• File System Support: Manages large file storage effectively.
• Polymorphic Type Handling: Facilitates heterogeneous data storage.
• Reliability: Utilizes a Write-Ahead Logging (WAL) mechanism for enhanced data safety.
• Indexing Support: Efficient searching capabilities with support for indexes.
• Full LINQ and IQueryable Support: Enables advanced querying capabilities.
• Custom ID Generation: Inspired by MongoDB, it supports custom ID generation strategies.
• Direct SQL Support: Allows raw SQL commands for more advanced operations.
• Open Source: Contributions and modifications are welcomed.
• .NET Standard Compatibility: Supports .NET Standard 2.0 and 2.1.
• Well-Tested: Maintains over 565 tests for assurance of code quality (although the tests are kept private).

Example Usages

Initializing the Database

Create a database either in-memory or on-disk with the following code:

using var onDiskDB = new SoloDB("path/to/database.db");
using var inMemoryDB = new SoloDB("memory:database-name");

Creating and Accessing Collections

Define data models and access collections easily:

public class User  
{
    public long Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
}

var db = new SoloDB("memory:my-app");
var users = db.GetCollection<User>(); 
var untypedUsers = db.GetUntypedCollection("User");

Custom ID Generation

Implement custom ID strategies:

public class MyStringIdGenerator : IIdGenerator<MyCustomIdType>
{
    public object GenerateId(ISoloDBCollection<MyCustomIdType> col, MyCustomIdType item)
    {
        ...
    }
}

Indexing Documents

Create indexes for efficient data management:

public class IndexedProduct
{
    [Indexed(/* unique = */ true)]
    public string SKU { get; set; }
}

Transactions

Execute actions within transactions to ensure consistency:

var _result = db.WithTransaction<object>(tx => {
    var collection = tx.GetCollection<ulong>();
    // Your transactional logic here
});

Polymorphic Types

Store objects of different types in a single collection:

public abstract class Shape
{
    public long Id { get; set; }
    public string Color { get; set; }
}

var shapes = db.GetCollection<Shape>();

File Storage Management

Manage files effectively within your database environment:

var fs = db.FileSystem;
fs.Upload(filePath, stream);

For full examples, refer to the detailed code snippets available in the README.

SoloDB serves as a modern alternative suitable for applications requiring both relational and document-oriented data handling. Its combination of performance, simplicity, and reliability positions it as a powerful tool for developers in the .NET ecosystem.