https://github.com/aunyks/sqlite-http

SQLite over HTTP. Plays nice with Litestream.
https://github.com/aunyks/sqlite-http

Last synced: about 1 month ago
JSON representation

SQLite over HTTP. Plays nice with Litestream.

• Host: GitHub
• URL: https://github.com/aunyks/sqlite-http
• Owner: aunyks
• Created: 2024-02-19T03:42:18.000Z (11 months ago)
• Default Branch: main
• Last Pushed: 2024-03-08T01:08:02.000Z (10 months ago)
• Last Synced: 2024-04-24T15:10:13.509Z (9 months ago)
• Language: Rust
• Size: 59.6 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# sqlite-http

An HTTP interface for SQLite. Plays very nicely with [Litestream](https://litestream.io/) for backup / replication.

## Install

```sh

cargo install sqlite-http

```

```sh

> sqlite-http --help

An HTTP interface for SQLite.

Usage: sqlite-http [OPTIONS] --host  --db-path 

Options:

      --host 

          The host to bind to

      --db-path 

          The path to the database file

      --collect-metadata

          Enable metadata collection about incoming queries

      --disable-wal-mode

          Disable Write-Ahead-Logging mode. Enabled by default

      --disable-foreign-keys

          Don't enforce foreign key constraints. Enforced by default

      --load-extension 

          Load an extension from the provided path. This flag can be used multiple times in one invocation to load multiple extensions

  -h, --help

          Print help

  -V, --version

          Print version

```

## Examples

Basic

```sh

sqlite-http --host 127.0.0.1:8080 --db-path ./example.db

```

Only receieve sqlite-http's logs

```sh

SQLITE_HTTP_LOG=off,sqlite_http=trace sqlite-http --host 127.0.0.1:8080 --db-path ./example.db

```

Replicate with litestream (existing config assumes a running local MinIO instance)

```sh

litestream replicate -config ./etc/litestream.yml

```

Restore with litestream (existing config assumes a running local MinIO instance)

```sh

litestream restore -config ./etc/litestream.yml -replica "S3 Backup" ./example.db

```

## Usage

Send this

```

{

    "sql" "INSERT INTO my_table (str_col, bool_col, blob_col, real_col) VALUES (?, ?, ?, ?)",

    "args": ["column 1", true, "03", 4]

}

```

Get this

```

{

    "rows": []

}

```

Send this

```

{

    "sql" "SELECT * FROM my_table",

    "args": []

}

```

Get this

```

{

    rows: [

        ["column 1", true, "03", 4]

    ]

}

```

## Collecting Metadata

Using the `--collect-metadata` flag creates a `__metadata_query` table that may be useful in debugging and performance monitoring. Its schema is as follows, and it can be queried as any other table.

| Column      | Type    |

| ----------- | ------- |

| id          | INTEGER |

| payload     | TEXT    |

| started_at  | TEXT    |

| finished_at | TEXT    |