• Home
  • Overview
  • Docs
  • Changelog
  • Sponsor
  • Contribute
  • Go Pro!
  • Professional Support
  • Github
Need help or advice? We now offer Development Support, direct from the maintainer Get support

Overview

  • Introduction
  • Example Gallery
  • Usage
    • CLI Usage
    • Library Usage
    • Schema-only Usage
  • Performance
  • Requirements
  • Required Knowledge

Operation

  • Quick Start Guide
  • Namespaces
  • Inflection
  • Tables
    • Relations
    • Connections
    • Filtering
    • CRUD Mutations
    • nodeId / id
  • Functions
    • Computed Columns
    • Custom Queries
    • Custom Mutations
    • Function Restrictions
    • Function Gallery
  • Enums
  • Views
  • Aggregates
  • PostgreSQL Indexes
  • Security
  • Realtime
    • Subscriptions
    • Live Queries
  • Background Tasks
  • Reserved Keywords
  • Debugging

Customising

  • Smart Tags
    • The postgraphile.tags.json5 file
    • Database Smart Comments
  • Schema Plugins
    • makeAddInflectorsPlugin
    • makeChangeNullabilityPlugin
    • makeExtendSchemaPlugin
    • makeProcessSchemaPlugin
    • makeWrapResolversPlugin
    • makeAddPgTableConditionPlugin
    • makeAddPgTableOrderByPlugin
    • makePgSmartTagsPlugin
    • makePluginByCombiningPlugins
    • Graphile Engine
    • Plugin Gallery
    • Community Plugins
  • Server Plugins

Guides

  • PostgreSQL Schema Design
  • Evaluating for your Project
  • Best Practices
  • Production Considerations
  • PostGraphile JWT Guide
  • JWK Verification (e.g. Auth0)
  • The Default Role
  • @graphile/pg-pubsub Migration Guide
  • v4 Feature Guide
  • v3 → v4 Migration Guide
  • Testing with Jest
  • Bundling with Webpack
  • Multiple GraphQL Schemas
  • Running PostGraphile in Docker
  • Running PostGraphile as a library in Docker

Deploying

  • Deploying to Heroku
  • Deploying with Docker
  • Deploying to AWS Lambda
  • Deploying to GCP

Community

  • Community Contributions
  • Community Chat
  • Code of Conduct

FAQ

  • Introspection?
  • Why is it nullable?
  • Versioning policy?
📝 Suggest improvement/edit this page

Deploying to AWS Lambda

We have an example of how to deploy to AWS Lambda located here:

https://github.com/graphile/postgraphile-lambda-example



Deploying with Docker
Deploying to GCP

Questions, comments or feedback?
Email [email protected]

Keep up to date on Graphile and PostGraphile features/changes. Subscribe to our occasional announcements newsletter:

PostGraphile
  • Documentation
  • About
  • Community Plugins
  • Changelog
Graphile Engine
  • Documentation
  • About
  • Plugins
Resources
  • News
  • GitHub
  • Chat (discord)
  • Mastodon
  • Twitter
  • Youtube
  • Press Kit
  • Learn
About
PostGraphile and Graphile Build are crowd-funded Open Source Software, developed and maintained primarily by @Benjie with the help of the community.

You can support the projects via sponsorship, by going Pro, or by paying for Professional Services. Your support is gratefully received 🙏

This site is copyright © Benjie Gillam 2025. Design and logos copyright © Benjie Gillam and Jof Arnold 2025.

Corrections and contributions to this website are gratefully received via its GitHub repository.

PostGraphile was originally authored as PostGraphQL by Caleb Meredith.