diff --git a/docs-2.0/20.appendix/6.eco-tool-version.md b/docs-2.0/20.appendix/6.eco-tool-version.md index 9d577bacae..69aeed9fa6 100644 --- a/docs-2.0/20.appendix/6.eco-tool-version.md +++ b/docs-2.0/20.appendix/6.eco-tool-version.md @@ -1,19 +1,33 @@ # 生态工具概览 -不同版本的生态工具支持的Nebula Graph内核版本不同,本文介绍Nebula Graph内核版本 {{ nebula.release }} 和生态工具版本的对应关系。 +!!! compatibility -!!! Note + 内核版本号命名规则为 `X.Y.Z`,表示`大版本X`,`中版本Y`,`小版本Z`。对于客户端的升级要求为: - 1.x版本的生态工具不支持在Nebula Graph 2.x版本中使用。 + - 内核从`X.Y.Z1`升级成`X.Y.Z2`: 表示内核完全前向兼容,通常用于bugfix,建议尽快升级内核小版本。此时客户端可以**不升级**; + + - 内核从`X.Y1.*`升级成`X.Y2.*`: 表示存在 API、语法、返回值部分不兼容,通常用于增加功能、提升性能、代码优化等。需要客户端相应升级至`X.Y2.*`; + + - 内核从`X1.*.*`升级成`X2.*.*`: 表示存储格式、API 、语法等存在大的不兼容。需要使用工具升级内核数据;客户端必须升级; -!!! caution + - 默认内核及客户端都不支持降级:不可从`X.Y.Z2`降级成`X.Y.Z1`; + + - 一个新版本的发布周期大约为3个月,其维护与支持周期为6个月; + + - 命名中含有`RC`表示仅用于预览的非正式版本(`Release Candidate`),其维护周期仅至下个版本发布,其客户端、数据兼容性等均无保证。 + +!!! compatibility - 大多数工具和客户端**未发布**相对内核 {{ nebula.release }} 版本的适配。但通常{{ nebula.base200 }}的客户端前后向兼容 {{ nebula.release }} 的内核版本。 + 1.x版本的生态工具完全不支持在Nebula Graph 2.x版本中使用。 ## Nebula Graph Studio Nebula Graph Studio(简称 Studio)是一款可以通过Web访问的图数据库可视化工具,搭配Nebula Graph DBMS使用,提供构图、数据导入、编写nGQL查询、图探索等一站式服务。详情请参见[什么是Nebula Graph Studio](../nebula-studio/about-studio/st-ug-what-is-graph-studio.md)。 +!!! Note + + Studio 版本发布节奏独立于 Nebula Graph 内核,其命名方式也不参照内核命名规则,两者兼容对应关系如下表。 + |Nebula Graph版本|Studio版本| |:---|:---| | {{ nebula.release }} | 2.2.1 | @@ -74,7 +88,11 @@ Docker Compose可以快速部署Nebula Graph集群。如何使用请参见[Docke |:---|:---| | {{ nebula.release }} | 2.0.0(2c2549a) | -## API +## API、SDK + +!!! compatibility + + 选择与内核版本相同`X.Y.*`的最新版本。 |Nebula Graph版本| 语言(commit id) | |:---| :--- |