Skip to content

Commit

Permalink
Update release note and package link (#570)
Browse files Browse the repository at this point in the history 
* release note

* replace 1.0.0-rc with 1.0.0
  • Loading branch information
@cyann7
cyann7 authored Nov 16, 2023
1 parent 909e4f8 commit fe22b92
Show file tree
Hide file tree
Showing 24 changed files with 219 additions and 192 deletions.
52 changes: 26 additions & 26 deletions docs/MatrixOne/Contribution-Guide/How-to-Contribute/preparation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ These introductions will help you go through you the key concepts and user detai

### Roadmap

MatrixOne v1.0.0-rc2 has been released, you can see [Release Notes](../../Release-Notes/v1.0.0-rc2.md) know more information.
MatrixOne v1.0.0 has been released, you can see [Release Notes](../../Release-Notes/v1.0.0.md) know more information.

For the long-term project roadmap, please refer to [MatrixOne roadmap](https://github.com/matrixorigin/matrixone/issues/613) for a more general overview.

Expand All @@ -32,37 +32,37 @@ Contributions to MatrixOne are not limited to writing code. What follows are dif

For contributing code, [matrixone](https://github.com/matrixorigin/matrixone) is the main repository you'll be working on. The main working directories are listed below:

| Directory | Working Files |
| ------------------------------ | ------------------------------------------------------------ |
| **/LICENSES** | The license of dependant libraries |
| **/cmd** | The binary entry of Go executables |
| **optools** | The test and deployment utilities |
| **pkg** | The main codebase of MatrixOne project |
| Directory | Working Files |
| ------------- | -------------------------------------- |
| **/LICENSES** | The license of dependant libraries |
| **/cmd** | The binary entry of Go executables |
| **optools** | The test and deployment utilities |
| **pkg** | The main codebase of MatrixOne project |

For different technical modules, a code structure under `/pkg` is as shown in the following table.

| Directory | Modules |
| ------------------------------ | ------------------------------------------------------------ |
| **frontend/** | SQL Frontend |
| **sql/** | MPP SQL Execution |
| **sql/parser** | SQL Parser |
| **sql/vectorize** | Vectorization of SQL Execution |
| **catalog/** | Catalog for storing metadata |
| **vm/engine** | Storage engine |
| **vm/engine/aoe** | Analytics Optimized Engine |
| **vm/engine/tpe** | Transaction Processing Engine |
| **buildin/** | System builtin functions |
| Directory | Modules |
| ----------------- | ------------------------------ |
| **frontend/** | SQL Frontend |
| **sql/** | MPP SQL Execution |
| **sql/parser** | SQL Parser |
| **sql/vectorize** | Vectorization of SQL Execution |
| **catalog/** | Catalog for storing metadata |
| **vm/engine** | Storage engine |
| **vm/engine/aoe** | Analytics Optimized Engine |
| **vm/engine/tpe** | Transaction Processing Engine |
| **buildin/** | System builtin functions |

For contributing documentation, [matrixorigin.io](https://github.com/matrixorigin/matrixorigin.io) , [matrixorigin.io.cn](https://github.com/matrixorigin/matrixorigin.io.cn) and [artwork](https://github.com/matrixorigin/artwork) are all the main repositories you'll be working on. For more details, please refer to [Contribute Documentation](contribute-documentation.md).

| Directory | Working Files |
| ------------------------------ | ------------------------------------------------------------ |
| **matrixone/docs/rfcs** | The design docs of MatrixOne project |
| **matrixorigin.io/docs/MatrixOne** | The content files of the English MatrixOne documentation website |
| **matrixorigin.io.cn/docs/MatrixOne** | The content files of the Chinese MatrixOne documentation website |
| **matrixorigin.io/mkdocs.yml** | The configuration file of the English documentation website |
| **matrixorigin.io.cn/mkdocs.yml** | The configuration file of the Chinese documentation website |
| **artwork/docs** | The images, screenshots and diagrams of documentation webstie |
| Directory | Working Files |
| ------------------------------------- | ---------------------------------------------------------------- |
| **matrixone/docs/rfcs** | The design docs of MatrixOne project |
| **matrixorigin.io/docs/MatrixOne** | The content files of the English MatrixOne documentation website |
| **matrixorigin.io.cn/docs/MatrixOne** | The content files of the Chinese MatrixOne documentation website |
| **matrixorigin.io/mkdocs.yml** | The configuration file of the English documentation website |
| **matrixorigin.io.cn/mkdocs.yml** | The configuration file of the Chinese documentation website |
| **artwork/docs** | The images, screenshots and diagrams of documentation webstie |

## **Set up your Development Environment**

Expand Down
12 changes: 6 additions & 6 deletions docs/MatrixOne/Deploy/deploy-MatrixOne-cluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,11 +102,11 @@ To prepare the cluster environment, you need to do the following:

The specific distribution of the machines is shown below:

| **Host** | **Intranet IP** | **Extranet IP** | **mem** | **CPU** | **Disk** | **Role** |
| ------------ | ------------- | --------------- | ------- | ------- | -------- | ----------- |
| kuboardspray | 10.206.0.6 | 1.13.2.100 | 2G | 2C | 50G | 跳板机 |
| master0 | 10.206.134.8 | 118.195.255.252 | 8G | 2C | 50G | master etcd |
| node0 | 10.206.134.14 | 1.13.13.199 | 8G | 2C | 50G | worker |
| **Host** | **Intranet IP** | **Extranet IP** | **mem** | **CPU** | **Disk** | **Role** |
| ------------ | --------------- | --------------- | ------- | ------- | -------- | ----------- |
| kuboardspray | 10.206.0.6 | 1.13.2.100 | 2G | 2C | 50G | 跳板机 |
| master0 | 10.206.134.8 | 118.195.255.252 | 8G | 2C | 50G | master etcd |
| node0 | 10.206.134.14 | 1.13.13.199 | 8G | 2C | 50G | worker |

#### **Deploying Kuboard Spray on a Jump Server**

Expand Down Expand Up @@ -648,7 +648,7 @@ mysql -h $(kubectl get svc/mo-tp-cn -n mo-hn -o jsonpath='{.spec.clusterIP}') -P
mysql: [Warning] Using a password on the command line interface can be insecure.
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 163
Server version: 8.0.30-MatrixOne-v1.0.0-rc2 MatrixOne
Server version: 8.0.30-MatrixOne-v1.0.0 MatrixOne

Copyright (c) 2000, 2023, Oracle and/or its affiliates.

Expand Down
2 changes: 1 addition & 1 deletion docs/MatrixOne/Deploy/update-MatrixOne-cluster.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ According to the introduction in [MatrixOne Distributed Cluster Deployment](depl
root@master0 ~]# mysql -h $(kubectl get svc/mo-tp-cn -n mo-hn -o jsonpath='{.spec.clusterIP}') -P 6001 -uroot -p111
Welcome to the MariaDB monitor. Commands end with ; or \g.
Your MySQL connection id is 1005
Server version: 8.0.30-MatrixOne-v1.0.0-rc2 MatrixOne
Server version: 8.0.30-MatrixOne-v1.0.0 MatrixOne
Copyright (c) 2000, 2018, Oracle, MariaDB Corporation Ab and others.
Expand Down
2 changes: 1 addition & 1 deletion docs/MatrixOne/Develop/Ecological-Tools/Computing-Engine/seatunnel-write.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ export SEATNUNNEL_HOME="/root/seatunnel"
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
```

2. Use the [mo_ctl](https://docs.matrixorigin.cn/1.0.0-rc2/MatrixOne/Maintain/mo_ctl/) tool to import the MySQL DDL statements into MatrixOne directly. Execute the following command:
2. Use the [mo_ctl](https://docs.matrixorigin.cn/1.0.0/MatrixOne/Maintain/mo_ctl/) tool to import the MySQL DDL statements into MatrixOne directly. Execute the following command:

```shell
mo_ctl sql /root/mysql.sql
Expand Down
2 changes: 1 addition & 1 deletion docs/MatrixOne/Develop/connect-mo/configure-mo-ssl-connection.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ To test the SSL configuration, perform the following steps:
Current pager: stdout
Using outfile: ''
Using delimiter: ;
Server version: 8.0.30-MatrixOne-v1.0.0-rc2 MatrixOne
Server version: 8.0.30-MatrixOne-v1.0.0 MatrixOne
Protocol version: 10
Connection: 127.0.0.1 via TCP/IP
Client characterset: utf8mb4
Expand Down
2 changes: 1 addition & 1 deletion docs/MatrixOne/Develop/connect-mo/database-client-tools.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ Make sure you have already [installed and launched MatrixOne](../../Get-Started/
```
Welcome to the MySQL monitor. Commands end with ; or \g. Your MySQL connection id is 1031
Server version: 8.0.30-MatrixOne-v1.0.0-rc2 MatrixOne
Server version: 8.0.30-MatrixOne-v1.0.0 MatrixOne
Copyright (c) 2000, 2022, Oracle and/or its affiliates.
Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.
Expand Down
2 changes: 1 addition & 1 deletion docs/MatrixOne/Develop/connect-mo/python-connect-to-matrixone.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ The PyMySQL is a pure-Python MySQL client library.
```
> python3 pymysql_connect_matrixone.py
Database version : 8.0.30-MatrixOne-v1.0.0-rc2
Database version : 8.0.30-MatrixOne-v1.0.0
```
## Using sqlalchemy connect to MatrixOne
Expand Down
2 changes: 1 addition & 1 deletion docs/MatrixOne/Develop/export-data/select-into-outfile.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ Make sure you have already [Deployed standalone MatrixOne](../../Get-Started/ins
If you install MatrixOne by `docker`, the directory is inside the docker image by default. To work with local directory, you need to bind a local directory to the container. In the following example, the local file system path `${local_data_path}/mo-data` is binded to the MatrixOne docker image, with a mapping to the `/mo-data` path. For more information, see [Docker Mount Volume tutorial](https://www.freecodecamp.org/news/docker-mount-volume-guide-how-to-mount-a-local-directory/).

```
sudo docker run --name <name> --privileged -d -p 6001:6001 -v ${local_data_path}/mo-data:/mo-data:rw matrixorigin/matrixone:1.0.0-rc2
sudo docker run --name <name> --privileged -d -p 6001:6001 -v ${local_data_path}/mo-data:/mo-data:rw matrixorigin/matrixone:1.0.0
```

### Steps
Expand Down
4 changes: 2 additions & 2 deletions docs/MatrixOne/Develop/import-data/bulk-load/load-csv.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ __Note__: A `csv`(comma-separated values) file is a delimited text file that use
### Example using `Load data` with `docker` version
If you install MatrixOne by `docker`, the file system is inside the docker image by default. To work with local directory, you need to bind a local directory to the container. In the following example, the local file system path `~/tmp/docker_loaddata_demo/` is binded to the MatrixOne docker image, with a mapping to the `/ssb-dbgen-path` path inside the docker.
We will walk you through the whole process of loading data with MatrixOne 1.0.0-rc2 docker version in this example.
We will walk you through the whole process of loading data with MatrixOne 1.0.0 docker version in this example.
1. Download the dataset file and store the data in *~/tmp/docker_loaddata_demo/*:
Expand All @@ -114,7 +114,7 @@ We will walk you through the whole process of loading data with MatrixOne 1.0.0-
3. Use Docker to launch MatrixOne, and mount the directory *~/tmp/docker_loaddata_demo/* that stores data files to a directory in the container. The container directory is */sb-dbgen-path* as an example:
```
sudo docker run --name matrixone --privileged -d -p 6001:6001 -v ~/tmp/docker_loaddata_demo/:/ssb-dbgen-path:rw matrixorigin/matrixone:1.0.0-rc2
sudo docker run --name matrixone --privileged -d -p 6001:6001 -v ~/tmp/docker_loaddata_demo/:/ssb-dbgen-path:rw matrixorigin/matrixone:1.0.0
```
4. Connect to MatrixOne server:
Expand Down
2 changes: 1 addition & 1 deletion docs/MatrixOne/Develop/import-data/bulk-load/using-source.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,6 @@ select * from tool;

## Constraints

MatrixOne 1.0.0-rc2 version already supports MySQL table creation statements, so you can smoothly migrate MySQL tables to MatrixOne. However, it should be noted that during the migration process, some keywords incompatible with MySQL, such as `engine=`, will be automatically ignored in MatrixOne and will not affect the migration of the table structure.
MatrixOne 1.0.0 version already supports MySQL table creation statements, so you can smoothly migrate MySQL tables to MatrixOne. However, it should be noted that during the migration process, some keywords incompatible with MySQL, such as `engine=`, will be automatically ignored in MatrixOne and will not affect the migration of the table structure.

However, it should be noted that although MatrixOne supports MySQL table creation statements, manual modification is still required if the migrated table contains incompatible data types, triggers, functions, or stored procedures. For more detailed compatibility information, see [MySQL Compatibility](../../../Overview/feature/mysql-compatibility.md).
20 changes: 10 additions & 10 deletions docs/MatrixOne/Get-Started/install-on-linux/install-on-linux-method1.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,12 @@ MatrixOne supports x86 and ARM Linux systems. This article uses the Debian11.1 x

To install and use the stand-alone MatrixOne through source code, you need to depend on the following software packages.

| Dependent software | Version |
| ------------ | ----------------------------- |
| golang | 1.20 or later |
| gcc | gcc8.5 or later|
| git | 2.20 or later |
| MySQL Client | 8.0 or later |
| Dependent software | Version |
| ------------------ | --------------- |
| golang | 1.20 or later |
| gcc | gcc8.5 or later |
| git | 2.20 or later |
| MySQL Client | 8.0 or later |

## Step 1: Install Dependency

Expand Down Expand Up @@ -184,7 +184,7 @@ GCC_VERSION="8.5.0"
CLANG_VERSION="13.0"
GO_VERSION="1.20"
MO_GIT_URL="https://github.com/matrixorigin/matrixone.git"
MO_DEFAULT_VERSION="1.0.0-rc2"
MO_DEFAULT_VERSION="v1.0.0"
GOPROXY="https://goproxy.cn,direct"
STOP_INTERVAL="5"
START_INTERVAL="2"
Expand All @@ -200,7 +200,7 @@ Generally, the parameters that may need to be adjusted are as follows:
````
mo_ctl set_conf MO_PATH="/data/mo/matrixone" # Set custom MatrixOne download path
mo_ctl set_conf MO_GIT_URL="https://ghproxy.com/https://github.com/matrixorigin/matrixone.git" # For the problem of slow downloading from the original GitHub address, set the proxy download address
mo_ctl set_conf MO_DEFAULT_VERSION="1.0.0-rc2" # Set the version of MatrixOne downloaded
mo_ctl set_conf MO_DEFAULT_VERSION="v1.0.0" # Set the version of MatrixOne downloaded
````
## Step 3: Get MatrixOne code
Expand All @@ -218,7 +218,7 @@ Depending on your needs, choose whether you want to keep your code up to date, o
=== "Get the MatrixOne(Stable Version) code to build"
```
mo_ctl deploy 1.0.0-rc2
mo_ctl deploy v1.0.0
```
## Step 4: Launch MatrixOne server
Expand Down Expand Up @@ -255,7 +255,7 @@ root@VM-16-2-debian:~# mo_ctl connect
mysql: [Warning] Using a password on the command line interface can be insecure.
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 15
Server version: 8.0.30-MatrixOne-v1.0.0-rc2 MatrixOne
Server version: 8.0.30-MatrixOne-v1.0.0 MatrixOne

Copyright (c) 2000, 2023, Oracle and/or its affiliates.

Expand Down
26 changes: 13 additions & 13 deletions docs/MatrixOne/Get-Started/install-on-linux/install-on-linux-method2.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ MatrixOne supports x86 and ARM Linux systems. This article uses the Debian11.1 x

Only the MySQL Client tool must be installed to deploy and install MatrixOne through the binary package.

| Dependent software | Version |
| ------------ | ----------------------------- |
| MySQL Client | 8.0 or later |
| Dependent software | Version |
| ------------------ | ------------ |
| MySQL Client | 8.0 or later |

## Step 1: Install Dependency

Expand Down Expand Up @@ -96,16 +96,16 @@ The Debian11.1 version does not have MySQL Client installed by default, so it ne
```bash
mkdir -p /root/matrixone & cd /root/
wget https://github.com/matrixorigin/matrixone/releases/download/v1.0.0-rc2/mo-v1.0.0-rc2-linux-x86_64.zip
unzip -d matrixone/ mo-v1.0.0-rc2-linux-x86_64.zip
wget https://github.com/matrixorigin/matrixone/releases/download/v1.0.0/mo-v1.0.0-linux-x86_64.zip
unzip -d matrixone/ mo-v1.0.0-linux-x86_64.zip
```
Binary for ARM architecture system:
```bash
mkdir -p /root/matrixone & cd /root/
wget https://github.com/matrixorigin/matrixone/releases/download/v1.0.0-rc2/mo-v1.0.0-rc2-linux-arm64.zip
unzip -d matrixone/ mo-v1.0.0-rc2-linux-arm64.zip
wget https://github.com/matrixorigin/matrixone/releases/download/v1.0.0/mo-v1.0.0-linux-arm64.zip
unzip -d matrixone/ mo-v1.0.0-linux-arm64.zip
```
=== "**Downloading method 2: Using `curl` to install binary packages**"
Expand All @@ -114,21 +114,21 @@ The Debian11.1 version does not have MySQL Client installed by default, so it ne
```bash
mkdir -p /root/matrixone & cd /root/
curl -OL https://github.com/matrixorigin/matrixone/releases/download/v1.0.0-rc2/mo-v1.0.0-rc2-linux-x86_64.zip
unzip -d matrixone/ mo-v1.0.0-rc2-linux-x86_64.zip
curl -OL https://github.com/matrixorigin/matrixone/releases/download/v1.0.0/mo-v1.0.0-linux-x86_64.zip
unzip -d matrixone/ mo-v1.0.0-linux-x86_64.zip
```
Binary for ARM architecture system:
```bash
mkdir -p /root/matrixone & cd /root/
curl -OL https://github.com/matrixorigin/matrixone/releases/download/v1.0.0-rc2/mo-v1.0.0-rc2-linux-arm64.zip
unzip -d matrixone/ mo-v1.0.0-rc2-linux-arm64.zip
curl -OL https://github.com/matrixorigin/matrixone/releases/download/v1.0.0/mo-v1.0.0-linux-arm64.zip
unzip -d matrixone/ mo-v1.0.0-linux-arm64.zip
```
=== "**Downloading method 3: Go to the page and download**"
If you want a more intuitive way to download the page, go to the [version 1.0.0-rc2](https://github.com/matrixorigin/matrixone/releases/tag/v1.0.0-rc2), pull down to find the **Assets** column, and click the installation package *mo-v1.0.0-rc2-linux-x86_64.zip* or *mo-v1.0.0-rc2-linux-arm64.zip* can be downloaded.
If you want a more intuitive way to download the page, go to the [version 1.0.0](https://github.com/matrixorigin/matrixone/releases/tag/v1.0.0), pull down to find the **Assets** column, and click the installation package *mo-v1.0.0-linux-x86_64.zip* or *mo-v1.0.0-linux-arm64.zip* can be downloaded.
## Step 3: Install the mo_ctl tool
Expand Down Expand Up @@ -184,7 +184,7 @@ root@VM-16-2-debian:~# mo_ctl connect
mysql: [Warning] Using a password on the command line interface can be insecure.
Welcome to the MySQL monitor. Commands end with ; or \g.
Your MySQL connection id is 15
Server version: 8.0.30-MatrixOne-v1.0.0-rc2 MatrixOne
Server version: 8.0.30-MatrixOne-v1.0.0 MatrixOne

Copyright (c) 2000, 2023, Oracle and/or its affiliates.

Expand Down
12 changes: 6 additions & 6 deletions docs/MatrixOne/Get-Started/install-on-linux/install-on-linux-method3.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,18 +41,18 @@ This document will guide you build standalone MatrixOne using Docker.
It will pull the image from Docker Hub if not exists. You can choose to pull the stable version image or the develop version image.
=== "Stable Version Image(1.0.0-rc2 version)"
=== "Stable Version Image(1.0.0 version)"
```bash
docker pull matrixorigin/matrixone:1.0.0-rc2
docker run -d -p 6001:6001 --name matrixone matrixorigin/matrixone:1.0.0-rc2
docker pull matrixorigin/matrixone:1.0.0
docker run -d -p 6001:6001 --name matrixone matrixorigin/matrixone:1.0.0
```
If you are using the network in mainland China, you can pull the MatrixOne stable version image on Alibaba Cloud:
```bash
docker pull registry.cn-shanghai.aliyuncs.com/matrixorigin/matrixone:1.0.0-rc2
docker run -d -p 6001:6001 --name matrixone registry.cn-shanghai.aliyuncs.com/matrixorigin/matrixone:1.0.0-rc2
docker pull registry.cn-shanghai.aliyuncs.com/matrixorigin/matrixone:1.0.0
docker run -d -p 6001:6001 --name matrixone registry.cn-shanghai.aliyuncs.com/matrixorigin/matrixone:1.0.0
```
=== "Develop Version Image"
Expand All @@ -77,7 +77,7 @@ It will pull the image from Docker Hub if not exists. You can choose to pull the
If your Docker version is lower than 20.10.18 or the Docker client and server versions are inconsistent, upgrading to the latest stable version before attempting is recommended. If you choose to proceed with the current versions, you need to add the parameter `--privileged=true` to the `docker run` command, as shown below:
```bash
docker run -d -p 6001:6001 --name matrixone --privileged=true matrixorigin/matrixone:1.0.0-rc2
docker run -d -p 6001:6001 --name matrixone --privileged=true matrixorigin/matrixone:1.0.0
```
!!! note
Expand Down
Loading

0 comments on commit fe22b92

Please sign in to comment.