# graphile-query
**`graphile-query`** provides utilities to execute GraphQL queries against a PostGraphile-generated schema using PostgreSQL connection pooling and contextual role-based settings.
It includes two main classes:
* `GraphileQuery`: A flexible query runner that supports `pgSettings`, role-based access control, and custom request context.
* `GraphileQuerySimple`: A minimal wrapper for GraphQL execution without advanced role or settings logic.
## π Installation
```bash
npm install graphile-query
```
## β¨ Features
* Built-in support for PostGraphile context and role-based `pgSettings`
* Works with pre-built PostGraphile schemas
* Supports raw string queries or parsed `DocumentNode`s
* Integrates with PostgreSQL via `pg.Pool`
## π¦ Usage
Use as a particular role, skipping any auth logic:
```ts
const results = await client.query({
role: 'postgres',
query,
variables
});
```
Or pass a request object to be evaluated based on logic:
```ts
const results = await client.query({
req: { something: { special: 'e90829ef-1da4-448d-3e44-b3d275702b86' } },
query: MyGraphQLQuery,
variables
});
```
### 1. Create a GraphQL Schema
```ts
import { Pool } from 'pg';
import { getSchema } from 'graphile-query';
const pool = new Pool();
const schema = await getSchema(pool, {
schema: ['app_public'],
pgSettings: req => ({ 'myapp.user_id': req.user?.id }),
});
```
### 2. Execute Queries with `GraphileQuery`
```ts
import { GraphileQuery } from 'graphile-query';
const client = new GraphileQuery({ schema, pool, settings });
const result = await client.query({
query: `
query GetUsers {
allUsers {
nodes {
id
username
}
}
}
`,
role: 'authenticated', // optional
req: { user: { id: 123 } }, // optional
});
```
### 3. Use `GraphileQuerySimple` for Lightweight Execution
```ts
import { GraphileQuerySimple } from 'graphile-query';
const client = new GraphileQuerySimple({ schema, pool });
const result = await client.query(`
query {
currentUser {
id
email
}
}
`);
```
## π API
### `getSchema(pool, settings)`
* Builds a PostGraphile schema using the given database pool and settings.
### `GraphileQuery`
* `constructor({ schema, pool, settings })`
* `query({ query, variables?, role?, req? })`
Supports full context, roles, and settings for advanced scenarios.
### `GraphileQuerySimple`
* `constructor({ schema, pool })`
* `query(query, variables?)`
Lightweight version with no role or settings support.
---
## Education and Tutorials
1. π [Quickstart: Getting Up and Running](https://constructive.io/learn/quickstart)
Get started with modular databases in minutes. Install prerequisites and deploy your first module.
2. π¦ [Modular PostgreSQL Development with Database Packages](https://constructive.io/learn/modular-postgres)
Learn to organize PostgreSQL projects with pgpm workspaces and reusable database modules.
3. βοΈ [Authoring Database Changes](https://constructive.io/learn/authoring-database-changes)
Master the workflow for adding, organizing, and managing database changes with pgpm.
4. π§ͺ [End-to-End PostgreSQL Testing with TypeScript](https://constructive.io/learn/e2e-postgres-testing)
Master end-to-end PostgreSQL testing with ephemeral databases, RLS testing, and CI/CD automation.
5. β‘ [Supabase Testing](https://constructive.io/learn/supabase)
Use TypeScript-first tools to test Supabase projects with realistic RLS, policies, and auth contexts.
6. π§ [Drizzle ORM Testing](https://constructive.io/learn/drizzle-testing)
Run full-stack tests with Drizzle ORM, including database setup, teardown, and RLS enforcement.
7. π§ [Troubleshooting](https://constructive.io/learn/troubleshooting)
Common issues and solutions for pgpm, PostgreSQL, and testing.
## Related Constructive Tooling
### π¦ Package Management
* [pgpm](https://github.com/constructive-io/constructive/tree/main/pgpm/pgpm): **π₯οΈ PostgreSQL Package Manager** for modular Postgres development. Works with database workspaces, scaffolding, migrations, seeding, and installing database packages.
### π§ͺ Testing
* [pgsql-test](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-test): **π Isolated testing environments** with per-test transaction rollbacksβideal for integration tests, complex migrations, and RLS simulation.
* [pgsql-seed](https://github.com/constructive-io/constructive/tree/main/postgres/pgsql-seed): **π± PostgreSQL seeding utilities** for CSV, JSON, SQL data loading, and pgpm deployment.
* [supabase-test](https://github.com/constructive-io/constructive/tree/main/postgres/supabase-test): **π§ͺ Supabase-native test harness** preconfigured for the local Supabase stackβper-test rollbacks, JWT/role context helpers, and CI/GitHub Actions ready.
* [graphile-test](https://github.com/constructive-io/constructive/tree/main/graphile/graphile-test): **π Authentication mocking** for Graphile-focused test helpers and emulating row-level security contexts.
* [pg-query-context](https://github.com/constructive-io/constructive/tree/main/postgres/pg-query-context): **π Session context injection** to add session-local context (e.g., `SET LOCAL`) into queriesβideal for setting `role`, `jwt.claims`, and other session settings.
### π§ Parsing & AST
* [pgsql-parser](https://www.npmjs.com/package/pgsql-parser): **π SQL conversion engine** that interprets and converts PostgreSQL syntax.
* [libpg-query-node](https://www.npmjs.com/package/libpg-query): **π Node.js bindings** for `libpg_query`, converting SQL into parse trees.
* [pg-proto-parser](https://www.npmjs.com/package/pg-proto-parser): **π¦ Protobuf parser** for parsing PostgreSQL Protocol Buffers definitions to generate TypeScript interfaces, utility functions, and JSON mappings for enums.
* [@pgsql/enums](https://www.npmjs.com/package/@pgsql/enums): **π·οΈ TypeScript enums** for PostgreSQL AST for safe and ergonomic parsing logic.
* [@pgsql/types](https://www.npmjs.com/package/@pgsql/types): **π Type definitions** for PostgreSQL AST nodes in TypeScript.
* [@pgsql/utils](https://www.npmjs.com/package/@pgsql/utils): **π οΈ AST utilities** for constructing and transforming PostgreSQL syntax trees.
### π Documentation & Skills
* [constructive-skills](https://github.com/constructive-io/constructive-skills): **π Platform documentation and AI agent skills** β feature catalog, blueprint reference, SDK guides (i18n, billing, limits, events, uploads, security, entities, search, AI), and deployment guides.
Install skills for AI coding agents:
```bash
# All platform skills (security, blueprints, codegen, billing, etc.)
npx skills add constructive-io/constructive-skills
# Individual repo skills (pgpm, testing, CLI, search, etc.)
npx skills add https://github.com/constructive-io/constructive --skill pgpm
npx skills add https://github.com/constructive-io/constructive --skill constructive-testing
```
## Credits
**π Built by the [Constructive](https://constructive.io) team β creators of modular Postgres tooling for secure, composable backends. If you like our work, contribute on [GitHub](https://github.com/constructive-io).**
## Disclaimer
AS DESCRIBED IN THE LICENSES, THE SOFTWARE IS PROVIDED "AS IS", AT YOUR OWN RISK, AND WITHOUT WARRANTIES OF ANY KIND.
No developer or entity involved in creating this software will be liable for any claims or damages whatsoever associated with your use, inability to use, or your interaction with other users of the code, including any direct, indirect, incidental, special, exemplary, punitive or consequential damages, or loss of profits, cryptocurrencies, tokens, or anything else of value.