GraphAware UUID is a simple library that transparently assigns a UUID to newly created nodes and relationships in the graph and makes sure nobody can (accidentally or intentionally) change or delete them.
When using Neo4j in the standalone server mode,
you will need the GraphAware Neo4j Framework and GraphAware Neo4j UUID .jar files (both of which you can download here) dropped
into the plugins directory of your Neo4j installation. After changing a few lines of config (read on) and restarting Neo4j, the module will do its magic.
Java developers that use Neo4j in embedded mode and those developing Neo4j server plugins, unmanaged extensions, GraphAware Runtime Modules, or Spring MVC Controllers can include use the UUID as a dependency for their Java project.
Releases are synced to Maven Central repository. When using Maven for dependency management, include the following dependency in your pom.xml.
<dependencies>
...
<dependency>
<groupId>com.graphaware.neo4j</groupId>
<artifactId>uuid</artifactId>
<version>2.3.3.37.8</version>
</dependency>
...
</dependencies>
To use the latest development version, just clone this repository, run mvn clean install and change the version in the
dependency above to 2.3.3.37.9-SNAPSHOT.
The version number has two parts. The first four numbers indicate compatibility with Neo4j GraphAware Framework. The last number is the version of the UUID library. For example, version 2.1.3.11.1 is version 1 of the UUID library compatible with GraphAware Neo4j Framework 2.1.3.11.
Edit neo4j.properties to register the UUID module:
com.graphaware.runtime.enabled=true
#UIDM becomes the module ID:
com.graphaware.module.UIDM.1=com.graphaware.module.uuid.UuidBootstrapper
#optional, default is uuid:
com.graphaware.module.UIDM.uuidProperty=uuid
#optional, default is all nodes:
com.graphaware.module.UIDM.node=hasLabel('Label1') || hasLabel('Label2')
#optional, default is no relationships:
com.graphaware.module.UIDM.relationship=isType('Type1')
#optional, default is uuidIndex
com.graphaware.module.UIDM.uuidIndex=uuidIndex
#optional, default is uuidRelIndex
com.graphaware.module.UIDM.uuidRelationshipIndex=uuidRelIndex
Note that "UIDM" becomes the module ID.
com.graphaware.module.UIDM.uuidProperty is the property name that will be used to store the assigned UUID on nodes and relationships. The default is "uuid".
com.graphaware.module.UIDM.node specifies either a fully qualified class name of NodeInclusionPolicy implementation,
or a Spring Expression Language expression determining, which nodes to assign a UUID to. The default is to assign the
UUID property to every node which isn't internal to the framework.
com.graphaware.module.UIDM.relationship specifies either a fully qualified class name of RelationshipInclusionPolicy implementation,
or a Spring Expression Language expression determining, which relationships to assign a UUID to. The default is not to assign the
UUID property to any relationship. If you want to assign UUID to all relationship, please use com.graphaware.module.UIDM.relationship=com.graphaware.runtime.policy.all.IncludeAllBusinessRelationships
com.graphaware.module.UIDM.uuidIndex is the index name that will be used to index nodes based on their UUID. The default is "uuidIndex".
com.graphaware.module.UIDM.uuidRelationshipIndex is the index name that will be used to index relationships based on their UUID. The default is "uuidRelIndex".
To use the UUID module programmatically, register the module like this
GraphAwareRuntime runtime = GraphAwareRuntimeFactory.createRuntime(database); //where database is an instance of GraphDatabaseService
UuidModule module = new UuidModule("UUIDM", UuidConfiguration.defaultConfiguration());
runtime.registerModule(module);
runtime.start();Alternatively:
GraphDatabaseService database = new GraphDatabaseFactory().newEmbeddedDatabaseBuilder(pathToDb)
.loadPropertiesFromFile(this.getClass().getClassLoader().getResource("neo4j.properties").getPath())
.newGraphDatabase();
//make sure neo4j.properties contain the lines mentioned in previous sectionApart from the configuration described above, the GraphAware UUID module requires nothing else to function. It will assign a UUID to nodes configured, and will prevent modifications to the UUID or deletion of the UUID property from these nodes by not allowing the transaction to commit. You can also retrieve a node by UUID.
In Server Mode, a node can be retrieved by its UUID via the REST API.
You can issue GET requests to http://your-server-address:7474/graphaware/uuid/{moduleId}/node/{uuid} to get the node ID for a given uuid.
GET requests to http://your-server-address:7474/graphaware/uuid/{moduleId}/relationship/{uuid} will get the relationship ID for a given uuid.
{moduleId} is the module ID the UUID Module was registered with. You can omit this part of the URL, in which case "UIDM" is assumed as the default value. If no node exists with the given UUID, a 404 status code will be returned.
To use the Java API to find a node by its UUID, please instantiate UuidReader and use the method getNodeIdByUuid or getRelationshipByUuid
UuidConfiguration configuration = getStartedRuntime(database).getModule(moduleId, UuidModule.class).getConfiguration();
UuidReader reader = UuidReader(configuration, database);
Node node = getNodeIdByUuid(uuid);
Relationship rel = getRelationshipByUuid(uuid);
Please refer to Javadoc for more detail.
Copyright (c) 2016 GraphAware
GraphAware is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.