Whenever we refer to "The Skybase Authors", "The Sky Authors", "The SkybaseDB Authors", "The SDB Authors", "The TerrabaseDB Authors", "The TDB Authors", or simply "The Authors", we are referring to:
Whenever we refer to "The Skytable Authors", "The Sky Authors", "The SkybaseDB Authors", "The SDB Authors", "The TerrabaseDB Authors", "The TDB Authors", or simply "The Authors", we are referring to:
Thank you for your interest in contributing to Skybase. In order to clarify the intellectual property license granted with Contributions from any person or entity, the Author (Sayan Nandan) must have a Contributor License Agreement ("CLA") on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of the Author and its users; it does not change your rights to use your own Contributions for any other purpose.
Thank you for your interest in contributing to Skytable. In order to clarify the intellectual property license granted with Contributions from any person or entity, the Author (Sayan Nandan) must have a Contributor License Agreement ("CLA") on file that has been signed by each Contributor, indicating agreement to the license terms below. This license is for your protection as a Contributor as well as the protection of the Author and its users; it does not change your rights to use your own Contributions for any other purpose.
You accept and agree to the following terms and conditions for Your present and future Contributions submitted to the Author. In return, the Author shall not use Your Contributions in a way that is contrary to the public benefit or inconsistent with its bylaws in effect at the time of the Contribution. Except for the license granted herein to the Author and recipients of software distributed by the Author, You reserve all right, title, and interest in and to Your Contributions.
You accept and agree to the following terms and conditions for Your present and future Contributions submitted to the Author. In return, the Author shall not use Your Contributions in a way that is contrary to the public benefit or inconsistent with its bylaws in effect at the time of the Contribution. Except for the license granted herein to the Author and recipients of software distributed by the Author, You reserve all right, title, and interest in and to Your Contributions.
@ -33,18 +33,18 @@ In other cases, use the C style.
### Parts of the project
### Parts of the project
* `ci` , `.github` : CI scripts (which, under normal circumstances, don't need to be modified)
* `ci` , `.github` : CI scripts (which, under normal circumstances, don't need to be modified)
* `cli` : Source for `skysh` which is the command-line client for Skybase
* `cli` : Source for `skysh` which is the command-line client for Skytable
* `examples` : Example configuration files
* `examples` : Example configuration files
* `libsky` : This contains functions, structs, ... used by both the `cli` and the
* `libsky` : This contains functions, structs, ... used by both the `cli` and the
* `server` : Source for the main database server ``
* `server` : Source for the main database server ``
* `sky-bench` : The source for the benchmarking tool resides here
* `sky-bench` : The source for the benchmarking tool resides here
* `sky-macros` : The source for custom compiler macros used by Skybase
* `sky-macros` : The source for custom compiler macros used by Skytable
### Jargon
### Jargon
Each project has its own jargon — and so do we!
Each project has its own jargon — and so do we!
* _actiondoc_ and _actions docs_ : This refers to the `actions.jsonc` file, which is used by the Skybase documentation website for automatically building documentation for the actions
* _actiondoc_ and _actions docs_ : This refers to the `actions.jsonc` file, which is used by the Skytable documentation website for automatically building documentation for the actions
Skybase (or SkybaseDB/SDB) is an effort to provide the best of key/value stores, document stores and columnar databases, that is, **simplicity, flexibility and queryability at scale**. The name 'Skybase' exemplifies our vision to create a database that has limitless possibilities. Skybase was previously known as TerrabaseDB.
Skytable (or SkybaseDB/SDB) is an effort to provide the best of key/value stores, document stores and columnar databases, that is, **simplicity, flexibility and queryability at scale**. The name 'Skytable' exemplifies our vision to create a database that has limitless possibilities. Skytable was previously known as TerrabaseDB (and then Skybase).
Skybase is curently in an alpha stage, but can be used as a **performant**, **secure** and **persistent key-value store**.
Skytable is curently in an alpha stage, but can be used as a **performant**, **secure** and **persistent key-value store**.
## Getting started 🚀
## Getting started 🚀
1. Download a bundle for your platform from [here ⬇️ ](https://github.com/skybasedb/skybase/releases)
1. Download a bundle for your platform from [here ⬇️ ](https://github.com/skytable/skytable/releases)
2. Unzip the bundle
2. Unzip the bundle
3. Make the files executable (run `chmod +x sdb skysh` on *nix systems)
3. Make the files executable (run `chmod +x sdb skysh` on *nix systems)
4. First run `sdb` to start the database server and then run `skysh` to start the interactive shell
4. First run `sdb` to start the database server and then run `skysh` to start the interactive shell
@ -30,12 +30,12 @@ You can learn more about installation [here](https://terrabasedb.github.io/docs/
* **Insanely fast**: Scale to millions of queries per second per node
* **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)
* **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
* **Snapshots**: Automated (and tunable) snapshots for stress-free backups
* **Secure**: Secure connections are built into Skybase with SSL/TLS
* **Secure**: Secure connections are built into Skytable with SSL/TLS
* **Multithreaded**: Designed to exploit all CPU cores
* **Multithreaded**: Designed to exploit all CPU cores
* **Resource friendly**: The database server doesn't need more than 1MB to run
* **Resource friendly**: The database server doesn't need more than 1MB to run
* **Convenient**: Without the setup hassle and system-specific dependencies
* **Convenient**: Without the setup hassle and system-specific dependencies
(... [and more on the way](https://github.com/skybasedb/skybase/labels/roadmap))
(... [and more on the way](https://github.com/skytable/skytable/labels/roadmap))
## Clients 🔌
## Clients 🔌
@ -59,13 +59,13 @@ This project strictly follows semver, however, since this project is currently i
**Yes - we need you!** Be it a typo, a bizarre idea, a dirty bug🐞 or an amazing patch - you're welcome to contribute to Skybase! Beginner friendly issues are marked with the [<img src=https://img.shields.io/badge/L--easy-C71585>](https://github.com/skybasedb/skybase/labels/L-easy) label. Read the guide [here](./CONTRIBUTING.md).
**Yes - we need you!** Be it a typo, a bizarre idea, a dirty bug🐞 or an amazing patch - you're welcome to contribute to Skytable! Beginner friendly issues are marked with the [<img src=https://img.shields.io/badge/L--easy-C71585>](https://github.com/skytable/skytable/labels/L-easy) label. Read the guide [here](./CONTRIBUTING.md).
## Contributors
## Contributors
You can see a full list of contributors [here](https://ohsayan.github.io/thanks)
You can see a full list of contributors [here](https://ohsayan.github.io/skythanks)
Sayan Nandan
4 years ago