Neo4J Schema Info¶
Retrieves high-level schema information from a Neo4J database, focusing on constraints and indexes. It authenticates using provided credentials, calls the Neo4J service, and returns a readable summary along with the raw JSON payload.
Usage¶
Use this node when you need to inspect or audit the graph schema—such as reviewing existing indexes and constraints—before drafting queries, optimizing performance, or enforcing governance. Place it early in a workflow to understand the current graph structure, or alongside query/maintenance steps to verify schema changes.
Inputs¶
| Field | Required | Type | Description | Example |
|---|---|---|---|---|
| credentials_path | True | CREDENTIALS | Path or reference to stored Neo4J credentials based on the 'neo4j' credential template. Must include endpoint/host, authentication, and any required configuration. | |
| timeout | True | INT | Request timeout in seconds for the operation. Prevents long-running schema calls from blocking the workflow. | 120 |
Outputs¶
| Field | Type | Description | Example |
|---|---|---|---|
| text | STRING | Human-readable summary of the schema info (constraints and indexes). | Neo4J Schema Info: 3 indexes, 2 constraints found. |
| json | STRING | Raw JSON string containing the full schema information returned by the service. | {"indexes": [...], "constraints": [...]} |
Important Notes¶
- Credentials required: You must supply valid Neo4J credentials via credentials_path using the 'neo4j' template.
- Read-only operation: This node only reads schema metadata; it does not alter the database.
- Timeout behavior: If the database is slow or unavailable, the node may return a timeout error based on the configured timeout.
- JSON structure: The JSON payload contents (fields for indexes/constraints) may vary depending on your Neo4J version and backend service implementation.
Troubleshooting¶
- Authentication failed: Verify credentials_path points to valid credentials and that the username/password or token is correct.
- Connection refused or timed out: Check network access to the Neo4J host/port and increase the timeout if needed.
- Empty or partial results: Ensure the authenticated user has sufficient privileges to view schema metadata.
- Invalid JSON output: If consuming the JSON downstream, ensure the consumer expects a JSON string and parses it before use.