Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joaoh82/rust_sqlite
SQLRite - Simple embedded database modeled off SQLite in Rust
https://github.com/joaoh82/rust_sqlite
computer-science database-design databases rust-lang sqlite-architecture
Last synced: 1 day ago
JSON representation
SQLRite - Simple embedded database modeled off SQLite in Rust
- Host: GitHub
- URL: https://github.com/joaoh82/rust_sqlite
- Owner: joaoh82
- License: mit
- Created: 2021-01-15T23:08:17.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-07-12T08:16:27.000Z (over 2 years ago)
- Last Synced: 2024-10-15T09:21:54.044Z (30 days ago)
- Topics: computer-science, database-design, databases, rust-lang, sqlite-architecture
- Language: Rust
- Homepage:
- Size: 388 KB
- Stars: 1,078
- Watchers: 45
- Forks: 59
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-rust-tools - rust_sqlite
README
Rust-SQLite (SQLRite)
===
[](https://github.com/joaoh82/rust_sqlite/actions)
[](https://deps.rs/repo/github/joaoh82/rust_sqlite)
[](https://coveralls.io/github/joaoh82/rust_sqlite?branch=main)
[](https://deps.rs/repo/github/joaoh82/rust_sqlite)
[](./LICENSE)
`Rust-SQLite`, aka `SQLRite` , is a simple embedded database modeled off `SQLite`, but developed with `Rust`. The goal is get a better understanding of database internals by building one.
> What I cannot create, I do not understand.
> — Richard Feynman
key
value
Design and discussions about direction
of the project going on over here.
Show us your support by buying us a coffee,
so we can keep building cool stuff. (coming soon)
Documentation (coming soon)
Come and Chat about databases with us
### Read the series of posts about it:
##### What would SQLite look like if written in Rust?
* [Part 0 - Overview](https://medium.com/the-polyglot-programmer/what-would-sqlite-would-look-like-if-written-in-rust-part-0-4fc192368984)
* [Part 1 - Understanding SQLite and Setting up CLI Application and REPL](https://medium.com/the-polyglot-programmer/what-would-sqlite-look-like-if-written-in-rust-part-1-4a84196c217d)
* [Part 2 - SQL Statement and Meta Commands Parser + Error Handling](https://medium.com/the-polyglot-programmer/what-would-sqlite-look-like-if-written-in-rust-part-2-55b30824de0c)
* [Part 3 - Understanding the B-Tree and its role on database design](https://medium.com/the-polyglot-programmer/what-would-sqlite-look-like-if-written-in-rust-part-3-edd2eefda473)
### CREATE TABLE and INSERT Statements
[](https://asciinema.org/a/406447)
### Requirements
Before you begin, ensure you have met the following requirements:
* Rust (latest stable) – [How to install Rust](https://www.rust-lang.org/en-US/install.html)
* SQLite3
### Usage (TBD)
```shell
> ./rust_sqlite -- help
SQLRite 0.1.0
Joao Henrique Machado Silva
Light version of SQLite developed with Rust
USAGE:
rust_sqlite
FLAGS:
-h, --help Prints help information
-V, --version Prints version information
```
### Project Progress
*Not checked means I am currently working on.*
- [x] CLI and REPL Interface
- [x] Parse meta commands and sql commands.
- [x] Execute simple commands
- [x] Standarized error handling
- [x] Generic validation structure for SQL Commands.
- [x] `Create Table` Command Parsing
- [x] Improve error handling with https://github.com/dtolnay/thiserror
- [x] Added support for parsing duplicate columns on CREATE TABLE
- [x] Added support for parsing multiple PRIMARY KEY on CREATE TABLE
- [x] In memory BTreeMap indexes initially only for PRIMARY KEYS.
- [x] Simple INSERT queries command parsing.
- [x] Implementation UNIQUE key constraints.
- [ ] Improve Error Handling and return without Panic!
- [ ] Simple SELECT queries (Single WHERE clause and no JOINS).
- [ ] Serialization | Deserialization to and from binary encodings ([bincode](https://crates.io/crates/bincode)).
### Roadmap
Features that are in the roadmap of the project:
*Ideally in order of priority, but nothing set in stone.*
- [ ] Implement Open command to load database with a command `.open`
- [ ] Joins
- [ ] INNER JOIN (or sometimes called simple join)
- [ ] LEFT OUTER JOIN (or sometimes called LEFT JOIN)
- [ ] CROSS JOIN
- The RIGHT OUTER JOIN and FULL OUTER JOIN are not supported in SQLite.
- [ ] WAL - Write Ahead Log Implementation
- [ ] `Pager Module`
- [ ] Implementing transactional ACID properties
- [ ] Concurrency
- [ ] Lock Manager
- [ ] Composite Indexing - cost and performance gain analysis
- [ ] Benchmarking vs SQLite for comparison
- [ ] Server Client / Connection Manager
- [ ] Different implementations of storage engines and data structures to optimize for different scenarios
- [ ] Write Heavy - `LSM Tree && SSTable`
- [ ] Read Heavy - `B-Tree`
### Contributing
**Pull requests are warmly welcome!!!**
For major changes, please [open an issue](https://github.com/joaoh82/rust_sqlite/issues/new) first and let's talk about it. We are all ears!
If you'd like to contribute, please fork the repository and make changes as you'd like and shoot a Pull Request our way!
**Please make sure to update tests as appropriate.**
If you feel like you need it go check the GitHub documentation on [creating a pull request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/creating-a-pull-request).
### Code of Conduct
Contribution to the project is organized under the terms of the
Contributor Covenant, the maintainer of SQLRite, [@joaoh82](https://github.com/joaoh82), promises to
intervene to uphold that code of conduct.
### Contact
If you want to contact me you can reach me at .
##### Inspiration
* https://cstack.github.io/db_tutorial/