Chapter 4. Configuration

一个JanusGraph数据库集群可以包含一个或多个JanusGraph实例。需要提供一个配置用于创建一个JanusGraph实例。

JanusGraph配置指定了JanusGraph应使用哪些组件，控制JanusGraph部署的所有操作，并提供许多配置选项使的JanusGraph集群获得最大性能。

JanusGraph配置至少需要定义后端的存储引擎。第III部分“存储后端”列出了所有支持的存储引擎以及如何配置它们。如果需要高级图查询支持（例如全文搜索，地理搜索或范围查询），则需要配置其他索引后端。有关详细信息，请参见第IV部分“索引后端”。如果需要考虑查询性能，则应启用缓存。缓存配置和调优在第13章JanusGraph 缓存中描述。

4.1. 配置示例

下面是一些示例配置文件，用于演示如何配置最常用的存储后端，索引系统和性能组件。这仅涵盖了可用配置选项的一小部分。有关所有选项的完整列表，请参阅第15章：配置参考。

4.1.1. Cassandra+Elasticsearch

设置JanusGraph使用本地运行的Cassandra存储引擎和远程Elasticsearch索引系统：

storage.backend=cql
storage.hostname=localhost
 
index.search.backend=elasticsearch
index.search.hostname=100.100.101.1, 100.100.101.2
index.search.elasticsearch.client-only=true

4.1.2. HBase+Caching

设置JanusGraph使用远程运行的HBase存储引擎，为了获取更好的性能，同时使用JanusGraph的缓存组件。

storage.backend=hbase
storage.hostname=100.100.101.1
storage.port=2181
 
cache.db-cache = true
cache.db-cache-clean-wait = 20
cache.db-cache-time = 180000
cache.db-cache-size = 0.5

4.1.3. BerkeleyDB

设置JanusGraph使用BerkeleyDB作为嵌入式存储引擎，将Elasticsearch作为嵌入式索引系统。

storage.backend=berkeleyje
storage.directory=/tmp/graph
 
index.search.backend=elasticsearch
index.search.directory=/tmp/searchindex
index.search.elasticsearch.client-only=false
index.search.elasticsearch.local-mode=true

第15章：配置参考详细介绍了所有这些配置选项。 JanusGraph发行版的conf目录包含其他配置示例。

4.1.4. 更多示例

已有几个配置样例文件在conf目录下，可以用来快读启动janusgraph。文件路径可以用下面的 JanusGraphFactory.open(...)打开：

// Connect to Cassandra on localhost using a default configuration
graph = JanusGraphFactory.open("conf/janusgraph-cql.properties")
// Connect to HBase on localhost using a default configuration
graph = JanusGraphFactory.open("conf/janusgraph-hbase.properties")

4.2. 使用配置

配置如何提供给janusgraph取决于实例化模式。

4.2.1. JanusGraphFactory

4.2.1.1. Gremlin Console

JanusGraph发行版包含一个命令行工具Gremlin Console，很容易的与JanusGraph互动。执行bin/gremlin.sh (Unix/Linux) or bin/gremlin.bat (Windows) 来启动Console，然后打开JanusGraph用factory传入配置路径：

graph = JanusGraphFactory.open('path/to/configuration.properties')

4.2.1.2. 内嵌JanusGraph

JanusGraphFactory也能用来打开一个JVM的用户应用程序里的内嵌JanusGraph实例。这种情况，JanusGraph是用户程序的一部分，应用程序可以通过公共api直接调用JanusGraph。

4.2.1.3. 短代码

如果JanusGraph图集群先配置好了，只有后端存储需要被定义。JanusGraphFactory接受冒号分隔的string表示后端存储名称和目录（主机名）

graph = JanusGraphFactory.open('cql:localhost')
graph = JanusGraphFactory.open('berkeleyje:/tmp/graph')

4.2.2 JanusGraph Server

JanusGraph，自身是一个简单的jar文件集合，并没有执行线程。有两种基础方法连接和使用JanusGraph数据库：

可以在内嵌了Janusgraph的客户端程序使用，由该程序提供执行线程。
JanusGraph Server端，启动后允许远程client，或逻辑分离的程序调用。

JanusGraph Server用Apache Tinkerpop框架的Gremlin Server来服务客户端请求。JanusGraph提供外部的配置文件用于快速启动JanusGraph Server，但这个配置文件是能被改变来提供广泛的服务器能力。

可以通过yaml配置文件放在./conf/gremlin-server目录来配置JanusGraph Server。配置文件中配置一个图实例则需要如下设置：

...
graphs: {
  graph: conf/janusgraph-berkeleyje.properties
}
scriptEngines: {
  gremlin-groovy: {
    plugins: { org.janusgraph.graphdb.tinkerpop.plugin.JanusGraphGremlinPlugin: {},
               org.apache.tinkerpop.gremlin.server.jsr223.GremlinServerGremlinPlugin: {},
               org.apache.tinkerpop.gremlin.tinkergraph.jsr223.TinkerGraphGremlinPlugin: {},
               org.apache.tinkerpop.gremlin.jsr223.ImportGremlinPlugin: {classImports: [java.lang.Math], methodImports: [java.lang.Math#*]},
               org.apache.tinkerpop.gremlin.jsr223.ScriptFileGremlinPlugin: {files: [scripts/empty-sample.groovy]}}}}
...

图实例设置的入口首先定义了指定的janusgraph配置，上面例子是绑定配置到conf/janusgraph-berkeleyje.properties。下面的plugins入口激活janusgraph gremlin插件，完成自动import一些janusgraph classes，使远端执行脚本可以引用这些classes方法。

更多可以到Chapter 7, JanusGraph Server了解。

4.2.2.1 部署Server

JanusGraph的zip文件包含一个快速启动server组件。帮助更易于启动janusgraph在gremlin server上。执行bin/janusgraph.sh启动一个gremlin server with Cassandra and Elasticsearch。

注意：因为安全考虑，es默认必须运行在非root账户下。

4.3 全局配置

JanusGraph区分local和global配置参数。local配置参数应用一个独立的实例。global配置参数应用与集群中所有实例。根据的，janusgraph区分下面5种配置范围：

local：只作用于一个独立的janusgraph实例，当初始化实例时在配置中明确指定。
maskable：是local模式的兼容、可重写版本，如果local配置没有提供，则从global配置中读取。
global：集群配置作用于所有实例，不可被重写。
global_offline：类似global，但是变更时必须重启集群，确保集群中所有实例的配置一致。
fixed：类似global，但是集群启动后不可更改。

当集群的第一个实例被启动，从本地配置文件初始化global配置参数。通过management API可以即时改变global配置参数。访问management API，在打开的实例上调用g.getManagementSystem()处理g。例如，改变默认的集群cache：

mgmt = graph.openManagement()
mgmt.get('cache.db-cache')
// Prints the current config setting
mgmt.set('cache.db-cache', true)
// Changes option
mgmt.get('cache.db-cache')
// Prints 'true'
mgmt.commit()
// Changes take effect

4.3.1 改变offline参数

改变配置参数不会影响运行的实例，只会作用于新实例。改变global_offline需要重启集群，配置会即刻生效于所有实例。下面是操作步骤：

关闭集群中所有实例；
连接到一个单独的实例；
确认所有运行中事务已关闭；
确认不会有新事务启动（如集群必须offline）；
打开management API；
改变配置参数；
执行commit，会自动关闭当前实例；
重启所有实例；

更详细的配置参数说明请看 * Chapter 15, Configuration Reference *