Skip to content

Commit

Permalink
docs(changeset): 🚨 Breaking changes around types and postgres configu…
Browse files Browse the repository at this point in the history
…ration:

- `GraphileBuild.GraphileResolverContext` renamed to `Grafast.Context`
- `GraphileConfig.GraphQLRequestContext` renamed to `Grafast.RequestContext`
- `Grafast.PgDatabaseAdaptorOptions` renaed to `GraphileConfig.PgDatabaseAdaptorOptions`
- `@dataplan/pg/adaptors/node-postgres` is now `@dataplan/pg/adaptors/pg` due to the bizarre naming of PostgreSQL clients on npm - we've decided to use the module name as the unique identifier
- `makePgConfigs`:
  - is now `makePgConfig` (singular) - so you'll need to wrap it in an array where you use it
  - no longer exported by `@dataplan/pg` (because it depended on `pg`) - instead each adaptor exposes this helper - so import from `@dataplan/pg/adaptors/node-postgres`
  - accepts an object parameter containing `{connectionString, schemas, superuserConnectionString}`, rather than multiple string parameters
- `postgraphile` CLI will now try and respect the adaptor stated in your preset when overriding connection arguments
- Removed `Grafast.RequestContext.httpRequest` and instead use `Grafast.RequestContext.node.req/res`; all server adaptors should implement this if appropriate
  • Loading branch information
benjie committed Feb 13, 2023
1 parent 2e62117 commit 652cf10
Showing 1 changed file with 31 additions and 0 deletions.
31 changes: 31 additions & 0 deletions .changeset/neat-cars-push.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
---
"@dataplan/pg": patch
"grafast": patch
"graphile-build": patch
"graphile-build-pg": patch
"postgraphile": patch
---

🚨 Breaking changes around types and postgres configuration:

- `GraphileBuild.GraphileResolverContext` renamed to `Grafast.Context`
- `GraphileConfig.GraphQLRequestContext` renamed to `Grafast.RequestContext`
- `Grafast.PgDatabaseAdaptorOptions` renaed to
`GraphileConfig.PgDatabaseAdaptorOptions`
- `@dataplan/pg/adaptors/node-postgres` is now `@dataplan/pg/adaptors/pg` due to
the bizarre naming of PostgreSQL clients on npm - we've decided to use the
module name as the unique identifier
- `makePgConfigs`:
- is now `makePgConfig` (singular) - so you'll need to wrap it in an array
where you use it
- no longer exported by `@dataplan/pg` (because it depended on `pg`) - instead
each adaptor exposes this helper - so import from
`@dataplan/pg/adaptors/node-postgres`
- accepts an object parameter containing
`{connectionString, schemas, superuserConnectionString}`, rather than
multiple string parameters
- `postgraphile` CLI will now try and respect the adaptor stated in your preset
when overriding connection arguments
- Removed `Grafast.RequestContext.httpRequest` and instead use
`Grafast.RequestContext.node.req/res`; all server adaptors should implement
this if appropriate

0 comments on commit 652cf10

Please sign in to comment.