Execute one command (or mount one Node.js middleware) and get an instant high-performance GraphQL API for your PostgreSQL database!
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode fix(tests): add missing `await` after premature merge (#925) Nov 23, 2018
assets feat(favicon): use PostGraphile favicon (#889) Oct 30, 2018
examples fix(docs): add `nullif` to current_user function (#911) Nov 16, 2018
postgraphiql sponsorship: donate -> sponsor (#937) Dec 6, 2018
resources refactor: GraphiQL embeds resources (#885) Oct 25, 2018
scripts docs(CONTRIBUTING): overhaul setup guide Dec 8, 2018
src sponsorship: donate -> sponsor (#937) Dec 6, 2018
typings feat(sponsors): feature a random sponsor ❤️ (#904) Nov 22, 2018
.dockerignore feat(docker): Docker Image (#496) Jul 9, 2017
.editorconfig 🌅 Oct 9, 2016
.gitignore refactor: GraphiQL embeds resources (#885) Oct 25, 2018
.npmignore Even smaller bundle Jul 15, 2017
.travis.yml chore: update requirements Feb 23, 2018
CONTRIBUTING.md docs(CONTRIBUTING): overhaul setup guide Dec 8, 2018
Dockerfile chore(Dockerfile): update Dockerfile to install from npm Jun 8, 2018
ISSUE_TEMPLATE.md Redirect chat to discord Oct 11, 2018
LICENSE.md docs: update README (#861) Sep 22, 2018
README.md sponsorship: donate -> sponsor (#937) Dec 6, 2018
SPONSORS.md sponsorship: link to /sponsor/ Dec 6, 2018
TROUBLESHOOTING.md docs(TROUBLESHOOTING): add instructions to file (#833) Aug 15, 2018
package.json 4.1.0 Dec 6, 2018
prettier.config.js chore(lint): add semicolons (via `prettier`) (#807) Jul 21, 2018
rmlocal.sh docs(CONTRIBUTION): dev setup guide Dec 7, 2018
sponsors.json fix(cli): add sponsors.json to bundled files Nov 24, 2018
tsconfig.json feat(deps): upgrade pg-sql2 and postgraphile-core (#839) Aug 22, 2018
tslint.json chore(lint): use more standard TSLint config (#810) Jul 23, 2018
yarn.lock feat(deps): upgrade postgraphile-core Dec 6, 2018

README.md

PostGraphile

Patreon sponsor button Discord chat room Package on npm MIT license Follow

Instant lightning-fast GraphQL API backed primarily by your PostgreSQL database. Highly customisable and extensible thanks to incredibly powerful plugin system. Formerly "PostGraphQL".

Documentation: graphile.org/postgraphile

GraphQL is a new way of communicating with your server. It eliminates the problems of over- and under-fetching, incorporates strong data types, has built-in introspection, documentation and deprecation capabilities, and is implemented in many programming languages. This all leads to gloriously low-latency user experiences, better developer experiences, and much increased productivity. Because of all this, GraphQL is typically used as a replacement for (or companion to) RESTful API services.

PostgreSQL is the self-proclaimed “world’s most advanced open source database,” with each new release bring more amazing features and performance gains. Thinking of your database as a plain CRUD store is now an archaic viewpoint as modern PostgreSQL can do so much for you — from authorization with Row-Level Security (RLS, introduced in PG9.5), through Foreign Data Wrappers (FDW), to real time notifications with LISTEN/NOTIFY.

PostGraphile pairs these two incredible technologies together, helping you not only build applications more rapidly, but to build lightning-fast applications. PostGraphile allows you to access the power of PostgreSQL through a well designed, extensible, customisable and incredibly performant GraphQL server. It automatically detects tables, columns, indexes, relationships, views, types, functions, comments, and more - providing a GraphQL server that is highly intelligent about your data, and that automatically updates itself without restarting when you change your database schema.

With PostGraphile, a well designed database schema should serve the basis for a well thought out API. PostgreSQL already has amazing authorization and relationship infrastructure, why duplicate that logic in a custom API? A PostGraphile API is likely to provide a more performant and standards compliant GraphQL API then any created in-house, and can be built in a fraction of the time. Focus on your product and let PostGraphile worry about the API layer. Once you need to expand beyond this, we have a powerful plugin system including many community contributed plugins. For a critical evaluation of PostGraphile to determine if it fits in your tech stack, read evaluating PostGraphile for your project.

Crowd-funded open-source software

In exchange for the incredible freedom we give in how this software can be used (thanks to the permissive MIT license) we ask the individuals and businesses that use it to sponsor ongoing maintenance and development. A huge amount of work goes into producing and maintaining this powerful and professional software, please give back via sponsorship.

Introduction

Watch a talk by the original author Caleb at GraphQL Summit for a walk-through of building an application with PostGraphile in under 7 minutes. This was using v2 (then called PostGraphQL); we're now up to v4 which has many more bells and whistles!

PostGraphile at GraphQL Summit

Hear from the current maintainer Benjie at GraphQL Finland about the benefits of Database-Driven GraphQL Development:

Database Driven GraphQL Development at GraphQL Finland

Usage

Documentation: graphile.org/postgraphile

You can use PostGraphile via the CLI, as a Node.js middleware, or use the GraphQL schema directly. Make sure to check out the full usage instructions on the documentation website. We also have a PostgreSQL schema design guide you can follow to build a fully functional PostGraphile API.

CLI

To get started you can install PostGraphile globally:

npm install -g postgraphile

…and then just run it! By default, PostGraphile will connect to your local database at postgres://localhost:5432 and introspect the public schema. See the available CLI flags with:

postgraphile --help

When you're ready to use PostGraphile for your own project, you're advised to install it locally with yarn, and run it with npx:

yarn add postgraphile
npx postgraphile --help

Middleware

You can also use PostGraphile as native HTTP, Connect, Express, or Koa (experimental) middleware, e.g.:

yarn add postgraphile
import { createServer } from 'http';
import postgraphile from 'postgraphile';

createServer(postgraphile());

Check out hapi-postgraphile if you're interested in using PostGraphile as a hapi server plugin.

Docker

To run via Docker, simply pass the CLI options to the Docker container:

docker pull graphile/postgraphile
docker run graphile/postgraphile --help

E.g. you might run this command (substituting the relevant variables):

docker run -p 5000:5000 graphile/postgraphile --connection postgres://POSTGRES_USER:POSTGRES_PASSWORD@POSTGRES_HOST:POSTGRES_PORT/POSTGRES_DATABASE --schema app_public --watch

Read More

Full documentation for PostGraphile is located at graphile.org/postgraphile.

PostGraphile features include:

Requirements

Full requirements are on the website, but a basic summary is:

  • Node v8.6+
  • PostgreSQL 9.6+ (officially; but currently works with 9.4+)
  • Linux, macOS or Windows

Caveats:

  • PostGraphile does not have automated tests on Windows, if you notice any issues please file them (or send a PR!)

Supporting PostGraphile

The fastest and easiest way you can help PostGraphile thrive is by sponsoring ongoing development and maintenance.

Want to help testing and developing PostGraphile? Check out the contributing document to get started quickly!

Commercial support, consultancy and development services are available direct from the maintainer; see Professional Services for more information, or get in touch!

The maintainer of this project is @Benjie - follow him on Twitter!

Thanks

Huge thanks to the individuals and companies who sponsor PostGraphile's development - their financial contributions enable more time to be spent on the project: from bug fixes, to code review, to new features! If you want to help the project advance more rapidly, please join them in supporting this project 🙏

A humongous, heart-felt, thank you to the original author of PostGraphile - Caleb Meredith - for everything he put into PostGraphile! He's now graduated from the project and we all wish him the best for his future ventures!

Thanks also to the people working on PostgREST which was a huge inspiration for this project!

Thanks and enjoy 👍