Neo4J Database Info¶
Retrieves high-level information about the connected Neo4J database via the Salt data service. Returns a human-readable summary along with the raw JSON payload. Typical details include version, edition, default database, and basic server/cluster metadata.
Usage¶
Use this node to verify connectivity and inspect your Neo4J environment before running queries or schema operations. It fits early in a workflow to validate credentials and understand the target database characteristics, or in monitoring/diagnostics flows to capture current database state.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | CREDENTIALS | Path or reference to stored Neo4J credentials configured for the Salt data service. The credentials must be associated with the 'neo4j' service profile. | |
| timeout | False | INT | Maximum time in seconds to wait for the data service to return database information before timing out. | 60 |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| text | TEXT | A readable summary of the Neo4J database information. | Neo4J Database Info Version: 5.x Edition: Community Default Database: neo4j Cluster: Single instance |
| json | JSON | Raw JSON payload with database information as returned by the service. | {"version":"5.x","edition":"Community","default_database":"neo4j","server":{"addresses":["bolt://localhost:7687"]}} |
| html | HTML | HTML content (if available for this call). For this node, it is typically empty. | |
| xlsx | XLSX | Binary Excel data (if available for this call). For this node, it is typically empty. | |
| Binary PDF data (if available for this call). For this node, it is typically empty. |
Important Notes¶
- Credentials: Ensure the provided credentials reference is valid and mapped to the 'neo4j' service profile.
- Network access: The Salt data service must be able to reach your Neo4J endpoint (host, port, and protocol).
- Timeouts: Increase the timeout for slow or remote environments to avoid premature failures.
- Read permissions: The credentials must have sufficient permissions to query database metadata.
Troubleshooting¶
- Authentication failed: Verify username/password or token in the credentials reference and that it targets the correct Neo4J instance.
- Connection error / timeout: Check network/firewall rules, host/port, protocol (bolt/neo4j with or without TLS), and increase the timeout input.
- Empty or partial info: Ensure the connected user has permissions to read database and system metadata.
- Service unavailable: Confirm the Salt data service is running and healthy, and retry once it is reachable.