Skip to content

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

License

Notifications You must be signed in to change notification settings

h1u2i3/pg-api

 
 

Repository files navigation

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/

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"

Then run any of the binaries in the releases.

FAQs

What security does this use?

None. Please don't use this as a standalone server. We are assuming you are using this behind a proxy which brings its own security, on your local machine, or using this internally with no access to the outside world. This is designed to be used as a part of a larger system.

Developers

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

Licence

Apache 2.0

Sponsors

We are building the features of Firebase using enterprise-grade, open source products. We support existing communities wherever possible, and if the products don’t exist we build them and open source them ourselves. Thanks to these sponsors who are making the OSS ecosystem better for everyone.

New Sponsor

About

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

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • TypeScript 69.5%
  • JavaScript 30.3%
  • Dockerfile 0.2%