Update docs [skip ci]

next
Sayan Nandan 3 years ago
parent f9b997c1f1
commit 624c7e5aaa
No known key found for this signature in database
GPG Key ID: 8BC07A0A4D41DD52

@ -2,18 +2,20 @@
All changes in this project will be noted in this file.
## Unreleased
## Version 0.7.5
### Additions
- `INSPECT KEYSPACE` without arguments to inspect the current keyspace
- `INSPECT TABLE` without arguments to inspect the current table
- `AUTH WHOAMI` returns the AuthID of the currently logged in user
- Enable multiples values to be pushed into a list at once with `lmod push`
### Fixes
- (skysh) Added error code output for new error codes which otherwise printed "Unknown error"
- (skysh) Fixed handling of EOF keystroke
- (skyd) Respect logging level for all terminal output
## Version 0.7.4

@ -32,13 +32,12 @@ In other cases, use the C style.
### Parts of the project
- `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 Skytable
- `examples` : Example configuration files
- `libsky` : This contains functions, structs, ... used by both the `cli` and the
- `server` : Source for the main database server ``
- `sky-bench` : The source for the benchmarking tool resides here
- `sky-macros` : The source for custom compiler macros used by Skytable
The main parts (ignorning CI scripts, stress test suite, test harness and custom compiler macros) are:
- `cli`: REPL shell
- `server`: database server
- `sky-bench`: benchmark tool
- `sky-migrate`: migration tool
### Jargon

@ -11,9 +11,11 @@
## What is Skytable?
Skytable 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) and is also nicknamed "STable", "Sky" and "SDB" by the community.
Skytable is a free and open-source NoSQL database that aims to provide flexible data modeling at
scale. For us simplicity, performance and flexibility are our guiding design principles.
We were previously known as TerrabaseDB or Skybase and are nicknamed Sky, SDB or STable by the community.
Skytable is currently under development but can be used as a **performant**, **secure** and **persistent key-value store**.
Features like keyspaces, tables, data types, authn+authz, snapshots and more are ready for you to use while we're working on [several new data models and features](https://github.com/skytable/skytable/issues/203). Skytable's key/value store is performant, secure and ready for you to deploy.
## Getting started 🚀
@ -23,13 +25,13 @@ Skytable is currently under development but can be used as a **performant**, **s
4. First run `skyd` to start the database server and then run `skysh` to start the interactive shell
5. Run commands like: `SET foo bar` , `GET bar` , `UPDATE cat mitten` or `DEL proprietary` on `skysh`!
You can learn more about installation [here](https://docs.skytable.io/getting-started/)
You can learn more about installation [here](https://docs.skytable.io/getting-started)
## Features
- **Insanely fast**: Scale to millions of queries per second per node
- **Multiple keyspaces/tables**: Seamlessly integrates with actions to provide a SQL-like experience
- **Key/value store**: `GET` , `SET` , `UPDATE` and [all that stuff](https://docs.skytable.io/actions-overview). With the `str` and `binstr` types.
- **Key/value store**: `GET` , `SET` , `UPDATE` and [all that stuff](https://docs.skytable.io/all-actions). With the `str` and `binstr` types.
- **Authn/Authz**: Simple and secure authentication/authorization
- **Volatile tables**: For all the caching you need
- **Snapshots**: Automated (and tunable) snapshots for stress-free backups

Loading…
Cancel
Save