🌱Introduction & Credits

Query sqlite via http - and remote clients too!

📢 This project's next version was forked, that will support more databases than sqlite (hence the new name, if you noticed 😉). It will take some time, through improvements and, alas, breaking changes. The development is happening in the fork/ws4sql branch, and you can find the changes and the steps needed to migrate a regular installation in the ROAD_TO_WS4SQL.md document.

I recently started a discussion over the future direction for this project. Take a look, and chip in if you want!

🌱 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:

// Set Content-type: application/json
{
    "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