From 43f2d6a46c02dc8165a92815862d87470dbf4b0f Mon Sep 17 00:00:00 2001 From: dl239 Date: Sat, 7 May 2022 01:58:32 -0500 Subject: [PATCH] docs: upgrade 0.5.0 version (#1755) --- CHANGELOG.md | 30 ++++++++++ docs/en/about/milestones.md | 1 + docs/en/about/release_notes.md | 31 ++++++++++ docs/en/deploy/compile.md | 10 ++-- docs/en/deploy/install_deploy.md | 60 +++++++++---------- docs/en/quickstart/java_sdk.md | 10 ++-- .../pulsar_openmldb_connector_demo.md | 4 +- docs/zh/README.md | 2 +- docs/zh/SUMMARY.md | 3 +- docs/zh/about/release_notes.md | 31 ++++++++++ docs/zh/deploy/compile.md | 12 ++-- docs/zh/deploy/install_deploy.md | 60 +++++++++---------- docs/zh/quickstart/java_sdk.md | 10 ++-- docs/zh/quickstart/openmldb_quickstart.md | 4 +- docs/zh/reference/ip_tips.md | 6 +- docs/zh/tutorial/modes.md | 2 +- .../pulsar_openmldb_connector_demo.md | 4 +- 17 files changed, 187 insertions(+), 93 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 128c0abdd2a..396dce984ca 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,35 @@ # Changelog +## [0.5.0] - 2022-05-07 + +### Features +- Support long window (#1532 #1573 #1583 #1622 #1627 #1672 # 1712 @zhanghaohit @nautaa) +- Register udf from external dynamic library (#1509 #1733 #1700 @dl239 @tobegit3hub) +- Support persistent storage engine enabled by Rocksdb (#1483 @Leowner) +- Add new SQL commands like `SHOW COMPONENTS`, `SHOW TABLE STATUS` (#1380 #1431 #1704 @aceforeverd) +- Support set global variables (#1310 #1359 #1364 @keyu813 @aceforeverd) +- Support reading Spark conf file from cli (#1600 @tobegit3hub) +- Support Spark local mode with multiple threads (#1675 @tobegit3hub) +- Optimize join condition expr (#1502 tobegit3hub) +- Add check for TaskManager config (#1262 @tobegit3hub) +- Add tracker service to track unfinished jobs (#1474 @tobegit3hub) +- Other minor features (#1601 @dl239; #1574 @vagetablechicken; #1546 @keyu813; #1729 @vagetablechicken; #1460 @tobegit3hub) + +### Bug Fixes +- Wrong result when query on index (#1709 @aceforeverd) +- `lag`/`at`/`lead` results is wrong (#1605 @aceforeverd) +- Memory leak in zk_client (#1660 @wuxiaobai24) +- Update catalog if leade role changed (#1655 @dl239) +- Fix unsaferow relavent problems(#1298, #1312, #1326, #1362, #1637, #1381, #1731 @tobegit3hub) +- Query result is incorrect after adding a new index in standalone mode (#1721 @keyu813) +- Fail to get correct result for `SHOW JOBS` command(#1453 @tobegit3hub) +- Result is incorrect for date columns with `UnsafeRowOpt`(#1469 @tobegit3hub) +- Other minor bug fix (#1698 @kfiring; #1651 @kutlayacar; #1621 @KaidoWang; #1150, #1243 @tobegit3hub; ) + +### Code Refactoring +#1616 @dl239; #1743 @zjx1319 + + ## [0.4.4] - 2022-04-01 ### Features diff --git a/docs/en/about/milestones.md b/docs/en/about/milestones.md index e4c5260b338..f66e37f24d9 100644 --- a/docs/en/about/milestones.md +++ b/docs/en/about/milestones.md @@ -28,6 +28,7 @@ In 2021, the development team abstracted, enhanced, and added many community-fri - 2021.12: Host the first Feature Store Meetup in China - 2022.1: v0.4.0 released, enhancing the SQL-centric development experience, introducing the new online monitoring module - 2022.1: OpenMLDB first community meeting +- 2022.5: v0.5.0 released, supporting long window and persistent storage engine, registering udf from external dynamic library ## 3. Roadmap diff --git a/docs/en/about/release_notes.md b/docs/en/about/release_notes.md index 73d057b408a..0cd8120127c 100644 --- a/docs/en/about/release_notes.md +++ b/docs/en/about/release_notes.md @@ -1,3 +1,34 @@ +# v0.5.x Release Notes + +## v0.5.0 Release Notes + +### Features +- Support long window (#1532 #1573 #1583 #1622 #1627 #1672 # 1712 @zhanghaohit @nautaa) +- Register udf from external dynamic library (#1509 #1733 #1700 @dl239 @tobegit3hub) +- Support persistent storage engine enabled by Rocksdb (#1483 @Leowner) +- Add new SQL commands like `SHOW COMPONENTS`, `SHOW TABLE STATUS` (#1380 #1431 #1704 @aceforeverd) +- Support set global variables (#1310 #1359 #1364 @keyu813 @aceforeverd) +- Support reading Spark conf file from cli (#1600 @tobegit3hub) +- Support Spark local mode with multiple threads (#1675 @tobegit3hub) +- Optimize join condition expr (#1502 tobegit3hub) +- Add check for TaskManager config (#1262 @tobegit3hub) +- Add tracker service to track unfinished jobs (#1474 @tobegit3hub) +- Other minor features (#1601 @dl239; #1574 @vagetablechicken; #1546 @keyu813; #1729 @vagetablechicken; #1460 @tobegit3hub) + +### Bug Fixes +- Wrong result when query on index (#1709 @aceforeverd) +- `lag`/`at`/`lead` results is wrong (#1605 @aceforeverd) +- Memory leak in zk_client (#1660 @wuxiaobai24) +- Update catalog if leade role changed (#1655 @dl239) +- Fix unsaferow relavent problems(#1298, #1312, #1326, #1362, #1637, #1381, #1731 @tobegit3hub) +- Query result is incorrect after adding a new index in standalone mode (#1721 @keyu813) +- Fail to get correct result for `SHOW JOBS` command(#1453 @tobegit3hub) +- Result is incorrect for date columns with `UnsafeRowOpt`(#1469 @tobegit3hub) +- Other minor bug fix (#1698 @kfiring; #1651 @kutlayacar; #1621 @KaidoWang; #1150, #1243 @tobegit3hub; ) + +### Code Refactoring +#1616 @dl239; #1743 @zjx1319 + # v0.4.x Release Notes ## v0.4.4 Release Notes diff --git a/docs/en/deploy/compile.md b/docs/en/deploy/compile.md index 4be4541cacb..e6b7f4cc343 100644 --- a/docs/en/deploy/compile.md +++ b/docs/en/deploy/compile.md @@ -8,25 +8,25 @@ Build This section describes the steps to compile and use OpenMLDB inside its official docker image [hybridsql](https://hub.docker.com/r/4pdosc/hybridsql). The docker image has packed required tools and dependencies, so there is no need to set them up separately. To compile without the official docker image, refer to the section [Detailed Instructions for Build](#detailed-instructions-for-build) below. -Keep in mind that you should always use the same version of both compile image and [OpenMLDB version](https://github.com/4paradigm/OpenMLDB/releases). This section demonstrates compiling for [OpenMLDB v0.4.4](https://github.com/4paradigm/OpenMLDB/releases/tag/v0.4.4) under `hybridsql:0.4.4` ,If you prefer to compile on the latest code in `main` branch, pull `hybridsql:latest` image instead. +Keep in mind that you should always use the same version of both compile image and [OpenMLDB version](https://github.com/4paradigm/OpenMLDB/releases). This section demonstrates compiling for [OpenMLDB v0.5.0](https://github.com/4paradigm/OpenMLDB/releases/tag/v0.5.0) under `hybridsql:0.5.0` ,If you prefer to compile on the latest code in `main` branch, pull `hybridsql:latest` image instead. 1. Pull the docker image ```bash - docker pull 4pdosc/hybridsql:0.4.4 + docker pull 4pdosc/hybridsql:0.5 ``` 2. Create a docker container with the hybridsql docker image ```bash - docker run -it 4pdosc/hybridsql:0.4.4 bash + docker run -it 4pdosc/hybridsql:0.5 bash ``` -3. Download the OpenMLDB source code inside the docker container, and setting the branch into v0.4.4 +3. Download the OpenMLDB source code inside the docker container, and setting the branch into v0.5.0 ```bash cd ~ - git clone -b v0.4.4 https://github.com/4paradigm/OpenMLDB.git + git clone -b v0.5.0 https://github.com/4paradigm/OpenMLDB.git ``` 4. Compile OpenMLDB diff --git a/docs/en/deploy/install_deploy.md b/docs/en/deploy/install_deploy.md index 824d11919ee..97d8916e71a 100644 --- a/docs/en/deploy/install_deploy.md +++ b/docs/en/deploy/install_deploy.md @@ -9,7 +9,7 @@ * The number of cores is recommended to be no less than 4 cores. If the CPU does not support the AVX2 instruction set in the Linux environment, the deployment package needs to be recompiled from the source code. ## Deployment Package -The precompiled OpenMLDB deployment package is used by default in this documentation ([Linux](https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.3/openmldb-0.4.3-linux.tar.gz) , [macOS](https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.3/openmldb-0.4.3-darwin.tar.gz)), the supported operating system requirements are: CentOS 7, Ubuntu 20.04, macOS >= 10.15. If the user wishes to compile by himself (for example, for OpenMLDB source code development, the operating system or CPU architecture is not in the support list of the precompiled deployment package, etc.), the user can choose to compile and use in the docker container or compile from the source code. For details, please refer to our [compile documentation](compile.md). +The precompiled OpenMLDB deployment package is used by default in this documentation ([Linux](https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz) , [macOS](https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-darwin.tar.gz)), the supported operating system requirements are: CentOS 7, Ubuntu 20.04, macOS >= 10.15. If the user wishes to compile by himself (for example, for OpenMLDB source code development, the operating system or CPU architecture is not in the support list of the precompiled deployment package, etc.), the user can choose to compile and use in the docker container or compile from the source code. For details, please refer to our [compile documentation](compile.md). ## Configure Environment (Linux) @@ -78,10 +78,10 @@ OpenMLDB standalone version needs to deploy a nameserver and a tablet. The names #### 1. Download the OpenMLDB Deployment Package ``` -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.3/openmldb-0.4.3-linux.tar.gz -tar -zxvf openmldb-0.4.3-linux.tar.gz -mv openmldb-0.4.3-linux openmldb-tablet-0.4.3 -cd openmldb-tablet-0.4.3 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-tablet-0.5.0 +cd openmldb-tablet-0.5.0 ``` #### 2. Modify the Configuration File: conf/standalone_tablet.flags @@ -110,10 +110,10 @@ sh bin/start.sh start standalone_tablet #### 1. Download the OpenMLDB Deployment Package ``` -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.3/openmldb-0.4.3-linux.tar.gz -tar -zxvf openmldb-0.4.3-linux.tar.gz -mv openmldb-0.4.3-linux openmldb-ns-0.4.3 -cd openmldb-ns-0.4.3 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-ns-0.5.0 +cd openmldb-ns-0.5.0 ``` #### 2. Modify the Configuration File: conf/standalone_nameserver.flags @@ -153,10 +153,10 @@ Before starting the APIServer, make sure that the OpenMLDB cluster has been star #### 1. Download the OpenMLDB Deployment Package ``` -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.3/openmldb-0.4.3-linux.tar.gz -tar -zxvf openmldb-0.4.3-linux.tar.gz -mv openmldb-0.4.3-linux openmldb-apiserver-0.4.3 -cd openmldb-apiserver-0.4.3 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-apiserver-0.5.0 +cd openmldb-apiserver-0.5.0 ``` #### 2. Modify the Configuration File: conf/standalone_apiserver.flags @@ -219,10 +219,10 @@ Deploy the Zookeeper cluster [refer to here](https://zookeeper.apache.org/doc/r3 #### 1. Download the OpenMLDB Deployment Package ``` -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.3/openmldb-0.4.3-linux.tar.gz -tar -zxvf openmldb-0.4.3-linux.tar.gz -mv openmldb-0.4.3-linux openmldb-tablet-0.4.3 -cd openmldb-tablet-0.4.3 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-tablet-0.5.0 +cd openmldb-tablet-0.5.0 ``` #### 2. Modify the Configuration File: conf/tablet.flags @@ -265,10 +265,10 @@ Repeat the above steps to deploy multiple tablets. #### 1. Download the OpenMLDB Deployment Package ``` -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.3/openmldb-0.4.3-linux.tar.gz -tar -zxvf openmldb-0.4.3-linux.tar.gz -mv openmldb-0.4.3-linux openmldb-ns-0.4.3 -cd openmldb-ns-0.4.3 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-ns-0.5.0 +cd openmldb-ns-0.5.0 ``` #### 2. Modify the Configuration File: conf/nameserver.flags @@ -312,10 +312,10 @@ Before running, make sure that the OpenMLDB cluster has been started, otherwise #### 1. Download the OpenMLDB Deployment Package ``` -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.3/openmldb-0.4.3-linux.tar.gz -tar -zxvf openmldb-0.4.3-linux.tar.gz -mv openmldb-0.4.3-linux openmldb-apiserver-0.4.3 -cd openmldb-apiserver-0.4.3 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-apiserver-0.5.0 +cd openmldb-apiserver-0.5.0 ``` #### 2. Modify the Configuration File: conf/apiserver.flags @@ -349,12 +349,12 @@ sh bin/start.sh start apiserver #### 1. Download the OpenMLDB Spark Distribution that is Optimized for Feature Engineering ``` -wget https://github.com/4paradigm/spark/releases/download/v3.0.0-openmldb0.4.3/spark-3.0.0-bin-openmldbspark.tgz +wget https://github.com/4paradigm/spark/releases/download/v3.0.0-openmldb0.5.0/spark-3.0.0-bin-openmldbspark.tgz tar -zxvf spark-3.0.0-bin-openmldbspark.tgz -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.3/openmldb-0.4.3-linux.tar.gz -tar -zxvf openmldb-0.4.3-linux.tar.gz -mv openmldb-0.4.3-linux openmldb-taskmanager-0.4.3 -cd openmldb-taskmanager-0.4.3 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-taskmanager-0.5.0 +cd openmldb-taskmanager-0.5.0 ``` #### 2. Modify the Configuration File conf/taskmanager.properties diff --git a/docs/en/quickstart/java_sdk.md b/docs/en/quickstart/java_sdk.md index 425e1afe0d4..41796560652 100644 --- a/docs/en/quickstart/java_sdk.md +++ b/docs/en/quickstart/java_sdk.md @@ -11,12 +11,12 @@ Configure maven pom com.4paradigm.openmldb openmldb-jdbc - 0.4.3 + 0.5.0 com.4paradigm.openmldb openmldb-native - 0.4.3 + 0.5.0 ``` ### Java SDK Package Installation on Mac @@ -26,15 +26,15 @@ Configure maven pom com.4paradigm.openmldb openmldb-jdbc - 0.4.3 + 0.5.0 com.4paradigm.openmldb openmldb-native - 0.4.3-macos + 0.5.0-macos ``` -Notice: Since openmldb-native contains the C++ static library compiled by OpenMLDB, the default is the linux static library. On macOS, the version of the above openmldb-native needs to be changed to `0.4.3-macos`, and the version of openmldb-jdbc remains unchanged . +Notice: Since openmldb-native contains the C++ static library compiled by OpenMLDB, the default is the linux static library. On macOS, the version of the above openmldb-native needs to be changed to `0.5.0-macos`, and the version of openmldb-jdbc remains unchanged . ## 2. Java SDK Quick Start diff --git a/docs/en/use_case/pulsar_openmldb_connector_demo.md b/docs/en/use_case/pulsar_openmldb_connector_demo.md index 298ffa0aada..348f19989a4 100644 --- a/docs/en/use_case/pulsar_openmldb_connector_demo.md +++ b/docs/en/use_case/pulsar_openmldb_connector_demo.md @@ -22,14 +22,14 @@ The below figure summarizes the workflow of using this connector. We will furthe ## Step 1 ### Create OpenMLDB Cluster -Use docker to start it simply, and we need to create a test table, you can check on [Get started with cluster version of OpenMLDB](https://openmldb.ai/docs/en/v0.4/quickstart/openmldb_quickstart.html#get-started-with-cluster-version-of-openmldb) . +Use docker to start it simply, and we need to create a test table, you can check on [Get started with cluster version of OpenMLDB](https://openmldb.ai/docs/en/v0.5/quickstart/openmldb_quickstart.html#get-started-with-cluster-version-of-openmldb) . ```{caution} Only OpenMLDB cluster mode can be the sink dist, and only write to online storage. ``` We recommend that you use ‘host network’ to run docker. And bind volume ‘files’ too. The sql scripts are in it. ``` -docker run -dit --network host -v `pwd`/files:/work/taxi-trip/files --name openmldb 4pdosc/openmldb:0.4.4 bash +docker run -dit --network host -v `pwd`/files:/work/taxi-trip/files --name openmldb 4pdosc/openmldb:0.5.0 bash docker exec -it openmldb bash ``` ```{note} diff --git a/docs/zh/README.md b/docs/zh/README.md index 91719b49e7f..be5b1030059 100644 --- a/docs/zh/README.md +++ b/docs/zh/README.md @@ -15,7 +15,7 @@ - [关于 OpenMLDB](about/about.md) - [OpenMLDB 简介](about/intro.md) - [发展历程](about/milestones.md) - - [v0.4.x Release Notes](about/release_notes.md) + - [v0.5.x Release Notes](about/release_notes.md) - [快速上手](quickstart/quickstart.md) - [OpenMLDB 快速上手](quickstart/openmldb_quickstart.md) - [Java SDK 快速上手](quickstart/java_sdk.md) diff --git a/docs/zh/SUMMARY.md b/docs/zh/SUMMARY.md index 1d6ab16c82b..f0f5261e40e 100644 --- a/docs/zh/SUMMARY.md +++ b/docs/zh/SUMMARY.md @@ -4,7 +4,7 @@ - [关于 OpenMLDB](about/about.md) - [OpenMLDB 简介](about/intro.md) - [发展历程](about/milestones.md) - - [v0.4.x Release Notes](about/release_notes.md) + - [v0.5.x Release Notes](about/release_notes.md) - [快速上手](quickstart/quickstart.md) - [OpenMLDB 快速上手](quickstart/openmldb_quickstart.md) - [Java SDK 快速上手](quickstart/java_sdk.md) @@ -29,6 +29,7 @@ - [开发者文档](developer/developer.md) - [Contributing](./developer/contributing.md) - [OpenMLDB SQL 内置函数开发指南](developer/built_in_function_develop_guide.md) + - [OpenMLDB SQL 自定义函数开发指南](developer/udf_develop_guide.md) - [参考](reference/reference.md) - [OpenMLDB运维CLI](reference/cli.md) - [REST APIs](reference/rest_api.md) diff --git a/docs/zh/about/release_notes.md b/docs/zh/about/release_notes.md index 73d057b408a..0cd8120127c 100644 --- a/docs/zh/about/release_notes.md +++ b/docs/zh/about/release_notes.md @@ -1,3 +1,34 @@ +# v0.5.x Release Notes + +## v0.5.0 Release Notes + +### Features +- Support long window (#1532 #1573 #1583 #1622 #1627 #1672 # 1712 @zhanghaohit @nautaa) +- Register udf from external dynamic library (#1509 #1733 #1700 @dl239 @tobegit3hub) +- Support persistent storage engine enabled by Rocksdb (#1483 @Leowner) +- Add new SQL commands like `SHOW COMPONENTS`, `SHOW TABLE STATUS` (#1380 #1431 #1704 @aceforeverd) +- Support set global variables (#1310 #1359 #1364 @keyu813 @aceforeverd) +- Support reading Spark conf file from cli (#1600 @tobegit3hub) +- Support Spark local mode with multiple threads (#1675 @tobegit3hub) +- Optimize join condition expr (#1502 tobegit3hub) +- Add check for TaskManager config (#1262 @tobegit3hub) +- Add tracker service to track unfinished jobs (#1474 @tobegit3hub) +- Other minor features (#1601 @dl239; #1574 @vagetablechicken; #1546 @keyu813; #1729 @vagetablechicken; #1460 @tobegit3hub) + +### Bug Fixes +- Wrong result when query on index (#1709 @aceforeverd) +- `lag`/`at`/`lead` results is wrong (#1605 @aceforeverd) +- Memory leak in zk_client (#1660 @wuxiaobai24) +- Update catalog if leade role changed (#1655 @dl239) +- Fix unsaferow relavent problems(#1298, #1312, #1326, #1362, #1637, #1381, #1731 @tobegit3hub) +- Query result is incorrect after adding a new index in standalone mode (#1721 @keyu813) +- Fail to get correct result for `SHOW JOBS` command(#1453 @tobegit3hub) +- Result is incorrect for date columns with `UnsafeRowOpt`(#1469 @tobegit3hub) +- Other minor bug fix (#1698 @kfiring; #1651 @kutlayacar; #1621 @KaidoWang; #1150, #1243 @tobegit3hub; ) + +### Code Refactoring +#1616 @dl239; #1743 @zjx1319 + # v0.4.x Release Notes ## v0.4.4 Release Notes diff --git a/docs/zh/deploy/compile.md b/docs/zh/deploy/compile.md index 5b0e45a1a6b..de0ba78334d 100644 --- a/docs/zh/deploy/compile.md +++ b/docs/zh/deploy/compile.md @@ -4,22 +4,22 @@ 此节介绍在官方编译镜像 [hybridsql](https://hub.docker.com/r/4pdosc/hybridsql) 中编译 OpenMLDB。镜像内置了编译所需要的工具和依赖,因此不需要额外的步骤单独配置它们。关于基于非 docker 的编译使用方式,请参照下面的 [编译详细说明](#编译详细说明) 章节。 -关于编译镜像版本,需要注意拉取的镜像版本和 [OpenMLDB 发布版本](https://github.com/4paradigm/OpenMLDB/releases)保持一致。以下例子演示了在 `hybridsql:0.4.4` 镜像版本上编译 [OpenMLDB v0.4.4](https://github.com/4paradigm/OpenMLDB/releases/tag/v0.4.4) 的代码,如果要编译最新 `main` 分支的代码,则需要拉取 `hybridsql:latest` 版本镜像。 +关于编译镜像版本,需要注意拉取的镜像版本和 [OpenMLDB 发布版本](https://github.com/4paradigm/OpenMLDB/releases)保持一致。以下例子演示了在 `hybridsql:0.5.0` 镜像版本上编译 [OpenMLDB v0.5.0](https://github.com/4paradigm/OpenMLDB/releases/tag/v0.5.0) 的代码,如果要编译最新 `main` 分支的代码,则需要拉取 `hybridsql:latest` 版本镜像。 1. 下载 docker 镜像 ```bash - docker pull 4pdosc/hybridsql:0.4.4 + docker pull 4pdosc/hybridsql:0.5 ``` 2. 启动 docker 容器 ```bash - docker run -it 4pdosc/hybridsql:0.4.4 bash + docker run -it 4pdosc/hybridsql:0.5 bash ``` -3. 在 docker 容器内, 克隆 OpenMLDB, 并切换分支到 v0.4.4 +3. 在 docker 容器内, 克隆 OpenMLDB, 并切换分支到 v0.5.0 ```bash cd ~ - git clone -b v0.4.4 https://github.com/4paradigm/OpenMLDB.git + git clone -b v0.5.0 https://github.com/4paradigm/OpenMLDB.git ``` 4. 在 docker 容器内编译 OpenMLDB @@ -130,7 +130,7 @@ make CMAKE_BUILD_TYPE=Debug 1. 下载预编译的OpenMLDB Spark发行版。 ```bash -wget https://github.com/4paradigm/spark/releases/download/v3.0.0-openmldb0.4.4/spark-3.0.0-bin-openmldbspark.tgz +wget https://github.com/4paradigm/spark/releases/download/v3.0.0-openmldb0.5.0/spark-3.0.0-bin-openmldbspark.tgz ``` 或者下载源代码并从头开始编译。 diff --git a/docs/zh/deploy/install_deploy.md b/docs/zh/deploy/install_deploy.md index 9df68349856..488d84b34c3 100644 --- a/docs/zh/deploy/install_deploy.md +++ b/docs/zh/deploy/install_deploy.md @@ -10,7 +10,7 @@ ## 部署包准备 -本说明文档中默认使用预编译好的 OpenMLDB 部署包([Linux](https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.4/openmldb-0.4.4-linux.tar.gz), [macOS](https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.4/openmldb-0.4.4-darwin.tar.gz)),所支持的操作系统要求为:CentOS 7, Ubuntu 20.04, macOS >= 10.15。如果用户期望自己编译(如做 OpenMLDB 源代码开发,操作系统或者 CPU 架构不在预编译部署包的支持列表内等原因),用户可以选择在 docker 容器内编译使用或者从源码编译,具体请参照我们的[编译文档](compile.md)。 +本说明文档中默认使用预编译好的 OpenMLDB 部署包([Linux](https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz), [macOS](https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-darwin.tar.gz)),所支持的操作系统要求为:CentOS 7, Ubuntu 20.04, macOS >= 10.15。如果用户期望自己编译(如做 OpenMLDB 源代码开发,操作系统或者 CPU 架构不在预编译部署包的支持列表内等原因),用户可以选择在 docker 容器内编译使用或者从源码编译,具体请参照我们的[编译文档](compile.md)。 ## 配置环境(Linux) @@ -76,10 +76,10 @@ OpenMLDB单机版需要部署一个nameserver和一个tablet. nameserver用于 ### 部署tablet #### 1 下载OpenMLDB部署包 ``` -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.4/openmldb-0.4.4-linux.tar.gz -tar -zxvf openmldb-0.4.4-linux.tar.gz -mv openmldb-0.4.4-linux openmldb-tablet-0.4.4 -cd openmldb-tablet-0.4.4 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-tablet-0.5.0 +cd openmldb-tablet-0.5.0 ``` #### 2 修改配置文件conf/standalone_tablet.flags * 修改endpoint。endpoint是用冒号分隔的部署机器ip/域名和端口号 @@ -98,10 +98,10 @@ sh bin/start.sh start standalone_tablet ### 部署nameserver #### 1 下载OpenMLDB部署包 ```` -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.4/openmldb-0.4.4-linux.tar.gz -tar -zxvf openmldb-0.4.4-linux.tar.gz -mv openmldb-0.4.4-linux openmldb-ns-0.4.4 -cd openmldb-ns-0.4.4 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-ns-0.5.0 +cd openmldb-ns-0.5.0 ```` #### 2 修改配置文件conf/standalone_nameserver.flags * 修改endpoint。endpoint是用冒号分隔的部署机器ip/域名和端口号 @@ -133,10 +133,10 @@ APIServer负责接收http请求,转发给OpenMLDB并返回结果。它是无 #### 1 下载OpenMLDB部署包 ``` -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.4/openmldb-0.4.4-linux.tar.gz -tar -zxvf openmldb-0.4.4-linux.tar.gz -mv openmldb-0.4.4-linux openmldb-apiserver-0.4.4 -cd openmldb-apiserver-0.4.4 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-apiserver-0.5.0 +cd openmldb-apiserver-0.5.0 ``` #### 2 修改配置文件conf/standalone_apiserver.flags @@ -191,10 +191,10 @@ sh bin/zkServer.sh start ### 部署tablet #### 1 下载OpenMLDB部署包 ``` -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.4/openmldb-0.4.4-linux.tar.gz -tar -zxvf openmldb-0.4.4-linux.tar.gz -mv openmldb-0.4.4-linux openmldb-tablet-0.4.4 -cd openmldb-tablet-0.4.4 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-tablet-0.5.0 +cd openmldb-tablet-0.5.0 ``` #### 2 修改配置文件conf/tablet.flags * 修改endpoint。endpoint是用冒号分隔的部署机器ip/域名和端口号 @@ -226,10 +226,10 @@ sh bin/start.sh start tablet ### 部署nameserver #### 1 下载OpenMLDB部署包 ```` -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.4/openmldb-0.4.4-linux.tar.gz -tar -zxvf openmldb-0.4.4-linux.tar.gz -mv openmldb-0.4.4-linux openmldb-ns-0.4.4 -cd openmldb-ns-0.4.4 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-ns-0.5.0 +cd openmldb-ns-0.5.0 ```` #### 2 修改配置文件conf/nameserver.flags * 修改endpoint。endpoint是用冒号分隔的部署机器ip/域名和端口号 @@ -266,10 +266,10 @@ APIServer负责接收http请求,转发给OpenMLDB并返回结果。它是无 #### 1 下载OpenMLDB部署包 ``` -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.4/openmldb-0.4.4-linux.tar.gz -tar -zxvf openmldb-0.4.4-linux.tar.gz -mv openmldb-0.4.4-linux openmldb-apiserver-0.4.4 -cd openmldb-apiserver-0.4.4 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-apiserver-0.5.0 +cd openmldb-apiserver-0.5.0 ``` #### 2 修改配置文件conf/apiserver.flags @@ -302,12 +302,12 @@ sh bin/start.sh start apiserver #### 1 下载 OpenMLDB 部署包和面向特征工程优化的 Spark 发行版 ```` -wget https://github.com/4paradigm/spark/releases/download/v3.0.0-openmldb0.4.4/spark-3.0.0-bin-openmldbspark.tgz +wget https://github.com/4paradigm/spark/releases/download/v3.0.0-openmldb0.5.0/spark-3.0.0-bin-openmldbspark.tgz tar -zxvf spark-3.0.0-bin-openmldbspark.tgz -wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.4.4/openmldb-0.4.4-linux.tar.gz -tar -zxvf openmldb-0.4.4-linux.tar.gz -mv openmldb-0.4.4-linux openmldb-taskmanager-0.4.4 -cd openmldb-taskmanager-0.4.4 +wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.5.0/openmldb-0.5.0-linux.tar.gz +tar -zxvf openmldb-0.5.0-linux.tar.gz +mv openmldb-0.5.0-linux openmldb-taskmanager-0.5.0 +cd openmldb-taskmanager-0.5.0 ```` #### 2 修改配置文件conf/taskmanager.properties diff --git a/docs/zh/quickstart/java_sdk.md b/docs/zh/quickstart/java_sdk.md index 3c62e6e1978..446a58e5b05 100644 --- a/docs/zh/quickstart/java_sdk.md +++ b/docs/zh/quickstart/java_sdk.md @@ -9,12 +9,12 @@ com.4paradigm.openmldb openmldb-jdbc - 0.4.4-hotfix1 + 0.5.0 com.4paradigm.openmldb openmldb-native - 0.4.4-hotfix1 + 0.5.0 ``` ### Mac下Java SDK包安装 @@ -24,15 +24,15 @@ com.4paradigm.openmldb openmldb-jdbc - 0.4.4-hotfix1 + 0.5.0 com.4paradigm.openmldb openmldb-native - 0.4.4-hotfix1-macos + 0.5.0-hotfix1-macos ``` -注意: 由于 openmldb-native 中包含了 OpenMLDB 编译的 C++ 静态库, 默认是 linux 静态库, macOS 上需将上述 openmldb-native 的 version 改成 `0.4.4-hotfix1-macos`, openmldb-jdbc 的版本保持不变。 +注意: 由于 openmldb-native 中包含了 OpenMLDB 编译的 C++ 静态库, 默认是 linux 静态库, macOS 上需将上述 openmldb-native 的 version 改成 `0.5.0-macos`, openmldb-jdbc 的版本保持不变。 ## 2. Java SDK快速上手 diff --git a/docs/zh/quickstart/openmldb_quickstart.md b/docs/zh/quickstart/openmldb_quickstart.md index 48571d2b068..4a06aaca871 100644 --- a/docs/zh/quickstart/openmldb_quickstart.md +++ b/docs/zh/quickstart/openmldb_quickstart.md @@ -34,8 +34,8 @@ docker run -it 4pdosc/openmldb:0.5.0 bash 下载样例数据 ```bash -curl https://openmldb.ai/demo/data.csv --output ./data/data.csv -curl https://openmldb.ai/demo/data.parquet --output ./data/data.parquet +curl https://openmldb.ai/demo/data.csv --output ./taxi-trip/data/data.csv +curl https://openmldb.ai/demo/data.parquet --output ./taxi-trip/data/data.parquet ``` ## 2. 单机版OpenMLDB 快速上手 diff --git a/docs/zh/reference/ip_tips.md b/docs/zh/reference/ip_tips.md index 6ab5e028a32..f856a10170d 100644 --- a/docs/zh/reference/ip_tips.md +++ b/docs/zh/reference/ip_tips.md @@ -37,12 +37,12 @@ docker network inspect bridge 单机版需要暴露三个组件(nameserver,tabletserver,apiserver)的端口: ``` -docker run -p 6527:6527 -p 9921:9921 -p 8080:8080 -it 4pdosc/openmldb:0.4.4 bash +docker run -p 6527:6527 -p 9921:9921 -p 8080:8080 -it 4pdosc/openmldb:0.5.0 bash ``` 集群版需要暴露zk端口与所有组件的端口: ``` -docker run -p 2181:2181 -p 7527:7527 -p 10921:10921 -p 10922:10922 -p 8080:8080 -p 9902:9902 -it 4pdosc/openmldb:0.4.4 bash +docker run -p 2181:2181 -p 7527:7527 -p 10921:10921 -p 10922:10922 -p 8080:8080 -p 9902:9902 -it 4pdosc/openmldb:0.5.0 bash ``` ```{tip} @@ -56,7 +56,7 @@ docker run -p 2181:2181 -p 7527:7527 -p 10921:10921 -p 10922:10922 -p 8080:8080 #### host network 或者更方便地,使用 host networking,不进行端口隔离,例如: ``` -docker run --network host -it 4pdosc/openmldb:0.4.4 bash +docker run --network host -it 4pdosc/openmldb:0.5.0 bash ``` 但这种情况下,很容易出现端口已被主机中其他进程占用。如果出现占用,请仔细更改端口号。 diff --git a/docs/zh/tutorial/modes.md b/docs/zh/tutorial/modes.md index 0ed4ee388aa..53342c1cfa4 100644 --- a/docs/zh/tutorial/modes.md +++ b/docs/zh/tutorial/modes.md @@ -4,7 +4,7 @@ OpenMLDB 针对线上线下的特征工程全流程,在不同阶段提供了 :::{note} -本文所述内容均以 OpenMLDB 最新发布的版本 v0.4.4 版本为准,部分功能的支持在持续迭代开发中,欢迎关注。 +本文所述内容均以 OpenMLDB 最新发布的版本 v0.5.0 版本为准,部分功能的支持在持续迭代开发中,欢迎关注。 ::: ## 1. OpenMLDB 使用流程概览 diff --git a/docs/zh/use_case/pulsar_openmldb_connector_demo.md b/docs/zh/use_case/pulsar_openmldb_connector_demo.md index 22bb8bb61c7..d83703d88c0 100644 --- a/docs/zh/use_case/pulsar_openmldb_connector_demo.md +++ b/docs/zh/use_case/pulsar_openmldb_connector_demo.md @@ -29,13 +29,13 @@ Pulsar OpenMLDB connector 用于 OpenMLDB 线上模式的实时数据流接入 ## 步骤 1:在 OpenMLDB 创建数据库和数据表 ### 启动 OpenMLDB 集群 -使用Docker可以快速启动OpenMLDB,除此之外,我们还需要创建测试用的表。创建OpenMLDB详请可以参考[集群版OpenMLDB 快速上手](https://openmldb.ai/docs/zh/v0.4/quickstart/openmldb_quickstart.html#id11)。 +使用Docker可以快速启动OpenMLDB,除此之外,我们还需要创建测试用的表。创建OpenMLDB详请可以参考[集群版OpenMLDB 快速上手](https://openmldb.ai/docs/zh/v0.5/quickstart/openmldb_quickstart.html#id11)。 ```{caution} 目前只有OpenMLDB集群版可以作为sink的接收端,数据只会sink到集群的在线存储中。 ``` 我们更推荐你使用‘host network’模式运行docker,以及绑定文件目录‘files’,sql脚本在该目录中。 ``` -docker run -dit --network host -v `pwd`/files:/work/taxi-trip/files --name openmldb 4pdosc/openmldb:0.4.4 bash +docker run -dit --network host -v `pwd`/files:/work/taxi-trip/files --name openmldb 4pdosc/openmldb:0.5.0 bash docker exec -it openmldb bash ```