add appendices

docs/appendices/other_documentation_versions.md

@@ -0,0 +1,15 @@
+
+
+附录E.其他文档版本
+
+最新:
+
+* 版本0.3.1
+* 版本0.3.0
+* 版本0.2.2
+* 版本0.2.1
+* 版本0.2.0
+* 版本0.1.1
+* 版本0.1.0
+
+请访问此页面的最新在线版本,以查看完整的文档版本列表。

docs/appendices/release_notes.md

@@ -0,0 +1,192 @@
+
+### 附录C.发行说明
+
+C.1 版本0.3.1（发布日期：2018年10月2日）
+
+```
+<dependency> 
+   <groupId> org.janusgraph </groupId> 
+   <artifactId> janusgraph-core </artifactId> 
+   <version> 0.3.1 </version> 
+</dependency>
+```
+
+经测试的兼容性：
+
+* 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
+
+有关0.3.1中的功能和错误修复的更多信息，请参阅GitHub里程碑：
+
+https://github.com/JanusGraph/janusgraph/milestone/7?closed=1
+
+C.2 版本0.3.0（发布日期：2018年7月31日）
+
+```
+<dependency> 
+   <groupId> org.janusgraph </groupId> 
+   <artifactId> janusgraph-core </artifactId> 
+   <version> 0.3.0 </version> 
+</dependency>
+```
+经测试的兼容性：
+
+* 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
+
+有关0.3.0中的功能和错误修复的更多信息，请参阅GitHub里程碑：
+
+https://github.com/JanusGraph/janusgraph/milestone/4?closed=1
+
+C.3 版本0.2.2（发布日期：2018年10月2日）
+```
+<dependency> 
+   <groupId> org.janusgraph </groupId> 
+   <artifactId> janusgraph-core </artifactId> 
+   <version> 0.2.2 </version>
+</dependency>
+```
+
+经测试的兼容性：
+
+* 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.2,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
+
+有关0.2.2中的功能和错误修复的更多信息，请参阅GitHub里程碑：
+
+https://github.com/JanusGraph/janusgraph/milestone/6?closed=1
+
+C.4 版本0.2.1（发布日期：2018年7月9日）
+
+```
+<dependency> 
+   <groupId> org.janusgraph </groupId> 
+   <artifactId> janusgraph-core </artifactId> 
+   <version> 0.2.1 </version> 
+</dependency>
+```
+经测试的兼容性：
+
+* 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
+
+有关0.2.1中的功能和错误修复的更多信息，请参阅GitHub里程碑：
+
+https://github.com/JanusGraph/janusgraph/milestone/5?closed=1
+
+C.5. 版本0.2.0（发布日期：2017年10月11日）
+
+```
+<dependency> 
+   <groupId> org.janusgraph </groupId> 
+   <artifactId> janusgraph-core </artifactId> 
+   <version> 0.2.0 </version> 
+</dependency>
+```
+
+经测试的兼容性：
+
+* 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
+
+有关0.2.0中的功能和错误修复的更多信息，请参阅GitHub里程碑：
+
+https://github.com/JanusGraph/janusgraph/milestone/2?closed=1
+
+C.6. 版本0.1.1（发布日期：2017年5月11日）
+
+```
+<dependency> 
+   <groupId> org.janusgraph </groupId> 
+   <artifactId> janusgraph-core </artifactId> 
+   <version> 0.1.1 </version> 
+</dependency>
+```
+经测试的兼容性：
+
+* 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
+
+有关0.1.1中的功能和错误修复的更多信息，请参阅GitHub里程碑：
+
+https://github.com/JanusGraph/janusgraph/milestone/3?closed=1
+
+C.7. 版本0.1.0（发布日期：2017年4月11日）
+
+```
+<dependency> 
+   <groupId> org.janusgraph </groupId> 
+   <artifactId> janusgraph-core </artifactId> 
+   <version> 0.1.0 </version> 
+</dependency>
+```
+经测试的兼容性：
+
+* 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
+
+自Titan 1.0.0版本以来添加的功能：
+
+TinkerPop 3.2.3兼容性
+
+* 包括Spark 1.6.1的更新
+* 查询优化：HasId和HasContainers中的JanusGraphStep折叠甚至可以折叠到中间遍历
+* 支持Google Cloud Bigtable作为HBase接口的后端
+* 与较新版本的后端和索引存储的兼容性
+
+* HBase 1.2
+* BerkeleyJE 7.3.7
+* 包括一些错误修复和优化
+
+有关0.1.0中的功能和错误修复的更多信息，请参阅GitHub里程碑：
+
+https://github.com/JanusGraph/janusgraph/milestone/1?closed=1

docs/appendices/upgrade_instructions.md

@@ -0,0 +1,120 @@
+### 附录D.升级说明
+
+从Titan或较旧的JanusGraph版本升级时，请按照这些说明进行操作。
+
+### D.1.升级到JanusGraph 0.3.0
+
+```
+重要：
+您应该在尝试升级之前备份数据！另请注意，升级完成后，您将无法再使用0.3.0之前的客户端版本连接到您的图表。
+
+```
+
+JanusGraph 0.3.0实现了模式约束，这使得有必要引入模式版本的概念。有一个检查可以防止客户端连接,要么使用不同的架构版本，要么没有架构版本的概念。要执行升级
+
+必须在要升级的每个图上设置配置 graph.allow-upgrade=true 选项。必须使用0.3.0或更高版本的JanusGraph打开图表，因为旧版本没有相关概念，graph.storage-version也不允许设置它。
+
+janusgraph.properties文件摘录：
+
+
+
+```
+# 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
+
+```
+
+如果graph.allow-upgrade在图形上设置为true graph.storage-version，graph.janusgraph-version则会自动升级以匹配打开图形的服务器或本地客户端的版本级别。您可以验证升级是通过打开管理API和验证的值成功graph.storage-version和graph.janusgraph-version。设置存储版本后，应从graph.allow-upgrade=true属性文件中删除并重新打开图表以确保升级成功。
+
+
+### D.2.从Titan 1.0.0,1.1.0-SNAPSHOT升级
+
+JanusGraph基于对Titan repotitan11分支 的最新承诺。
+JanusGraph对Titan进行了以下更改，因此您需要相应地调整代码和配置：
+
+* 模块名称：titan-*现在janusgraph-*
+* 包名：com.thinkaurelius.titan现在org.janusgraph
+* 类名：Titan*现在JanusGraph*除了这会复制一个单词的情况，例如，TitanGraph简单JanusGraph而不是 JanusGraphGraph
+
+有关如何配置JanusGraph以读取先前由Titan编写的数据的更多信息，请参阅第39章“ 从Titan迁移”。
+
+###D.3.从JanusGraph 0.1.z升级
+###### D.3.1.Elasticsearch
+
+JanusGraph 0.1.z与Elasticsearch 1.5.z兼容。有几种可用的配置选项，包括传输客户端，节点客户端和旧配置跟踪。JanusGraph 0.2.0与1.y到6.y的Elasticsearch版本兼容，但它只使用REST客户端提供单个配置选项。
+
+###### D.3.1.1.TRANSPORT_CLIENT
+
+该TRANSPORT_CLIENT接口已被替换REST_CLIENT。将现有图形迁移到JanusGraph 0.2.0时，interface必须在连接到图形时设置该属性：
+
+```
+index.search.backend=elasticsearch
+index.search.elasticsearch.interface=REST_CLIENT
+index.search.hostname=127.0.0.1
+```
+
+连接到图表后，可以通过以下方式进行更改，使属性更新成为永久更新JanusGraphManagement：
+
+```
+mgmt = graph.openManagement()
+mgmt.set("index.search.elasticsearch.interface", "REST_CLIENT")
+mgmt.commit()
+```
+###### D.3.1.2.节点客户端
+
+可以通过几种方式配置具有JanusGraph的节点客户端。如果节点客户端配置为仅客户端或非数据节点，请按照传输客户端部分中的步骤使用相应的连接到现有群集REST_CLIENT。如果节点客户端是数据节点（本地模式），则将其转换为独立的Elasticsearch节点，该节点在应用程序进程的单独JVM中运行。这可以通过使用JanusGraph配置中的节点配置来启动独立的Elasticsearch 1.5.z节点来完成。例如，我们从这些JanusGraph 0.1.z属性开始：
+
+
+```
+index.search.backend=elasticsearch
+index.search.elasticsearch.interface=NODE
+index.search.conf-file=es-client.yml
+index.search.elasticsearch.ext.node.name=alice
+```
+配置文件es-client.yml具有属性的位置：
+
+```
+node.data: true
+path.data: /var/lib/elasticsearch/data
+path.work: /var/lib/elasticsearch/work
+path.logs: /var/log/elasticsearch
+```
+可以插入配置文件中es-client.yml的index.search.elasticsearch.ext.*属性和 属性，$ES_HOME/config/elasticsearch.yml 以便可以使用相同的属性启动独立的Elasticsearch 1.5.z节点。请记住，如果任何path位置具有相对路径，则可能需要适当更新这些值。启动独立Elasticsearch节点后，请按照传输客户端 部分中的说明完成到REST_CLIENT界面的迁移。请注意，接口中不使用index.search.conf-file和index.search.elasticsearch.ext.*属性REST_CLIENT，因此可以从配置属性中删除它们。
+
+###### D.3.1.3.旧版配置
+JanusGraph 0.1.z不推荐使用旧版配置跟踪，而且JanusGraph 0.2.0不再支持它们。用户应参考前面的部分并迁移到REST_CLIENT。
+
+### D.4.从JanusGraph 0.2.0升级
+
+###### D.4.1.HBase TTL
+在JanusGraph 0.2.0中，为HBase存储后端添加了生存时间（TTL）支持。为了利用HBase上的TTL功能，图形时间戳需要为MILLI。如果该graph.timestamps属性未明确设置为MILLI，则默认值为JanusGraph 0.2.0中的MICRO，这会对HBase TTL不起作用。由于graph.timestamps 属性是FIXED，因此需要创建新图表以使graph.timestamps 属性的更改生效。

docs/appendices/version_compatibility.md

@@ -0,0 +1,15 @@
+
+
+附录B.版本兼容性
+
+JanusGraph项目协同其它的图表和大数据生态系统一起发展，并使用存储和索引后端。以下是各种组件版本之间的版本兼容性。
+
+对于依赖的后端系统，也支持其它不同的次要的版本。强烈建议在部署JanusGraph之前验证版本兼容性。尽管JanusGraph可能与较旧且不再受支持的依赖项版本兼容，但会警告用户使用不再支持或更新的运行软件可能存在风险和安全风险。请与软件提供商联系以了解其支持的版本。强烈建议用户使用最新版本的软件。
+
+表B.1 版本兼容表
+
+| 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.2.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 |