Skip to content

Commit 4175453

Browse files
committed
docs: Document automatic FK discovery in PostgreSQL catalog connector
The PostgreSQL Catalog Connector now discovers foreign key relationships during catalog refresh and surfaces them via the table_schema tool and FlightSQL GetTables.
1 parent 179393a commit 4175453

1 file changed

Lines changed: 9 additions & 0 deletions

File tree

website/docs/components/catalogs/postgres.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,15 @@ catalogs:
100100
pg_connection_string: postgresql://${secrets:REDSHIFT_USER}:${secrets:REDSHIFT_PASS}@my-cluster.abc123.us-east-1.redshift.amazonaws.com:5439/my_database?sslmode=require
101101
```
102102

103+
## Foreign Key Discovery
104+
105+
The PostgreSQL Catalog Connector automatically discovers foreign key relationships by querying `information_schema.referential_constraints` and `key_column_usage` during catalog refresh. Discovered FK metadata is attached to each table's Arrow schema and surfaces through:
106+
107+
- The `table_schema` tool — agents can use FK relationships to infer join paths between tables
108+
- FlightSQL `GetTables` — programmatic clients receive FK metadata in the schema response
109+
110+
No configuration is required. If FK discovery fails for a schema (e.g., due to insufficient permissions on `information_schema`), tables are still registered without FK metadata and a warning is logged.
111+
103112
## Secrets
104113

105114
Spice integrates with multiple secret stores to help manage sensitive data securely. For detailed information on supported secret stores, refer to the [secret stores documentation](../secret-stores). Additionally, learn how to use referenced secrets in component parameters by visiting the [using referenced secrets guide](../secret-stores#using-secrets).

0 commit comments

Comments
 (0)