From 054dfef09b86f2b0f0d843535a38c4d55d39c36e Mon Sep 17 00:00:00 2001 From: Jem Gillam <6413628+jemgillam@users.noreply.github.com> Date: Fri, 7 Feb 2025 14:27:16 +0000 Subject: [PATCH 1/5] initial commit --- postgraphile/website/postgraphile/extending.md | 2 +- postgraphile/website/postgraphile/make-extend-schema-plugin.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/postgraphile/website/postgraphile/extending.md b/postgraphile/website/postgraphile/extending.md index f0f0ee94c6..3066f7eb90 100644 --- a/postgraphile/website/postgraphile/extending.md +++ b/postgraphile/website/postgraphile/extending.md @@ -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. diff --git a/postgraphile/website/postgraphile/make-extend-schema-plugin.md b/postgraphile/website/postgraphile/make-extend-schema-plugin.md index bbec4607c7..5819d07038 100644 --- a/postgraphile/website/postgraphile/make-extend-schema-plugin.md +++ b/postgraphile/website/postgraphile/make-extend-schema-plugin.md @@ -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. ::: From b3470edc28c7cba97061dafa5bb2a48762bd7e3d Mon Sep 17 00:00:00 2001 From: Jem Gillam <6413628+jemgillam@users.noreply.github.com> Date: Fri, 7 Feb 2025 14:56:37 +0000 Subject: [PATCH 2/5] update links to build website --- postgraphile/website/postgraphile/performance.md | 2 +- postgraphile/website/postgraphile/registry.md | 2 +- .../website/versioned_docs/version-4/extending-raw.md | 4 ++-- .../website/versioned_docs/version-4/extending.md | 2 +- postgraphile/website/versioned_docs/version-4/index.mdx | 4 ++-- .../website/versioned_docs/version-4/performance.md | 2 +- .../website/versioned_docs/version-4/usage-library.mdx | 8 ++++---- .../website/versioned_docs/version-4/usage-schema.md | 8 ++++---- .../website/versioned_docs/version-5/extending.md | 2 +- .../versioned_docs/version-5/make-extend-schema-plugin.md | 2 +- postgraphile/website/versioned_docs/version-5/registry.md | 2 +- 11 files changed, 19 insertions(+), 19 deletions(-) diff --git a/postgraphile/website/postgraphile/performance.md b/postgraphile/website/postgraphile/performance.md index 5399a5c8c6..e02be50dc3 100644 --- a/postgraphile/website/postgraphile/performance.md +++ b/postgraphile/website/postgraphile/performance.md @@ -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 diff --git a/postgraphile/website/postgraphile/registry.md b/postgraphile/website/postgraphile/registry.md index 97ad908d56..4a88271331 100644 --- a/postgraphile/website/postgraphile/registry.md +++ b/postgraphile/website/postgraphile/registry.md @@ -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 diff --git a/postgraphile/website/versioned_docs/version-4/extending-raw.md b/postgraphile/website/versioned_docs/version-4/extending-raw.md index 63a376f6b9..66cb7e5ba1 100644 --- a/postgraphile/website/versioned_docs/version-4/extending-raw.md +++ b/postgraphile/website/versioned_docs/version-4/extending-raw.md @@ -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) { diff --git a/postgraphile/website/versioned_docs/version-4/extending.md b/postgraphile/website/versioned_docs/version-4/extending.md index f2d1fbbcfa..17d60eab23 100644 --- a/postgraphile/website/versioned_docs/version-4/extending.md +++ b/postgraphile/website/versioned_docs/version-4/extending.md @@ -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. diff --git a/postgraphile/website/versioned_docs/version-4/index.mdx b/postgraphile/website/versioned_docs/version-4/index.mdx index f8aa27e864..2f77f10969 100644 --- a/postgraphile/website/versioned_docs/version-4/index.mdx +++ b/postgraphile/website/versioned_docs/version-4/index.mdx @@ -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: diff --git a/postgraphile/website/versioned_docs/version-4/performance.md b/postgraphile/website/versioned_docs/version-4/performance.md index 318855b97f..91ee099ba0 100644 --- a/postgraphile/website/versioned_docs/version-4/performance.md +++ b/postgraphile/website/versioned_docs/version-4/performance.md @@ -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 diff --git a/postgraphile/website/versioned_docs/version-4/usage-library.mdx b/postgraphile/website/versioned_docs/version-4/usage-library.mdx index 0d7662520f..d77885c99b 100644 --- a/postgraphile/website/versioned_docs/version-4/usage-library.mdx +++ b/postgraphile/website/versioned_docs/version-4/usage-library.mdx @@ -406,17 +406,17 @@ for postgraphile@4.12.3. 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). diff --git a/postgraphile/website/versioned_docs/version-4/usage-schema.md b/postgraphile/website/versioned_docs/version-4/usage-schema.md index fcb22ad5a1..911015e1a3 100644 --- a/postgraphile/website/versioned_docs/version-4/usage-schema.md +++ b/postgraphile/website/versioned_docs/version-4/usage-schema.md @@ -141,17 +141,17 @@ for postgraphile@4.12.3. 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). diff --git a/postgraphile/website/versioned_docs/version-5/extending.md b/postgraphile/website/versioned_docs/version-5/extending.md index 3546e03449..604357ff30 100644 --- a/postgraphile/website/versioned_docs/version-5/extending.md +++ b/postgraphile/website/versioned_docs/version-5/extending.md @@ -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. diff --git a/postgraphile/website/versioned_docs/version-5/make-extend-schema-plugin.md b/postgraphile/website/versioned_docs/version-5/make-extend-schema-plugin.md index 0dd3a54c9f..16d4d5e114 100644 --- a/postgraphile/website/versioned_docs/version-5/make-extend-schema-plugin.md +++ b/postgraphile/website/versioned_docs/version-5/make-extend-schema-plugin.md @@ -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. ::: diff --git a/postgraphile/website/versioned_docs/version-5/registry.md b/postgraphile/website/versioned_docs/version-5/registry.md index 97ad908d56..4a88271331 100644 --- a/postgraphile/website/versioned_docs/version-5/registry.md +++ b/postgraphile/website/versioned_docs/version-5/registry.md @@ -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 From b540629d9d9cf182d0289e27bafcec99dcaaf7c2 Mon Sep 17 00:00:00 2001 From: Jem Gillam <6413628+jemgillam@users.noreply.github.com> Date: Thu, 13 Feb 2025 13:09:00 +0000 Subject: [PATCH 3/5] last link fixes --- postgraphile/website/news/2023-04-26-alpha-release.md | 6 +++--- postgraphile/website/postgraphile/community-plugins.md | 2 +- postgraphile/website/postgraphile/customization-overview.md | 4 ++-- .../website/versioned_docs/version-4/community-plugins.md | 2 +- .../website/versioned_docs/version-4/reserved-keywords.md | 2 +- .../website/versioned_docs/version-5/community-plugins.md | 2 +- 6 files changed, 9 insertions(+), 9 deletions(-) diff --git a/postgraphile/website/news/2023-04-26-alpha-release.md b/postgraphile/website/news/2023-04-26-alpha-release.md index 4c70b40260..17cb3fe820 100644 --- a/postgraphile/website/news/2023-04-26-alpha-release.md +++ b/postgraphile/website/news/2023-04-26-alpha-release.md @@ -31,7 +31,7 @@ Gra*fast* even generates a plan diagram showing what steps are necessary to exec
-[![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)
@@ -46,11 +46,11 @@ Thanks to these advanced planning capabilities, PostGraphile is now able to gene
-[![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)
-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.
diff --git a/postgraphile/website/postgraphile/community-plugins.md b/postgraphile/website/postgraphile/community-plugins.md index 1e7a813691..7a97782937 100644 --- a/postgraphile/website/postgraphile/community-plugins.md +++ b/postgraphile/website/postgraphile/community-plugins.md @@ -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 diff --git a/postgraphile/website/postgraphile/customization-overview.md b/postgraphile/website/postgraphile/customization-overview.md index 4fec534f48..4e0c00f5be 100644 --- a/postgraphile/website/postgraphile/customization-overview.md +++ b/postgraphile/website/postgraphile/customization-overview.md @@ -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 diff --git a/postgraphile/website/versioned_docs/version-4/community-plugins.md b/postgraphile/website/versioned_docs/version-4/community-plugins.md index 9c4d13c344..bc824cee2c 100644 --- a/postgraphile/website/versioned_docs/version-4/community-plugins.md +++ b/postgraphile/website/versioned_docs/version-4/community-plugins.md @@ -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). +the “edit this page” link below to do so. See the [CLI](./usage-cli) or [library](./usage-library) docs for how to load plugins. diff --git a/postgraphile/website/versioned_docs/version-4/reserved-keywords.md b/postgraphile/website/versioned_docs/version-4/reserved-keywords.md index f3b632f6a3..d8751aceed 100644 --- a/postgraphile/website/versioned_docs/version-4/reserved-keywords.md +++ b/postgraphile/website/versioned_docs/version-4/reserved-keywords.md @@ -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 diff --git a/postgraphile/website/versioned_docs/version-5/community-plugins.md b/postgraphile/website/versioned_docs/version-5/community-plugins.md index 2f2797f1c1..6291ac1f9d 100644 --- a/postgraphile/website/versioned_docs/version-5/community-plugins.md +++ b/postgraphile/website/versioned_docs/version-5/community-plugins.md @@ -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 From 76682affcc785ef364b1680408b2d4acb8a5c19f Mon Sep 17 00:00:00 2001 From: Jem <6413628+jemgillam@users.noreply.github.com> Date: Thu, 13 Feb 2025 13:13:02 +0000 Subject: [PATCH 4/5] Update postgraphile/website/versioned_docs/version-4/community-plugins.md --- .../website/versioned_docs/version-4/community-plugins.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/postgraphile/website/versioned_docs/version-4/community-plugins.md b/postgraphile/website/versioned_docs/version-4/community-plugins.md index bc824cee2c..53bbe9d3b9 100644 --- a/postgraphile/website/versioned_docs/version-4/community-plugins.md +++ b/postgraphile/website/versioned_docs/version-4/community-plugins.md @@ -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 -the “edit this page” link below to do so. +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. From 5da82fb1fd86bd9aeca8e9674b8fbb0bb3d12582 Mon Sep 17 00:00:00 2001 From: Benjie Date: Fri, 14 Feb 2025 10:12:30 +0000 Subject: [PATCH 5/5] Update postgraphile/website/versioned_docs/version-5/extending.md --- postgraphile/website/versioned_docs/version-5/extending.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/postgraphile/website/versioned_docs/version-5/extending.md b/postgraphile/website/versioned_docs/version-5/extending.md index 604357ff30..c196fdb284 100644 --- a/postgraphile/website/versioned_docs/version-5/extending.md +++ b/postgraphile/website/versioned_docs/version-5/extending.md @@ -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/5/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.