pg_graphql: GraphQL for PostgreSQL

pg_graphql is PostgreSQL extension for interacting with the database using GraphQL instead of SQL.

The extension reflects a GraphQL schema from the existing SQL schema and exposes it through a SQL function, graphql.resolve(...). This enables any programming language that can connect to PostgreSQL to query the database via GraphQL with no additional servers, processes, or libraries.

The pg_graphql resolve method is designed to interop with PostgREST, the tool that underpins the Supabase API, such that the graphql.resolve function can be called via RPC to safely and performantly expose the GraphQL API over HTTP/S.

For more information about how the SQL schema is reflected into a GraphQL schema, see the pg_graphql API docs.

Enable the extension#

Go to the Database page in the Dashboard.
Click on Extensions in the sidebar.
Search for "pg_graphql" and enable the extension.

Usage#

Given a table

create table "Blog"(
  id serial primary key,
  name text not null,
  description text,
);
insert into "Blog"(name)
values ('My Blog');

The reflected GraphQL schema can be queries immediately as

select
  graphql.resolve($$
    {
      blogCollection(first: 1) {
        edges {
          node {
            id,
            name
          }
        }
      }
    }
  $$);

returning the JSON

{
  "data": {
    "blogCollection": {
      "edges": [
        {
          "node": {
            "id": 1
            "name": "My Blog"
          }
        }
      ]
    }
  }
}

Note that pg_graphql fully supports schema introspection so you can connect any GraphQL IDE or schema inspection tool to see the full set of fields and arguments available in the API.

API#

graphql.resolve: A SQL function for executing GraphQL queries.

Resources#

Official pg_graphql documentation

Edit this page on GitHub