tigergraph__get_node_edges
Retrieve all outgoing edges from a specified vertex, with optional filtering by edge type. Returns edge details including type, attributes, and target vertex information.
Instructions
Purpose: Retrieve all edges connected to a specific vertex (node).
When to Use:
Explore connections from a vertex
Find relationships of a specific type
Analyze node connectivity patterns
Get edge attributes and target vertices
What You Get:
Edge type and ID
Edge attributes
Target vertex information
Edge direction (outgoing from the specified vertex)
Common Workflows:
Explore all connections:
get_node_edges(vertex_type='Person', vertex_id='123')Specific relationship type:
get_node_edges(..., edge_type='FRIEND_OF')Degree analysis: Count returned edges to get outgoing degree
Tips:
Returns OUTGOING edges only (edges starting from this vertex)
Use get_node_degree() for quick connection count
Use get_neighbors() to get target vertices without edge details
Combine with pagination (limit) for highly connected vertices
Note: This returns edges where the specified vertex is the SOURCE. For incoming edges, use a reverse traversal query or get_neighbors().
Related Tools:
get_node_degree: Count connections without retrieving edges
get_neighbors: Get connected vertices
get_edges: Query edges by type across the graph
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| limit | No | Maximum number of edges to return (default: 100) | |
| profile | No | Connection profile name. Omit to use the active default profile. Use 'list_connections' to see available profiles. | |
| edge_type | No | Optional: Filter by specific edge type. If omitted, returns all edge types. | |
| vertex_id | Yes | The unique identifier of the source vertex | |
| graph_name | No | Name of the graph (uses default if not specified) | |
| vertex_type | Yes | The type of the source vertex |