proofrock/ws4sqlite-docs

Sources for https://germ.gitbook.io/ws4sqlite/

description
Query sqlite via http - and remote clients too!

This project has now a reimplementarion in Rust, called sqliterg, at sqliterg.dev. It is not a 1:1 rewrite, but I tried to fix some concepts that I feel I got wrong here; plus it's smaller, (even) faster, (even) less memory-hungry and it can be built with an embedded sqlite or using the one on the system. You should feel at home with it, anyway a migration guide is here.

ws4sqlite is not really deprecated, it will continue to receive libraries updates (about monthly), but probably not new features.

🌱 Introduction & Credits

ws4sqlite is a server-side application that, applied to one or more SQLite files, allows to perform SQL queries and statements on them via REST (or better, JSON over HTTP).

Possible use cases are the ones where remote access to a sqlite db is useful/needed, for example a data layer for a remote application, possibly serverless or even called from a web page (after security considerations of course).

Client libraries are available, that will abstract the "raw" JSON-based communication. See here for Java/JVM, here for Go(lang); others will follow.

As a quick example, after launching

ws4sqlite --db mydatabase.db

It's possible to make a POST call to http://localhost:12321/mydatabase, e.g. with the following body:

{
    "transaction": [
        {
            "statement": "INSERT INTO TEST_TABLE (ID, VAL, VAL2) VALUES (:id, :val, :val2)",
            "values": { "id": 1, "val": "hello", "val2": null }
        },
        {
            "query": "SELECT * FROM TEST_TABLE"
        }
    ]
}

Obtaining an answer of:

{
    "results": [
        {
            "success": true,
            "rowsUpdated": 1
        },
        {
            "success": true,
            "resultSet": [
                { "ID": 1, "VAL": "hello", "VAL2": null }
            ]
        }
    ]
}

Credits

Many thanks and all the credits to these awesome projects:

• lnquy's cron (MIT License);
• robfig's cron (MIT License);
• gofiber's fiber (MIT License);
• klauspost's compress (3-Clause BSD license);
• mitchellh's go-homedir (MIT License);
• modernc.org's sqlite (3-Clause BSD License);
• wI2L's jettison (MIT License)
• and of course, Google Go.

Kindly supported by JetBrains for Open Source development

ws4sqlite-docs's Issues

Proofread the "security" page

Clarify the comments in the cheat sheet

There are 10 supported platforms, not 9 as stated in the README