Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hirunya/nosqlite
A Rusty NoSQL layer over SQLite
https://github.com/hirunya/nosqlite
json nosql rust sqlite
Last synced: about 1 month ago
JSON representation
A Rusty NoSQL layer over SQLite
- Host: GitHub
- URL: https://github.com/hirunya/nosqlite
- Owner: HiruNya
- License: mit
- Created: 2020-03-15T09:56:38.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2022-09-06T07:21:48.000Z (over 2 years ago)
- Last Synced: 2023-03-06T14:12:27.703Z (almost 2 years ago)
- Topics: json, nosql, rust, sqlite
- Language: Rust
- Homepage:
- Size: 6.14 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NoSQLite
*A Rusty NoSQL layer over SQLite*
[](https://hiru.dev/docs/nosqlite/nosqlite/index.html)
[Documentation can be found here.](https://hiru.dev/docs/nosqlite/nosqlite/index.html)
The intention of this crate is to allow the user to use this library
as if it was a NoSQL library (e.g. only deal with JSON objects, no schema, etc.)
but have the data stored in a SQLite database,
which is a great single-file database.
It does this by using SQLite's Json1 extension
and [`rusqlite`](https://github.com/jgallagher/rusqlite)'s safe bindings.
Unfortunately due to the requirement of parsing and serializing JSON,
this crate may not perform as fast as using `SQLite` directly.
However this crate does try to be as ergonomic and flexible as possible.
## Features
- Insert JSON objects.
- Get and remove JSON objects by primary key.
- Iterate through multiple entries in a table.
- Filter and Sort the entries by using the fields in a JSON object
or columns in the SQL table.
- Get *only* the primary key, JSON object,
or specific field(s) from the JSON object.
- Set, insert, replace, and remove fields in a JSON object.
- 'Patch' JSON objects with other JSON objects.
- Use indexes to speed up queries.
## To Do
- Set, insert, and replace fields of a single entry using its primary key.
## Example
This example can be found in `examples/iterator.rs`
```rust
#[derive(Serialize)]
struct User {
name: String,
age: u8,
}
fn main() {
let connection = Connection::in_memory().unwrap();
let table = connection.table("people").unwrap();
table.insert(&User{ name: "Hiruna".into(), age: 18 }, &connection).unwrap();
table.insert(&User{ name: "Bob".into(), age: 13 }, &connection).unwrap();
table.insert(&User{ name: "Callum".into(), age: 25 }, &connection).unwrap();
table.insert(&User{ name: "Alex".into(), age: 20 }, &connection).unwrap();
// Iterate over the entries in the table
table.iter()
// Sort by Age
.sort(field("age").ascending())
// Only get people who are 18+
.filter(field("age").gte(18))
// Gets the name and age fields of the JSON object
.fields::<(String, u8), _, _, _>(&["name", "age"], &connection)
.unwrap()
.into_iter()
.for_each(|(name, age)| println!("{:10} : {}", name, age));
}
```
## Installation
In your `Cargo.toml` file add this
```toml
[dependencies]
nosqlite = { git = "https://github.com/HiruNya/nosqlite.git" }
```
This crate may have breaking changes in its API so I would recommend also adding
in the specific commit to ensure your code does not break.
I have considered publishing this crate onto [crates.io]
but since I'm the only one currently using it I decided against it.
If you wish to use this crate and would prefer installing it the normal way using [crates.io]
then please don't hesitate in making an issue.
## Inspirations
[hotpot-db](https://github.com/drbh/hotpot-db)
was the original database that used SQLite and its Json1 extension.
However it didn't have certain functions that I needed
for a personal project of mine but is still a great crate
depending on your use case.
[crates.io]: https://crates.io