14 releases (1 stable)

2.0.0 Nov 4, 2021
0.11.0 Oct 28, 2021
0.10.4 Oct 27, 2021
0.10.0 Feb 19, 2021
0.2.0 Nov 7, 2020

#1236 in Database interfaces

33 downloads per month

MIT license

110KB
2.5K SLoC

Crates.io Discord docs.rs License

PoloDB is an embedded document database.

| Documentations |

Introduction

PoloDB is a library written in Rust that implements a lightweight MongoDB.

Why

PoloDB aims to offer a modern alternative to SQLite, which is currently the almost exclusive option for client-side data storage. Although SQLite is an old and stable software, it lacks some modern features. That's why we developed PoloDB, which is NoSQL, supports multi-threading and multi-sessions, and retains the embedded and lightweight features of SQLite.

Features

  • Simple and Lightweight
  • Easy to learn and use
    • NoSQL
    • MongoDB-like API
  • Cross-Platform
  • Multiple backends
    • Filesystem(WAL)
    • Memory
    • IndexedDB(WIP)

Quick start

PoloDB is easy to learn and use:

use polodb_core::Database;
use serde::{Serialize, Deserialize};

#[derive(Debug, Serialize, Deserialize)]
struct Book {
    title: String,
    author: String,
}

let db = Database::open_file(db_path)?;
let collection = db.collection::<Book>("books");
collection.insert_one(Book {
    title: "The Three-Body Problem".to_string(),
    author: "Liu Cixin".to_string(),
})?;

Backends

Filesystem Backend

With the filesystem backend, PoloDB stores data in a single file. All the data are saved persistently on the disk.

It's designed to be flexible, universal, and easy to be searched. All the data are encoded in bson format and stored in the PoloDB's lsm-tree format.

PoloDB uses WAL(write-ahead logging) to implement transactional writing and protect your data from program crashes.

Memory Backend

With the memory backend, all the data all stored in memory, making PoloDB a pure memory database.

Platform

Theoretically, PoloDB supports all platforms that the Rust compiler supports. But PoloDB is a personal project currently. Limited by my time, I have only compiled and tested on the following platforms:

  • macOS Big Sur x64
  • Linux x64 (Tested on Fedora 32)
  • Windows 10 x64

Manual

Roadmap

The features will be implemented one by one in order.

  • Backend
    • Memory
    • File
    • IndexedDB(WIP)
  • Basic database API
    • CRUD
    • Transactions
    • Serde
    • Indexes(Alpha)
    • Aggregation
  • Command line Tools
  • Platforms
    • MacOS
    • Linux
    • Windows
    • Web Browser(WIP)
    • iOS
    • Android
  • Visualization Tools

Dependencies

~1.5MB
~23K SLoC