Databases
This component provides access to a remote instance of the Neo4j database using the HTTP port. Support to the Bolt protocol is planned but currently not available. Check out the video for an example.
The configuration section of the component has the following fields:
- Endpoint: address the Neo4j instance is running on, including protocol (e.g. "http://localhost")
- Port: the Neo4j HTTP port (Default: 7474)
- User: the Neo4j instance username
- Password: the Neo4j instance password
- Use V4: activate this to use Neo4j 4.x (support to Neo4j 4 will be discontinued with the FANTASIA release for Unreal Engine 5.5)
This enum type defines the query modes available when submitting queries to Neo4j. Values are:
- SINGLE_REQUEST: Send and commit a query. The transaction is automatically opened and committed;
- BEGIN_TRANSACTION: Open a transaction and execute a query in it without committing the transaction;
- COMMIT_TRANSCATION: Send a query in a specified transaction and commit the transaction;
- ROLLBACK_TRANSACTION: Send a query in a specified transaction and roll it back;
- ADD_TO_TRANSACTION: Add a query to an open transaction and do not commit it.
This object contains the table result of a query returned by the Neo4j component. It contains the following properties:
- TransactionID (String): the ID of the transaction the response refers to;
- Headers (Array of strings): the list of column names in the response table;
- Rows (Array of Neo4jResultRows): the list of rows composing the response table. Each row is represented by a Neo4jResultRow object.
This object contains a single row of the results table. It contains the following properties:
- Cells: A Map using, as keys, the column names of the results table. The Map values are the results returned by Neo4j, represented by Neo4jResultCell objects.
This object represents a cell in a results row from the table returned by Neo4j. It is an abstract class grouping all the different kinds of results that Neo4j can return: Neo4jResultCellNode, Neo4jResultCellRelationship and Neo4jResultCellSimple
This object represents a results cell containing a Neo4j node. It contains the following properties:
- Labels: A list of strings representing the Neo4j node labels;
- ID: An integer representing the node ID (to be converted in the new elementID string used by more recent versions of Neo4j);
- Properties: A Map using, as keys, the property names of the represented node. The Map values are the corresponding property values in Neo4j.
This object represents a results cell containing a Neo4j relationship. It contains the following properties:
- Label: A string representing the Neo4j relationship label;
- ID: An integer representing the node ID (to be converted in the new elementID string used by more recent versions of Neo4j);
- Properties: A Map using, as keys, the property names of the represented node. The Map values are the corresponding property values in Neo4j.
This object represents a results cell containing a Neo4j value. It contains the following properties:
- Value: A string representing the value returned by Neo4j;
This function sends a query to the Neo4j database with the specified configuration.
Input:
- Target: the Neo4j Component to send the query through;
- Query: the Cypher query to send;
- Operation: the operation type to use (among the Nel4jOperationEnum values);
- Transaction ID (Optional): the transaction ID to execute the query in. Will be returned by the event reporting the Neo4j result;
- Parameters (Optional): A Map using, as keys, the parameter names in the Neo4j query and, as values, the values corresponding to the parameters;
- Database: The database name on which to execute the query.
This event fires when the Neo4j result to a submitted query is available.
Data:
- Response transaction ID: the transaction ID corresponding to the submitted query;
- Neo4j response headers: the list of column names in the results table;
- Neo4j response rows: the list of rows in the results table.