This folder has a number of examples that can help provide a feel for httpsql. There is a folder for both Postgres and Sqlite. Each uses the same examples and shows how the same API calls can be sent to different databases.

Each file expects the following environment variable to be set in order to connect to your postgres database:

• DATABASE_URL

We suggest using a .env file in the root of the project to drive these values. A .env.sample has been provided in the examples directory.

The examples create a foobar database. Feel free to change the destination.

Please note that executing transactions in Sqlite has tradeoffs. A write lock on the database is maintained throughout the life of the transaction. If you start a transaction with 4-5 Httpsql commands, you should not run into problems snce the transaction should complete quickly. However, if you have a very write intensive workload, consider carefully how many commands are sent through in a single transaction as you will likely run into write contentions and timeouts. Keep track of the total execution time of each transaction as captured in the context response.

Each example can be executed directly via node:

node ./01.create-table.js

Script commands have also been setup in the package so npm run can execute :

npm run pg-sample1
npm run sqlite-sample1

Drops a projects table if it exists and then creates it again. Run this file first to get started and can be run before and after each sample in order to start fresh.

Demonstrates a simple project insert with returned data and an expectation that only one row gets created.

Creates a project and then attempts to create another project with the same ID and fails. Demonstrate failure handling at the database level as well as the use to {variable:...} and {lastop:...} dynamic parameters.

Does a simple fetch of all rows in the projects table. Use after each example to see the state of the projects table.

Creates a project, attempts to fetch it by name, validates a specific status value, then updates the record with a new status value. Demonstrates the use of a logic operation (logicOp) to drive future commands.

Uses an incorrectly formatted command to demonstrate how validation errors are thrown. See the json-schemas directory for the different validation schemas.

Creates a contacts table

Demonstrates how a logic operation can transform the shape of the final output.