Skip to content

Commit

Permalink
docs: upgrade 0.8.3 (#3496)
Browse files Browse the repository at this point in the history
  • Loading branch information
dl239 committed Sep 15, 2023
1 parent 1b2f945 commit b685e64
Show file tree
Hide file tree
Showing 32 changed files with 156 additions and 120 deletions.
38 changes: 37 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,40 @@
# Changelog

## [0.8.3] - 2023-09-15

### Features
- Optimize the performance of Java SDK (#3445 @dl239)
- Optimize the writing performance and significantly reduce the memory consumption of the Spark connector (#3443 @vagetablechicken)
- Support loading data from HIVE with customized SQLs (#3380 @tobegit3hub)
- Improve the output message for SDK and CLI (#3384 @vagetablechicken, #3434 #3494 @dl239)
- Support new built-in functions `json_array_length` and `get_json_object` (#3414 #3429 @aceforeverd)
- Add new options `RANGE_BIAS` and `ROWS_BIAS` for the `DEPLOYMENT` statement (#3456 @vagetablechicken)
- Support `const` project in online mode (#3376 @aceforeverd)
- Support `SHOW DEPLOYMENT` and `DROP DEPLOYMENT` with a database name (#3353 @emo-coder)
- Support inheriting environment variables for Spark (#3450 @vagetablechicken)
- Support deleting HDFS files when dropping tables (#3369 @tobegit3hub)
- Enhance the diagnostic tool (#3330 @zhangziheng01233)
- Enhance the operation tool (#3455 @dl239)
- Use the timeout value set by an user only if that is greater than the default value (#3484 @vagetablechicken)
- Remove the sync tool from the demo docker image (#3390 @dl239)
- Improve the documents (#3383 #3392 #3410 @vagetablechicken, #3175 #3447 ##3463 @TanZiYen, #3436 @aceforeverd, #3451 @wangerry, #3453 #3462 #3498 @dl239)

### Bug Fixes
- `CREATE TABLE LIKE HIVE` returns success even if a database is not found (#3379 @emo-coder)
- If an error occurred when executing `DROP FUNCTION`, the function cannot be deleted again. (#3362 @vagetablechicken, #3441 @dl239)
- The results of `SHOW JOBS` are not sorted by `id` (#3371 @emo-coder)
- NameServer will crash if creating system tables fails. (#3432 @dl239)
- `CREATE INDEX` may fail if the previous `CREATE INDEX` command on the same table has not finished. (#3393 @dl239)
- The result of `SELECT` on the deleted index column is empty (#3426 @dl239)
- Other minor bug fixes (#3391 #3408 @vagetablechicken, #3386 #3427 #3459 @dl239, #3367 #3495 @aceforeverd)

### Code Refactoring
#3397 @emo-coder, #3411 @vagetablechicken, #3435 @aceforeverd, #3473 @lqy222

### Breaking Changes
- The return type of `GetInternalSchema` in `SQLResultSet` changes from native Schema to `com._4paradigm.openmldb.sdk.Schema` #3445
- Remove the deprecated TaskManager configuration `namenode.uri` #3369

## [0.8.2] - 2023-07-20

### Features
Expand All @@ -16,7 +51,7 @@
- The bool type is not properly packed in APIServer. (#3366 @vagetablechicken)
- The table can be created successfully when there are duplicated indexs. (#3306 @dl239)

### Breaking Changes:
### Breaking Changes
- The field `Offline_deep_copy` will be replaced by `Offline_symbolic_paths` in the result of `SHOW TABLE STATUS` #3349.

## [0.8.1] - 2023-06-28
Expand Down Expand Up @@ -618,6 +653,7 @@ Removed
- openmldb-0.2.0-linux.tar.gz targets on x86_64
- aarch64 artifacts consider experimental

[0.8.3]: https://github.com/4paradigm/OpenMLDB/compare/v0.8.2...v0.8.3
[0.8.2]: https://github.com/4paradigm/OpenMLDB/compare/v0.8.1...v0.8.2
[0.8.1]: https://github.com/4paradigm/OpenMLDB/compare/v0.8.0...v0.8.1
[0.8.0]: https://github.com/4paradigm/OpenMLDB/compare/v0.7.3...v0.8.0
Expand Down
2 changes: 1 addition & 1 deletion demo/java_quickstart/demo/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-jdbc</artifactId>
<version>0.8.2</version>
<version>0.8.3</version>
</dependency>
<dependency>
<groupId>org.testng</groupId>
Expand Down
4 changes: 2 additions & 2 deletions demo/predict-taxi-trip-duration/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ w2 as (PARTITION BY passenger_count ORDER BY pickup_datetime ROWS_RANGE BETWEEN
**Start docker**
```
docker run -it 4pdosc/openmldb:0.8.2 bash
docker run -it 4pdosc/openmldb:0.8.3 bash
```
**Initialize environment**
```bash
Expand Down Expand Up @@ -138,7 +138,7 @@ python3 predict.py
**Start docker**
```bash
docker run -it 4pdosc/openmldb:0.8.2 bash
docker run -it 4pdosc/openmldb:0.8.3 bash
```
**Initialize environment**
Expand Down
2 changes: 1 addition & 1 deletion demo/talkingdata-adtracking-fraud-detection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ We recommend you to use docker to run the demo. OpenMLDB and dependencies have b
**Start docker**

```
docker run -it 4pdosc/openmldb:0.8.2 bash
docker run -it 4pdosc/openmldb:0.8.3 bash
```

#### Run locally
Expand Down
8 changes: 4 additions & 4 deletions docs/en/deploy/compile.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
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.8.2](https://github.com/4paradigm/OpenMLDB/releases/tag/v0.8.2) under `hybridsql:0.8.2` ,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.8.3](https://github.com/4paradigm/OpenMLDB/releases/tag/v0.8.3) under `hybridsql:0.8.3` ,If you prefer to compile on the latest code in `main` branch, pull `hybridsql:latest` image instead.

1. Pull the docker image

Expand All @@ -21,11 +21,11 @@ Keep in mind that you should always use the same version of both compile image a
docker run -it 4pdosc/hybridsql:0.8 bash
```

3. Download the OpenMLDB source code inside the docker container, and setting the branch into v0.8.2
3. Download the OpenMLDB source code inside the docker container, and setting the branch into v0.8.3

```bash
cd ~
git clone -b v0.8.2 https://github.com/4paradigm/OpenMLDB.git
git clone -b v0.8.3 https://github.com/4paradigm/OpenMLDB.git
```

4. Compile OpenMLDB
Expand Down Expand Up @@ -151,7 +151,7 @@ The built jar packages are in the `target` path of each submodule. If you want t
1. Downloading the pre-built OpenMLDB Spark distribution:

```bash
wget https://github.com/4paradigm/spark/releases/download/v3.2.1-openmldb0.8.2/spark-3.2.1-bin-openmldbspark.tgz
wget https://github.com/4paradigm/spark/releases/download/v3.2.1-openmldb0.8.3/spark-3.2.1-bin-openmldbspark.tgz
```

Alternatively, you can also download the source code and compile from scratch:
Expand Down
68 changes: 34 additions & 34 deletions docs/en/deploy/install_deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,17 +52,17 @@ If your operating system is not mentioned above or if you want to compile from s

### Linux Platform Compatibility pre-test

Due to the variations among Linux platforms, the distribution package may not be entirely compatible with your machine. Therefore, it's recommended to conduct a preliminary compatibility test. Download the pre-compiled package `openmldb-0.8.2-linux.tar.gz`, and execute:
Due to the variations among Linux platforms, the distribution package may not be entirely compatible with your machine. Therefore, it's recommended to conduct a preliminary compatibility test. Download the pre-compiled package `openmldb-0.8.3-linux.tar.gz`, and execute:

```
tar -zxvf openmldb-0.8.2-linux.tar.gz
./openmldb-0.8.2-linux/bin/openmldb --version
tar -zxvf openmldb-0.8.3-linux.tar.gz
./openmldb-0.8.3-linux/bin/openmldb --version
```

The result should display the version number of the program, as shown below:

```
openmldb version 0.8.2-xxxx
openmldb version 0.8.3-xxxx
Debug build (NDEBUG not #defined)
```

Expand Down Expand Up @@ -177,9 +177,9 @@ DataCollector and SyncTool currently do not support one-click deployment. Please
### Download OpenMLDB

```
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.8.2/openmldb-0.8.2-linux.tar.gz
tar -zxvf openmldb-0.8.2-linux.tar.gz
cd openmldb-0.8.2-linux
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.8.3/openmldb-0.8.3-linux.tar.gz
tar -zxvf openmldb-0.8.3-linux.tar.gz
cd openmldb-0.8.3-linux
```

### Environment Configuration
Expand All @@ -188,7 +188,7 @@ The environment variables are defined in `conf/openmldb-env.sh`, as shown in the

| Environment Variable | Default Value | Note |
| --------------------------------- | ------------------------------------------------------- | ------------------------------------------------------------ |
| OPENMLDB_VERSION | 0.8.2 | OpenMLDB version |
| OPENMLDB_VERSION | 0.8.3 | OpenMLDB version |
| OPENMLDB_MODE | standalone | standalone or cluster |
| OPENMLDB_HOME | root directory of the release folder | openmldb root directory |
| SPARK_HOME | $OPENMLDB_HOME/spark | openmldb spark root directory,If the directory does not exist, it will be downloaded automatically.|
Expand Down Expand Up @@ -361,10 +361,10 @@ Note that at least two TabletServer need to be deployed, otherwise errors may oc
**1. Download the OpenMLDB deployment package**

```
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.8.2/openmldb-0.8.2-linux.tar.gz
tar -zxvf openmldb-0.8.2-linux.tar.gz
mv openmldb-0.8.2-linux openmldb-tablet-0.8.2
cd openmldb-tablet-0.8.2
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.8.3/openmldb-0.8.3-linux.tar.gz
tar -zxvf openmldb-0.8.3-linux.tar.gz
mv openmldb-0.8.3-linux openmldb-tablet-0.8.3
cd openmldb-tablet-0.8.3
```

**2. Modify the configuration file `conf/tablet.flags`**
Expand Down Expand Up @@ -427,12 +427,12 @@ For clustered versions, the number of TabletServers must be 2 or more. If there'

To start the next TabletServer on a different machine, simply repeat the aforementioned steps on that machine. If starting the next TabletServer on the same machine, ensure it's in a different directory, and do not reuse a directory where the TabletServer is already running.

For instance, you can decompress the package again (avoid using a directory where TabletServer is already running, as files generated after startup may be affected), and name the directory `openmldb-tablet-0.8.2-2`.
For instance, you can decompress the package again (avoid using a directory where TabletServer is already running, as files generated after startup may be affected), and name the directory `openmldb-tablet-0.8.3-2`.

```
tar -zxvf openmldb-0.8.2-linux.tar.gz
mv openmldb-0.8.2-linux openmldb-tablet-0.8.2-2
cd openmldb-tablet-0.8.2-2
tar -zxvf openmldb-0.8.3-linux.tar.gz
mv openmldb-0.8.3-linux openmldb-tablet-0.8.3-2
cd openmldb-tablet-0.8.3-2
```

Modify the configuration again and start the TabletServer. Note that if all TabletServers are on the same machine, use different port numbers to avoid "Fail to listen" error in the log (`logs/tablet.WARNING`).
Expand All @@ -450,10 +450,10 @@ Please ensure that all TabletServer have been successfully started before deploy
**1. Download the OpenMLDB deployment package**

````
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.8.2/openmldb-0.8.2-linux.tar.gz
tar -zxvf openmldb-0.8.2-linux.tar.gz
mv openmldb-0.8.2-linux openmldb-ns-0.8.2
cd openmldb-ns-0.8.2
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.8.3/openmldb-0.8.3-linux.tar.gz
tar -zxvf openmldb-0.8.3-linux.tar.gz
mv openmldb-0.8.3-linux openmldb-ns-0.8.3
cd openmldb-ns-0.8.3
````

**2. Modify the configuration file conf/nameserver.flags**
Expand Down Expand Up @@ -498,12 +498,12 @@ You can have only one NameServer, but if you need high availability, you can dep

To start the next NameServer on another machine, simply repeat the above steps on that machine. If starting the next NameServer on the same machine, ensure it's in a different directory and do not reuse the directory where NameServer has already been started.

For instance, you can decompress the package again (avoid using the directory where NameServer is already running, as files generated after startup may be affected) and name the directory `openmldb-ns-0.8.2-2`.
For instance, you can decompress the package again (avoid using the directory where NameServer is already running, as files generated after startup may be affected) and name the directory `openmldb-ns-0.8.3-2`.

```
tar -zxvf openmldb-0.8.2-linux.tar.gz
mv openmldb-0.8.2-linux openmldb-ns-0.8.2-2
cd openmldb-ns-0.8.2-2
tar -zxvf openmldb-0.8.3-linux.tar.gz
mv openmldb-0.8.3-linux openmldb-ns-0.8.3-2
cd openmldb-ns-0.8.3-2
```

Then modify the configuration and start.
Expand Down Expand Up @@ -544,10 +544,10 @@ Before running APIServer, ensure that the TabletServer and NameServer processes
**1. Download the OpenMLDB deployment package**

```
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.8.2/openmldb-0.8.2-linux.tar.gz
tar -zxvf openmldb-0.8.2-linux.tar.gz
mv openmldb-0.8.2-linux openmldb-apiserver-0.8.2
cd openmldb-apiserver-0.8.2
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.8.3/openmldb-0.8.3-linux.tar.gz
tar -zxvf openmldb-0.8.3-linux.tar.gz
mv openmldb-0.8.3-linux openmldb-apiserver-0.8.3
cd openmldb-apiserver-0.8.3
```

**2. Modify the configuration file conf/apiserver.flags**
Expand Down Expand Up @@ -607,18 +607,18 @@ You can have only one TaskManager, but if you require high availability, you can
Spark distribution:

```shell
wget https://github.com/4paradigm/spark/releases/download/v3.2.1-openmldb0.8.2/spark-3.2.1-bin-openmldbspark.tgz
# Image address (China):http://43.138.115.238/download/v0.8.2/spark-3.2.1-bin-openmldbspark.tgz
wget https://github.com/4paradigm/spark/releases/download/v3.2.1-openmldb0.8.3/spark-3.2.1-bin-openmldbspark.tgz
# Image address (China):http://43.138.115.238/download/v0.8.3/spark-3.2.1-bin-openmldbspark.tgz
tar -zxvf spark-3.2.1-bin-openmldbspark.tgz
export SPARK_HOME=`pwd`/spark-3.2.1-bin-openmldbspark/
```

OpenMLDB deployment package:
```
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.8.2/openmldb-0.8.2-linux.tar.gz
tar -zxvf openmldb-0.8.2-linux.tar.gz
mv openmldb-0.8.2-linux openmldb-taskmanager-0.8.2
cd openmldb-taskmanager-0.8.2
wget https://github.com/4paradigm/OpenMLDB/releases/download/v0.8.3/openmldb-0.8.3-linux.tar.gz
tar -zxvf openmldb-0.8.3-linux.tar.gz
mv openmldb-0.8.3-linux openmldb-taskmanager-0.8.3
cd openmldb-taskmanager-0.8.3
```

**2. Modify the configuration file conf/taskmanager.properties**
Expand Down
2 changes: 1 addition & 1 deletion docs/en/quickstart/openmldb_quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ This article is developed and deployed based on OpenMLDB CLI, and it is necessar
Execute the following command in the command line to pull the OpenMLDB image and start the Docker container:

```bash
docker run -it 4pdosc/openmldb:0.8.2 bash
docker run -it 4pdosc/openmldb:0.8.3 bash
```

``` {note}
Expand Down
10 changes: 5 additions & 5 deletions docs/en/quickstart/sdk/java_sdk.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,12 @@
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-jdbc</artifactId>
<version>0.7.2</version>
<version>0.8.3</version>
</dependency>
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-native</artifactId>
<version>0.7.2</version>
<version>0.8.3</version>
</dependency>
```

Expand All @@ -27,16 +27,16 @@
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-jdbc</artifactId>
<version>0.7.2</version>
<version>0.8.3</version>
</dependency>
<dependency>
<groupId>com.4paradigm.openmldb</groupId>
<artifactId>openmldb-native</artifactId>
<version>0.7.2-macos</version>
<version>0.8.3-macos</version>
</dependency>
```

Note: Since the openmldb-native package contains the C++ static library compiled for OpenMLDB, it is defaults to the Linux static library. For macOS, the version of openmldb-native should be changed to `0.7.2-macos`, while the version of openmldb-jdbc should remain unchanged.
Note: Since the openmldb-native package contains the C++ static library compiled for OpenMLDB, it is defaults to the Linux static library. For macOS, the version of openmldb-native should be changed to `0.8.3-macos`, while the version of openmldb-jdbc should remain unchanged.

The macOS version of openmldb-native only supports macOS 12. To run it on macOS 11 or macOS 10.15, the openmldb-native package needs to be compiled from source code on the corresponding OS. For detailed compilation methods, please refer to [Concurrent Compilation of Java SDK](https://openmldb.ai/docs/zh/main/deploy/compile.html#java-sdk).

Expand Down
6 changes: 3 additions & 3 deletions docs/en/reference/ip_tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,12 +38,12 @@ Expose the port through `-p` when starting the container, and the client can acc

The stand-alone version needs to expose the ports of three components (nameserver, tabletserver, apiserver):
```
docker run -p 6527:6527 -p 9921:9921 -p 8080:8080 -it 4pdosc/openmldb:0.8.2 bash
docker run -p 6527:6527 -p 9921:9921 -p 8080:8080 -it 4pdosc/openmldb:0.8.3 bash
```

The cluster version needs to expose the zk port and the ports of all components:
```
docker run -p 2181:2181 -p 7527:7527 -p 10921:10921 -p 10922:10922 -p 8080:8080 -p 9902:9902 -it 4pdosc/openmldb:0.8.2 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.8.3 bash
```

```{tip}
Expand All @@ -57,7 +57,7 @@ If the OpenMLDB service process is distributed, the "port number is occupied" ap
#### Host Network
Or more conveniently, use host networking without port isolation, for example:
```
docker run --network host -it 4pdosc/openmldb:0.8.2 bash
docker run --network host -it 4pdosc/openmldb:0.8.3 bash
```
But in this case, it is easy to find that the port is occupied by other processes in the host. If occupancy occurs, change the port number carefully.

Expand Down
2 changes: 1 addition & 1 deletion docs/en/use_case/JD_recommendation_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ Oneflow-serving:https://github.com/Oneflow-Inc/serving/tree/ce5d667468b6b3ba66
Pull the OpenMLDB docker image and run.

```bash
docker run -dit --name=openmldb --network=host -v $demodir:/work/oneflow_demo 4pdosc/openmldb:0.8.2 bash
docker run -dit --name=openmldb --network=host -v $demodir:/work/oneflow_demo 4pdosc/openmldb:0.8.3 bash
docker exec -it openmldb bash
```

Expand Down
2 changes: 1 addition & 1 deletion docs/en/use_case/airflow_provider_demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ For the newest version, please visit [GitHub example_dags](https://github.com/4p
- Please project the previously downloaded files to the path `/work/airflow/dags`, where Airflow will access for the DAG.

```
docker run -p 8080:8080 -v `pwd`/airflow_demo_files:/work/airflow/dags -it 4pdosc/openmldb:0.8.2 bash
docker run -p 8080:8080 -v `pwd`/airflow_demo_files:/work/airflow/dags -it 4pdosc/openmldb:0.8.3 bash
```

#### 0.3 Download and Install the Airflow and the Airflow OpenMLDB Provider
Expand Down
2 changes: 1 addition & 1 deletion docs/en/use_case/dolphinscheduler_task_demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ In addition to the feature engineering done by OpenMLDB, the prediction also req

The demo can run on MacOS or Linux, the OpenMLDB docker image is recommended. We'll start OpenMLDB and DolphinScheduler in the same container, expose the DolphinScheduler web port:
```
docker run -it -p 12345:12345 4pdosc/openmldb:0.8.2 bash
docker run -it -p 12345:12345 4pdosc/openmldb:0.8.3 bash
```

```{attention}
Expand Down
2 changes: 1 addition & 1 deletion docs/en/use_case/kafka_connector_demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ For OpenMLDB Kafka Connector implementation, please refer to [extensions/kafka-c
This article will start the OpenMLDB in docker container, so there is no need to download the OpenMLDB separately. Moreover, Kafka and connector can be started in the same container. We recommend that you save the three downloaded packages to the same directory. Let's assume that the packages are in the `/work/kafka` directory.

```
docker run -it -v `pwd`:/work/kafka --name openmldb 4pdosc/openmldb:0.8.2 bash
docker run -it -v `pwd`:/work/kafka --name openmldb 4pdosc/openmldb:0.8.3 bash
```

### Steps
Expand Down
2 changes: 1 addition & 1 deletion docs/en/use_case/lightgbm_demo.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Note that: (1) this case is based on the OpenMLDB cluster version for tutorial d
- Pull the OpenMLDB docker image and run the corresponding container:

```bash
docker run -it 4pdosc/openmldb:0.8.2 bash
docker run -it 4pdosc/openmldb:0.8.3 bash
```

The image is preinstalled with OpenMLDB and preset with all scripts, third-party libraries, open-source tools and training data required for this case.
Expand Down
Loading

0 comments on commit b685e64

Please sign in to comment.