Skip to content

Commit 554e430

Browse files
morningmanmorningman
authored
[opt] fix format of jdbc catalog overview (#2633)
## Versions - [x] dev - [x] 3.0 - [x] 2.1 - [ ] 2.0 ## Languages - [x] Chinese - [x] English ## Docs Checklist - [ ] Checked by AI - [ ] Test Cases Built
1 parent 65435c8 commit 554e430

File tree

6 files changed

+171
-171
lines changed

6 files changed

+171
-171
lines changed

‎docs/lakehouse/catalogs/jdbc-catalog-overview.md

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -48,35 +48,35 @@ CREATE CATALOG [IF NOT EXISTS] catalog_name PROPERTIES (
4848

4949
* Required Properties
5050

51-
| Parameter Name | Description | Example |
52-
| ---------------- | ---------------------------------------- | ----------------------------- |
53-
| `user` | Data source username | |
54-
| `password` | Data source password | |
55-
| `jdbc_url` | Data source connection URL | `jdbc:mysql://host:3306` |
56-
| `driver_url` | Path to the JDBC driver file. For driver package security, see the appendix. | Supports three methods, see below. |
57-
| `driver_class` | Class name of the JDBC driver | |
58-
59-
`driver_url` supports the following three specifications:
51+
| Parameter Name | Description | Example |
52+
| ---------------- | ---------------------------------------- | ----------------------------- |
53+
| `user` | Data source username | |
54+
| `password` | Data source password | |
55+
| `jdbc_url` | Data source connection URL | `jdbc:mysql://host:3306` |
56+
| `driver_url` | Path to the JDBC driver file. For driver package security, see the appendix. | Supports three methods, see below. |
57+
| `driver_class` | Class name of the JDBC driver | |
58+
59+
`driver_url` supports the following three specifications:
6060

61-
1. Filename. For example, `mysql-connector-j-8.3.0.jar`. The Jar file must be pre-placed in the `jdbc_drivers/` directory under the FE and BE deployment directories. The system will automatically search in this directory. The location can also be modified by the `jdbc_drivers_dir` configuration in `fe.conf` and `be.conf`.
62-
63-
2. Local absolute path. For example, `file:///path/to/mysql-connector-j-8.3.0.jar`. The Jar file must be pre-placed in the specified path on all FE/BE nodes.
64-
65-
3. HTTP URL. For example: `http://repo1.maven.org/maven2/com/mysql/mysql-connector-j/8.3.0/mysql-connector-j-8.3.0.jar`. The system will download the driver file from this HTTP address. Only supports HTTP services without authentication.
61+
1. Filename. For example, `mysql-connector-j-8.3.0.jar`. The Jar file must be pre-placed in the `jdbc_drivers/` directory under the FE and BE deployment directories. The system will automatically search in this directory. The location can also be modified by the `jdbc_drivers_dir` configuration in `fe.conf` and `be.conf`.
62+
63+
2. Local absolute path. For example, `file:///path/to/mysql-connector-j-8.3.0.jar`. The Jar file must be pre-placed in the specified path on all FE/BE nodes.
64+
65+
3. HTTP URL. For example: `http://repo1.maven.org/maven2/com/mysql/mysql-connector-j/8.3.0/mysql-connector-j-8.3.0.jar`. The system will download the driver file from this HTTP address. Only supports HTTP services without authentication.
6666

6767
* Optional Properties
6868

69-
| Parameter Name | Default Value | Description |
70-
| ----------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
71-
| `lower_case_meta_names` | false | Whether to synchronize the database, table, and column names from the external data source in lowercase |
72-
| `meta_names_mapping` | | When the external data source has names that differ only in case, such as `MY_TABLE` and `my_table`, Doris will report an error due to ambiguity when querying the Catalog. You need to configure the `meta_names_mapping` parameter to resolve conflicts. |
73-
| `only_specified_database` | false | Whether to synchronize only the database specified in the `jdbc_url` (this Database maps to the Database level in Doris) |
74-
| `connection_pool_min_size` | 1 | Defines the minimum number of connections in the connection pool, used to initialize the pool and ensure at least this number of active connections when keep-alive is enabled. |
75-
| `connection_pool_max_size` | 30 | Defines the maximum number of connections in the connection pool. Each FE or BE node corresponding to each Catalog can hold up to this number of connections. |
76-
| `connection_pool_max_wait_time`| 5000 | Defines the maximum wait time in milliseconds for a client to wait for a connection if none are available in the pool. |
77-
| `connection_pool_max_life_time`| 1800000 | Sets the maximum active duration (in milliseconds) for a connection in the pool. Connections exceeding this time will be recycled. Additionally, half of this value is used as the minimum eviction idle time for the pool, making connections reaching this time eligible for eviction. |
78-
| `connection_pool_keep_alive` | false | Effective only on BE nodes, it determines whether to keep connections active that have reached the minimum eviction idle time but not the maximum lifetime. Disabled by default to reduce unnecessary resource usage. |
79-
69+
| Parameter Name | Default Value | Description |
70+
| ----------------------------- | ------------- | --------------------------------------------------------------------------------------------------------------------------------------------- |
71+
| `lower_case_meta_names` | false | Whether to synchronize the database, table, and column names from the external data source in lowercase |
72+
| `meta_names_mapping` | | When the external data source has names that differ only in case, such as `MY_TABLE` and `my_table`, Doris will report an error due to ambiguity when querying the Catalog. You need to configure the `meta_names_mapping` parameter to resolve conflicts. |
73+
| `only_specified_database` | false | Whether to synchronize only the database specified in the `jdbc_url` (this Database maps to the Database level in Doris) |
74+
| `connection_pool_min_size` | 1 | Defines the minimum number of connections in the connection pool, used to initialize the pool and ensure at least this number of active connections when keep-alive is enabled. |
75+
| `connection_pool_max_size` | 30 | Defines the maximum number of connections in the connection pool. Each FE or BE node corresponding to each Catalog can hold up to this number of connections. |
76+
| `connection_pool_max_wait_time`| 5000 | Defines the maximum wait time in milliseconds for a client to wait for a connection if none are available in the pool. |
77+
| `connection_pool_max_life_time`| 1800000 | Sets the maximum active duration (in milliseconds) for a connection in the pool. Connections exceeding this time will be recycled. Additionally, half of this value is used as the minimum eviction idle time for the pool, making connections reaching this time eligible for eviction. |
78+
| `connection_pool_keep_alive` | false | Effective only on BE nodes, it determines whether to keep connections active that have reached the minimum eviction idle time but not the maximum lifetime. Disabled by default to reduce unnecessary resource usage. |
79+
8080
* `{CommonProperties}`
8181

8282
The CommonProperties section is used to configure common properties. Please refer to the [Catalog Overview](../catalog-overview.md) section on **Common Properties**.
@@ -443,15 +443,15 @@ SQL Server: Login is locked out
443443
444444
* Increase the maximum number of connections in the pool:
445445
446-
```sql
447-
ALTER CATALOG catalog_name SET PROPERTIES ('connection_pool_max_size' = '100');
448-
```
446+
```sql
447+
ALTER CATALOG catalog_name SET PROPERTIES ('connection_pool_max_size' = '100');
448+
```
449449
450450
* Increase the connection timeout:
451451
452-
```sql
453-
ALTER CATALOG catalog_name SET PROPERTIES ('connection_pool_max_wait_time' = '10000');
454-
```
452+
```sql
453+
ALTER CATALOG catalog_name SET PROPERTIES ('connection_pool_max_wait_time' = '10000');
454+
```
455455
456456
* If there are additional error messages besides `Connection is not available, request timed out after 5000ms`, check these additional errors:
457457

‎i18n/zh-CN/docusaurus-plugin-content-docs/current/lakehouse/catalogs/jdbc-catalog-overview.md

Lines changed: 26 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -48,36 +48,36 @@ CREATE CATALOG [IF NOT EXISTS] catalog_name PROPERTIES (
4848

4949
* 必须属性
5050

51-
| 参数名称 | 说明 | 示例 |
52-
| ------------- | --------------------------------- | ---------------------- |
53-
| `user` | 数据源用户名 | |
54-
| `password` | 数据源密码 | |
55-
| `jdbc_url` | 数据源连接 URL | `jdbc:mysql://host:3306` |
56-
| `driver_url` | 数据源 JDBC 驱动程序文件的路径。关于驱动包安全性，详见附录。 | 驱动程序支持三种方式，详见下面说明。 |
57-
| `driver_class` | 数据源 JDBC 驱动程序的类名 | |
58-
59-
`driver_url` 支持以下三种指定方式：
60-
61-
1. 文件名。如 `mysql-connector-j-8.3.0.jar`。需将 Jar 包预先存放在 FE 和 BE 部署目录下的 `jdbc_drivers/` 目录下。系统会自动在这个目录下寻找。该目录的位置，也可以由 `fe.conf` 和 `be.conf` 中的 `jdbc_drivers_dir` 配置修改。
62-
63-
2. 本地绝对路径。如 `file:///path/to/mysql-connector-j-8.3.0.jar`。需将 Jar 包预先存放在所有 FE/BE 节点指定的路径下。
64-
65-
3. Http 地址。如：`http://repo1.maven.org/maven2/com/mysql/mysql-connector-j/8.3.0/mysql-connector-j-8.3.0.jar` 系统会从这个 Http 地址下载 Driver 文件。仅支持无认证的 Http 服务。
51+
| 参数名称 | 说明 | 示例 |
52+
| ------------- | --------------------------------- | ---------------------- |
53+
| `user` | 数据源用户名 | |
54+
| `password` | 数据源密码 | |
55+
| `jdbc_url` | 数据源连接 URL | `jdbc:mysql://host:3306` |
56+
| `driver_url` | 数据源 JDBC 驱动程序文件的路径。关于驱动包安全性，详见附录。 | 驱动程序支持三种方式，详见下面说明。 |
57+
| `driver_class` | 数据源 JDBC 驱动程序的类名 | |
58+
59+
`driver_url` 支持以下三种指定方式：
60+
61+
1. 文件名。如 `mysql-connector-j-8.3.0.jar`。需将 Jar 包预先存放在 FE 和 BE 部署目录下的 `jdbc_drivers/` 目录下。系统会自动在这个目录下寻找。该目录的位置，也可以由 `fe.conf` 和 `be.conf` 中的 `jdbc_drivers_dir` 配置修改。
62+
63+
2. 本地绝对路径。如 `file:///path/to/mysql-connector-j-8.3.0.jar`。需将 Jar 包预先存放在所有 FE/BE 节点指定的路径下。
64+
65+
3. Http 地址。如：`http://repo1.maven.org/maven2/com/mysql/mysql-connector-j/8.3.0/mysql-connector-j-8.3.0.jar` 系统会从这个 Http 地址下载 Driver 文件。仅支持无认证的 Http 服务。
6666

6767

6868
* 可选属性
6969

70-
| 参数名称 | 默认值 | 说明 |
71-
| --------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
72-
| `lower_case_meta_names` | false | 是否以小写的形式同步外部数据源的库名和表名以及列名 |
73-
| `meta_names_mapping` | | 当外部数据源存在名称相同只有大小写不同的情况，例如 `MY_TABLE` 和 `my_table`，Doris 由于歧义而在查询 Catalog 时报错，此时需要配置 `meta_names_mapping` 参数来解决冲突。 |
74-
| `only_specified_database` | false | 是否只同步 `jdbc_url` 中指定的数据源的 Database（此处的 Database 为映射到 Doris 的 Database 层级） |
75-
| `connection_pool_min_size` | 1 | 定义连接池的最小连接数，用于初始化连接池并保证在启用保活机制时至少有该数量的连接处于活跃状态。 |
76-
| `connection_pool_max_size` | 30 | 定义连接池的最大连接数，每个 Catalog 对应的每个 FE 或 BE 节点最多可持有此数量的连接。 |
77-
| `connection_pool_max_wait_time` | 5000 | 如果连接池中没有可用连接，定义客户端等待连接的最大毫秒数。 |
78-
| `connection_pool_max_life_time` | 1800000 | 设置连接在连接池中保持活跃的最大时长（毫秒）。超时的连接将被回收。同时，此值的一半将作为连接池的最小逐出空闲时间，达到该时间的连接将成为逐出候选对象。 |
79-
| `connection_pool_keep_alive` | false | 仅在 BE 节点上有效，用于决定是否保持达到最小逐出空闲时间但未到最大生命周期的连接活跃。默认关闭，以减少不必要的资源使用。 |
80-
70+
| 参数名称 | 默认值 | 说明 |
71+
| --------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------- |
72+
| `lower_case_meta_names` | false | 是否以小写的形式同步外部数据源的库名和表名以及列名 |
73+
| `meta_names_mapping` | | 当外部数据源存在名称相同只有大小写不同的情况，例如 `MY_TABLE` 和 `my_table`，Doris 由于歧义而在查询 Catalog 时报错，此时需要配置 `meta_names_mapping` 参数来解决冲突。 |
74+
| `only_specified_database` | false | 是否只同步 `jdbc_url` 中指定的数据源的 Database（此处的 Database 为映射到 Doris 的 Database 层级） |
75+
| `connection_pool_min_size` | 1 | 定义连接池的最小连接数，用于初始化连接池并保证在启用保活机制时至少有该数量的连接处于活跃状态。 |
76+
| `connection_pool_max_size` | 30 | 定义连接池的最大连接数，每个 Catalog 对应的每个 FE 或 BE 节点最多可持有此数量的连接。 |
77+
| `connection_pool_max_wait_time` | 5000 | 如果连接池中没有可用连接，定义客户端等待连接的最大毫秒数。 |
78+
| `connection_pool_max_life_time` | 1800000 | 设置连接在连接池中保持活跃的最大时长（毫秒）。超时的连接将被回收。同时，此值的一半将作为连接池的最小逐出空闲时间，达到该时间的连接将成为逐出候选对象。 |
79+
| `connection_pool_keep_alive` | false | 仅在 BE 节点上有效，用于决定是否保持达到最小逐出空闲时间但未到最大生命周期的连接活跃。默认关闭，以减少不必要的资源使用。 |
80+
8181
* `{CommonProperties}`
8282

8383
CommonProperties 部分用于填写通用属性。请参阅[ 数据目录概述 ](../catalog-overview.md)中【通用属性】部分。

0 commit comments

Comments
 (0)