graphile / graphile/graphile.github.io

Make pgSettings clearer

Open
#54 0 comments 0 reactions 0 assignees View on GitHub
enhancement help wanted quick
Dominant language
SCSS
Stars
27
Forks
126
PR merge metrics
No merged PRs in 30d

Description

e.g. demonstrate settings you want to be period-less (e.g. `role`, `statement_timeout` which affect PostgreSQL directly) and settings you want to have periods in (e.g. `jwt.claims.user_id` etc which don't affect PostgreSQL directly but your own application code can use).

This page: https://www.graphile.org/postgraphile/usage-library/#pgsettings-function

This file: https://github.com/graphile/graphile.github.io/blob/develop/src/pages/postgraphile/usage-library.md

Contributor guide

No contributing guide indexed for this repository

Research direction

Open src/pages/postgraphile/usage-library.md and read the pgSettings function section. Add examples showing period-less settings such as role and statement_timeout, alongside dotted settings such as jwt.claims.user_id. Done means the page clearly distinguishes settings passed to PostgreSQL from settings intended for application code.

Written by the indexing model from the issue text.

Assessment

Tech stack
postgresql
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.