Skip to content
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

postgraphile website: links fixes #2362

Merged
merged 6 commits into from
Feb 19, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions postgraphile/website/news/2023-04-26-alpha-release.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Gra*fast* even generates a plan diagram showing what steps are necessary to exec

<figure>

[![A Grafast plan diagram for an AllPosts query](../static/img/news/2023-04-26-mermaid-diagram.png)](../static/img/news/2023-04-26-mermaid-diagram.png)
[![A Grafast plan diagram for an AllPosts query](/img/news/2023-04-26-mermaid-diagram.png)](/img/news/2023-04-26-mermaid-diagram.png)

<figcaption>

Expand All @@ -46,11 +46,11 @@ Thanks to these advanced planning capabilities, PostGraphile is now able to gene

<figure>

[![A GraphQL query for AllPosts](../static/img/news/2023-04-26-v4-v5-comparison.png)](../static/img/news/2023-04-26-v4-v5-comparison.png)
[![A GraphQL query for AllPosts](/img/news/2023-04-26-v4-v5-comparison.png)](/img/news/2023-04-26-v4-v5-comparison.png)

<figcaption>

An example of the vast improvement in the autogenerated SQL queries in Version 5 as compared to Version 4 for the same [GraphQL “AllPosts” query](../static/img/news/2023-04-26-comparison-query-ruru.png). Generated SQL is now easier to understand and debug, and the V5 SQL query shown is twice as fast as the V4 SQL query.
An example of the vast improvement in the autogenerated SQL queries in Version 5 as compared to Version 4 for the same [GraphQL “AllPosts” query](/img/news/2023-04-26-comparison-query-ruru.png). Generated SQL is now easier to understand and debug, and the V5 SQL query shown is twice as fast as the V4 SQL query.

</figcaption>
</figure>
Expand Down
2 changes: 1 addition & 1 deletion postgraphile/website/postgraphile/community-plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ directed to the plugin authors, not to this project. This page is maintained by
the community and is not an endorsement by the project.

If you have written a PostGraphile plugin (or have found one that is not listed
here), then please feel free to add it, you can use the ["edit this page"](https://github.com/graphile/crystal/tree/main/postgraphile/website/postgraphile/community-plugins.md) link
here), then please feel free to add it, you can use the edit this page link below
to do so.

See [the configuration docs](./config) for how to load
Expand Down
4 changes: 2 additions & 2 deletions postgraphile/website/postgraphile/customization-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,11 +319,11 @@ In general it’s better to prevent a field being added in the first place than
to remove it after it has been added to the schema. To avoid a field being
added to the schema, either remove the corresponding object from your database,
revoke the permissions granted on it, or add a `@behavior -*` [smart
tag](smart-tags). (Note you can also remove specific behaviors (e.g. `@behavior
tag](./smart-tags). (Note you can also remove specific behaviors (e.g. `@behavior
-update`).)

Should this not work, you can also [explicitly delete fields from your
schema](./extending-raw/#removing-things-from-the-schema).
schema](./extending-raw#removing-things-from-the-schema).

### Adding documentation

Expand Down
2 changes: 1 addition & 1 deletion postgraphile/website/postgraphile/extending.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: GraphQL Schema Plugins
---

PostGraphile’s schema generator is built from a number of
[graphile-build plugins](https://build.graphile.org/graphile-build/plugins/). You can
[graphile-build plugins](https://build.graphile.org/graphile-build/5/plugins). You can
write your own plugins — either using the helpers available in `graphile-utils`,
or using the raw plugin interface available from Graphile Build.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ never use that type, that will likely not cause a schema validation error. If
you use a directive that does not exist (or pass the wrong arguments to a
directive), that’s also unlikely to error. The SDL is just used as a convenient
syntax, it is converted under the hood into [schema
hooks](https://build.graphile.org/graphile-build/hooks) as if you had written
hooks](https://build.graphile.org/graphile-build/5/hooks) as if you had written
a Graphile Build plugin by hand.

:::
Expand Down
2 changes: 1 addition & 1 deletion postgraphile/website/postgraphile/performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ on Medium.
### How is it so fast?

We leverage graphile-build's
[look-ahead](https://build.graphile.org/graphile-build/look-ahead) features when
[look-ahead](https://build.graphile.org/graphile-build/4/look-ahead) features when
resolving a GraphQL request so that a single root level query, no matter how
nested, is compiled into just one SQL query. PostgreSQL has an excellent query
planner which optimises and executes this query for us, avoiding the need for
Expand Down
2 changes: 1 addition & 1 deletion postgraphile/website/postgraphile/registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Registry

As you know: PostGraphile builds a GraphQL schema for you by introspecting your
database. What you may not know is that it does this through multiple phases
using the [Graphile Build](https://build.graphile.org/graphile-build/) library.
using the [Graphile Build](https://build.graphile.org/graphile-build/5) library.
In the `gather` phase, PostGraphile introspects your database, and builds up a
"registry" of all of the "codecs", "resources" and "relations" that it finds.
Then during the `schema` phase, it inspects this registry and uses it to decide
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ the community and is not an endorsement by the project.

If you have written a PostGraphile plugin (or have found one that is not listed
here), then please feel free to add it, you can
[edit this page in GitHub](https://github.com/graphile/crystal/tree/main/postgraphile/website/versioned_docs/version-4.x/community-plugins.md).
use the “edit this page” link below to do so.

See the [CLI](./usage-cli) or [library](./usage-library) docs for how to load
plugins.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,11 +151,11 @@ Previously we used `GraphQLObjectType:fields` to add a field, as that
manipulates the list of fields. This time we are manipulating an individual
field, so we will use the `GraphQLObjectType:fields:field` hook. This makes our
intent clear, and also grants us access to
[the `addArgDataGenerator`](https://build.graphile.org/graphile-build/look-ahead#when-processing-arguments-addargdatagenerator)
[the `addArgDataGenerator`](https://build.graphile.org/graphile-build/4/look-ahead#when-processing-arguments-addargdatagenerator)
function which we need to request the record id. The following example also uses
an instance of [`queryBuilder.`](./make-extend-schema-plugin/#querybuilder)
(Read more about the different hooks
[in the Graphile Engine docs](https://build.graphile.org/graphile-build/all-hooks).)
[in the Graphile Engine docs](https://build.graphile.org/graphile-build/4/all-hooks).)

```js
function performAnotherTask(linkId) {
Expand Down
2 changes: 1 addition & 1 deletion postgraphile/website/versioned_docs/version-4/extending.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: Schema Plugins
# GraphQL Schema Plugins

PostGraphile's schema generator is built from a number of
[Graphile Engine plugins](https://build.graphile.org/graphile-build/plugins). You can
[Graphile Engine plugins](https://build.graphile.org/graphile-build/4/plugins). You can
write your own plugins - either using the helpers available in `graphile-utils`,
or using the raw plugin interface available from Graphile Engine.

Expand Down
4 changes: 2 additions & 2 deletions postgraphile/website/versioned_docs/version-4/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ By combining powerful features such as PostgreSQL's
and
[row-level security policies](https://www.postgresql.org/docs/current/static/ddl-rowsecurity.html)
with Graphile Engine's advanced
[GraphQL look-ahead](https://build.graphile.org/graphile-build/look-ahead) and
[plugin expansion](https://build.graphile.org/graphile-build/plugins) technologies,
[GraphQL look-ahead](https://build.graphile.org/graphile-build/4/look-ahead) and
[plugin expansion](https://build.graphile.org/graphile-build/4/plugins) technologies,
PostGraphile ensures your generated schema is secure, performant and extensible.

Some of the features we offer:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ on Medium.
### How is it so fast?

We leverage graphile-build's
[look-ahead](https://build.graphile.org/graphile-build/look-ahead) features when
[look-ahead](https://build.graphile.org/graphile-build/4/look-ahead) features when
resolving a GraphQL request so that a single root level query, no matter how
nested, is compiled into just one SQL query. PostgreSQL has an excellent query
planner which optimises and executes this query for us, avoiding the need for
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ automatically converts between these for you.
generated twice and cause issues.

There are other potential conflicts too, if you discover more conflicts then
please consider using the "Edit this page" link above to suggest some changes!
please consider using the "Edit this page" link below to suggest some changes!

### Non-unique table names

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -406,17 +406,17 @@ for <tt>postgraphile@<span></span>4.12.3</tt>.
the client. Optionally can send down custom responses. If you use this then
`showErrorStack` and `extendedError` may have no effect.
- `appendPlugins`: An array of
[Graphile Engine](https://build.graphile.org/graphile-build/plugins) schema
[Graphile Engine](https://build.graphile.org/graphile-build/4/plugins) schema
plugins to load after the default plugins.
- `prependPlugins`: An array of
[Graphile Engine](https://build.graphile.org/graphile-build/plugins) schema
[Graphile Engine](https://build.graphile.org/graphile-build/4/plugins) schema
plugins to load before the default plugins (you probably don't want this).
- `replaceAllPlugins`: The full array of
[Graphile Engine](https://build.graphile.org/graphile-build/plugins) schema
[Graphile Engine](https://build.graphile.org/graphile-build/4/plugins) schema
plugins to use for schema generation (you almost definitely don't want
this!).
- `skipPlugins`: An array of
[Graphile Engine](https://build.graphile.org/graphile-build/plugins) schema
[Graphile Engine](https://build.graphile.org/graphile-build/4/plugins) schema
plugins to skip.
- `readCache`: A file path string or an object. Reads cached values to improve
startup time (you may want to do this in production).
Expand Down
8 changes: 4 additions & 4 deletions postgraphile/website/versioned_docs/version-4/usage-schema.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,17 +141,17 @@ for <tt>postgraphile@<span></span>4.12.3</tt>.
applications don't need them to be exposed to the end user. You can use this
flag to include them in the generated schema (not recommended).
- `appendPlugins`: An array of
[Graphile Engine](https://build.graphile.org/graphile-build/plugins) schema
[Graphile Engine](https://build.graphile.org/graphile-build/4/plugins) schema
plugins to load after the default plugins.
- `prependPlugins`: An array of
[Graphile Engine](https://build.graphile.org/graphile-build/plugins) schema
[Graphile Engine](https://build.graphile.org/graphile-build/4/plugins) schema
plugins to load before the default plugins (you probably don't want this).
- `replaceAllPlugins`: The full array of
[Graphile Engine](https://build.graphile.org/graphile-build/plugins) schema
[Graphile Engine](https://build.graphile.org/graphile-build/4/plugins) schema
plugins to use for schema generation (you almost definitely don't want
this!).
- `skipPlugins`: An array of
[Graphile Engine](https://build.graphile.org/graphile-build/plugins) schema
[Graphile Engine](https://build.graphile.org/graphile-build/4/plugins) schema
plugins to skip.
- `readCache`: A file path string or an object. Reads cached values to improve
startup time (you may want to do this in production).
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ directed to the plugin authors, not to this project. This page is maintained by
the community and is not an endorsement by the project.

If you have written a PostGraphile plugin (or have found one that is not listed
here), then please feel free to add it, you can use the "edit this page" link
here), then please feel free to add it, you can use the edit this page link below
to do so.

See [the configuration docs](./config) for how to load
Expand Down
2 changes: 1 addition & 1 deletion postgraphile/website/versioned_docs/version-5/extending.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ title: GraphQL Schema Plugins
---

PostGraphile's schema generator is built from a number of
[graphile-build plugins](https://build.graphile.org/graphile-build/plugins/). You can
[graphile-build plugins](https://build.graphile.org/graphile-build/5/plugins). You can
write your own plugins - either using the helpers available in `graphile-utils`,
or using the raw plugin interface available from Graphile Build.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ never use that type, that will likely not cause a schema validation error. If
you use a directive that does not exist (or pass the wrong arguments to a
directive), that's also unlikely to error. The SDL is just used as a convenient
syntax, it is converted under the hood into [schema
hooks](https://build.graphile.org/graphile-build/hooks) as if you had written
hooks](https://build.graphile.org/graphile-build/5/hooks) as if you had written
a Graphile Build plugin by hand.

:::
Expand Down
2 changes: 1 addition & 1 deletion postgraphile/website/versioned_docs/version-5/registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ title: Registry

As you know: PostGraphile builds a GraphQL schema for you by introspecting your
database. What you may not know is that it does this through multiple phases
using the [Graphile Build](https://build.graphile.org/graphile-build/) library.
using the [Graphile Build](https://build.graphile.org/graphile-build/5) library.
In the `gather` phase, PostGraphile introspects your database, and builds up a
"registry" of all of the "codecs", "resources" and "relations" that it finds.
Then during the `schema` phase, it inspects this registry and uses it to decide
Expand Down