Skip to content
This repository

PostgreSQL HTTP API Server

branch: master
README.md

PostgreSQL HTTP API Server

Attempt to implement something like the proposal at http://wiki.postgresql.org/wiki/HTTP_API

Build Status

Installing

NOTE: Requires node.js

# npm install postgresql-http-server

Usage

# postgresql-http-server --help
PostgreSQL HTTP API Server

Options:
  --port      HTTP Server port      [required]  [default: 3000]
  --dbhost    PostgreSQL host       [required]  [default: "localhost"]
  --dbport    PostgreSQL port       [required]  [default: 5432]
  --database  PostgreSQL database   [required]  [default: <user>]
  --user      PostgreSQL username   [required]  [default: <user>]
  --password  PostgreSQL password
  --raw       Enable raw SQL usage  [boolean]
  --cors      Enable CORS support   [boolean]
  --secure    Enable Basic Auth support  [boolean]
              (configured via PG_BASIC_PASS and PG_BASIC_USER) 
  --help      Show this message

API Usage

The API is discoverable which means you can access the root resource at / and follow links to subresources from there but lets say you have a database named testdb with a table named testtable in the public schema you can then do the following operations:

Retrieve (GET) or update (PUT) a single row at:
/db/testdb/schemas/public/tables/testtable/rows/id

Retrieve rows (GET), update rows (PUT) or create a new row (POST) at:
/db/testdb/schemas/public/tables/testtable/rows

The above resources accepts parameters select, where, limit, offset and orderby where applicable. Examples:

GET a maximum of 10 rows where cost>100 at:
/db/testdb/schemas/public/tables/testtable/rows?where=cost>100&limit=10

GET rows with fields id and geom (as WKT) intersecting a polygon
/db/testdb/schemas/public/tables/testtable/rows?select=id,ST_AsText(geom) as geom&where=st_intersects(geom,'POLYGON((10 10,10 100,100 100,100 10,10 10))'::geometry)

The default and currently the only dataformat is JSON. POSTing or PUTing expects a JSON object with properties corresponding to column names.

Raw SQL queries can be POSTed to the database resource. Expected data is a JSON object with the SQL string as property named "sql".

TODOs

  • Use real primary key (current single row operations assume a primary key named id)
  • Stream row data
  • Configurable max rows hard limit
  • Optional security "firewall" (initially no access, open access to paths/operations based on configurable rules)
  • Use as "plugin" to your existing express application

License

The MIT License (MIT)

Copyright (c) 2012-2013 Björn Harrtell

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Something went wrong with that request. Please try again.