Neo4J Nodes by Label¶
Retrieves nodes from a Neo4J database filtered by a specified label, with a configurable maximum number of results. It returns a human-readable text summary along with machine-readable JSON, and may also provide empty placeholders for additional export formats.
Usage¶
Use this node to quickly browse or extract entities of a specific type (label) from your Neo4J graph, e.g., all Person nodes. Typical workflow: provide valid Neo4J credentials, set the label (such as Person, Product, etc.), choose a result limit, and connect the outputs to downstream nodes for analysis, visualization, or export.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | STRING | Path or reference to the stored credentials for the Neo4J service, following the 'neo4j' credential template. | |
| timeout | False | INT | Maximum time in seconds to wait for the operation before it times out. | 120 |
| label | True | STRING | The Neo4J node label to filter by. | Person |
| limit | True | INT | Maximum number of nodes to return. Supported range is 1 to 10000. | 100 |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| text | TEXT | A readable summary of the retrieved nodes and operation context. | Neo4J Nodes by Label: Person Returned 100 nodes. |
| json | JSON | Raw JSON data of the retrieved nodes and related metadata. | {"nodes": [{"id": 1, "labels": ["Person"], "properties": {"name": "Alice"}}], "count": 100} |
| html | HTML | HTML-rendered version of the results if available; may be empty if not generated. | |
| xlsx | XLSX | Excel file data for the results if available; may be empty if not generated. | |
| PDF file data for the results if available; may be empty if not generated. |
Important Notes¶
- Credentials required: You must provide valid Neo4J credentials using the 'neo4j' credential template.
- Label sensitivity: Labels must match existing labels in your graph; otherwise the result may be empty.
- Result cap: The limit parameter accepts values from 1 to 10000; higher values may increase execution time.
- Timeout considerations: Large datasets or busy databases may require increasing the timeout input to avoid timeouts.
- Outputs: The primary consumable outputs are text and json; html/xlsx/pdf may be empty depending on configuration.
Troubleshooting¶
- Empty results: Verify the label is correct and exists in your database. Try a smaller limit or different label.
- Timeouts: Increase the timeout value or reduce the limit. Ensure network connectivity and database performance are adequate.
- Authentication errors: Check the credentials_path points to valid credentials and that the account has read permissions.
- Malformed output handling: If downstream nodes expect specific fields, inspect the json output structure and adapt accordingly.