List foreign keys
list_foreign_keysRetrieve foreign key constraints defined in a specific schema, including source and target columns and tables.
Instructions
List foreign keys in a schema, resolved to columns and referenced table. Returns a list of objects with name, from_table, from_columns, to_schema, to_table, to_columns.
Example: list_foreign_keys(schema='public')
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| schema | Yes | ||
| database | No | Optional: target a configured secondary (read-only) database by name; omit for the primary. Call list_databases to see the configured ids. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |