Skip to content

Commit 436d45e

Browse files
authored
update tablename description (#881)
1 parent 7578cea commit 436d45e

12 files changed

+29
-2
lines changed

src/UserGuide/Master/Table/API/Programming-Java-Native-API_apache.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,8 @@ public class TableSessionBuilder {
343343
}
344344
```
345345

346+
> Note: When creating tables using the native API, if table or column names contain special characters or Chinese characters, do not add extra double quotes around them. Otherwise, the quotation marks will become part of the name itself.
347+
346348
## 4. Session Pool
347349

348350
### 4.1 ITableSessionPool Interface

src/UserGuide/Master/Table/API/Programming-Java-Native-API_timecho.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,8 @@ public class TableSessionBuilder {
343343
}
344344
```
345345

346+
> Note: When creating tables using the native API, if table or column names contain special characters or Chinese characters, do not add extra double quotes around them. Otherwise, the quotation marks will become part of the name itself.
347+
346348
## 4. Session Pool
347349

348350
### 4.1 ITableSessionPool Interface

src/UserGuide/Master/Table/Basic-Concept/Table-Management.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ comment
7070
2. Can include special characters such as `~!`"`%`, etc.
7171
3. Names with special or Chinese characters must be enclosed in double quotes (`""`).
7272
4. Outer double quotes are not retained in the final table name. For example: `"a""b"` becomes `a"b`.
73+
5. Note: In SQL, table or column names with special characters or Chinese characters must be wrapped in double quotes. However, in the native API, do not add extra quotes—otherwise, the quotation marks will become part of the name itself.
7374
5. **`columnDefinition`**: Column names share the same characteristics as table names and can include special characters such as `.`.
7475
6. COMMENT adds comments to the table.
7576

src/UserGuide/latest-Table/API/Programming-Java-Native-API_apache.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,9 @@ public class TableSessionBuilder {
343343
}
344344
```
345345

346+
347+
> Note: When creating tables using the native API, if table or column names contain special characters or Chinese characters, do not add extra double quotes around them. Otherwise, the quotation marks will become part of the name itself.
348+
346349
## 4. Session Pool
347350

348351
### 4.1 ITableSessionPool Interface

src/UserGuide/latest-Table/API/Programming-Java-Native-API_timecho.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -343,6 +343,8 @@ public class TableSessionBuilder {
343343
}
344344
```
345345

346+
> Note: When creating tables using the native API, if table or column names contain special characters or Chinese characters, do not add extra double quotes around them. Otherwise, the quotation marks will become part of the name itself.
347+
346348
## 4. Session Pool
347349

348350
### 4.1 ITableSessionPool Interface

src/UserGuide/latest-Table/Basic-Concept/Table-Management.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,7 @@ comment
7070
2. Can include special characters such as `~!`"`%`, etc.
7171
3. Names with special or Chinese characters must be enclosed in double quotes (`""`).
7272
4. Outer double quotes are not retained in the final table name. For example: `"a""b"` becomes `a"b`.
73+
5. Note: In SQL, table or column names with special characters or Chinese characters must be wrapped in double quotes. However, in the native API, do not add extra quotes—otherwise, the quotation marks will become part of the name itself.
7374
5. **`columnDefinition`**: Column names share the same characteristics as table names and can include special characters such as `.`.
7475
6. COMMENT adds comments to the table.
7576

src/zh/UserGuide/Master/Table/API/Programming-Java-Native-API_apache.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,8 @@ public class TableSessionBuilder {
348348
}
349349
```
350350

351+
> 注意: 原生API中创建表时,表名或列名中若含有特殊字符或中文字符,无需额外添加双引号括起,否则会包含引号字符。
352+
351353
## 4. 客户端连接池
352354

353355
### 4.1 ITableSessionPool 接口

src/zh/UserGuide/Master/Table/API/Programming-Java-Native-API_timecho.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,8 @@ public class TableSessionBuilder {
348348
}
349349
```
350350

351+
> 注意: 原生API中创建表时,表名或列名中若含有特殊字符或中文字符,无需额外添加双引号括起,否则会包含引号字符。
352+
351353
## 4. 客户端连接池
352354

353355
### 4.1 ITableSessionPool 接口

src/zh/UserGuide/Master/Table/Basic-Concept/Table-Management.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,11 +68,15 @@ comment
6868
4. <TABLE_NAME>表名称,具有以下特性:
6969
- 大小写不敏感,创建成功后,统一显示为小写
7070
- 名称可包含特殊字符,如 `~!`"%` 等
71-
- 包含特殊字符或中文字符的数据库名创建时必须用双引号 "" 括起来。
71+
- 包含特殊字符或中文字符的表名创建时必须用双引号 "" 括起来。
72+
- 注意:SQL中特殊字符或中文表名需加双引号。原生API中无需额外添加,否则表名会包含引号字符。
7273
- 当为表命名时,最外层的双引号(`""`)不会在实际创建的表名中出现。
7374
- ```SQL
75+
-- SQL 中
7476
"a""b" --> a"b
7577
"""""" --> ""
78+
-- API 中
79+
"a""b" --> "a""b"
7680
```
7781
5. columnDefinition 列名称与表名称具有相同特性,并且可包含特殊字符`.`
7882
6. COMMENT 给表添加注释。

src/zh/UserGuide/latest-Table/API/Programming-Java-Native-API_apache.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -348,6 +348,8 @@ public class TableSessionBuilder {
348348
}
349349
```
350350

351+
> 注意: 原生API中创建表时,表名或列名中若含有特殊字符或中文字符,无需额外添加双引号括起,否则会包含引号字符。
352+
351353
## 4. 客户端连接池
352354

353355
### 4.1 ITableSessionPool 接口

0 commit comments

Comments
 (0)