This is an automated email from the ASF dual-hosted git repository.
dockerzhang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/inlong-website.git
The following commit(s) were added to refs/heads/master by this push:
new 40fdf831f4 [INLONG-781][Doc][SqlServer] Describe tables using MarkDown
(#785)
40fdf831f4 is described below
commit 40fdf831f4bdd2db578ef7271d60f13800eaa32e
Author: emhui <[email protected]>
AuthorDate: Wed Jun 28 15:16:43 2023 +0800
[INLONG-781][Doc][SqlServer] Describe tables using MarkDown (#785)
---
docs/data_node/extract_node/sqlserver-cdc.md | 244 +++------------------
.../data_node/extract_node/sqlserver-cdc.md | 242 +++-----------------
.../current/data_node/load_node/sqlserver.md | 28 +--
3 files changed, 86 insertions(+), 428 deletions(-)
diff --git a/docs/data_node/extract_node/sqlserver-cdc.md
b/docs/data_node/extract_node/sqlserver-cdc.md
index 1fad93484e..ec4170bd76 100644
--- a/docs/data_node/extract_node/sqlserver-cdc.md
+++ b/docs/data_node/extract_node/sqlserver-cdc.md
@@ -110,126 +110,29 @@ TODO
## SQLServer Extract Node Options
-<div class="highlight">
-<table class="colwidths-auto docutils">
- <thead>
- <tr>
- <th class="text-left" style={{width: '10%'}}>Option</th>
- <th class="text-left" style={{width: '8%'}}>Required</th>
- <th class="text-left" style={{width: '7%'}}>Default</th>
- <th class="text-left" style={{width: '10%'}}>Type</th>
- <th class="text-left" style={{width: '65%'}}>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>connector</td>
- <td>required</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>Specify what connector to use, here should be
'sqlserver-cdc-inlong'.</td>
- </tr>
- <tr>
- <td>hostname</td>
- <td>required</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>IP address or hostname of the SQLServer database.</td>
- </tr>
- <tr>
- <td>username</td>
- <td>required</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>Username to use when connecting to the SQLServer database.</td>
- </tr>
- <tr>
- <td>password</td>
- <td>required</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>Password to use when connecting to the SQLServer database.</td>
- </tr>
- <tr>
- <td>database-name</td>
- <td>required</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>Database name of the SQLServer database to monitor.</td>
- </tr>
- <tr>
- <td>schema-name</td>
- <td>required</td>
- <td style={{wordWrap: 'break-word'}}>dbo</td>
- <td>String</td>
- <td>Schema name of the SQLServer database to monitor.</td>
- </tr>
- <tr>
- <td>table-name</td>
- <td>required</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>Table name of the SQLServer database to monitor.</td>
- </tr>
- <tr>
- <td>port</td>
- <td>optional</td>
- <td style={{wordWrap: 'break-word'}}>1433</td>
- <td>Integer</td>
- <td>Integer port number of the SQLServer database.</td>
- </tr>
- <tr>
- <td>server-time-zone</td>
- <td>optional</td>
- <td style={{wordWrap: 'break-word'}}>UTC</td>
- <td>String</td>
- <td>The session time zone in database server, e.g. "Asia/Shanghai".</td>
- </tr>
- <tr>
- <td>inlong.metric.labels</td>
- <td>optional</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>Inlong metric label, format of value is
groupId=[groupId]&streamId=[streamId]&nodeId=[nodeId].</td>
- </tr>
- </tbody>
-</table>
-</div>
+| Option | Required | Default | Type | Description |
+| --- | --- | --- | --- | --- |
+| connector | required | (none) | String | Specify what connector to use, here
should be 'sqlserver-cdc-inlong'. |
+| hostname | required | (none) | String | IP address or hostname of the
SQLServer database. |
+| username | required | (none) | String | Username to use when connecting to
the SQLServer database. |
+| password | required | (none) | String | Password to use when connecting to
the SQLServer database. |
+| database-name | required | (none) | String | Database name of the SQLServer
database to monitor. |
+| schema-name | required | dbo | String | Schema name of the SQLServer
database to monitor. |
+| table-name | required | (none) | String | Table name of the SQLServer
database to monitor. |
+| port | optional | 1433 | Integer | Integer port number of the SQLServer
database. |
+| server-time-zone | optional | UTC | String | The session time zone in
database server, e.g. "Asia/Shanghai". |
+| inlong.metric.labels | optional | (none) | String | Inlong metric label,
format of value is groupId=[groupId]&streamId=[streamId]&nodeId=[nodeId]. |
## Available Metadata
+
The following format metadata can be exposed as read-only (VIRTUAL) columns in
a table definition.
-<table class="colwidths-auto docutils">
- <thead>
- <tr>
- <th class="text-left" style={{width: '15%'}}>Key</th>
- <th class="text-left" style={{width: '30%'}}>DataType</th>
- <th class="text-left" style={{width: '55%'}}>Description</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>table_name</td>
- <td>STRING NOT NULL</td>
- <td>Name of the table that contain the row.</td>
- </tr>
- <tr>
- <td>schema_name</td>
- <td>STRING NOT NULL</td>
- <td>Name of the schema that contain the row.</td>
- </tr>
- <tr>
- <td>database_name</td>
- <td>STRING NOT NULL</td>
- <td>Name of the database that contain the row.</td>
- </tr>
- <tr>
- <td>op_ts</td>
- <td>TIMESTAMP_LTZ(3) NOT NULL</td>
- <td>It indicates the time that the change was made in the database.
<br/>If the record is read from snapshot of the table instead of the binlog,
the value is always 0.</td>
- </tr>
- </tbody>
-</table>
+| Key | DataType | Description |
+| --- | --- | --- |
+| table_name | STRING NOT NULL | Name of the table that contain the row. |
+| schema_name | STRING NOT NULL | Name of the schema that contain the row. |
+| database_name | STRING NOT NULL | Name of the database that contain the row.
|
+| op_ts | TIMESTAMP_LTZ(3) NOT NULL | It indicates the time that the change
was made in the database.<br/>If the record is read from snapshot of the table
instead of the binlog, the value is always 0. |
The extended CREATE TABLE example demonstrates the syntax for exposing these
metadata fields:
```sql
@@ -252,96 +155,21 @@ CREATE TABLE sqlserver_extract_node (
```
## Data Type Mapping
-<div class="wy-table-responsive">
-<table class="colwidths-auto docutils">
- <thead>
- <tr>
- <th class="text-left">SQLServer type</th>
- <th class="text-left">Flink SQL type</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>char(n)</td>
- <td>CHAR(n)</td>
- </tr>
- <tr>
- <td>
- varchar(n)<br/>
- nvarchar(n)<br/>
- nchar(n)</td>
- <td>VARCHAR(n)</td>
- </tr>
- <tr>
- <td>
- text<br/>
- ntext<br/>
- xml</td>
- <td>STRING</td>
- </tr>
- <tr>
- <td>
- decimal(p, s)<br/>
- money<br/>
- smallmoney</td>
- <td>DECIMAL(p, s)</td>
- </tr>
- <tr>
- <td>numeric</td>
- <td>NUMERIC</td>
- </tr>
- <tr>
- <td>
- REAL<br/>
- FLOAT<br/>
- </td>
- <td>FLOAT</td>
- </tr>
- <tr>
- <td>bit</td>
- <td>BOOLEAN</td>
- </tr>
- <tr>
- <td>int</td>
- <td>INT</td>
- </tr>
- <tr>
- <td>tinyint</td>
- <td>TINYINT</td>
- </tr>
- <tr>
- <td>smallint</td>
- <td>SMALLINT</td>
- </tr>
- <tr>
- <td>time (n)</td>
- <td>TIME (n)</td>
- </tr>
- <tr>
- <td>bigint</td>
- <td>BIGINT</td>
- </tr>
- <tr>
- <td>date</td>
- <td>DATE</td>
- </tr>
- <tr>
- <td>
- datetime2<br/>
- datetime<br/>
- smalldatetime
- </td>
- <td>TIMESTAMP(n)</td>
- </tr>
- <tr>
- <td>
- datetimeoffset
- </td>
- <td>TIMESTAMP_LTZ(3)</td>
- </tr>
- </tbody>
-</table>
-</div>
-
-
+| SQLServer type | Flink SQL type |
+| --- | --- |
+| char(n) | CHAR(n) |
+| varchar(n) <br/>nvarchar(n) <br/>nchar(n) | VARCHAR(n) |
+| text <br/>ntext <br/>xml | STRING |
+| decimal(p, s) <br/>money <br/>smallmoney | DECIMAL(p, s) |
+| numeric | NUMERIC |
+| REAL <br/>FLOAT | FLOAT |
+| bit | BOOLEAN |
+| int | INT |
+| tinyint | TINYINT |
+| smallint | SMALLINT |
+| time (n) | TIME (n) |
+| bigint | BIGINT |
+| date | DATE |
+| datetime2 <br/>datetime <br/>smalldatetime | TIMESTAMP(n) |
+| datetimeoffset | TIMESTAMP_LTZ(3) |
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/data_node/extract_node/sqlserver-cdc.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/data_node/extract_node/sqlserver-cdc.md
index 5f8dd84688..a9aed9e29d 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/data_node/extract_node/sqlserver-cdc.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/data_node/extract_node/sqlserver-cdc.md
@@ -110,127 +110,29 @@ TODO
## SQLServer 抽取节点参数信息
-<div class="highlight">
-<table class="colwidths-auto docutils">
- <thead>
- <tr>
- <th class="text-left" style={{width: '10%'}}>参数</th>
- <th class="text-left" style={{width: '8%'}}>是否必须</th>
- <th class="text-left" style={{width: '7%'}}>默认值</th>
- <th class="text-left" style={{width: '10%'}}>数据类型</th>
- <th class="text-left" style={{width: '65%'}}>描述</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>connector</td>
- <td>必须</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>指定使用什么连接器，这里应该是 'sqlserver-cdc-inlong'。</td>
- </tr>
- <tr>
- <td>hostname</td>
- <td>必须</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>SQLServer 数据库 IP 地址或者 hostname。</td>
- </tr>
- <tr>
- <td>username</td>
- <td>必须</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>SQLServer 数据库用户名。</td>
- </tr>
- <tr>
- <td>password</td>
- <td>必须</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>SQLServer 数据库用户密码。</td>
- </tr>
- <tr>
- <td>database-name</td>
- <td>必须</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>SQLServer 数据库监控的数据库名称。</td>
- </tr>
- <tr>
- <td>schema-name</td>
- <td>必须</td>
- <td style={{wordWrap: 'break-word'}}>dbo</td>
- <td>String</td>
- <td>SQLServer 数据库监控的 schema 名称。</td>
- </tr>
- <tr>
- <td>table-name</td>
- <td>必须</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>SQLServer 数据库监控的表名称。</td>
- </tr>
- <tr>
- <td>port</td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>1433</td>
- <td>Integer</td>
- <td>SQLServer 数据库端口。</td>
- </tr>
- <tr>
- <td>server-time-zone</td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>UTC</td>
- <td>String</td>
- <td>SQLServer 数据库连接配置时区。 例如： "Asia/Shanghai"。</td>
- </tr>
- <tr>
- <td>inlong.metric.labels</td>
- <td>可选</td>
- <td style={{wordWrap: 'break-word'}}>(none)</td>
- <td>String</td>
- <td>inlong metric
的标签值，该值的构成为groupId=[groupId]&streamId=[streamId]&nodeId=[nodeId]。</td>
- </tr>
- </tbody>
-</table>
-</div>
+| 参数 | 是否必须 | 默认值 | 数据类型 | 描述
|
+| --- | --- | --- | ---
|----------------------------------------------------------------------------------|
+| connector | 必须 | (none) | String | 指定使用什么连接器，这里应该是 'sqlserver-cdc-inlong'。
|
+| hostname | 必须 | (none) | String | SQLServer 数据库 IP 地址或者 hostname。
|
+| username | 必须 | (none) | String | SQLServer 数据库用户名。
|
+| password | 必须 | (none) | String | SQLServer 数据库用户密码。
|
+| database-name | 必须 | (none) | String | SQLServer 数据库监控的数据库名称。
|
+| schema-name | 必须 | dbo | String | SQLServer 数据库监控的 schema 名称。
|
+| table-name | 必须 | (none) | String | SQLServer 数据库监控的表名称。
|
+| port | 可选 | 1433 | Integer | SQLServer 数据库端口。
|
+| server-time-zone | 可选 | UTC | String | SQLServer 数据库连接配置时区。 例如：
"Asia/Shanghai"。 |
+| inlong.metric.labels | 可选 | (none) | String | inlong metric 的标签值，该值的构成为
groupId=[groupId]&streamId=[streamId]&nodeId=[nodeId]。 |
## 可用的元数据字段
以下格式元数据可以作为表定义中的只读 (VIRTUAL) 列公开。
-<table class="colwidths-auto docutils">
- <thead>
- <tr>
- <th class="text-left" style={{width: '15%'}}>字段名称</th>
- <th class="text-left" style={{width: '30%'}}>数据类型</th>
- <th class="text-left" style={{width: '55%'}}>描述</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>table_name</td>
- <td>STRING NOT NULL</td>
- <td>包含该行的表的名称。</td>
- </tr>
- <tr>
- <td>schema_name</td>
- <td>STRING NOT NULL</td>
- <td>包含该行 schema 的名称。</td>
- </tr>
- <tr>
- <td>database_name</td>
- <td>STRING NOT NULL</td>
- <td>包含该行数据库的名称。</td>
- </tr>
- <tr>
- <td>op_ts</td>
- <td>TIMESTAMP_LTZ(3) NOT NULL</td>
- <td>它表示在数据库中进行更改的时间。如果记录是从表的快照而不是 binlog 中读取的，则该值始终为 0。</td>
- </tr>
- </tbody>
-</table>
+| 字段名称 | 数据类型 | 描述 |
+| --- | --- | --- |
+| table_name | STRING NOT NULL | 包含该行的表的名称。 |
+| schema_name | STRING NOT NULL | 包含该行 schema 的名称。 |
+| database_name | STRING NOT NULL | 包含该行数据库的名称。 |
+| op_ts | TIMESTAMP_LTZ(3) NOT NULL | 它表示在数据库中进行更改的时间。如果记录是从表的快照而不是 binlog
中读取的，则该值始终为 0。 |
使用元数据字段的例子：
```sql
@@ -253,93 +155,21 @@ CREATE TABLE sqlserver_extract_node (
```
## 数据类型映射
-<div class="wy-table-responsive">
-<table class="colwidths-auto docutils">
- <thead>
- <tr>
- <th class="text-left">SQLServer type</th>
- <th class="text-left">Flink SQL type</th>
- </tr>
- </thead>
- <tbody>
- <tr>
- <td>char(n)</td>
- <td>CHAR(n)</td>
- </tr>
- <tr>
- <td>
- varchar(n)<br/>
- nvarchar(n)<br/>
- nchar(n)</td>
- <td>VARCHAR(n)</td>
- </tr>
- <tr>
- <td>
- text<br/>
- ntext<br/>
- xml</td>
- <td>STRING</td>
- </tr>
- <tr>
- <td>
- decimal(p, s)<br/>
- money<br/>
- smallmoney</td>
- <td>DECIMAL(p, s)</td>
- </tr>
- <tr>
- <td>numeric</td>
- <td>NUMERIC</td>
- </tr>
- <tr>
- <td>
- REAL<br/>
- FLOAT<br/>
- </td>
- <td>FLOAT</td>
- </tr>
- <tr>
- <td>bit</td>
- <td>BOOLEAN</td>
- </tr>
- <tr>
- <td>int</td>
- <td>INT</td>
- </tr>
- <tr>
- <td>tinyint</td>
- <td>TINYINT</td>
- </tr>
- <tr>
- <td>smallint</td>
- <td>SMALLINT</td>
- </tr>
- <tr>
- <td>time (n)</td>
- <td>TIME (n)</td>
- </tr>
- <tr>
- <td>bigint</td>
- <td>BIGINT</td>
- </tr>
- <tr>
- <td>date</td>
- <td>DATE</td>
- </tr>
- <tr>
- <td>
- datetime2<br/>
- datetime<br/>
- smalldatetime
- </td>
- <td>TIMESTAMP(n)</td>
- </tr>
- <tr>
- <td>
- datetimeoffset
- </td>
- <td>TIMESTAMP_LTZ(3)</td>
- </tr>
- </tbody>
-</table>
-</div>
+
+| SQLServer type | Flink SQL type |
+| --- | --- |
+| char(n) | CHAR(n) |
+| varchar(n)<br/>nvarchar(n)<br/>nchar(n) | VARCHAR(n) |
+| text<br/>ntext<br/>xml | STRING |
+| decimal(p, s)<br/>money<br/>smallmoney | DECIMAL(p, s) |
+| numeric | NUMERIC |
+| REAL<br/>FLOAT | FLOAT |
+| bit | BOOLEAN |
+| int | INT |
+| tinyint | TINYINT |
+| smallint | SMALLINT |
+| time (n) | TIME (n) |
+| bigint | BIGINT |
+| date | DATE |
+| datetime2<br/>datetime<br/>smalldatetime | TIMESTAMP(n) |
+| datetimeoffset | TIMESTAMP_LTZ(3) |
\ No newline at end of file
diff --git
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/data_node/load_node/sqlserver.md
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/data_node/load_node/sqlserver.md
index b785673fc5..547f217237 100644
---
a/i18n/zh-CN/docusaurus-plugin-content-docs/current/data_node/load_node/sqlserver.md
+++
b/i18n/zh-CN/docusaurus-plugin-content-docs/current/data_node/load_node/sqlserver.md
@@ -80,21 +80,21 @@ TODO: 将在未来支持此功能。
## SQLServer Load 节点参数
-| 参数 | 是否必选 | 默认值 | 数据类型 | 描述 |
-|---------|----------|---------|------|------------|
-| connector | 必选 | (none) | String | 指定使用什么类型的连接器，这里应该是 'jdbc-inlong'。 |
-| url | 必选 | (none) | String | JDBC 数据库 url。 |
-| table-name | 必选 | (none) | String | 连接到 JDBC 表的名称。 |
-| driver | 可选 | (none) | String | 用于连接到此 URL 的 JDBC 驱动类名，如果不设置，将自动从 URL 中推导。 |
-| username | 可选 | (none) | String | JDBC 用户名。如果指定了 'username' 和 'password'
中的任一参数，则两者必须都被指定。 |
-| password | 可选 | (none) | String | JDBC 密码。 |
-| connection.max-retry-timeout | 可选 | 60s | Duration | 最大重试超时时间，以秒为单位且不应该小于 1
秒。 |
-| sink.buffer-flush.max-rows | 可选 | 100 | Integer | flush 前缓存记录的最大值，可以设置为 '0'
来禁用它。 |
+| 参数 | 是否必选 | 默认值 | 数据类型 | 描述
|
+|---------|----------|---------|------|--------------------------------------------------------------------------------------------------------------------------------------|
+| connector | 必选 | (none) | String | 指定使用什么类型的连接器，这里应该是 'jdbc-inlong'。
|
+| url | 必选 | (none) | String | JDBC 数据库 url。
|
+| table-name | 必选 | (none) | String | 连接到 JDBC 表的名称。
|
+| driver | 可选 | (none) | String | 用于连接到此 URL 的 JDBC 驱动类名，如果不设置，将自动从 URL 中推导。
|
+| username | 可选 | (none) | String | JDBC 用户名。如果指定了 'username' 和 'password'
中的任一参数，则两者必须都被指定。
|
+| password | 可选 | (none) | String | JDBC 密码。
|
+| connection.max-retry-timeout | 可选 | 60s | Duration | 最大重试超时时间，以秒为单位且不应该小于 1
秒。
|
+| sink.buffer-flush.max-rows | 可选 | 100 | Integer | flush 前缓存记录的最大值，可以设置为 '0'
来禁用它。
|
| sink.buffer-flush.interval | 可选 | 1s | Duration | flush 间隔时间，超过该时间后异步线程将
flush 数据。可以设置为 '0' 来禁用它。注意, 为了完全异步地处理缓存的 flush 事件，可以将
'sink.buffer-flush.max-rows' 设置为 '0' 并配置适当的 flush 时间间隔。 |
-| sink.max-retries | 可选 | 3 | Integer | 写入记录到数据库失败后的最大重试次数。 |
-| sink.parallelism | 可选 | (none) | Integer | 用于定义 JDBC sink
算子的并行度。默认情况下，并行度是由框架决定：使用与上游链式算子相同的并行度。 |
-| sink.ignore.changelog | 可选 | false | Boolean | 忽略所有 RowKind 类型的变更日志，将它们当作
INSERT 的数据来采集。 |
-| inlong.metric.labels | 可选 | (none) | String | inlong metric
的标签值，该值的构成为groupId=`{groupId}`&streamId=`{streamId}`&nodeId=`{nodeId}`。|
+| sink.max-retries | 可选 | 3 | Integer | 写入记录到数据库失败后的最大重试次数。
|
+| sink.parallelism | 可选 | (none) | Integer | 用于定义 JDBC sink
算子的并行度。默认情况下，并行度是由框架决定：使用与上游链式算子相同的并行度。
|
+| sink.ignore.changelog | 可选 | false | Boolean | 忽略所有 RowKind 类型的变更日志，将它们当作
INSERT 的数据来采集。
|
+| inlong.metric.labels | 可选 | (none) | String | inlong metric 的标签值，该值的构成为
groupId=`{groupId}`&streamId=`{streamId}`&nodeId=`{nodeId}`。
|
## 数据映射
