tigergraph__get_nodes
Retrieve multiple vertices from a TigerGraph graph with optional filtering, sorting, and pagination.
Instructions
Purpose: Retrieve multiple vertices (nodes) from the graph with optional filtering and sorting.
When to Use:
List vertices of a specific type
Search for vertices matching certain criteria
Browse graph data with pagination
Find vertices based on attribute values
Key Features:
WHERE clause for filtering
Sorting by attributes (ascending/descending)
Limit results for pagination
Returns complete vertex data including all attributes
Common Workflows:
List all vertices:
get_nodes(vertex_type='Person', limit=10)Filter by attribute:
get_nodes(vertex_type='Person', where='age > 25')Sort results:
get_nodes(vertex_type='Person', sort='-created_at', limit=20)
Tips:
Use limit to avoid retrieving too many vertices
WHERE clause syntax follows TigerGraph conventions
Sort with '-' prefix for descending order
Combine where, sort, and limit for precise queries
Related Tools:
get_node: Get a single specific vertex
get_vertex_count: Count vertices before retrieving
run_query: For complex multi-hop queries
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| sort | No | Sort results by attribute. Use '-' prefix for descending (e.g., '-age') | |
| limit | No | Maximum number of vertices to return (default: 100) | |
| where | No | Optional filter condition. Use TigerGraph WHERE syntax. Examples: - 'age > 25' - 'name == "John"' - 'active == true' | |
| profile | No | Connection profile name. Omit to use the active default profile. Use 'list_connections' to see available profiles. | |
| graph_name | No | Name of the graph to query (uses default if not specified) | |
| vertex_type | Yes | The type of vertices to retrieve |