< html >
< div align = "center" >
< img src = "https://raw.githubusercontent.com/terrabasedb/docs/master/docs/assets/img/favicon.ico" height = 64 width = 64 style = "float:left" >
< h1 > Terrabase< b > DB< / b > < / h1 > < h3 > The next-generation NoSQL database< / h3 >
![GitHub Workflow Status ](https://img.shields.io/github/workflow/status/terrabasedb/terrabasedb/Tests?style=flat-square ) ![Status: Alpha ](https://img.shields.io/badge/status-alpha-critical?style=flat-square ) ![Development ](https://img.shields.io/badge/development-actively%20developed-32CD32?style=flat-square ) ![GitHub release (latest SemVer including pre-releases) ](https://img.shields.io/github/v/release/terrabasedb/terrabasedb?include_prereleases&sort=semver&style=flat-square ) ![GitHub commit activity ](https://img.shields.io/github/commit-activity/m/terrabasedb/terrabasedb?label=commits&style=flat-square )
[![Docker Pulls ](https://img.shields.io/docker/pulls/terrabasedb/tdb?style=flat-square )](https://hub.docker.com/r/terrabasedb/tdb)
[![Docs ](https://img.shields.io/badge/readthedocs-here-blueviolet?style=flat-square )](https://terrabasedb.github.io/docs)
< / div >
< / html >
## What is TerrabaseDB?
TerrabaseDB (or TDB for short) is an effort to provide the best of key/value stores, document stores and columnar databases, that is, **simplicity, flexibility and queryability at scale** . TDB is curently in an alpha stage, but can be used as a **performant** and **persistent key-value store** .
## Getting started 🚀
1. Download a bundle for your platform from [here ⬇️ ](https://github.com/terrabasedb/terrabase/releases )
2. Unzip the bundle
3. Make the files executable (run `chmod +x tdb tsh` on *nix systems)
4. First run `tdb` to start the database server and then run `tsh` to start the interactive shell
5. Run commands like: `SET foo bar` , `GET bar` , `UPDATE cat mitten` or `DEL proprietary` 🤪 on `tsh` !
## Features
- **Insanely fast**: Scale to millions of queries per second per node
- **Key/value store**: `GET` , `SET` , `UPDATE` and [all that stuff ](https://terrabasedb.github.io/docs/List-Of-Actions )
- **Snapshots**: Automated (and tunable) snapshots for stress-free backups
- **Multithreaded**: Designed to exploit all CPU cores
- **Resource friendly**: The database server doesn't need more than 1MB to run
- **Convenient**: Without the setup hassle and system-specific dependencies
(... and more on the way)
## Clients 🔌
Until we release an official driver, you'll have to write your own clients — all you need to do is implement the simple and performant [Terrapipe protocol spec ](https://terrabasedb.github.io/docs/Protocols/terrapipe/ ).
## Community 👐
A project which is powered by the community believes in the power of community! If you get stuck anywhere - here are your options!
< html >
< a href = "https://gitter.im/terrabasehq/community" > < img src = "https://img.shields.io/badge/chat%20on-gitter-ed1965?logo=gitter&style=flat-square" > < / img >
< / a >
< a href = "https://join.slack.com/t/terrabasedb/shared_invite/zt-fnkfgzf7-~WO~RzGUUvTiYV4iPAMiiQ" > < img src = "https://img.shields.io/badge/discuss%20on-slack-4A154B?logo=slack&style=flat-square" > < / img >
< / a > < a href = "https://discord.gg/QptWFdx" > < img src = "https://img.shields.io/badge/talk-on%20discord-7289DA?logo=discord&style=flat-square" > < / img > < / a >
< / html >
## Platforms 💻
![Linux supported ](https://img.shields.io/badge/Linux%20x86__64-supported%20✓-228B22?style=flat-square&logo=linux ) ![macOS supported ](https://img.shields.io/badge/macOS%20x86__64-supported%20✓-228B22?style=flat-square&logo=apple ) ![Windows supported ](https://img.shields.io/badge/Windows%20x86__64-supported%20✓-228B22?style=flat-square&logo=windows )
## Versioning
This project strictly follows semver, however, since this project is currently in the development phase (0.x.y), the API may change unpredictably
## Contributing
**Yes - we need you!** Be it a typo, a bizarre idea, a dirty bug🐞 or an amazing patch - you're welcome to contribute to TDB! Beginner friendly issues are marked with the [<img src=https://img.shields.io/badge/L--easy-C71585> ](https://github.com/terrabasedb/terrabasedb/labels/L-easy ) label. Read the guide [here ](./CONTRIBUTING.md ).
## Contributors
You can see a full list of contributors [here ](https://ohsayan.github.io/thanks )
## License
This project is licensed under the [AGPL-3.0 License ](./LICENSE ).