https://github.com/supabase/pg_graphql

GraphQL support for PostgreSQL
https://github.com/supabase/pg_graphql

api graphql graphql-server postgres postgresql sql

Last synced: about 2 months ago
JSON representation

GraphQL support for PostgreSQL

• Host: GitHub
• URL: https://github.com/supabase/pg_graphql
• Owner: supabase
• License: apache-2.0
• Created: 2021-08-05T20:09:12.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2024-04-11T12:55:28.000Z (5 months ago)
• Last Synced: 2024-04-13T21:54:15.788Z (5 months ago)
• Topics: api, graphql, graphql-server, postgres, postgresql, sql
• Language: Rust
• Homepage: https://supabase.github.io/pg_graphql
• Size: 9.42 MB
• Stars: 2,753
• Watchers: 35
• Forks: 87
• Open Issues: 35
• Metadata Files:
  • Readme: README.md
  • Contributing: docs/contributing.md
  • License: LICENSE
  • Security: docs/security.md

Awesome Lists containing this project

• awesome-repositories - supabase/pg_graphql - GraphQL support for PostgreSQL (Rust)
• jimsghstars - supabase/pg_graphql - GraphQL support for PostgreSQL (Rust)

README

        
# `pg_graphql`











---

**Documentation**: https://supabase.github.io/pg_graphql

**Source Code**: https://github.com/supabase/pg_graphql

---

`pg_graphql` adds GraphQL support to your PostgreSQL database.

- [x] __Performant__

- [x] __Consistent__

- [x] __Serverless__

- [x] __Open Source__

### Overview

`pg_graphql` reflects a GraphQL schema from the existing SQL schema.

The extension keeps schema translation and query resolution neatly contained on your database server. This enables any programming language that can connect to PostgreSQL to query the database via GraphQL with no additional servers, processes, or libraries.

### TL;DR

The SQL schema

```sql

create table account(

    id serial primary key,

    email varchar(255) not null,

    created_at timestamp not null,

    updated_at timestamp not null

);

create table blog(

    id serial primary key,

    owner_id integer not null references account(id),

    name varchar(255) not null,

    description varchar(255),

    created_at timestamp not null,

    updated_at timestamp not null

);

create type blog_post_status as enum ('PENDING', 'RELEASED');

create table blog_post(

    id uuid not null default uuid_generate_v4() primary key,

    blog_id integer not null references blog(id),

    title varchar(255) not null,

    body varchar(10000),

    status blog_post_status not null,

    created_at timestamp not null,

    updated_at timestamp not null

);

```

Translates into a GraphQL schema displayed below.

Each table receives an entrypoint in the top level `Query` type that is a pageable collection with relationships defined by its foreign keys. Tables similarly recieve entrypoints in the `Mutation` schema that enable bulk operations for insert, update, and delete.

![GraphiQL](./docs/assets/quickstart_graphiql.png)