ayb

With ayb, all your base can finally belong to you. Move SQL for great justice.

Build status

Introduction

ayb makes it easy to create databases, share them with collaborators, and query them from a web application or the command line. An ayb server allows users or organizations to create SQLite databases (other databases to come), and then exposes those databases through an HTTP API. In database terms, ayb is a multi-tenant RDBMS that relies on embedded databases like SQLite for persistence and query processing while exposing those databases over HTTP.

alpha warning: ayb is neither feature complete nor production-ready. Functionality like authentication, permissions, isolation, high availability, transaction support, collaboration, or DuckDB hosting are on the Roadmap but not available today. I work on ayb as a hobbyist side project.

Getting started

Installing

ayb is written in Rust, and is available as the ayb crate. Assuming you have installed Rust on your machine, installing ayb takes a single command:

bash cargo install ayb

Running the server

An ayb server stores its metadata in SQLite or PostgreSQL, and its embedded databases on a local disk. First, create an ayb.toml configuration file to tell the server what host/port to listen for connections on, how to connect to the database, and the data path for the embedded databases:

```bash cat <url = "sqlite://aybdata/ayb.sqlite"

Or, for Postgres:

databaseurl = "postgresql://postgresuser:test@localhost:5432/test_db"

datapath = "./aybdata" EOF ```

Running the server then requires one command bash $ ayb server

Running the client

Once the server is running, you can set its URL as an environment variable called AYB_SERVER_URL, register a user (in this case, marcua), create a database marcua/test.sqlite, and issue SQL as your heart pleases. Here's how to do that at the command line:

```bash $ export AYBSERVERURL=http://127.0.0.1:5433

$ ayb client register marcua Successfully registered marcua

$ ayb client create_database marcua/test.sqlite Successfully created marcua/test.sqlite

$ ayb client query marcua/test.sqlite "CREATE TABLE favorite_databases(name varchar, score integer);"

Rows: 0

$ ayb client query marcua/test.sqlite "INSERT INTO favorite_databases (name, score) VALUES (\"PostgreSQL\", 10);"

Rows: 0

$ ayb client query marcua/test.sqlite "INSERT INTO favorite_databases (name, score) VALUES (\"SQLite\", 9);"

Rows: 0

$ ayb client query marcua/test.sqlite "INSERT INTO favorite_databases (name, score) VALUES (\"DuckDB\", 9);"

Rows: 0

$ ayb client query marcua/test.sqlite "SELECT * FROM favorite_databases;" name | score ------------+------- PostgreSQL | 10 SQLite | 9 DuckDB | 9

Rows: 3 ```

The command line invocations above are a thin wrapper around ayb's HTTP API. Here are the same commands as above, but with curl: ```bash $ curl -w "\n" -X POST http://127.0.0.1:5433/v1/marcua -H "entity-type: user"

{"entity":"marcua","entity_type":"user"}

$ curl -w "\n" -X POST http://127.0.0.1:5433/v1/marcua/test.sqlite -H "db-type: sqlite"

{"entity":"marcua","database":"test.sqlite","database_type":"sqlite"}

$ curl -w "\n" -X POST http://127.0.0.1:5433/v1/marcua/test.sqlite/query -d 'CREATE TABLE favorite_databases(name varchar, score integer);'

{"fields":[],"rows":[]}

$ curl -w "\n" -X POST http://127.0.0.1:5433/v1/marcua/test.sqlite/query -d "INSERT INTO favorite_databases (name, score) VALUES (\"PostgreSQL\", 10);"

{"fields":[],"rows":[]}

$ curl -w "\n" -X POST http://127.0.0.1:5433/v1/marcua/test.sqlite/query -d "INSERT INTO favorite_databases (name, score) VALUES (\"SQLite\", 9);"

{"fields":[],"rows":[]}

$ curl -w "\n" -X POST http://127.0.0.1:5433/v1/marcua/test.sqlite/query -d "INSERT INTO favorite_databases (name, score) VALUES (\"DuckDB\", 9);"

{"fields":[],"rows":[]}

$ curl -w "\n" -X POST http://127.0.0.1:5433/v1/marcua/test.sqlite/query -d "SELECT * FROM favorite_databases;"

{"fields":["name","score"],"rows":[["PostgreSQL","10"],["SQLite","9"],["DuckDB","9"]]} ```

What's with the name?

Thank you for asking. I hope the answer elicits some nostalgia! Shout out to Meelap Shah and Eugene Wu for convincing me to not call this project stacks, to Andrew Lange-Abramowitz for making the connection to the storied meme, and to Meredith Blumenstock for listening to me fret over it all.

Roadmap

Here's a rough roadmap for the project, with items near the top of the list more likely to be completed first. The nitty-gritty list of prioritized issues can be found on this project board, with the most-likely-to-be-completed issues near the top of the to-do list.

Contributing

(This section is inspired by the LiteFS project, and is just one of the many things to love about that project.)

ayb contributions work a little different than most GitHub projects: * If you have a small bug fix or typo fix, please PR directly to this repository. * If you want to contribute documentation, please PR directly to this repository. * If you would like to contribute a feature, create and discuss the feature in an issue on this GitHub repository first. Once the feature and some of its finer details are hashed out in the issue and potentially a design document, submit a pull request. I might politely decline pull requests that haven't first been discussed/designed.

This project has a roadmap and features are added and tested in a certain order. I'm adding a little friction in requiring a discussion/design document for features before submitting a pull request to ensure that I can focus my attention on well-motivated, well-sequenced, and well-understood functionality.