GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQLSPONSORNEWSLEARNPROFESSIONAL SUPPORTGRAPHILEGETTING STARTED A quick-start project for full-stack application development in React, Node.js, GraphQL and PostgreSQL. Graphile Starter includes the foundations of a modern web application, with a full user registration system, session management, optimised job queue, pre GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQL Rapidly develop lightning-fast powerful applications PostGraphile 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 modify your database.

POSTGRAPHILE

POSTGRAPHILE

PostGraphile (formerly PostGraphQL) builds a powerful, extensible and performant GraphQL API from a PostgreSQL schema in seconds; saving you weeks if not months of development time. If you already use PostgreSQL then you understand the value that a strongly typed and well defined schema can bring to application development; GraphQL is the

POSTGRAPHILE

NOTE: this documentation applies to PostGraphile v4.1.0+ The graphile-utils module contains some helpers for extending your PostGraphile (or Graphile Engine) GraphQL schema without having to understand the complex plugin system.. The main one you'll care about to start with is makeExtendSchemaPlugin.. Using makeExtendSchemaPlugin you can write a plugin that will merge

POSTGRAPHILE

PostGraphile | Usage - Schema Only. The PostGraphile middleware gives you a lot of excellent features for running your own GraphQL server. However, if you want to execute a PostGraphile query in Node.js without having to go through HTTP you can use some other

POSTGRAPHILE

Out of the box, PostGraphile supports rudimentary filtering on connections using a condition argument. This allows you to filter for specific values (e.g. username: "Alice" or category: ARTICLE). It's important when implementing filters to keep performance in mind, so PostGraphile gives you the ability to omit certain fields from the list of filters using the @omit filter smart comment.

POSTGRAPHILE

Deploying with Docker. PostGraphile has an official Docker image which is suitable to use if you don't need custom plugins and are deploying PostGraphile as standalone: Our Docker images are versioned: graphile/postgraphile:4 will give you the latest stable in the "v4.x.x" line (no alphas, betas, rcs); this is the recommended version

to use

POSTGRAPHILE

To enable the JWT functionality you must provide a --jwt-secret on the CLI (or jwtSecret to the library options). This will allow PostGraphile to authenticate incoming JWTs and set the granted claims on the database transaction. You should also supply a --default-role

POSTGRAPHILE

The first line FROM postgres:alpine indicates to build the Docker image based on the official PostgreSQL Docker image running in an Alpine Linux container. The second line COPY ./init/ /docker-entrypoint-initdb.d/ will copy the database initialization files (SQL) into the folder docker-entrypoint-initdb.d located in the Docker container. This folder is read by PostgreSQL upon database GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQLSPONSORNEWSLEARNPROFESSIONAL SUPPORTGRAPHILEGETTING STARTED A quick-start project for full-stack application development in React, Node.js, GraphQL and PostgreSQL. Graphile Starter includes the foundations of a modern web application, with a full user registration system, session management, optimised job queue, pre GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQL Rapidly develop lightning-fast powerful applications PostGraphile 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 modify your database.

POSTGRAPHILE

POSTGRAPHILE

PostGraphile (formerly PostGraphQL) builds a powerful, extensible and performant GraphQL API from a PostgreSQL schema in seconds; saving you weeks if not months of development time. If you already use PostgreSQL then you understand the value that a strongly typed and well defined schema can bring to application development; GraphQL is the

POSTGRAPHILE

NOTE: this documentation applies to PostGraphile v4.1.0+ The graphile-utils module contains some helpers for extending your PostGraphile (or Graphile Engine) GraphQL schema without having to understand the complex plugin system.. The main one you'll care about to start with is makeExtendSchemaPlugin.. Using makeExtendSchemaPlugin you can write a plugin that will merge

POSTGRAPHILE

PostGraphile | Usage - Schema Only. The PostGraphile middleware gives you a lot of excellent features for running your own GraphQL server. However, if you want to execute a PostGraphile query in Node.js without having to go through HTTP you can use some other

POSTGRAPHILE

Out of the box, PostGraphile supports rudimentary filtering on connections using a condition argument. This allows you to filter for specific values (e.g. username: "Alice" or category: ARTICLE). It's important when implementing filters to keep performance in mind, so PostGraphile gives you the ability to omit certain fields from the list of filters using the @omit filter smart comment.

POSTGRAPHILE

Deploying with Docker. PostGraphile has an official Docker image which is suitable to use if you don't need custom plugins and are deploying PostGraphile as standalone: Our Docker images are versioned: graphile/postgraphile:4 will give you the latest stable in the "v4.x.x" line (no alphas, betas, rcs); this is the recommended version

to use

POSTGRAPHILE

To enable the JWT functionality you must provide a --jwt-secret on the CLI (or jwtSecret to the library options). This will allow PostGraphile to authenticate incoming JWTs and set the granted claims on the database transaction. You should also supply a --default-role

POSTGRAPHILE

The first line FROM postgres:alpine indicates to build the Docker image based on the official PostgreSQL Docker image running in an Alpine Linux container. The second line COPY ./init/ /docker-entrypoint-initdb.d/ will copy the database initialization files (SQL) into the folder docker-entrypoint-initdb.d located in the Docker container. This folder is read by PostgreSQL upon database GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQL A quick-start project for full-stack application development in React, Node.js, GraphQL and PostgreSQL. Graphile Starter includes the foundations of a modern web application, with a full user registration system, session management, optimised job queue, pre

POSTGRAPHILE

NOTE: this documentation applies to PostGraphile v4.1.0+ The graphile-utils module contains some helpers for extending your PostGraphile (or Graphile Engine) GraphQL schema without having to understand the complex plugin system.. The main one you'll care about to start with is makeExtendSchemaPlugin.. Using makeExtendSchemaPlugin you can write a plugin that will merge

POSTGRAPHILE

PostGraphile Realtime. Every application is different, and no more so than when it comes to their realtime requirements. Some applications are read-heavy, others write-heavy, and others are collaborative and need to put in effort to avoid conflicts between multiple people editing the same things at the same time (e.g. Google Docs).

POSTGRAPHILE

Enabling with an Express app. When using PostGraphile as a library, you may enable Custom Subscriptions by passing the pluginHook with the @graphile/pg-pubsub plugin, setting subscriptions: true and adding your custom plugin.. We emulate part of the Express stack, so if you require sessions you can pass additional Connect/Express middlewares (sorry, we don't support Koa middlewares here at

POSTGRAPHILE

Common Middleware Considerations. In a production app, you typically want to add a few common enhancements, e.g. Logging. Gzip or similar compression. Security protections. Rate limiting. Since there's already a lot of options and opinions in this space, and they're not directly related to the problem of serving GraphQL from your

PostgreSQL

POSTGRAPHILE

Library mode is the most popular way of running PostGraphile; it gives more power than using the CLI (see CLI usage), but is much easier to setup and more fully featured than Schema-only Usage.. Details of the configuration options can be found below. PostGraphile supports usage in library mode within various Node server frameworks.

POSTGRAPHILE

Performance. On a Digital Ocean compute-optimised droplet with 8GB of RAM, running PostGraphile, PostgreSQL and the benchmarking software all through Docker, PostGraphile running in cluster mode over 4 vCPUs can handle 3250 requests per second for the following simple query: For a more complex 3-level query, it can handle about 1450 requests

POSTGRAPHILE

The first line FROM postgres:alpine indicates to build the Docker image based on the official PostgreSQL Docker image running in an Alpine Linux container. The second line COPY ./init/ /docker-entrypoint-initdb.d/ will copy the database initialization files (SQL) into the folder docker-entrypoint-initdb.d located in the Docker container. This folder is read by PostgreSQL upon database

POSTGRAPHILE

Globally Unique Object Identification ("nodeId" / "id") We implement the Relay Global Object Identification Specification , so any table that has a primary key will automatically have a unique nodeId field available for queries and mutations. This is commonly used as the cache key for your client library, e.g. with Apollo Client's

dataIdFromObject:

POSTGRAPHILE

The easiest way to get up and running with PostGraphile is to use the Command Line Interface. Install PostGraphile globally via npm: npm install -g postgraphile. This will make the postgraphile command available. You can then run: postgraphile -c postgres:///mydb -s public -a -j. where -c is the connection string (defaults to

postgres:/// ), -s

GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQLSPONSORNEWSLEARNPROFESSIONAL SUPPORTGRAPHILEGETTING STARTED A quick-start project for full-stack application development in React, Node.js, GraphQL and PostgreSQL. Graphile Starter includes the foundations of a modern web application, with a full user registration system, session management, optimised job queue, pre GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQL Rapidly develop lightning-fast powerful applications PostGraphile 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 modify your database.

POSTGRAPHILE

POSTGRAPHILE

Enabling with an Express app. When using PostGraphile as a library, you may enable Custom Subscriptions by passing the pluginHook with the @graphile/pg-pubsub plugin, setting subscriptions: true and adding your custom plugin.. We emulate part of the Express stack, so if you require sessions you can pass additional Connect/Express middlewares (sorry, we don't support Koa middlewares here at

POSTGRAPHILE

PostGraphile Realtime. Every application is different, and no more so than when it comes to their realtime requirements. Some applications are read-heavy, others write-heavy, and others are collaborative and need to put in effort to avoid conflicts between multiple people editing the same things at the same time (e.g. Google Docs).

POSTGRAPHILE

Deploying with Docker. PostGraphile has an official Docker image which is suitable to use if you don't need custom plugins and are deploying PostGraphile as standalone: Our Docker images are versioned: graphile/postgraphile:4 will give you the latest stable in the "v4.x.x" line (no alphas, betas, rcs); this is the recommended version

to use

POSTGRAPHILE

NOTE: this documentation applies to PostGraphile v4.1.0+ The graphile-utils module contains some helpers for extending your PostGraphile (or Graphile Engine) GraphQL schema without having to understand the complex plugin system.. The main one you'll care about to start with is makeExtendSchemaPlugin.. Using makeExtendSchemaPlugin you can write a plugin that will merge

POSTGRAPHILE

Out of the box, PostGraphile supports rudimentary filtering on connections using a condition argument. This allows you to filter for specific values (e.g. username: "Alice" or category: ARTICLE). It's important when implementing filters to keep performance in mind, so PostGraphile gives you the ability to omit certain fields from the list of filters using the @omit filter smart comment.

POSTGRAPHILE

To enable the JWT functionality you must provide a --jwt-secret on the CLI (or jwtSecret to the library options). This will allow PostGraphile to authenticate incoming JWTs and set the granted claims on the database transaction. You should also supply a --default-role

POSTGRAPHILE

The first line FROM postgres:alpine indicates to build the Docker image based on the official PostgreSQL Docker image running in an Alpine Linux container. The second line COPY ./init/ /docker-entrypoint-initdb.d/ will copy the database initialization files (SQL) into the folder docker-entrypoint-initdb.d located in the Docker container. This folder is read by PostgreSQL upon database GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQLSPONSORNEWSLEARNPROFESSIONAL SUPPORTGRAPHILEGETTING STARTED A quick-start project for full-stack application development in React, Node.js, GraphQL and PostgreSQL. Graphile Starter includes the foundations of a modern web application, with a full user registration system, session management, optimised job queue, pre GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQL Rapidly develop lightning-fast powerful applications PostGraphile 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 modify your database.

POSTGRAPHILE

POSTGRAPHILE

Enabling with an Express app. When using PostGraphile as a library, you may enable Custom Subscriptions by passing the pluginHook with the @graphile/pg-pubsub plugin, setting subscriptions: true and adding your custom plugin.. We emulate part of the Express stack, so if you require sessions you can pass additional Connect/Express middlewares (sorry, we don't support Koa middlewares here at

POSTGRAPHILE

PostGraphile Realtime. Every application is different, and no more so than when it comes to their realtime requirements. Some applications are read-heavy, others write-heavy, and others are collaborative and need to put in effort to avoid conflicts between multiple people editing the same things at the same time (e.g. Google Docs).

POSTGRAPHILE

Deploying with Docker. PostGraphile has an official Docker image which is suitable to use if you don't need custom plugins and are deploying PostGraphile as standalone: Our Docker images are versioned: graphile/postgraphile:4 will give you the latest stable in the "v4.x.x" line (no alphas, betas, rcs); this is the recommended version

to use

POSTGRAPHILE

NOTE: this documentation applies to PostGraphile v4.1.0+ The graphile-utils module contains some helpers for extending your PostGraphile (or Graphile Engine) GraphQL schema without having to understand the complex plugin system.. The main one you'll care about to start with is makeExtendSchemaPlugin.. Using makeExtendSchemaPlugin you can write a plugin that will merge

POSTGRAPHILE

Out of the box, PostGraphile supports rudimentary filtering on connections using a condition argument. This allows you to filter for specific values (e.g. username: "Alice" or category: ARTICLE). It's important when implementing filters to keep performance in mind, so PostGraphile gives you the ability to omit certain fields from the list of filters using the @omit filter smart comment.

POSTGRAPHILE

To enable the JWT functionality you must provide a --jwt-secret on the CLI (or jwtSecret to the library options). This will allow PostGraphile to authenticate incoming JWTs and set the granted claims on the database transaction. You should also supply a --default-role

POSTGRAPHILE

The first line FROM postgres:alpine indicates to build the Docker image based on the official PostgreSQL Docker image running in an Alpine Linux container. The second line COPY ./init/ /docker-entrypoint-initdb.d/ will copy the database initialization files (SQL) into the folder docker-entrypoint-initdb.d located in the Docker container. This folder is read by PostgreSQL upon database

POSTGRAPHILE

PostGraphile (formerly PostGraphQL) builds a powerful, extensible and performant GraphQL API from a PostgreSQL schema in seconds; saving you weeks if not months of development time. If you already use PostgreSQL then you understand the value that a strongly typed and well defined schema can bring to application development; GraphQL is the GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQL Timely access to the Graphile team throughout the year. Our Support Plan gives your team access to the knowledge and experience of the Graphile team for any issues you have with PostGraphile and the Graphile suite. 🌟 The Support Plan includes 2 x 30 minute consultancy calls each month, where you can screenshare with Graphile's maintainer.

POSTGRAPHILE

NOTE: this documentation applies to PostGraphile v4.1.0+ The graphile-utils module contains some helpers for extending your PostGraphile (or Graphile Engine) GraphQL schema without having to understand the complex plugin system.. The main one you'll care about to start with is makeExtendSchemaPlugin.. Using makeExtendSchemaPlugin you can write a plugin that will merge

POSTGRAPHILE

Common Middleware Considerations. In a production app, you typically want to add a few common enhancements, e.g. Logging. Gzip or similar compression. Security protections. Rate limiting. Since there's already a lot of options and opinions in this space, and they're not directly related to the problem of serving GraphQL from your

PostgreSQL

POSTGRAPHILE

Now PostgreSQL is ready, you can enable live queries support in PostGraphile. First, install the plugin: yarn add @graphile/subscriptions-lds. Because of the power the replication interface gives, it's necessary to use a superuser or database owner account, so in addition to your normal connection string you must also pass an "owner" connection

POSTGRAPHILE

You can add root-level Query fields to your GraphQL schema using "Custom Queries". These are PostgreSQL functions, similar to computed columns, that can return scalars, records, lists or sets.Sets (denoted by RETURNS SETOF ) are exposed as connections.The arguments to these functions will be exposed via GraphQL - named arguments are preferred, if your arguments are not named we will

POSTGRAPHILE

An example of an open source PostGraphile server plugin is @graphile/operation-hooks: uses cli:flags:add:schema to add --operation-messages and --operation-messages-preflight CLI options. Other examples you may wish to check out include @graphile/persisted-operations and postgraphile-log

POSTGRAPHILE

Performance. On a Digital Ocean compute-optimised droplet with 8GB of RAM, running PostGraphile, PostgreSQL and the benchmarking software all through Docker, PostGraphile running in cluster mode over 4 vCPUs can handle 3250 requests per second for the following simple query: For a more complex 3-level query, it can handle about 1450 requests

POSTGRAPHILE

When a GraphQL field is expected to return a large list of database records, we typically implement a connection adhering to the Relay Cursor Connections Specification (with a few enhancements). This connection allows you to perform cursor-based pagination

POSTGRAPHILE

Globally Unique Object Identification ("nodeId" / "id") We implement the Relay Global Object Identification Specification , so any table that has a primary key will automatically have a unique nodeId field available for queries and mutations. This is commonly used as the cache key for your client library, e.g. with Apollo Client's

dataIdFromObject:

GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQLSPONSORNEWSLEARNPROFESSIONAL SUPPORTGRAPHILEGETTING STARTED A quick-start project for full-stack application development in React, Node.js, GraphQL and PostgreSQL. Graphile Starter includes the foundations of a modern web application, with a full user registration system, session management, optimised job queue, pre GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQL Rapidly develop lightning-fast powerful applications PostGraphile 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 modify your database.

POSTGRAPHILE

POSTGRAPHILE

Enabling with an Express app. When using PostGraphile as a library, you may enable Custom Subscriptions by passing the pluginHook with the @graphile/pg-pubsub plugin, setting subscriptions: true and adding your custom plugin.. We emulate part of the Express stack, so if you require sessions you can pass additional Connect/Express middlewares (sorry, we don't support Koa middlewares here at

POSTGRAPHILE

PostGraphile Realtime. Every application is different, and no more so than when it comes to their realtime requirements. Some applications are read-heavy, others write-heavy, and others are collaborative and need to put in effort to avoid conflicts between multiple people editing the same things at the same time (e.g. Google Docs).

POSTGRAPHILE

Deploying with Docker. PostGraphile has an official Docker image which is suitable to use if you don't need custom plugins and are deploying PostGraphile as standalone: Our Docker images are versioned: graphile/postgraphile:4 will give you the latest stable in the "v4.x.x" line (no alphas, betas, rcs); this is the recommended version

to use

POSTGRAPHILE

NOTE: this documentation applies to PostGraphile v4.1.0+ The graphile-utils module contains some helpers for extending your PostGraphile (or Graphile Engine) GraphQL schema without having to understand the complex plugin system.. The main one you'll care about to start with is makeExtendSchemaPlugin.. Using makeExtendSchemaPlugin you can write a plugin that will merge

POSTGRAPHILE

Out of the box, PostGraphile supports rudimentary filtering on connections using a condition argument. This allows you to filter for specific values (e.g. username: "Alice" or category: ARTICLE). It's important when implementing filters to keep performance in mind, so PostGraphile gives you the ability to omit certain fields from the list of filters using the @omit filter smart comment.

POSTGRAPHILE

To enable the JWT functionality you must provide a --jwt-secret on the CLI (or jwtSecret to the library options). This will allow PostGraphile to authenticate incoming JWTs and set the granted claims on the database transaction. You should also supply a --default-role

POSTGRAPHILE

The first line FROM postgres:alpine indicates to build the Docker image based on the official PostgreSQL Docker image running in an Alpine Linux container. The second line COPY ./init/ /docker-entrypoint-initdb.d/ will copy the database initialization files (SQL) into the folder docker-entrypoint-initdb.d located in the Docker container. This folder is read by PostgreSQL upon database GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQLSPONSORNEWSLEARNPROFESSIONAL SUPPORTGRAPHILEGETTING STARTED A quick-start project for full-stack application development in React, Node.js, GraphQL and PostgreSQL. Graphile Starter includes the foundations of a modern web application, with a full user registration system, session management, optimised job queue, pre GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQL Rapidly develop lightning-fast powerful applications PostGraphile 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 modify your database.

POSTGRAPHILE

POSTGRAPHILE

Enabling with an Express app. When using PostGraphile as a library, you may enable Custom Subscriptions by passing the pluginHook with the @graphile/pg-pubsub plugin, setting subscriptions: true and adding your custom plugin.. We emulate part of the Express stack, so if you require sessions you can pass additional Connect/Express middlewares (sorry, we don't support Koa middlewares here at

POSTGRAPHILE

PostGraphile Realtime. Every application is different, and no more so than when it comes to their realtime requirements. Some applications are read-heavy, others write-heavy, and others are collaborative and need to put in effort to avoid conflicts between multiple people editing the same things at the same time (e.g. Google Docs).

POSTGRAPHILE

Deploying with Docker. PostGraphile has an official Docker image which is suitable to use if you don't need custom plugins and are deploying PostGraphile as standalone: Our Docker images are versioned: graphile/postgraphile:4 will give you the latest stable in the "v4.x.x" line (no alphas, betas, rcs); this is the recommended version

to use

POSTGRAPHILE

NOTE: this documentation applies to PostGraphile v4.1.0+ The graphile-utils module contains some helpers for extending your PostGraphile (or Graphile Engine) GraphQL schema without having to understand the complex plugin system.. The main one you'll care about to start with is makeExtendSchemaPlugin.. Using makeExtendSchemaPlugin you can write a plugin that will merge

POSTGRAPHILE

Out of the box, PostGraphile supports rudimentary filtering on connections using a condition argument. This allows you to filter for specific values (e.g. username: "Alice" or category: ARTICLE). It's important when implementing filters to keep performance in mind, so PostGraphile gives you the ability to omit certain fields from the list of filters using the @omit filter smart comment.

POSTGRAPHILE

To enable the JWT functionality you must provide a --jwt-secret on the CLI (or jwtSecret to the library options). This will allow PostGraphile to authenticate incoming JWTs and set the granted claims on the database transaction. You should also supply a --default-role

POSTGRAPHILE

The first line FROM postgres:alpine indicates to build the Docker image based on the official PostgreSQL Docker image running in an Alpine Linux container. The second line COPY ./init/ /docker-entrypoint-initdb.d/ will copy the database initialization files (SQL) into the folder docker-entrypoint-initdb.d located in the Docker container. This folder is read by PostgreSQL upon database

POSTGRAPHILE

PostGraphile (formerly PostGraphQL) builds a powerful, extensible and performant GraphQL API from a PostgreSQL schema in seconds; saving you weeks if not months of development time. If you already use PostgreSQL then you understand the value that a strongly typed and well defined schema can bring to application development; GraphQL is the GRAPHILE | POWERFUL, EXTENSIBLE AND PERFORMANT GRAPHQL Timely access to the Graphile team throughout the year. Our Support Plan gives your team access to the knowledge and experience of the Graphile team for any issues you have with PostGraphile and the Graphile suite. 🌟 The Support Plan includes 2 x 30 minute consultancy calls each month, where you can screenshare with Graphile's maintainer.

POSTGRAPHILE

NOTE: this documentation applies to PostGraphile v4.1.0+ The graphile-utils module contains some helpers for extending your PostGraphile (or Graphile Engine) GraphQL schema without having to understand the complex plugin system.. The main one you'll care about to start with is makeExtendSchemaPlugin.. Using makeExtendSchemaPlugin you can write a plugin that will merge

POSTGRAPHILE

Common Middleware Considerations. In a production app, you typically want to add a few common enhancements, e.g. Logging. Gzip or similar compression. Security protections. Rate limiting. Since there's already a lot of options and opinions in this space, and they're not directly related to the problem of serving GraphQL from your

PostgreSQL

POSTGRAPHILE

Now PostgreSQL is ready, you can enable live queries support in PostGraphile. First, install the plugin: yarn add @graphile/subscriptions-lds. Because of the power the replication interface gives, it's necessary to use a superuser or database owner account, so in addition to your normal connection string you must also pass an "owner" connection

POSTGRAPHILE

You can add root-level Query fields to your GraphQL schema using "Custom Queries". These are PostgreSQL functions, similar to computed columns, that can return scalars, records, lists or sets.Sets (denoted by RETURNS SETOF ) are exposed as connections.The arguments to these functions will be exposed via GraphQL - named arguments are preferred, if your arguments are not named we will

POSTGRAPHILE

An example of an open source PostGraphile server plugin is @graphile/operation-hooks: uses cli:flags:add:schema to add --operation-messages and --operation-messages-preflight CLI options. Other examples you may wish to check out include @graphile/persisted-operations and postgraphile-log

POSTGRAPHILE

Performance. On a Digital Ocean compute-optimised droplet with 8GB of RAM, running PostGraphile, PostgreSQL and the benchmarking software all through Docker, PostGraphile running in cluster mode over 4 vCPUs can handle 3250 requests per second for the following simple query: For a more complex 3-level query, it can handle about 1450 requests

POSTGRAPHILE

When a GraphQL field is expected to return a large list of database records, we typically implement a connection adhering to the Relay Cursor Connections Specification (with a few enhancements). This connection allows you to perform cursor-based pagination

POSTGRAPHILE

Globally Unique Object Identification ("nodeId" / "id") We implement the Relay Global Object Identification Specification , so any table that has a primary key will automatically have a unique nodeId field available for queries and mutations. This is commonly used as the cache key for your client library, e.g. with Apollo Client's

dataIdFromObject:

* Home

* Sponsor

* News

* Chat

* Learn

*

* Professional Support

* Github

EXTENSIBLE HIGH-PERFORMANCE AUTOMATIC GRAPHQL API FOR POSTGRESQL

Documentation

Learn More

GRAPHILE STARTER

A QUICK-START PROJECT FOR FULL-STACK APPLICATION DEVELOPMENT IN REACT, NODE.JS, GRAPHQL AND POSTGRESQL Graphile Starter includes the foundations of a modern web application, with a full user registration system, session management, optimised job queue, pre-configured tooling, tests and much more.

Learn more

DATABASE TOOLS

GRAPHILE WORKER

HIGH PERFORMANCE NODE.JS/POSTGRESQL JOB QUEUE Run jobs (e.g. sending emails, generating PDFs, …) "in the background" so that your HTTP response code is not held up. Starts jobs almost instantly (2ms latency).Used with any PostgreSQL-backed

application.

Documentation

GRAPHILE MIGRATEALPHA OPINIONATED SQL-POWERED PRODUCTIVE ROLL-FORWARD MIGRATION TOOL FOR

POSTGRESQL.

Experimental, being developed in the open. Focusses on fast iteration

speed.

Documentation

CROWD-FUNDED OPEN-SOURCE SOFTWARE We're extremely grateful to our sponsors, for helping to fund ongoing development on PostGraphile, Graphile Engine, Graphile Worker and

Graphile Migrate.

THANK YOU!

Learn more about sponsors and sponsorship PROFESSIONAL SUPPORT GUARANTEED RESPONSE TO CRITICAL ISSUES IN UNDER 1 BUSINESS DAY Give your team access to the knowledge and experience of PostGraphile's maintainer for any issues you face whilst using

Graphile tools.

Learn more

GRAPHILE ENGINE

BUILD HIGH-PERFORMANCE EASILY-EXTENSIBLE GRAPHQL SCHEMAS BY COMBINING

PLUGINS

Graphile Engine is the database-independent heart of PostGraphile — it's an extremely powerful way to build extensible automatic GraphQL APIs over any data source.

Documentation

Learn more

POSTGRAPHILE

* Documentation

* About

* Community Plugins

* __ Changelog

GRAPHILE ENGINE

* Documentation

* About

* Plugins

RESOURCES

* __ News

* __ GitHub

* __ Chat (discord)

* __ Twitter

* __ 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 2020. Design and logos copyright © Benjie Gillam and Jof Arnold 2020. Corrections and contributions to this website are gratefully received via its GitHub repository

.

PostGraphile was originally authored as PostGraphQL by

Caleb Meredith .