Changelog

Version Compatibility

The JanusGraph project is growing along with the rest of the graph and big data ecosystem and utilized storage and indexing backends. Below are version compatibilities between the various versions of components. For dependent backend systems, different minor versions are typically supported as well. It is strongly encouraged to verify version compatibility prior to deploying JanusGraph.

Although JanusGraph may be compatible with older and no longer supported versions of its dependencies, users are warned that there are possible risks and security exposures with running software that is no longer supported or updated. Please check with the software providers to understand their supported versions. Users are strongly encouraged to use the latest versions of the software.

Version Compatibility Matrix

JanusGraph	Storage Version	Cassandra	HBase	Bigtable	Elasticsearch	Solr	TinkerPop	Spark	Scala
0.1.z	1	1.2.z, 2.0.z, 2.1.z	0.98.z, 1.0.z, 1.1.z, 1.2.z	0.9.z, 1.0.0-preZ, 1.0.0	1.5.z	5.2.z	3.2.z	1.6.z	2.10.z
0.2.z	1	1.2.z, 2.0.z, 2.1.z, 2.2.z, 3.0.z, 3.11.z	0.98.z, 1.0.z, 1.1.z, 1.2.z, 1.3.z	0.9.z, 1.0.0-preZ, 1.0.0	1.5-1.7.z, 2.3-2.4.z, 5.y, 6.y	5.2-5.5.z, 6.2-6.6.z, 7.y	3.2.z	1.6.z	2.10.z
0.3.z	2	1.2.z, 2.0.z, 2.1.z, 2.2.z, 3.0.z, 3.11.z	1.0.z, 1.1.z, 1.2.z, 1.3.z, 1.4.z	1.0.0, 1.1.0, 1.1.2, 1.2.0, 1.3.0, 1.4.0	1.5-1.7.z, 2.3-2.4.z, 5.y, 6.y	5.2-5.5.z, 6.2-6.6.z, 7.y	3.3.z	2.2.z	2.11.z
0.4.z	2	2.1.z, 2.2.z, 3.0.z, 3.11.z	1.2.z, 1.3.z, 1.4.z, 2.1.z	1.3.0, 1.4.0, 1.5.z, 1.6.z, 1.7.z, 1.8.z, 1.9.z, 1.10.z, 1.11.z	5.y, 6.y	7.y	3.4.z	2.2.z	2.11.z

Release Notes

Version 0.4.1 (Release Date: January 14, 2020)

MavenGradle

<dependency>
    <groupId>org.janusgraph</groupId>
    <artifactId>janusgraph-core</artifactId>
    <version>0.4.1</version>
</dependency>

compile "org.janusgraph:janusgraph-core:0.4.1"

Tested Compatibility:

• Apache Cassandra 2.2.10, 3.0.14, 3.11.0
• Apache HBase 1.2.6, 1.3.1, 1.4.10, 2.1.5
• Google Bigtable 1.3.0, 1.4.0, 1.5.0, 1.6.0, 1.7.0, 1.8.0, 1.9.0, 1.10.0, 1.11.0
• Oracle BerkeleyJE 7.5.11
• Elasticsearch 5.6.14, 6.0.1, 6.6.0
• Apache Lucene 7.0.0
• Apache Solr 7.0.0
• Apache TinkerPop 3.4.4
• Java 1.8

For more information on features and bug fixes in 0.4.1, see the GitHub milestone:

• https://github.com/JanusGraph/janusgraph/milestone/15?closed=1

Upgrade Instructions

TinkerPop: Upgrade from 3.4.1 to 3.4.4

Adding multiple values in the same query to a new vertex property without explicitly defined type (i.e. using Automatic Schema Maker to create a property type) requires explicit usage of VertexProperty.Cardinality for each call (only for the first query which defines a property) if the VertexProperty.Cardinality is different than VertexProperty.Cardinality.single.

Version 0.4.0 (Release Date: July 1, 2019)

Legacy documentation: https://old-docs.janusgraph.org/0.4.0/index.html

MavenGradle

<dependency>
    <groupId>org.janusgraph</groupId>
    <artifactId>janusgraph-core</artifactId>
    <version>0.4.0</version>
</dependency>

compile "org.janusgraph:janusgraph-core:0.4.0"

Tested Compatibility:

• Apache Cassandra 2.2.10, 3.0.14, 3.11.0
• Apache HBase 1.2.6, 1.3.1, 1.4.10, 2.1.5
• Google Bigtable 1.3.0, 1.4.0, 1.5.0, 1.6.0, 1.7.0, 1.8.0, 1.9.0, 1.10.0, 1.11.0
• Oracle BerkeleyJE 7.5.11
• Elasticsearch 5.6.14, 6.0.1, 6.6.0
• Apache Lucene 7.0.0
• Apache Solr 7.0.0
• Apache TinkerPop 3.4.1
• Java 1.8

For more information on features and bug fixes in 0.4.0, see the GitHub milestone:

• https://github.com/JanusGraph/janusgraph/milestone/8?closed=1

Upgrade Instructions

HBase: Upgrade from 1.2 to 2.1

The version of HBase that is included in the distribution of JanusGraph was upgraded from 1.2.6 to 2.1.5. HBase 2.x client is not fully backward compatible with HBase 1.x server. Users who operate their own HBase version 1.x cluster may need to upgrade their cluster to version 2.x. Optionally users may build their own distribution of JanusGraph which includes HBase 1.x from source with the maven flags -Dhbase.profile -Phbase1.

Cassandra: Upgrade from 2.1 to 2.2

The version of Cassandra that is included in the distribution of JanusGraph was upgraded from 2.1.20 to 2.2.13. Refer to the upgrade documentation of Cassandra for detailed instructions to perform this upgrade. Users who operate their own Cassandra cluster instead of using Cassandra distributed together with JanusGraph are not affected by this upgrade. This also does not change the different versions of Cassandra that are supported by JanusGraph (see <> for a detailed list of the supported versions).

BerkeleyDB : Upgrade from 7.4 to 7.5

The BerkeleyDB version has been updated, and it contains changes to the file format stored on disk (see the BerkeleyDB changelog for reference). This file format change is forward compatible with previous versions of BerkeleyDB, so existing graph data stored with JanusGraph can be read in. However, once the data has been read in with the newer version of BerkeleyDB, those files can no longer be read by the older version. Users are encouraged to backup the BerkeleyDB storage directory before attempting to use it with the JanusGraph release.

Solr: Compatible Lucene version changed from 5.0.0 to 7.0.0 in distributed config

The JanusGraph distribution contains a solrconfig.xml file that can be used to configure Solr. The value luceneMatchVersion in this config that tells Solr to behave according to that Lucene version was changed from 5.0.0 to 7.0.0 as that is the default version currently used by JanusGraph. Users should generally set this value to the version of their Solr installation. If the config distributed by JanusGraph is used for an existing Solr installation that used a lower version before (like 5.0.0 from a previous versions of this file), it is highly recommended that a re-indexing is performed.

Version 0.3.3 (Release Date: January 11, 2020)

MavenGradle

<dependency>
    <groupId>org.janusgraph</groupId>
    <artifactId>janusgraph-core</artifactId>
    <version>0.3.3</version>
</dependency>

compile "org.janusgraph:janusgraph-core:0.3.3"

Tested Compatibility:

• Apache Cassandra 2.1.20, 2.2.10, 3.0.14, 3.11.0
• Apache HBase 1.2.6, 1.3.1, 1.4.4
• Google Bigtable 1.0.0, 1.1.2, 1.2.0, 1.3.0, 1.4.0
• Oracle BerkeleyJE 7.4.5
• Elasticsearch 1.7.6, 2.4.6, 5.6.5, 6.0.1
• Apache Lucene 7.0.0
• Apache Solr 5.5.4, 6.6.1, 7.0.0
• Apache TinkerPop 3.3.3
• Java 1.8

For more information on features and bug fixes in 0.3.3, see the GitHub milestone:

• https://github.com/JanusGraph/janusgraph/milestone/14?closed=1

Version 0.3.2 (Release Date: June 16, 2019)

Legacy documentation: https://old-docs.janusgraph.org/0.3.2/index.html

MavenGradle

<dependency>
    <groupId>org.janusgraph</groupId>
    <artifactId>janusgraph-core</artifactId>
    <version>0.3.2</version>
</dependency>

compile "org.janusgraph:janusgraph-core:0.3.2"

Tested Compatibility:

• Apache Cassandra 2.1.20, 2.2.10, 3.0.14, 3.11.0
• Apache HBase 1.2.6, 1.3.1, 1.4.4
• Google Bigtable 1.0.0, 1.1.2, 1.2.0, 1.3.0, 1.4.0
• Oracle BerkeleyJE 7.4.5
• Elasticsearch 1.7.6, 2.4.6, 5.6.5, 6.0.1
• Apache Lucene 7.0.0
• Apache Solr 5.5.4, 6.6.1, 7.0.0
• Apache TinkerPop 3.3.3
• Java 1.8

For more information on features and bug fixes in 0.3.2, see the GitHub milestone:

• https://github.com/JanusGraph/janusgraph/milestone/10?closed=1

Version 0.3.1 (Release Date: October 2, 2018)

Legacy documentation: https://old-docs.janusgraph.org/0.3.1/index.html

MavenGradle

<dependency>
    <groupId>org.janusgraph</groupId>
    <artifactId>janusgraph-core</artifactId>
    <version>0.3.1</version>
</dependency>

compile "org.janusgraph:janusgraph-core:0.3.1"

Tested Compatibility:

• Apache Cassandra 2.1.20, 2.2.10, 3.0.14, 3.11.0
• Apache HBase 1.2.6, 1.3.1, 1.4.4
• Google Bigtable 1.0.0, 1.1.2, 1.2.0, 1.3.0, 1.4.0
• Oracle BerkeleyJE 7.4.5
• Elasticsearch 1.7.6, 2.4.6, 5.6.5, 6.0.1
• Apache Lucene 7.0.0
• Apache Solr 5.5.4, 6.6.1, 7.0.0
• Apache TinkerPop 3.3.3
• Java 1.8

For more information on features and bug fixes in 0.3.1, see the GitHub milestone:

• https://github.com/JanusGraph/janusgraph/milestone/7?closed=1

Version 0.3.0 (Release Date: July 31, 2018)

Legacy documentation: https://old-docs.janusgraph.org/0.3.0/index.html

MavenGradle

<dependency>
    <groupId>org.janusgraph</groupId>
    <artifactId>janusgraph-core</artifactId>
    <version>0.3.0</version>
</dependency>

compile "org.janusgraph:janusgraph-core:0.3.0"

Tested Compatibility:

• Apache Cassandra 2.1.20, 2.2.10, 3.0.14, 3.11.0
• Apache HBase 1.2.6, 1.3.1, 1.4.4
• Google Bigtable 1.0.0, 1.1.2, 1.2.0, 1.3.0, 1.4.0
• Oracle BerkeleyJE 7.4.5
• Elasticsearch 1.7.6, 2.4.6, 5.6.5, 6.0.1
• Apache Lucene 7.0.0
• Apache Solr 5.5.4, 6.6.1, 7.0.0
• Apache TinkerPop 3.3.3
• Java 1.8

For more information on features and bug fixes in 0.3.0, see the GitHub milestone:

• https://github.com/JanusGraph/janusgraph/milestone/4?closed=1

Upgrade Instructions

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.

Version 0.2.3 (Release Date: May 21, 2019)

Legacy documentation: https://old-docs.janusgraph.org/0.2.3/index.html

MavenGradle

<dependency>
    <groupId>org.janusgraph</groupId>
    <artifactId>janusgraph-core</artifactId>
    <version>0.2.3</version>
</dependency>

compile "org.janusgraph:janusgraph-core:0.2.3"

Tested Compatibility:

• Apache Cassandra 2.1.20, 2.2.10, 3.0.14, 3.11.0
• Apache HBase 0.98.24-hadoop2, 1.2.6, 1.3.1
• Google Bigtable 1.0.0
• Oracle BerkeleyJE 7.3.7
• Elasticsearch 1.7.6, 2.4.6, 5.6.5, 6.0.1
• Apache Lucene 7.0.0
• Apache Solr 5.5.4, 6.6.1, 7.0.0
• Apache TinkerPop 3.2.9
• Java 1.8

For more information on features and bug fixes in 0.2.3, see the GitHub milestone:

• https://github.com/JanusGraph/janusgraph/milestone/9?closed=1

Version 0.2.2 (Release Date: October 9, 2018)

Legacy documentation: https://old-docs.janusgraph.org/0.2.2/index.html

MavenGradle

<dependency>
    <groupId>org.janusgraph</groupId>
    <artifactId>janusgraph-core</artifactId>
    <version>0.2.2</version>
</dependency>

compile "org.janusgraph:janusgraph-core:0.2.2"

Tested Compatibility:

• Apache Cassandra 2.1.20, 2.2.10, 3.0.14, 3.11.0
• Apache HBase 0.98.24-hadoop2, 1.2.6, 1.3.1
• Google Bigtable 1.0.0
• Oracle BerkeleyJE 7.3.7
• Elasticsearch 1.7.6, 2.4.6, 5.6.5, 6.0.1
• Apache Lucene 7.0.0
• Apache Solr 5.5.4, 6.6.1, 7.0.0
• Apache TinkerPop 3.2.9
• Java 1.8

For more information on features and bug fixes in 0.2.2, see the GitHub milestone:

• https://github.com/JanusGraph/janusgraph/milestone/6?closed=1

Version 0.2.1 (Release Date: July 9, 2018)

Legacy documentation: https://old-docs.janusgraph.org/0.2.1/index.html

MavenGradle

<dependency>
    <groupId>org.janusgraph</groupId>
    <artifactId>janusgraph-core</artifactId>
    <version>0.2.1</version>
</dependency>

compile "org.janusgraph:janusgraph-core:0.2.1"

Tested Compatibility:

• Apache Cassandra 2.1.20, 2.2.10, 3.0.14, 3.11.0
• Apache HBase 0.98.24-hadoop2, 1.2.6, 1.3.1
• Google Bigtable 1.0.0
• Oracle BerkeleyJE 7.3.7
• Elasticsearch 1.7.6, 2.4.6, 5.6.5, 6.0.1
• Apache Lucene 7.0.0
• Apache Solr 5.5.4, 6.6.1, 7.0.0
• Apache TinkerPop 3.2.9
• Java 1.8

For more information on features and bug fixes in 0.2.1, see the GitHub milestone:

• https://github.com/JanusGraph/janusgraph/milestone/5?closed=1

Upgrade Instructions

HBase TTL

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.

Version 0.2.0 (Release Date: October 11, 2017)

Legacy documentation: https://old-docs.janusgraph.org/0.2.0/index.html

MavenGradle

<dependency>
    <groupId>org.janusgraph</groupId>
    <artifactId>janusgraph-core</artifactId>
    <version>0.2.0</version>
</dependency>

compile "org.janusgraph:janusgraph-core:0.2.0"

Tested Compatibility:

• Apache Cassandra 2.1.18, 2.2.10, 3.0.14, 3.11.0
• Apache HBase 0.98.24-hadoop2, 1.2.6, 1.3.1
• Google Bigtable 1.0.0-pre3
• Oracle BerkeleyJE 7.3.7
• Elasticsearch 1.7.6, 2.4.6, 5.6.2, 6.0.0-rc1
• Apache Lucene 7.0.0
• Apache Solr 5.5.4, 6.6.1, 7.0.0
• Apache TinkerPop 3.2.6
• Java 1.8

For more information on features and bug fixes in 0.2.0, see the GitHub milestone:

• https://github.com/JanusGraph/janusgraph/milestone/2?closed=1

Upgrade Instructions

Elasticsearch

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.

Transport 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()

Node client

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.

Legacy configuration

The legacy configuration track was not recommended in JanusGraph 0.1.z and is no longer supported in JanusGraph 0.2.0. Users should refer to the previous sections and migrate to the REST_CLIENT.

Version 0.1.1 (Release Date: May 11, 2017)

Documentation: https://old-docs.janusgraph.org/0.1.1/index.html

MavenGradle

<dependency>
    <groupId>org.janusgraph</groupId>
    <artifactId>janusgraph-core</artifactId>
    <version>0.1.1</version>
</dependency>

compile "org.janusgraph:janusgraph-core:0.1.1"

Tested Compatibility:

• Apache Cassandra 2.1.9
• Apache HBase 0.98.8-hadoop2, 1.0.3, 1.1.8, 1.2.4
• Google Bigtable 0.9.5.1
• Oracle BerkeleyJE 7.3.7
• Elasticsearch 1.5.1
• Apache Lucene 4.10.4
• Apache Solr 5.2.1
• Apache TinkerPop 3.2.3
• Java 1.8

For more information on features and bug fixes in 0.1.1, see the GitHub milestone:

• https://github.com/JanusGraph/janusgraph/milestone/3?closed=1

Version 0.1.0 (Release Date: April 11, 2017)

Documentation: https://old-docs.janusgraph.org/0.1.0/index.html

MavenGradle

<dependency>
    <groupId>org.janusgraph</groupId>
    <artifactId>janusgraph-core</artifactId>
    <version>0.1.0</version>
</dependency>

compile "org.janusgraph:janusgraph-core:0.1.0"

Tested Compatibility:

• Apache Cassandra 2.1.9
• Apache HBase 0.98.8-hadoop2, 1.0.3, 1.1.8, 1.2.4
• Google Bigtable 0.9.5.1
• Oracle BerkeleyJE 7.3.7
• Elasticsearch 1.5.1
• Apache Lucene 4.10.4
• Apache Solr 5.2.1
• Apache TinkerPop 3.2.3
• Java 1.8

Features added since version Titan 1.0.0:

• TinkerPop 3.2.3 compatibility

  • Includes update to Spark 1.6.1

• Query optimizations: JanusGraphStep folds in HasId and HasContainers can be folded in even mid-traversal

• Support Google Cloud Bigtable as a backend over the HBase interface

• Compatibility with newer versions of backend and index stores

  • HBase 1.2

  • BerkeleyJE 7.3.7

• Includes a number of bug fixes and optimizations

For more information on features and bug fixes in 0.1.0, see the GitHub milestone:

• https://github.com/JanusGraph/janusgraph/milestone/1?closed=1

Upgrade Instructions

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:

1. module names: titan-* are now janusgraph-*

2. package names: com.thinkaurelius.titan are now org.janusgraph

3. class names: Titan* are now JanusGraph* except in cases where this would duplicate a word, e.g., TitanGraph is simply JanusGraph rather than JanusGraphGraph

For more information on how to configure JanusGraph to read data which had previously been written by Titan refer to Migration from titan.