Neo4J Property Keys¶
Retrieves all distinct property keys present in the connected Neo4J database. It loads saved Neo4J credentials, calls the backend service to fetch keys, and returns a human-readable summary along with the raw JSON data.
Usage¶
Use this node when you need an overview of all property keys used across nodes and relationships in your Neo4J graph. It’s typically placed after a credentials setup step and before query-building or schema analysis tasks to inform consistent property naming and validation.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | CREDENTIALS | Path or reference to saved Neo4J credentials configured for the service. | /configs/credentials/neo4j.json |
| timeout | True | INT | Maximum time in seconds to wait for the operation before failing. | 120 |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| text | STRING | Readable summary of the retrieved property keys. | Neo4J Property Keys Total keys: 24 Sample: ['name', 'age', 'createdAt', 'email', 'title'] |
| json | STRING | JSON-encoded result data containing the property keys and related metadata, if any. | {"keys": ["name", "age", "createdAt", "email", "title"]} |
| html | STRING | HTML representation (not used by this node’s default output; returned empty). | |
| xlsx | STRING | XLSX content or reference (not used by this node’s default output; returned empty). | |
| STRING | PDF content or reference (not used by this node’s default output; returned empty). |
Important Notes¶
- Credentials required: Ensure a valid Neo4J credential set is available at the provided credentials_path.
- Read-only operation: This node only reads metadata (property keys) and does not modify the database.
- Timeout behavior: Large graphs or slow connections may require increasing the timeout value.
- Output structure: The default outputs include a text summary and a JSON string; other formats are returned empty by design.
Troubleshooting¶
- Authentication errors: Verify the credentials_path points to a valid Neo4J configuration and that the username/password are correct.
- Network/connection issues: If requests time out or fail to connect, check network access, host/port, and increase the timeout as needed.
- Empty results: If the JSON payload contains no keys, confirm that your database contains nodes/relationships with properties.
- Invalid credentials path: Ensure the path is accessible to the runtime environment and formatted correctly.