Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/PoloDB/PoloDB
PoloDB is an embedded document database.
https://github.com/PoloDB/PoloDB
cross-platform database document-database embedded-database localfirst nosql rust
Last synced: about 1 month ago
JSON representation
PoloDB is an embedded document database.
- Host: GitHub
- URL: https://github.com/PoloDB/PoloDB
- Owner: PoloDB
- License: apache-2.0
- Created: 2020-08-01T09:03:18.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-27T19:54:03.000Z (about 2 months ago)
- Last Synced: 2024-10-28T00:13:55.595Z (about 2 months ago)
- Topics: cross-platform, database, document-database, embedded-database, localfirst, nosql, rust
- Language: Rust
- Homepage: https://www.polodb.org/
- Size: 17.5 MB
- Stars: 909
- Watchers: 12
- Forks: 47
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-rust - PoloDB - An embedded JSON-based database has API similar to MongoDB.  (Libraries / Database)
- awesome-luooooob - PoloDB/PoloDB - PoloDB is an embedded document database. (Rust)
- awesome-rust - PoloDB - An embedded JSON-based database has API similar to MongoDB.  (Libraries / Database)
- fucking-awesome-rust - PoloDB - An embedded JSON-based database has API similar to MongoDB.  (Libraries / Database)
- fucking-awesome-rust - PoloDB - An embedded JSON-based database has API similar to MongoDB.  (Libraries / Database)
README
[](https://crates.io/crates/polodb_core)
[](https://discord.gg/NmGQyVx6hH)
[](https://docs.rs/polodb_core)
[](LICENSE)
PoloDB is an embedded document database.
| [Documentations](https://www.polodb.org/docs) |
# Introduction
PoloDB is a library written in Rust
that implements a lightweight [MongoDB](https://www.mongodb.com/).
# 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
- can be embedded library or a standalone server
- Easy to learn and use
- NoSQL
- MongoDB-like API
- Cross-Platform
# Quick start
PoloDB is easy to learn and use:
```rust
use polodb_core::Database;
use serde::{Serialize, Deserialize};
#[derive(Debug, Serialize, Deserialize)]
struct Book {
title: String,
author: String,
}
let db = Database::open_path(db_path)?;
let collection = db.collection::("books");
collection.insert_one(Book {
title: "The Three-Body Problem".to_string(),
author: "Liu Cixin".to_string(),
})?;
```
# Packages
- polodb: The standalone server of PoloDB, which is compatible with MongoDB's wire protocol.
- [polodb_core](https://crates.io/crates/polodb_core): The core library of PoloDB, which can be embedded in your application.
# 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
- [Documentations](https://www.polodb.org/docs)
- [Rust](https://docs.rs/polodb_core)
# Roadmap
The features will be implemented one by one in order.
- [x] Basic database API
- [x] CRUD
- [x] Transactions
- [x] Serde
- [x] Indexes(Alpha)
- [x] Aggregation(Alpha)
- [x] Command line Tools
- [ ] Platforms
- [x] MacOS
- [x] Linux
- [x] Windows
- [ ] iOS
- [ ] Android
- [ ] Languages
- [ ] Python
- [ ] JavaScript