Please follow these instructions when upgrading from Titan or an older JanusGraph release.
Important | |
---|---|
You should back-up your data prior to attempting an upgrade! Also please note that once an upgrade has been completed you will no longer be able to connect to your graph with client versions prior to 0.3.0. |
JanusGraph 0.3.0 implements schema constraints which made it necessary to also introduce the concept of a schema version. There is a check to prevent client connections that either expect a different schema version or have no concept of a schema version. To perform an upgrade, the configuration option graph.allow-upgrade=true
must be set on each graph you wish to upgrade. The graph must be opened with a 0.3.0 or greater version of JanusGraph since older versions have no concept of graph.storage-version
and will not allow for it to be set.
Example excerpt from janusgraph.properties
file
# JanusGraph configuration sample: Cassandra over a socket # # This file connects to a Cassandra daemon running on localhost via # Thrift. Cassandra must already be started before starting JanusGraph # with this file. # This option should be removed as soon as the upgrade is complete. Otherwise if this file # is used in the future to connect to a different graph it could cause an unintended upgrade. graph.allow-upgrade=true gremlin.graph=org.janusgraph.core.JanusGraphFactory # The primary persistence provider used by JanusGraph. This is required. # It should be set one of JanusGraph's built-in shorthand names for its # standard storage backends (shorthands: berkeleyje, cassandrathrift, # cassandra, astyanax, embeddedcassandra, cql, hbase, inmemory) or to the # full package and classname of a custom/third-party StoreManager # implementation. # # Default: (no default value) # Data Type: String # Mutability: LOCAL storage.backend=cassandrathrift # The hostname or comma-separated list of hostnames of storage backend # servers. This is only applicable to some storage backends, such as # cassandra and hbase. # # Default: 127.0.0.1 # Data Type: class java.lang.String[] # Mutability: LOCAL storage.hostname=127.0.0.1
If graph.allow-upgrade
is set to true on a graph graph.storage-version
and graph.janusgraph-version
will automatically be upgraded to match the version level of the server, or local client, that is opening the graph.
You can verify the upgrade was successful by opening the management API and validating the values of graph.storage-version
and graph.janusgraph-version
.
Once the storage version has been set you should remove graph.allow-upgrade=true
from your properties file and reopen your graph to ensure that the upgrade was successful.
JanusGraph is based on the latest commit to the titan11
branch of
Titan repo.
JanusGraph has made the following changes to Titan, so you will need to adjust your code and configuration accordingly:
- module names:
titan-*
are nowjanusgraph-*
- package names:
com.thinkaurelius.titan
are noworg.janusgraph
- class names:
Titan*
are nowJanusGraph*
except in cases where this would duplicate a word, e.g.,TitanGraph
is simplyJanusGraph
rather thanJanusGraphGraph
For more information on how to configure JanusGraph to read data which had previously been written by Titan refer to Chapter 39, Migrating from Titan.
JanusGraph 0.1.z is compatible with Elasticsearch 1.5.z. There were several configuration options available, including transport client, node client, and legacy configuration track. JanusGraph 0.2.0 is compatible with Elasticsearch versions from 1.y through 6.y, however it offers only a single configuration option using the REST client.
The TRANSPORT_CLIENT
interface has been replaced with REST_CLIENT
. When
migrating an existing graph to JanusGraph 0.2.0, the interface
property must
be set when connecting to the graph:
index.search.backend=elasticsearch index.search.elasticsearch.interface=REST_CLIENT index.search.hostname=127.0.0.1
After connecting to the graph, the property update can be made permanent by
making the change with JanusGraphManagement
:
mgmt = graph.openManagement() mgmt.set("index.search.elasticsearch.interface", "REST_CLIENT") mgmt.commit()
A node client with JanusGraph can be configured in a few ways. If the node
client was configured as a client-only or non-data node, follow the steps
from the transport client section to connect to the
existing cluster using the REST_CLIENT
instead. If the node client was
a data node (local-mode), then convert it into a standalone Elasticsearch
node, running in a separate JVM from your application process. This can be
done by using the node’s configuration from the JanusGraph configuration to
start a standalone Elasticsearch 1.5.z node. For example, we start with these
JanusGraph 0.1.z properties:
index.search.backend=elasticsearch index.search.elasticsearch.interface=NODE index.search.conf-file=es-client.yml index.search.elasticsearch.ext.node.name=alice
where the configuration file es-client.yml
has properties:
node.data: true path.data: /var/lib/elasticsearch/data path.work: /var/lib/elasticsearch/work path.logs: /var/log/elasticsearch
The properties found in the configuration file es-client.yml
and the
index.search.elasticsearch.ext.*
properties can be inserted into $ES_HOME/config/elasticsearch.yml
so that a standalone Elasticsearch 1.5.z node can be started with the same
properties. Keep in mind that if any path
locations have relative paths,
those values may need to be updated appropriately. Once the standalone
Elasticsearch node is started, follow the directions in the transport client
section to complete the migration to the REST_CLIENT
interface. Note that
the index.search.conf-file
and index.search.elasticsearch.ext.*
properties
are not used by the REST_CLIENT
interface, so they can be removed from the
configuration properties.
In JanusGraph 0.2.0, time-to-live (TTL) support was added for HBase storage backend.
In order to utilize the TTL capability on HBase, the graph timestamps need to be
MILLI. If the graph.timestamps
property is not explicitly set to MILLI, the default
is MICRO in JanusGraph 0.2.0, which does not work for HBase TTL. Since the graph.timestamps
property is FIXED, a new graph needs to be created to make any change of the graph.timestamps
property effective.