GithubHelp home page GithubHelp logo

Skytable Skytable Logo

A modern NoSQL database, powered by BlueQL.

GitHub release (with filter) GitHub Workflow Status (with event) Discord Docs Static Badge

What is Skytable?

Skytable is a modern NoSQL database that focuses on performance, flexibility and scalability. Skytable is a primarily in-memory, wide-column based database with support for additional data models* that uses its own storage engine (structured like n-ary records with optimized delayed-durability transactions) and enables querying with its own query language BlueQL that builds on top of SQL to improve security and flexibility.

Skytable is best-suited for applications that need to store large-scale data, need high-performance and low latencies.

You can read more about Skytable's architecture, including information on the clustering and HA implementation that we're currently working on, and limitations on this page.

Features

  • Spaces, models and more: For flexible data definition
  • Powerful querying with BlueQL: A modern query language based on SQL
  • Rich data modeling: Use models to define data with complex types, collections and more
  • Performant: Heavily multithreaded, optimized write batching and more
  • Secure: BlueQL is designed to strongly deter query injection pathways
  • Enforces best practices: If you're building with Skytable today, the practices you'll learn here will let you easily take on the job of building performant systems, even outside Skytable

Learn more about Skytable's features here.

Getting started

  1. Set up Skytable on your machine: You'll need to download a bundled release file from the releases page. Unzip the files and you're ready to go.
  2. Start the database server: ./skyd --auth-root-password <password> with your choice of a password for the root account. The root account is just like a root account on Unix based systems that has control over everything.
  3. Start the interactive client REPL: ./skysh and then enter your password.
  4. You're ready to run queries!

For a more detailed guide on installation and deployment, follow the guide here.

Using Skytable

Skytable has SPACEs instead of DATABASEs due to signficant operational differences (and because SPACEs store a lot more than tabular data).

With the REPL started, follow this guide:

  1. Create a space and switch to it:
    CREATE SPACE myspace
    USE myspace
  2. Create a model:
    CREATE MODEL myspace.mymodel(username: string, password: string, notes: list { type: string })
    The rough representation for this in Rust would be:
    pub struct MyModel {
     username: String,
     password: String,
     notes: Vec<String>,
    }
  3. INSERT some data:
    INSERT INTO mymodel('sayan', 'pass123', [])
  4. UPDATE some data:
    UPDATE mymodel SET notes += "my first note" WHERE username = 'sayan'
  5. SELECT some data
    SELECT * FROM mymodel WHERE username = 'sayan'
  6. Poke around! And then make sure you read the documentation learn BlueQL.

For a complete guide on Skytable, it's architecture, BlueQL, queries and more we strongly recommend you to read the documentation here.

While you're seeing strings and other values being used here, this is so because the REPL client smartly parameterizes queries behind the scenes. BlueQL has mandatory parameterization. (See below to see how the Rust client handles this)

Find a client driver

You need a client driver to use Skytable in your programs. Officially, we maintain a regularly updated Rust client driver which is liberally license under the Apache-2.0 license so that you can use it anywhere.

Using the Rust client driver, it's very straightforward to run queries thanks to Rust's powerful type system and macros:

use skytable::{Config, query};

fn main() {
    let mut db = Config::new_default("username", "password").connect().unwrap();
    let query = query!("select username, password from myspace.mymodel where username = ?", "sayan");
    let (username, password): (String, Vec<u8>) = db.query_parse(&query).unwrap();
    // do something with it!
}

You can find more information on client drivers on this page. If you want to help write a client driver for your language of choice, we're here to support your work. Please reach out to: [email protected] or leave a message on our Discord server!

Getting help

We exclusively use Discord for most real-time communications — you can chat with developers, maintainers, and our amazing users! Outside that, we recommend that you use our GitHub Discussions page for any questions or open a new issue if you think you've found a bug.

We're here to help!

Contributing

Please read the contributing guide here.

Acknowledgements

Please read the acknowledgements document.

License

Skytable is distributed under the AGPL-3.0 License. You may not use Skytable's logo for other projects.

Skytable's Projects

bagel icon bagel

Compile-time stuff and other goodies for rustaceans 🦀

docs icon docs

Documentation for Skytable

perf icon perf

Skytable Performance Analysis

rfcs icon rfcs

RFCs for changes to the Skytable database.

setupapp icon setupapp

The Skytable Setup App (for versions >= 0.4.6)

skytable icon skytable

Skytable is a modern scalable NoSQL database with BlueQL, designed for performance, scalability and flexibility. Skytable gives you spaces, models, data types, complex collections and more to build powerful experiences

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.