PG-API

A RESTful API for managing your Postgres. Fetch tables, add roles, and run queries (and more).

Usage

Full documentation: https://supabase.github.io/pg-api/

A trial API is set up here: https://pg-api.fly.dev/. To try this with your own Postgres database, read the usage section in the docs.

Quickstart

Set the following ENV VARS:

PG_API_PORT=8080
PG_API_DB_HOST="postgres"
PG_API_DB_NAME="postgres"
PG_API_DB_USER="postgres"
PG_API_DB_PORT=5432
PG_API_DB_PASSWORD="postgres"
PG_API_DB_SSL=false

Then run any of the bin files in the bin directory

./bin/start-linux
./bin/start-macos
./bin/start-windows.exe

FAQs

What security does this use?

None right now. We are assuming you are using this behind a proxy which brings it's own security, or using this internally with no access to the outside world. We may add security in the future, but only something very basic.

Can I use this on my website/client?

No. Primarily because you shouldn't really query your database directly from a client unless you want to give everyone full access to your data. (Don't do it.)

Developers

1. Start the database using docker-compose up
2. Run npm run dev
3. Run npm test while you work

Deploy

Deploys are automated on tag:

git tag <version> # use package.json version
git push origin --tags

Licence

Apache 2.0