findRelationships
Discover and traverse relationships between records in RushDB to trace multi-hop paths or filter relationship edges by type, labels, and properties. Use for graph queries; use record search for metrics.
Instructions
Discover and traverse relationships between records. Use this tool in two scenarios: (1) Multi-hop path discovery — fetch a sample record ID, then call findRelationships with source.where or target.where containing that ID to reveal adjacent labels; repeat to trace the full path before building a nested findRecords where clause. (2) Edge filtering — where applies to relationship type/properties; use source/target for endpoint record predicates. Does NOT support select or groupBy — use findRecords for metrics/analytics across related labels.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| skip | No | Number of relationships to skip | |
| limit | No | Maximum number of relationships to return | |
| where | No | Relationship-edge predicates. `type` filters the relationship type; other fields filter relationship properties. | |
| source | No | Optional source endpoint filter: labels and/or record-scoped where predicates. | |
| target | No | Optional target endpoint filter: labels and/or record-scoped where predicates. | |
| orderBy | No | Sorting configuration: key = field, value = asc|desc |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| relationships | Yes |