ayb

ayb 使创建数据库、与协作者共享以及从 Web 应用程序或命令行查询变得容易。

使用 ayb，您的所有（数据）库最终可以归您所有。让 SQL 为正义而战。

简介

ayb 是一个数据库管理系统，具有易于托管的实例，使用户能够快速注册账户、创建数据库、与协作者共享以及从 Web 应用程序或命令行查询。一个 ayb 服务器允许用户创建 SQLite 数据库（其他数据库即将推出），并通过 HTTP API 公开这些数据库。

要了解更多关于为什么 ayb 重要的信息，如何工作以及适用于谁，请阅读这篇介绍性博客文章。

alpha 警告：ayb 既不功能完整，也不是生产就绪。功能如身份验证、权限、协作、隔离、高可用性和事务支持在路线图中，但今天不可用。我将 ayb 作为爱好者的副项目进行开发。

入门

安装

ayb 用 Rust 编写，作为 ayb 包提供。假设您已在计算机上安装了 Rust，则安装 ayb 只需一条命令。

cargo install ayb

运行服务器

ayb 服务器将其元数据存储在 SQLite 或 PostgreSQL 中，并将托管在其本地磁盘上的数据库存储。一个 ayb.toml 文件告诉服务器要监听哪些主机/端口上的连接，如何连接到数据库以及托管数据库的数据路径。您可以使用 ayb default_server_config 生成启动文件。

$ ayb default_server_config > ayb.toml

$ cat ayb.toml

host = "0.0.0.0"
port = 5433
database_url = "sqlite://ayb_data/ayb.sqlite"
# Or, for Postgres:
# database_url = "postgresql://postgres_user:test@localhost:5432/test_db"
data_path = "./ayb_data"

[authentication]
# A secret (and unique to your server) key that is used for account registration.
fernet_key = "<UNIQUE_KEY_GENERATED_BY_COMMAND>="
token_expiration_seconds = 3600

[email]
from = "Server Sender <[email protected]>"
reply_to = "Server Reply <[email protected]>"
smtp_host = "localhost"
smtp_port = 465
smtp_username = "[email protected]"
smtp_password = "the_password"

运行服务器只需一条命令

$ ayb server

运行客户端

一旦服务器运行，您可以注册一个用户（在这个例子中，是marcua），创建一个数据库 marcua/test.sqlite，然后像您喜欢的那样发出SQL命令。下面是如何在命令行中这样做

$ ayb client --url http://127.0.0.1:5433 register marcua [email protected]
Check your email to finish registering marcua

# You will receive an email at [email protected] instructing you to type the next command
$ ayb client confirm <TOKEN_FROM_EMAIL>
Successfully authenticated and saved token <API_TOKEN>

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

$ ayb client list marcua
 Database slug | Type 
---------------+--------
 test.sqlite   | sqlite 

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

Rows: 0

# If you don't pass a query to the query command, ayb launches an interactive query session
$ ayb client query marcua/test.sqlite
Launching an interactive session for marcua/test.sqlite
marcua/test.sqlite> INSERT INTO favorite_databases (name, score) VALUES ("PostgreSQL", 10);

Rows: 0
marcua/test.sqlite> INSERT INTO favorite_databases (name, score) VALUES ("SQLite", 9);

Rows: 0
marcua/test.sqlite> INSERT INTO favorite_databases (name, score) VALUES ("DuckDB", 9);

Rows: 0
marcua/test.sqlite> SELECT * FROM favorite_databases;
 name       | score 
------------+-------
 PostgreSQL | 10 
 SQLite     | 9 
 DuckDB     | 9 

Rows: 3
marcua/test.sqlite>

$ ayb client update_profile marcua --display_name 'Adam Marcus' --links 'http://marcua.net'

Successfully updated profile

$ ayb client profile marcua
 Display name | Description | Organization | Location | Links 
--------------+-------------+--------------+----------+-------------------
 Adam Marcus  |             |              |          | http://marcua.net 

注意，命令行还为您保存了一个配置文件，以便您不必每次都输入服务器URL或API令牌。如果您想明确设置这些，则可以使用命令行标志 --url/--token 和环境变量 AYB_SERVER_URL/AYB_API_TOKEN 来覆盖保存的配置。默认情况下，配置文件可以在此处找到

• Linux: /home/alice/.config/ayb/ayb.json
• MacOS（未经测试）: /Users/Alice/Library/Application Support/org.ayb.ayb/ayb.json
• Windows（未经测试）: C:\Users\Alice\AppData\Roaming\ayb\ayb\config\ayb.json

上面的命令行调用是对ayb的HTTP API的薄包装。以下是与上面相同的命令，但使用了curl

$ curl -w "\n" -X POST http://127.0.0.1:5433/v1/register -H "entity-type: user" -H "entity: marcua" -H "email-address: [email protected]"

{}

$ curl -w "\n" -X POST http://127.0.0.1:5433/v1/confirm -H "authentication-token: TOKEN_FROM_EMAIL"

{"entity":"marcua","token":"<API_TOKEN>"}

$ curl -w "\n" -X POST http://127.0.0.1:5433/v1/marcua/test.sqlite/create -H "db-type: sqlite" -H "authorization: Bearer <API_TOKEN_FROM_PREVIOUS_COMMAND>"

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

$ curl -w "\n" -X PATCH http://127.0.0.1:5433/v1/entity/marcua -H "authorization: Bearer <API_TOKEN_FROM_PREVIOUS_COMMAND>" -d "{\"display_name\": \"Adam Marcus\"}"

{}

$ curl -w "\n" -X GET https://127.0.0.1:5433/v1/entity/marcua -H "authorization: Bearer <API_TOKEN_FROM_PREVIOUS_COMMAND>"

{"slug":"marcua","databases":[{"slug":"test.sqlite","database_type":"sqlite"}],"profile":{"display_name":"Adam Marcus"}}

$ curl -w "\n" -X POST http://127.0.0.1:5433/v1/marcua/test.sqlite/query -H "authorization: Bearer <API_TOKEN_FROM_PREVIOUS_COMMAND>" -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 -H "authorization: Bearer <API_TOKEN_FROM_PREVIOUS_COMMAND>" -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 -H "authorization: Bearer <API_TOKEN_FROM_PREVIOUS_COMMAND>" -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 -H "authorization: Bearer <API_TOKEN_FROM_PREVIOUS_COMMAND>" -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 -H "authorization: Bearer <API_TOKEN_FROM_PREVIOUS_COMMAND>" -d "SELECT * FROM favorite_databases;"

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

隔离

ayb允许多个用户在同一台机器上存储的数据库上运行查询。隔离功能可以防止一个用户访问另一个用户的数据，并允许您限制任何单个用户能够使用的资源。

默认情况下，ayb使用SQLITE_DBCONFIG_DEFENSIVE标志，并将SQLITE_LIMIT_ATTACHED设置为0，以防止用户损坏数据库或连接到文件系统上的其他数据库。

[isolation]
nsjail_path = "path/to/nsjail"

cargo test --verbose

scripts/build_nsjail.sh && mv nsjail tests/