Neo4J Test Connection
Validates connectivity to a Neo4J database using the provided credentials. It performs a non-destructive health check and returns a readable status plus a JSON payload with details. Useful for confirming host, port, authentication, and SSL settings before running queries.
Usage
Use this node at the start of a workflow to ensure your Neo4J credentials and network access are correct. If the test passes, proceed with query, write, or schema operations. If it fails, inspect the returned JSON for error details and adjust credentials or connection parameters.
| Field | Required | Type | Description | Example |
|---|
| credentials_path | True | STRING | Path or reference to stored Neo4J credentials configured for this environment. | |
| timeout | True | INT | Maximum time in seconds to wait for the connection test to complete. | 30 |
Outputs
| Field | Type | Description | Example |
|---|
| text | STRING | Human-readable summary of the connection test result. | Neo4J Connection Test\nStatus: OK\nLatency: 120 ms |
| json | STRING | Machine-readable JSON payload with connection test details (e.g., status, errors, server info). | {"status": "ok", "server_version": "5.x", "latency_ms": 120} |
| html | HTML | HTML rendition of the results (may be empty if not requested). | |
| xlsx | XLSX | XLSX export of the results (may be empty if not requested). | |
| pdf | PDF | PDF export of the results (may be empty if not requested). | |
Important Notes
- This node requires valid Neo4J credentials to be configured and accessible via credentials_path.
- The operation is read-only and does not modify the database.
- Timeout applies to the connection check request; very short timeouts may cause false negatives on slow networks.
- If using encrypted protocols, ensure certificates and trust settings in your credentials are correct.
Troubleshooting
- Authentication failed: Verify username/password in the credentials and ensure the account has access.
- Connection timed out: Check host/port, firewall rules, VPN/proxy settings, and increase the timeout.
- TLS/SSL errors: Adjust protocol (e.g., bolt+s/neo4j+s), trust settings, or certificates in your credentials.
- Protocol/port mismatch: Use the correct protocol and port (e.g., bolt on 7687, HTTP endpoints are not supported here).
- Service unreachable: Confirm the Neo4J server is running and accessible from the environment executing this node.
