Skip to content

Commit 35bc0a7

Browse files
fbjorkpimeys
authored andcommitted
tweaks for consistency
1 parent 6e6aeb6 commit 35bc0a7

3 files changed

Lines changed: 17 additions & 22 deletions

File tree

Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

extensions/postgres/Cargo.toml

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,12 @@
11
[package]
2-
name = "postgres-extension"
2+
name = "postgres"
33
version = "0.1.0"
44
edition = "2024"
55
license = "Apache-2.0"
66

77
[lib]
8-
name = "postgres_extension"
9-
path = "src/lib.rs"
108
crate-type = ["cdylib"]
119

12-
[features]
13-
default = []
14-
1510
# Common dependencies for both WASI and native
1611
[dependencies]
1712
Inflector.workspace = true

extensions/postgres/README.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Grafbase Postgres Extension
1+
# Postgres extension
22

3-
This Postgres extension for the Grafbase Gateway acts as a complete virtual subgraph that you can compose into your federated schema.
3+
This extension allows you to integrate Postgres databases into your federated graph declaratively with GraphQL directives.
44

5-
Use the [`grafbase-postgres`](https://github.com/grafbase/extensions/tree/julius/ywmxqwoumunr/cli/postgres) introspection tool to generate a subgraph schema from your Postgres database. You can then compose this subgraph into your federated schema. Commit the generated schema to your repository and re-introspect the database periodically to keep the schema up-to-date.
5+
Use the [`grafbase-postgres`](https://github.com/grafbase/extensions/tree/main/cli/postgres) introspection tool to generate a subgraph schema from your Postgres database. You can then compose this subgraph into your federated schema. Commit the generated schema to your repository and re-introspect the database periodically to keep the schema up-to-date.
66

77
The introspection process generates a complete set of types representing the data in your Postgres database, including entities, relationships, and scalar fields. Use these types to query and mutate data in your Postgres database via the Grafbase Gateway.
88

@@ -18,11 +18,11 @@ Generally, every operation executed through the extension generates exactly one
1818

1919
### Introspection Tool (`grafbase-postgres`)
2020

21-
Currently, you must compile the `grafbase-postgres` introspection tool from source (refer to its [repository](https://github.com/grafbase/extensions/tree/julius/ywmxqwoumunr/cli/postgres) for instructions). After successful compilation, copy the resulting binary to a directory in your system's `PATH`.
21+
Currently, you must compile the `grafbase-postgres` introspection tool from source (refer to its [repository](https://github.com/grafbase/extensions/tree/main/cli/postgres) for instructions). After successful compilation, copy the resulting binary to a directory in your system's `PATH`.
2222

2323
*Future versions will offer easier installation, likely integrated with the Grafbase CLI.*
2424

25-
### Building the Extension (Wasm)
25+
### Building the Extension
2626

2727
To use the extension with the Grafbase Gateway, you first need to build the Wasm component.
2828

@@ -39,14 +39,14 @@ To use the extension with the Grafbase Gateway, you first need to build the Wasm
3939

4040
### Gateway Configuration
4141

42-
Configure your Grafbase Gateway to use the extension in your `grafbase.config.toml`.
42+
Configure your Grafbase Gateway to use the extension in your `grafbase.toml` configuration file.
4343

44-
**Using a Published Version (Recommended when available):**
44+
**Using a Published Version:**
4545

46-
Specify the desired version (replace `0.1` when newer versions are released):
46+
Specify the desired version of the Postgres extension:
4747

4848
```toml
49-
# grafbase.config.toml
49+
# grafbase.toml
5050
[extensions.postgres]
5151
version = "0.1"
5252
```
@@ -56,7 +56,7 @@ version = "0.1"
5656
If you built the extension manually, point the gateway to the build directory:
5757

5858
```toml
59-
# grafbase.config.toml
59+
# grafbase.toml
6060
[extensions.postgres]
6161
path = "/path/to/your/build" # Update this path
6262
```
@@ -102,10 +102,10 @@ PREBUILT_EXTENSION=1 cargo test
102102
103103
## Configuration
104104
105-
Configure the Postgres extension within your `grafbase.config.toml` under the `[extensions.postgres.config]` section. See the [Grafbase Gateway configuration documentation](https://grafbase.com/docs/reference/gateway/configuration/extensions) for general extension configuration details.
105+
Configure the Postgres extension within your `grafbase.toml` under the `[extensions.postgres.config]` section. See the [Grafbase Gateway configuration documentation](https://grafbase.com/docs/reference/gateway/configuration/extensions) for general extension configuration details.
106106
107107
```toml
108-
# Example configuration within grafbase.config.toml
108+
# Example configuration within grafbase.toml
109109
[extensions.postgres]
110110
# version = "0.1" # Or path = "..."
111111
@@ -132,7 +132,7 @@ max_lifetime_ms = 1800000
132132
133133
## Introspection
134134
135-
Use the `grafbase-postgres introspect` command to generate a GraphQL schema definition (SDL) from your database:
135+
Use the `grafbase-postgres introspect` command to generate a GraphQL schema from your database:
136136
137137
```bash
138138
# Ensure grafbase-postgres is in your PATH
@@ -294,6 +294,6 @@ type Mutation {
294294
* **Returning Data:** All mutations support a `returning` selection set, allowing you to fetch data about the affected rows within the same database transaction.
295295
* **Performance:** Each mutation executes as a single SQL statement.
296296
297-
### Supported PostgreSQL Versions
297+
### Supported Postgres Versions
298298
299-
We primarily test against the latest stable PostgreSQL version. The extension relies on SQL features, particularly JSON/JSONB functions, available in PostgreSQL. Therefore, the minimum supported version is **PostgreSQL 9.4**.
299+
We primarily test against the latest stable Postgres version. The extension relies on SQL features, particularly JSON/JSONB functions, available in Postgres. Therefore, the minimum supported version is **Postgres 9.4**.

0 commit comments

Comments
 (0)