Skip to content

docs: some small updates after beta 39+ #2566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Conversation

jemgillam
Copy link
Contributor

@jemgillam jemgillam commented Jun 10, 2025

Description

Slowly tweaking some documentation to align with changes made in grafast beta 39 onwards

ref https://github.com/graphile/crystal/blob/main/postgraphile/postgraphile/CHANGELOG.md#500-beta39

  • "modifier step" now becomes "Modifier class"
  • dropping the "Step" suffix as needed
  • "wherePlan" and "havingPlan" have been removed from pgUnionAll and pgSelect
  • I've assumed fieldArgs.get becomes fieldArgs.getRaw in our simple examples
  • $step.placeholder($step, codec) becomes step.sqlValueWithCodec(value, codec)

@github-project-automation github-project-automation bot moved this to 🌳 Triage in V5.0.0 Jun 10, 2025
Copy link

changeset-bot bot commented Jun 10, 2025

⚠️ No Changeset found

Latest commit: f63fc88

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@jemgillam
Copy link
Contributor Author

This is good to be reviewed and merged

@jemgillam jemgillam marked this pull request as ready for review June 10, 2025 14:01
Copy link
Member

@benjie benjie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks!

@github-project-automation github-project-automation bot moved this from 🌳 Triage to 🌱 In Progress in V5.0.0 Jun 10, 2025
}
}
}
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jemgillam I'm not sure this belongs here.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It was the following, I assume you thought it was an easy self-explanatory example

const $users = usersResource.find();
const tbl = $users.alias;

const $username = fieldArgs.getRaw("username");
const frag = $users.placeholder($username, TYPES.citext);

$users.where(sql`${tbl}.username = ${frag}`);

Remove the example if it's too complicated?

benjie
benjie previously approved these changes Jun 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: 🌱 In Progress
Development

Successfully merging this pull request may close these issues.

2 participants