PostGraphile

Graphile's Crystal Monorepo; home to Grafast, PostGraphile, pg-introspectio...

GraphQL SQL

graphile/crystal graphile.org/postgraphile

README

🔮 Graphile's Crystal Monorepo

At Graphile we love GraphQL so much we named ourself for our love of it! This

repository houses many of the Graphile packages that relate to GraphQL (or

relate to the packages that relate to GraphQL, or relate to those package...);

the two headline projects are *Grafast* and PostGraphile but there's

many other packages, a fair few of which can be used independently - see below

for more details.

[Grafast][grafast]: A cutting-edge planning and execution engine for

GraphQL.js ─ use this as a drop-in replacement for the execute method from

GraphQL.js and by moving from traditional resolvers to Grafast "plan

resolvers" you'll be able to leverage the declarative nature of GraphQL requests

to execute your business logic in the most efficient way, leading to reduced

server load and happier customers. Use this if you're building your own GraphQL

schemas and want the best performance and efficiency without having to put much

extra effort in.

[PostGraphile][postgraphile]: An incredibly low-effort way to build a well

structured and high-performance GraphQL API backed primarily by a PostgreSQL

database. Our main focusses are performance, automatic best-practices and

customisability/extensibility. Use this if you have a PostgreSQL database and

you want to use it as the "source of truth" for an auto-generated GraphQL API

(which you can still make significant changes to). NOTE: thanks to

[graphile-export][] you can also use this as a starting point for an API that

you then manage yourself.

➡️
---

Project summaries

Here's a rough breakdown of the main packages:

- [grafast][] - standalone cutting-edge planning and execution engine for

GraphQL; see above for full description.

- [@dataplan/pg][] - plan classes for interacting with PostgreSQL

- [@dataplan/json][] - plan classes for encoding/decoding JSON

- [graphile-export][] - a package that can (under the right circumstances)

export an in-memory dynamically-constructed GraphQL schema to raw JavaScript

source code that can be imported and executed

- [eslint-plugin-graphile-export][] - an ESLint plugin that helps you

write code compatible with graphile-export

- [jest-serializer-graphql-schema][] - a simple Jest serializer that

understands GraphQL schemas and thus does not fill snapshots with \"\"\"

etc.

- [graphile-config][] - a module that handles the plugins, presets and

configuration files for Graphile software - a universal configuration layer.

- [graphile-build][] - a system for building a GraphQL.js schema from

"plugins", particularly useful for auto-generated GraphQL APIs (e.g.

PostGraphile uses this) but also useful for hand-rolled schemas that have a

lot of modular but widely-used concerns such as connections, naming, etc.

- [graphile-build-pg][] - plugins for graphile-build that understand

@dataplan/pg (i.e. PostgreSQL) services and can generate types, relations,

mutations, etc for these database resources.

- [@graphile/lru][] - an _obsessively_ performant least-recently-used cache

(possibly the fastest general purpose LRU cache in Node.js) with a

ridiculously tiny feature set; you almost certainly want @isaacs' lru-cache

instead of this.

- [pg-sql2][] - a library for building highly dynamic SQL-injection-proof

PostgreSQL queries using tagged template literals.

- [pg-introspection][] - a strongly typed introspection library for

PostgreSQL, generated from the PostgreSQL documentation to provide up-to-date

details of each introspection field.

- [postgraphile][] - pulls most of the above technologies together; see

above for full description.

Crowd-funded open-source software

To help us develop this software sustainably, we ask all individuals and

businesses that use it to help support its ongoing maintenance and development

via sponsorship.

Click here to find out more about sponsors and sponsorship.

And please give some love to our featured sponsors 🤩:

Why the "crystal" monorepo?

Originally what is now Grafast (and was previously DataPlanner) was known by

the codename "Graphile Crystal." This lead us to use the 🔮 emoji to represent

the project in secret before we announced it publicly, as a codeword for those

in the know. Now that Grafast is the name for our planning and execution

engine and we needed a name for the monorepo that wasn't too GraphQL specific

(since there are things in here that aren't strictly related to GraphQL) and we

figured that calling it the Crystal monorepo would honour our original nickname

for the project. Rumours that the name was inspired by the maintainers'

crystal wedding anniversary

are greatly exaggerated.