Describe property graph
describe_property_graphRetrieve the vertex and edge tables of a property graph by schema and name. Use after listing graphs to prepare a PGQ query.
Instructions
Describe one SQL/PGQ property graph by schema-qualified name. Requires PG 19+; raises an error otherwise. Useful when an agent has located a graph via list_property_graphs and needs the full membership before composing a run_pgq query. Returns an object with schema, name, vertex_tables (list of schema.table strings), and edge_tables (same shape).
Example: describe_property_graph(schema='public', name='org_chart')
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | ||
| 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 |
|---|---|---|---|
| name | Yes | ||
| schema | Yes | ||
| edge_tables | Yes | ||
| vertex_tables | Yes |