From 17298f85ec88848ef62f5fecfe6466bdb62b4a44 Mon Sep 17 00:00:00 2001 From: VampireAchao Date: Sun, 16 Jun 2024 17:47:53 +0800 Subject: [PATCH 1/7] [improve] Add h2 dialect usage documentation --- docs/get-started/3.dockerDeployment.md | 8 +++++++- .../current/get-started/3.dockerDeployment.md | 8 +++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/get-started/3.dockerDeployment.md b/docs/get-started/3.dockerDeployment.md index 1e32ff2e9..f0d1e23cb 100644 --- a/docs/get-started/3.dockerDeployment.md +++ b/docs/get-started/3.dockerDeployment.md @@ -22,7 +22,13 @@ To start the service with docker-compose, you need to install [docker-compose](h ### 1. Apache StreamPark™ deployment based on h2 and docker-compose -This method is suitable for beginners to learn and become familiar with the features. The configuration will reset after the container is restarted. Below, you can configure Mysql or Pgsql for persistence. +This method is suitable for beginners to learn, become familiar with the features, and use on a lightweight scale. + +H2 is a lightweight embedded relational database with a small footprint, high performance, and easy integration into Java applications. Its syntax is very similar to MySQL, and it supports persistence. StreamPark uses H2 as its default configuration, allowing developers to quickly get started. + +The default persistence configuration for H2 (`datasource.h2-dir`) is set to `~/streampark/h2-data` under the user's directory. If the user configures `datasource.h2-dir` to a custom path, such as `~/streampark/h2-data-dir`, users can adjust this configuration according to their needs. + +Additionally, you can also configure MySQL or PostgreSQL for persistence. ### 2. Deployment diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md index 618d018fe..293d19906 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md @@ -21,7 +21,13 @@ sidebar_position: 3 ### 1. 基于 h2 和 docker-compose 部署 Apache StreamPark™ -该方式适用于入门学习、熟悉功能特性，容器重启后配置会失效，下方可以配置Mysql、Pgsql进行持久化 +该方式适用于入门学习、熟悉功能特性以及轻量规模使用 + +H2 是一个体积小、性能高、易于嵌入 Java 应用程序的轻量级嵌入式关系型数据库，其语法和 Mysql 大同小异，同时其支持持久化，StreamPark 默认配置也是采用 H2 数据库，方便开发者快速使用 + +H2 默认持久化配置 `datasource.h2-dir` 目录为 `~/streampark/h2-data` 下，如用户自由配置 `datasource.h2-dir`，例如配置为 `~/streampark/h2-data-dir`，用户可以根据自己的需求进行配置 + +同时下方也可以配置Mysql、Pgsql进行持久化 #### 2. 部署 From 5baf9ae0900d254f78d4008ccb5efd4a840b6eb4 Mon Sep 17 00:00:00 2001 From: VampireAchao Date: Wed, 19 Jun 2024 00:08:32 +0800 Subject: [PATCH 2/7] [improve] Update h2 dialect usage documentation --- docs/get-started/3.dockerDeployment.md | 12 +++++++++--- .../current/get-started/3.dockerDeployment.md | 12 ++++++++++-- 2 files changed, 19 insertions(+), 5 deletions(-) diff --git a/docs/get-started/3.dockerDeployment.md b/docs/get-started/3.dockerDeployment.md index f0d1e23cb..be0ba0e57 100644 --- a/docs/get-started/3.dockerDeployment.md +++ b/docs/get-started/3.dockerDeployment.md @@ -24,11 +24,17 @@ To start the service with docker-compose, you need to install [docker-compose](h This method is suitable for beginners to learn, become familiar with the features, and use on a lightweight scale. -H2 is a lightweight embedded relational database with a small footprint, high performance, and easy integration into Java applications. Its syntax is very similar to MySQL, and it supports persistence. StreamPark uses H2 as its default configuration, allowing developers to quickly get started. +H2 is a lightweight, high-performance embedded relational database that is easy to integrate into Java applications. It has a syntax similar to MySQL and supports data persistence. StreamPark defaults to using the H2 database, allowing developers to quickly start projects -The default persistence configuration for H2 (`datasource.h2-dir`) is set to `~/streampark/h2-data` under the user's directory. If the user configures `datasource.h2-dir` to a custom path, such as `~/streampark/h2-data-dir`, users can adjust this configuration according to their needs. +To achieve data persistence, you can configure the datasource.h2-data-dir parameter to specify the storage path for the data files. This ensures that data will not be lost even if the service is restarted -Additionally, you can also configure MySQL or PostgreSQL for persistence. +datasource.h2-data-dir: Used to specify the storage path of the H2 database files, by default located in the ~/streampark/h2-data/ directory in the user's home directory + +Regarding the H2 console, according to the configuration code, the access path /h2-console has been set to be enabled by default and allows access from other computers. The console can be used to execute SQL queries, manage databases, etc + +After opening /h2-console, fill in JDBC_URL as the H2 database file directory + /metadata, for example, if the default configuration has not been modified, fill in as jdbc:h2:~/streampark/h2-data/metadata + +Username and password: The default username is admin, the password is streampark ### 2. Deployment diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md index 293d19906..9aee6b33e 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md @@ -23,9 +23,17 @@ sidebar_position: 3 该方式适用于入门学习、熟悉功能特性以及轻量规模使用 -H2 是一个体积小、性能高、易于嵌入 Java 应用程序的轻量级嵌入式关系型数据库，其语法和 Mysql 大同小异，同时其支持持久化，StreamPark 默认配置也是采用 H2 数据库，方便开发者快速使用 +H2 是一个体积小、性能高、易于嵌入 Java 应用程序的轻量级嵌入式关系型数据库。与 MySQL 有着相似的语法，并且支持数据持久化。StreamPark 默认使用 H2 数据库，使开发者能够快速开始项目 -H2 默认持久化配置 `datasource.h2-dir` 目录为 `~/streampark/h2-data` 下，如用户自由配置 `datasource.h2-dir`，例如配置为 `~/streampark/h2-data-dir`，用户可以根据自己的需求进行配置 +为了实现数据的持久化存储，您可以配置 datasource.h2-data-dir 参数来指定数据文件的存储路径。这确保了即便重启服务，数据也不会丢失 + +datasource.h2-data-dir: 用于指定 H2 数据库文件的存储路径，默认在用户主目录下的 ~/streampark/h2-data/ 目录下 + +关于 H2 控制台，根据配置代码，访问路径 /h2-console 已被设定为默认启用，并允许从其他计算机访问。控制台可用于执行 SQL 查询、管理数据库等操作 + +打开 /h2-console 以后填写 JDBC_URL 为 H2 数据库文件目录 + /metadata，如默认配置未修改的情况下填写为 jdbc:h2:~/streampark/h2-data/metadata + +用户名和密码: 默认的用户名为 admin，密码为 streampark 同时下方也可以配置Mysql、Pgsql进行持久化 From 8180b634c5db5f8ef2c5faf23416769688a842d8 Mon Sep 17 00:00:00 2001 From: VampireAchao Date: Tue, 2 Jul 2024 21:49:22 +0800 Subject: [PATCH 3/7] [improve] Update h2 dialect usage documentation --- docs/get-started/3.dockerDeployment.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docs/get-started/3.dockerDeployment.md b/docs/get-started/3.dockerDeployment.md index be0ba0e57..8a3c4e010 100644 --- a/docs/get-started/3.dockerDeployment.md +++ b/docs/get-started/3.dockerDeployment.md @@ -36,6 +36,8 @@ After opening /h2-console, fill in JDBC_URL as the H2 database file directory + Username and password: The default username is admin, the password is streampark +Below, you can configure Mysql or Pgsql for persistence. + ### 2. Deployment ```shell From 005fe882ba99af03347444d49c6c9f0f46f2ab3f Mon Sep 17 00:00:00 2001 From: VampireAchao Date: Sat, 26 Jul 2025 10:02:04 +0800 Subject: [PATCH 4/7] Update i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md Co-authored-by: Yuepeng Pan --- .../current/get-started/3.dockerDeployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md index 9aee6b33e..a5d261ecd 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md @@ -35,7 +35,7 @@ datasource.h2-data-dir: 用于指定 H2 数据库文件的存储路径，默认 用户名和密码: 默认的用户名为 admin，密码为 streampark -同时下方也可以配置Mysql、Pgsql进行持久化 +同时下方也可以配置 MySQL、PgSQL 进行持久化 #### 2. 部署 From 8e2e1e8044558bd00460441135d8066917583204 Mon Sep 17 00:00:00 2001 From: VampireAchao Date: Sat, 26 Jul 2025 10:02:11 +0800 Subject: [PATCH 5/7] Update docs/get-started/3.dockerDeployment.md Co-authored-by: Yuepeng Pan --- docs/get-started/3.dockerDeployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/get-started/3.dockerDeployment.md b/docs/get-started/3.dockerDeployment.md index 8a3c4e010..e7c93a27f 100644 --- a/docs/get-started/3.dockerDeployment.md +++ b/docs/get-started/3.dockerDeployment.md @@ -36,7 +36,7 @@ After opening /h2-console, fill in JDBC_URL as the H2 database file directory + Username and password: The default username is admin, the password is streampark -Below, you can configure Mysql or Pgsql for persistence. +Below, you can configure MySQL or PgSQL for persistence. ### 2. Deployment From b4252168c185352f9f83cc83312aff6fd0d186a3 Mon Sep 17 00:00:00 2001 From: VampireAchao Date: Sat, 26 Jul 2025 10:04:01 +0800 Subject: [PATCH 6/7] commit suggestion --- .../current/get-started/3.dockerDeployment.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md index 9aee6b33e..8a9b930a2 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md @@ -25,7 +25,7 @@ sidebar_position: 3 H2 是一个体积小、性能高、易于嵌入 Java 应用程序的轻量级嵌入式关系型数据库。与 MySQL 有着相似的语法，并且支持数据持久化。StreamPark 默认使用 H2 数据库，使开发者能够快速开始项目 -为了实现数据的持久化存储，您可以配置 datasource.h2-data-dir 参数来指定数据文件的存储路径。这确保了即便重启服务，数据也不会丢失 +从 2.1.5 开始，StreamPark 支持了 h2 数据文件的本地持久化(系统重启后，数据不丢失), 您可以配置 datasource.h2-data-dir 参数来指定数据文件的存储路径。这确保了即便重启服务，数据也不会丢失 datasource.h2-data-dir: 用于指定 H2 数据库文件的存储路径，默认在用户主目录下的 ~/streampark/h2-data/ 目录下 From f13ca1bfc5d33c4fa00f1babf12b86fe650fc8ad Mon Sep 17 00:00:00 2001 From: VampireAchao Date: Mon, 28 Jul 2025 11:11:02 +0800 Subject: [PATCH 7/7] keep same style --- docs/get-started/3.dockerDeployment.md | 16 ++++++++-------- .../current/get-started/3.dockerDeployment.md | 16 ++++++++-------- 2 files changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/get-started/3.dockerDeployment.md b/docs/get-started/3.dockerDeployment.md index 62adbbf2d..fa0d2bc42 100644 --- a/docs/get-started/3.dockerDeployment.md +++ b/docs/get-started/3.dockerDeployment.md @@ -22,21 +22,21 @@ To start the service with docker-compose, you need to install [docker-compose](h ### 1. Apache StreamPark™ deployment based on h2 and docker-compose -This method is suitable for beginners to learn, become familiar with the features, and use on a lightweight scale. +- This method is suitable for beginners to learn, become familiar with the features, and use on a lightweight scale. -H2 is a lightweight, high-performance embedded relational database that is easy to integrate into Java applications. It has a syntax similar to MySQL and supports data persistence. StreamPark defaults to using the H2 database, allowing developers to quickly start projects +- H2 is a lightweight, high-performance embedded relational database that is easy to integrate into Java applications. It has a syntax similar to MySQL and supports data persistence. StreamPark defaults to using the H2 database, allowing developers to quickly start projects -To achieve data persistence, you can configure the datasource.h2-data-dir parameter to specify the storage path for the data files. This ensures that data will not be lost even if the service is restarted +- To achieve data persistence, you can configure the datasource.h2-data-dir parameter to specify the storage path for the data files. This ensures that data will not be lost even if the service is restarted -datasource.h2-data-dir: Used to specify the storage path of the H2 database files, by default located in the ~/streampark/h2-data/ directory in the user's home directory +- datasource.h2-data-dir: Used to specify the storage path of the H2 database files, by default located in the ~/streampark/h2-data/ directory in the user's home directory -Regarding the H2 console, according to the configuration code, the access path /h2-console has been set to be enabled by default and allows access from other computers. The console can be used to execute SQL queries, manage databases, etc +- Regarding the H2 console, according to the configuration code, the access path /h2-console has been set to be enabled by default and allows access from other computers. The console can be used to execute SQL queries, manage databases, etc -After opening /h2-console, fill in JDBC_URL as the H2 database file directory + /metadata, for example, if the default configuration has not been modified, fill in as jdbc:h2:~/streampark/h2-data/metadata +- After opening /h2-console, fill in JDBC_URL as the H2 database file directory + /metadata, for example, if the default configuration has not been modified, fill in as jdbc:h2:~/streampark/h2-data/metadata -Username and password: The default username is admin, the password is streampark +- Username and password: The default username is admin, the password is streampark -Below, you can configure MySQL or PgSQL for persistence. +- Below, you can configure MySQL or PgSQL for persistence. ### 2. Deployment diff --git a/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md index 3b2cc3558..2d8f43325 100644 --- a/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md +++ b/i18n/zh-CN/docusaurus-plugin-content-docs/current/get-started/3.dockerDeployment.md @@ -21,21 +21,21 @@ sidebar_position: 3 ### 1. 基于 h2 和 docker-compose 部署 Apache StreamPark™ -该方式适用于入门学习、熟悉功能特性以及轻量规模使用 +- 该方式适用于入门学习、熟悉功能特性以及轻量规模使用 -H2 是一个体积小、性能高、易于嵌入 Java 应用程序的轻量级嵌入式关系型数据库。与 MySQL 有着相似的语法，并且支持数据持久化。StreamPark 默认使用 H2 数据库，使开发者能够快速开始项目 +- H2 是一个体积小、性能高、易于嵌入 Java 应用程序的轻量级嵌入式关系型数据库。与 MySQL 有着相似的语法，并且支持数据持久化。StreamPark 默认使用 H2 数据库，使开发者能够快速开始项目 -从 2.1.5 开始，StreamPark 支持了 h2 数据文件的本地持久化(系统重启后，数据不丢失), 您可以配置 datasource.h2-data-dir 参数来指定数据文件的存储路径。这确保了即便重启服务，数据也不会丢失 +- 从 2.1.5 开始，StreamPark 支持了 h2 数据文件的本地持久化(系统重启后，数据不丢失), 您可以配置 datasource.h2-data-dir 参数来指定数据文件的存储路径。这确保了即便重启服务，数据也不会丢失 -datasource.h2-data-dir: 用于指定 H2 数据库文件的存储路径，默认在用户主目录下的 ~/streampark/h2-data/ 目录下 +- datasource.h2-data-dir: 用于指定 H2 数据库文件的存储路径，默认在用户主目录下的 ~/streampark/h2-data/ 目录下 -关于 H2 控制台，根据配置代码，访问路径 /h2-console 已被设定为默认启用，并允许从其他计算机访问。控制台可用于执行 SQL 查询、管理数据库等操作 +- 关于 H2 控制台，根据配置代码，访问路径 /h2-console 已被设定为默认启用，并允许从其他计算机访问。控制台可用于执行 SQL 查询、管理数据库等操作 -打开 /h2-console 以后填写 JDBC_URL 为 H2 数据库文件目录 + /metadata，如默认配置未修改的情况下填写为 jdbc:h2:~/streampark/h2-data/metadata +- 打开 /h2-console 以后填写 JDBC_URL 为 H2 数据库文件目录 + /metadata，如默认配置未修改的情况下填写为 jdbc:h2:~/streampark/h2-data/metadata -用户名和密码: 默认的用户名为 admin，密码为 streampark +- 用户名和密码: 默认的用户名为 admin，密码为 streampark -同时下方也可以配置 MySQL、PgSQL 进行持久化 +- 同时下方也可以配置 MySQL、PgSQL 进行持久化 #### 2. 部署