From 5dbcaf86f46c9634ec67cbc6a69acba90a20bd18 Mon Sep 17 00:00:00 2001 From: He Wang Date: Wed, 30 Nov 2022 02:09:12 +0800 Subject: [PATCH] [doc] update version compatibility about groupId and artifactId (#62) --- docs/quickstart/logproxy-client-tutorial-cn.md | 12 ++++++++++++ docs/quickstart/logproxy-client-tutorial.md | 16 ++++++++++++++-- 2 files changed, 26 insertions(+), 2 deletions(-) diff --git a/docs/quickstart/logproxy-client-tutorial-cn.md b/docs/quickstart/logproxy-client-tutorial-cn.md index 9899384..5ab1d46 100644 --- a/docs/quickstart/logproxy-client-tutorial-cn.md +++ b/docs/quickstart/logproxy-client-tutorial-cn.md @@ -230,6 +230,18 @@ LogProxyClient client = new LogProxyClient("127.0.0.1", 2983, config, clientConf ### 版本兼容性 +##### 组件ID + +最初版本的 LogProxy 客户端使用 `'groupId'='com.oceanbase.logclient'`,`'artifactId'='logproxy-client'`,从 `1.1.0` 开始,更改组件 ID 为 `'groupId'='com.oceanbase'`,`'artifactId'='oblogclient-logproxy'`。如果你想使用旧版本的 LogProxy 客户端,可以在 Maven 中使用如下方式引入: + +```xml + + com.oceanbase.logclient + logproxy-client + 1.0.7 + +``` + ##### 数据压缩 LogProxy 社区版从 1.0.1 开始默认会对发送到客户端的数据进行压缩,正确解压缩需要使用客户端 1.0.4 或之后的版本。 diff --git a/docs/quickstart/logproxy-client-tutorial.md b/docs/quickstart/logproxy-client-tutorial.md index a8a1966..74c3fdc 100644 --- a/docs/quickstart/logproxy-client-tutorial.md +++ b/docs/quickstart/logproxy-client-tutorial.md @@ -71,7 +71,7 @@ To connect to LogProxy, there are some options in `ObReaderConfig`: Empty String setClusterUrl - The url used to get information about OceanBase servers. Query with show parameters like 'obconfig_url' using user of `sys` tenant, and you can get it at the `value` field. + The url used to get information about servers of OceanBase Enterprise Edition. Query with show parameters like 'obconfig_url' using user of `sys` tenant, and you can get it at the `value` field. rootserver_list @@ -79,7 +79,7 @@ To connect to LogProxy, there are some options in `ObReaderConfig`: Empty String setRsList - The OceanBase server list. Query with show parameters like 'rootservice_list' using user of `sys` tenant, and you can get it at the `value` field. + The server list of OceanBase Community Edition. Query with show parameters like 'rootservice_list' using user of `sys` tenant, and you can get it at the `value` field. cluster_user @@ -230,6 +230,18 @@ LogProxyClient client = new LogProxyClient("127.0.0.1", 2983, config, clientConf ### Version Compatibility +#### GroupId and ArtifactId + +The initial version of LogProxy client is released with `'groupId'='com.oceanbase.logclient'` and `'artifactId'='logproxy-client'`, and we use `'groupId'='com.oceanbase'` and `'artifactId'='oblogclient-logproxy'` since `1.1.0`. If you want to use a legacy version of LogProxy client, you can add it to Maven as following: + +```xml + + com.oceanbase.logclient + logproxy-client + 1.0.7 + +``` + #### Record Compression The log proxy compresses the record data by default from `1.0.1`, and to decompress the data properly, you should use `1.0.4` or later version of the client. -- GitLab