Neo4jConnect

Neo4j database connection

Description

Create a Neo4j^® database connection using the MATLAB^® interface to Neo4j with the REST API. With the Neo4j database connection, you can explore the graph database, update the graph database, store a MATLAB directed graph, and perform graph analytics using the MATLAB directed graph.

You can also create a Neo4j database connection using the Database Toolbox™ Interface for Neo4j Bolt Protocol. To use this interface, you must install the Database Toolbox Interface for Neo4j Bolt Protocol. For details, see Database Toolbox Interface for Neo4j Bolt Protocol Installation.

With a Neo4jConnect object, you can perform these tasks:

• Explore the graph database for nodes and relationships.

• Search the graph database for nodes, relationships, or a subgraph.

• Store a directed graph.

• Update nodes and relationships in the graph database.

• Execute a Cypher^® query.

Creation

Create a Neo4jConnect object using neo4j.

Properties

URL — Neo4j database connection URL

character vector

This property is read-only.

Neo4j database connection URL that contains the server, port number, and web location of the Neo4j database, specified as a character vector.

If you specify a Bolt database connection URL using the Database Toolbox Interface for Neo4j Bolt Protocol, then the neo4j function creates a Bolt connection instead.

Example: http://localhost:7474/db/data specifies using the HTTP protocol where localhost is the server, 7474 is the port number, and /db/data is the web location of the database.

Example: bolt://localhost:7687/db/data specifies using the Bolt protocol where localhost is the server, 7687 is the port number, and /db/data is the web location of the database.

Data Types: char

UserName — User name

character vector

This property is read-only.

User name for accessing the Neo4j database, specified as a character vector.

Data Types: char

Message — Error message

character vector

This property is read-only.

Error message, specified as a character vector. If this property is empty, the database connection is successful.

Data Types: char

Object Functions

Graph Database Connection

close

Close Neo4j database connection

Traverse the Graph

nodeLabels	All node labels in Neo4j database
relationTypes	All relationship types in Neo4j database
propertyKeys	All property keys in Neo4j database
searchNodeByID	Search Neo4j database nodes by node identifier
searchNode	Search Neo4j database nodes by label or by property key and value
searchRelation	Search relationships for Neo4j database node
searchRelationByID	Search Neo4j relationship by relationship identifier
searchGraph	Search for subgraph or entire graph in Neo4j database

Update the Graph

createNode	Create nodes in Neo4j database
createRelation	Create relationships between nodes in Neo4j database
deleteNode	Delete nodes from Neo4j database
deleteRelation	Delete relationships from Neo4j database

Update Labels and Properties in Graph

addNodeLabel	Add labels to nodes in Neo4j database
removeNodeLabel	Remove labels from nodes in Neo4j database
removeNodeProperty	Remove properties from nodes in Neo4j database
removeRelationProperty	Remove properties from relationships in Neo4j database
setNodeProperty	Set properties for nodes in Neo4j database
setRelationProperty	Set properties for relationships in Neo4j database
updateNode	Update node labels and properties in Neo4j database
updateRelation	Update relationship properties in Neo4j database

Store Directed Graph

storeDigraph

Store directed graph in Neo4j database

Execute Cypher Query

executeCypher

Execute Cypher query on Neo4j database

Examples

Connect to Neo4j Database

Create a Neo4j® database connection using the URL http://localhost:7474/db/data, user name neo4j, and password matlab.

url = 'http://localhost:7474/db/data';
username = 'neo4j';
password = 'matlab';

neo4jconn = neo4j(url,username,password)

neo4jconn = 
  Neo4jConnect with properties:

         URL: 'http://localhost:7474/db/data/'
    UserName: 'neo4j'
     Message: []

neo4j returns a Neo4jConnect object with these properties:

• URL — The Neo4j database web location

• UserName — The user name used to connect to the database

• Message — Any database connection error messages

Check the Message property of the Neo4j connection object neo4jconn. The blank Message property indicates a successful Neo4j database connection.

neo4jconn.Message

ans =

     []

Retrieve all node labels using the Neo4j database connection neo4jconn. The cell array nlabels contains a character vector for the one node label in the Neo4j database.

nlabels = nodeLabels(neo4jconn)

nlabels = 1×1 cell array
    {'Person'}

Close the database connection.

close(neo4jconn)

Version History

Introduced in R2016b