Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/frectonz/jabroni
Query your SQLite DB over WebSockets
https://github.com/frectonz/jabroni
rust sqlite sqlite3 websocket
Last synced: 1 day ago
JSON representation
Query your SQLite DB over WebSockets
- Host: GitHub
- URL: https://github.com/frectonz/jabroni
- Owner: frectonz
- License: mit
- Created: 2024-11-13T11:14:51.000Z (2 days ago)
- Default Branch: main
- Last Pushed: 2024-11-14T03:37:02.000Z (1 day ago)
- Last Synced: 2024-11-14T04:27:39.094Z (1 day ago)
- Topics: rust, sqlite, sqlite3, websocket
- Language: Rust
- Homepage:
- Size: 492 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Jabroni
Jabroni let's you connect to your SQLite database over WebSockets and query your data. Jabroni also generates a type-safe typescript client library that provides an API similar to the browser's built in `fetch`.
## Features
- List rows in a table.
- Select specific columns to be returned.
- Paginate results by using a page number.
- Batch insert rows.
- Create, Read, Update and Delete a single rows.
- Round robin connection pooling, to solve socket congestion.
- Type safe client library.
- All the benefits of a WebSocket connection.
## Planned Features
- [ ] Authorization using a JWT
- [ ] Support for table joins
## Install
### Linux and MacOS
```
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/frectonz/jabroni/releases/download/0.1.0/jabroni-installer.sh | sh
```
### Windows
```
powershell -ExecutionPolicy ByPass -c "irm https://github.com/frectonz/jabroni/releases/download/0.1.0/jabroni-installer.ps1 | iex"
```
### Nix
```
nix shell github:frectonz/jabroni
```
### Docker
```
docker run \
-e ADDRESS=0.0.0.0:4949 \
-e DATABASE=/data/sample.sqlite3 \
-v $(pwd)/sample.sqlite3:/data/sample.sqlite3 \
frectonz/jabroni \
serve
```
## Usage
Start a jabroni server
```bash
$ jabroni sample.sqlite3 serve
2024-11-13T11:29:13.776666Z INFO jabroni::db: found 13 tables in sample.sqlite3
2024-11-13T11:29:13.776809Z INFO jabroni: listening on: 127.0.0.1:3030
```
Start a jabroni server on a custom address
```bash
$ jabroni sample.sqlite3 serve --address localhost:4949
2024-11-13T11:34:21.546608Z INFO jabroni::db: found 13 tables in sample.sqlite3
2024-11-13T11:34:21.547339Z INFO jabroni: listening on: localhost:4949
```
Generate a jabroni client library for a database
> [!IMPORTANT]
> The jabroni client library depends on `zod` and `nanoid`, so you should have them installed in your project.
```bash
$ jabroni sample.sqlite3 generate -o jabroni.ts
2024-11-13T11:32:10.130350Z INFO jabroni::db: found 13 tables in sample.sqlite3
2024-11-13T11:32:10.130458Z INFO jabroni: generating client library
2024-11-13T11:32:10.133559Z INFO jabroni: client library generated at jabroni.ts
```
## Client Library
Example usage of the client library
```ts
import { nanoid } from "nanoid";
import { makeWebSocketFetch } from "./jabroni.ts";
// Initialize client library
const $fetch = await makeWebSocketFetch({
url: "ws://127.0.0.1:3030",
connectionCount: 10,
});
// Fetch all rows and all columns in the "employees" table
const resp = $fetch({
type: "ListRows",
table: "employees",
select: [],
request_id: nanoid(),
});
// Only fetch the "FirstName" and "LastName" columns
const resp = $fetch({
type: "ListRows",
table: "employees",
select: ["FirstName", "LastName"],
request_id: nanoid(),
});
// Sort response on the "FirstName" column
const resp = $fetch({
type: "ListRows",
table: "employees",
select: ["FirstName", "EmployeeId"],
sort: { column: "FirstName", order: "Asc" },
request_id: nanoid(),
});
// Paginate response
const resp = $fetch({
type: "ListRows",
table: "employees",
page: { number: 2, size: 2 },
request_id: nanoid(),
});
// Inset a new emplyoee in the "employees" table
const resp = $fetch({
type: "InsertRow",
table: "employees",
data: {
FirstName: "John",
LastName: "Doe",
Phone: "+1 (780) 428-9482",
Email: "[email protected]",
Title: "General Manager",
Fax: "+1 (780) 428-3457",
Address: "11120 Jasper Ave NW",
City: "Edmonton",
State: "AB",
Country: "Canada",
BirthDate: "1962-02-18 00:00:00",
HireDate: "2002-08-14 00:00:00",
PostalCode: "T5K 2N1",
ReportsTo: null,
},
request_id: nanoid(),
});
// ...
```
## You Keep Using This Word `Jabroni`, and It's Awesome
It's a [cool word](https://www.youtube.com/watch?v=eCV9254WaLQ).