This is an automated email from the ASF dual-hosted git repository. renqs pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/flink-cdc.git
The following commit(s) were added to refs/heads/master by this push: new 1c69a650e [FLINK-34732][cdc][ci] Add document dead link check for Flink CDC Documentation (#3168) 1c69a650e is described below commit 1c69a650e3187734962e824e40ed35de0d94ccfc Author: gongzhongqiang <gongzhongqi...@apache.org> AuthorDate: Mon Mar 25 16:01:23 2024 +0800 [FLINK-34732][cdc][ci] Add document dead link check for Flink CDC Documentation (#3168) --- .dlc.json | 35 +++++++++++++++++ .github/workflows/build_docs.yml | 18 ++++++++- README.md | 2 +- docs/content.zh/_index.md | 2 +- .../connectors/legacy-flink-cdc-sources/db2-cdc.md | 6 +-- .../legacy-flink-cdc-sources/mysql-cdc.md | 8 ++-- .../legacy-flink-cdc-sources/overview.md | 44 +++++++++++----------- .../legacy-flink-cdc-sources/vitess-cdc.md | 2 +- docs/content.zh/docs/connectors/mysql.md | 2 +- .../developer-guide/contribute-to-flink-cdc.md | 8 ++-- docs/content/_index.md | 2 +- .../connectors/legacy-flink-cdc-sources/db2-cdc.md | 6 +-- .../legacy-flink-cdc-sources/mysql-cdc.md | 8 ++-- .../legacy-flink-cdc-sources/overview.md | 44 +++++++++++----------- .../legacy-flink-cdc-sources/vitess-cdc.md | 2 +- docs/content/docs/connectors/mysql.md | 2 +- 16 files changed, 121 insertions(+), 70 deletions(-) diff --git a/.dlc.json b/.dlc.json new file mode 100644 index 000000000..a55469383 --- /dev/null +++ b/.dlc.json @@ -0,0 +1,35 @@ +{ + "ignorePatterns": [ + { + "pattern": "^http://localhost" + }, + { + "pattern": "^#" + }, + { + "pattern": "^{" + }, + { + "pattern": "^https://repo1.maven.org/maven2/org/apache/flink.*SNAPSHOT.*" + }, + { + "pattern": "^https://mvnrepository.com" + }, + { + "pattern": "^https://img.shields.io" + }, + { + "pattern": "^https://twitter.com*" + } + ], + "timeout": "30s", + "retryOn429": true, + "retryCount": 10, + "fallbackRetryDelay": "1000s", + "aliveStatusCodes": [ + 0, + 200, + 401, + 403 + ] +} diff --git a/.github/workflows/build_docs.yml b/.github/workflows/build_docs.yml index f8c2a283f..446ebf4f4 100644 --- a/.github/workflows/build_docs.yml +++ b/.github/workflows/build_docs.yml @@ -16,6 +16,12 @@ name: "Build documentation" on: + pull_request: + branches: + - master + - release-* + paths: + - 'docs/**' push: paths: - 'docs/**' @@ -30,9 +36,19 @@ concurrency: cancel-in-progress: true jobs: - build-documentation: + + markdown-link-check: if: github.repository == 'apache/flink-cdc' runs-on: ubuntu-latest + steps: + - uses: actions/checkout@master + - uses: gaurav-nelson/github-action-markdown-link-check@1.0.15 + with: + config-file: '.dlc.json' + + build-documentation: + if: github.event_name != 'pull_request' && github.repository == 'apache/flink-cdc' + runs-on: ubuntu-latest strategy: max-parallel: 1 matrix: diff --git a/README.md b/README.md index 46676e224..03daba57d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ <p align="center"> - <a href="[https://github.com/apache/flink-cdc](https://nightlies.apache.org/flink/flink-cdc-docs-stable/)"><img src="docs/static/fig/flinkcdc-logo.png" alt="Flink CDC" style="width: 375px;"></a> + <a href="https://nightlies.apache.org/flink/flink-cdc-docs-stable/"><img src="docs/static/fig/flinkcdc-logo.png" alt="Flink CDC" style="width: 375px;"></a> </p> <p align="center"> <a href="https://github.com/apache/flink-cdc/" target="_blank"> diff --git a/docs/content.zh/_index.md b/docs/content.zh/_index.md index fc2c11f6f..f439ee43b 100644 --- a/docs/content.zh/_index.md +++ b/docs/content.zh/_index.md @@ -165,7 +165,7 @@ under the License. <p style="text-align: left; color: #BF74F1; font-size: x-large; padding: 0">Try Flink CDC</p> <p style="text-align: left;"> Flink CDC provides a series of quick start demos without any dependencies or java code. A Linux or MacOS computer with Docker installed is enough. - Please check out our <a href="docs/get-started/introduction">Quick Start</a> for more information. + Please check out our <a href="{{< ref "docs/get-started/introduction" >}}">Quick Start</a> for more information. </p> </div> <div style="flex: 1;"></div> diff --git a/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/db2-cdc.md b/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/db2-cdc.md index 45732cff8..1b21f2439 100644 --- a/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/db2-cdc.md +++ b/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/db2-cdc.md @@ -32,9 +32,9 @@ describes how to setup the db2 CDC connector to run SQL queries against Db2 data ## Supported Databases -| Connector | Database | Driver | -|-----------------------|----------------------------------------------------|----------------------| -| [Db2-cdc](../db2-cdc) | <li> [Db2](https://www.ibm.com/products/db2): 11.5 | Db2 Driver: 11.5.0.0 | +| Connector | Database | Driver | +|-----------|----------------------------------------------------|----------------------| +| Db2-cdc | <li> [Db2](https://www.ibm.com/products/db2): 11.5 | Db2 Driver: 11.5.0.0 | Dependencies ------------ diff --git a/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/mysql-cdc.md b/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/mysql-cdc.md index 9f005f35e..d15404e38 100644 --- a/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/mysql-cdc.md +++ b/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/mysql-cdc.md @@ -30,9 +30,9 @@ MySQL CDC 连接器允许从 MySQL 数据库读取快照数据和增量数据。 ## 支持的数据库 -| Connector | Database | Driver | -|----------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| -| mysql-cdc | <li> [MySQL](https://dev.mysql.com/doc): 5.6, 5.7, 8.0.x <li> [RDS MySQL](https://www.aliyun.com/product/rds/mysql): 5.6, 5.7, 8.0.x <li> [PolarDB MySQL](https://www.aliyun.com/product/polardb): 5.6, 5.7, 8.0.x <li> [Aurora MySQL](https://aws.amazon.com/cn/rds/aurora): 5.6, 5.7, 8.0.x <li> [MariaDB](https://mariadb.org): 10.x <li> [PolarDB X](https://github.com/ApsaraDB/galaxysql): 2.0.1 | JDBC Driver: 8.0.27 | +| Connector | Database | Driver | +|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| mysql-cdc | <li> [MySQL](https://dev.mysql.com/doc): 5.6, 5.7, 8.0.x <li> [RDS MySQL](https://www.aliyun.com/product/rds/mysql): 5.6, 5.7, 8.0.x <li> [PolarDB MySQL](https://www.aliyun.com/product/polardb): 5.6, 5.7, 8.0.x <li> [Aurora MySQL](https://aws.amazon.com/cn/rds/aurora): 5.6, 5.7, 8.0.x <li> [MariaDB](https://mariadb.org): 10.x <li> [PolarDB X](https://github.com/ApsaraDB/galaxysql): 2.0.1 | JDBC Driver: 8.0.27 | 依赖 ------------ @@ -740,7 +740,7 @@ $ ./bin/flink run \ <table class="colwidths-auto docutils"> <thead> <tr> - <th class="text-left" style="width:30%;">MySQL type<a href="https://dev.mysql.com/doc/man/8.0/en/data-types.html"></a></th> + <th class="text-left" style="width:30%;">MySQL type<a href="https://dev.mysql.com/doc/refman/8.0/en/data-types.html"></a></th> <th class="text-left" style="width:10%;">Flink SQL type<a href="{% link dev/table/types.md %}"></a></th> <th class="text-left" style="width:60%;">NOTE</th> </tr> diff --git a/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/overview.md b/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/overview.md index 5a485e946..5fc627371 100644 --- a/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/overview.md +++ b/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/overview.md @@ -35,17 +35,17 @@ You can also read [tutorials]({{< ref "docs/connectors/legacy-flink-cdc-sources/ ## Supported Connectors -| Connector | Database | Driver | -|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| -| [mongodb-cdc](../mongodb-cdc) | <li> [MongoDB](https://www.mongodb.com): 3.6, 4.x, 5.0 | MongoDB Driver: 4.3.4 | -| [mysql-cdc](../mysql-cdc) | <li> [MySQL](https://dev.mysql.com/doc): 5.6, 5.7, 8.0.x <li> [RDS MySQL](https://www.aliyun.com/product/rds/mysql): 5.6, 5.7, 8.0.x <li> [PolarDB MySQL](https://www.aliyun.com/product/polardb): 5.6, 5.7, 8.0.x <li> [Aurora MySQL](https://aws.amazon.com/cn/rds/aurora): 5.6, 5.7, 8.0.x <li> [MariaDB](https://mariadb.org): 10.x <li> [PolarDB X](https://github.com/ApsaraDB/galaxysql): 2.0.1 | JDBC Driver: 8.0.28 | -| [oceanbase-cdc](../oceanbase-cdc) | <li> [OceanBase CE](https://open.oceanbase.com): 3.1.x, 4.x <li> [OceanBase EE](https://www.oceanbase.com/product/oceanbase): 2.x, 3.x, 4.x | OceanBase Driver: 2.4.x | -| [oracle-cdc](../oracle-cdc) | <li> [Oracle](https://www.oracle.com/index.html): 11, 12, 19, 21 | Oracle Driver: 19.3.0.0 | -| [postgres-cdc](../postgres-cdc) | <li> [PostgreSQL](https://www.postgresql.org): 9.6, 10, 11, 12, 13, 14 | JDBC Driver: 42.5.1 | -| [sqlserver-cdc](../sqlserver-cdc) | <li> [Sqlserver](https://www.microsoft.com/sql-server): 2012, 2014, 2016, 2017, 2019 | JDBC Driver: 9.4.1.jre8 | -| [tidb-cdc](../tidb-cdc) | <li> [TiDB](https://www.pingcap.com/): 5.1.x, 5.2.x, 5.3.x, 5.4.x, 6.0.0 | JDBC Driver: 8.0.27 | -| [db2-cdc](../db2-cdc) | <li> [Db2](https://www.ibm.com/products/db2): 11.5 | Db2 Driver: 11.5.0.0 | -| [vitess-cdc](../vitess-cdc) | <li> [Vitess](https://vitess.io/): 8.0.x, 9.0.x | MySql JDBC Driver: 8.0.26 | +| Connector | Database | Driver [...] +|---------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------- [...] +| [mongodb-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/mongodb-cdc" >}}) | <li> [MongoDB](https://www.mongodb.com): 3.6, 4.x, 5.0 | MongoDB D [...] +| [mysql-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/mysql-cdc" >}}) | <li> [MySQL](https://dev.mysql.com/doc): 5.6, 5.7, 8.0.x <li> [RDS MySQL](https://www.aliyun.com/product/rds/mysql): 5.6, 5.7, 8.0.x <li> [PolarDB MySQL](https://www.aliyun.com/product/polardb): 5.6, 5.7, 8.0.x <li> [Aurora MySQL](https://aws.amazon.com/cn/rds/aurora): 5.6, 5.7, 8.0.x <li> [MariaDB](https://mariadb.org): 10.x <li> [PolarDB X](https://github.com/ApsaraDB/galaxysql): 2.0.1 | JDBC Driv [...] +| [oceanbase-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/oceanbase-cdc" >}}) | <li> [OceanBase CE](https://open.oceanbase.com): 3.1.x, 4.x <li> [OceanBase EE](https://www.oceanbase.com/product/oceanbase): 2.x, 3.x, 4.x | OceanBase [...] +| [oracle-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/oracle-cdc" >}}) | <li> [Oracle](https://www.oracle.com/index.html): 11, 12, 19, 21 | Oracle Dr [...] +| [postgres-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/postgres-cdc" >}}) | <li> [PostgreSQL](https://www.postgresql.org): 9.6, 10, 11, 12, 13, 14 | JDBC Driv [...] +| [sqlserver-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/sqlserver-cdc" >}}) | <li> [Sqlserver](https://www.microsoft.com/sql-server): 2012, 2014, 2016, 2017, 2019 | JDBC Driv [...] +| [tidb-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/tidb-cdc" >}}) | <li> [TiDB](https://www.pingcap.com/): 5.1.x, 5.2.x, 5.3.x, 5.4.x, 6.0.0 | JDBC Driv [...] +| [db2-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/db2-cdc" >}}) | <li> [Db2](https://www.ibm.com/products/db2): 11.5 | Db2 Drive [...] +| [vitess-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/vitess-cdc" >}}) | <li> [Vitess](https://vitess.io/): 8.0.x, 9.0.x | MySql JDB [...] ## Supported Flink Versions The following table shows the version mapping between Flink<sup>®</sup> CDC Connectors and Flink<sup>®</sup>: @@ -72,17 +72,17 @@ The following table shows the version mapping between Flink<sup>®</sup> CDC Con The following table shows the current features of the connector: -| Connector | No-lock Read | Parallel Read | Exactly-once Read | Incremental Snapshot Read | -|--------------------------------|--------------|---------------|-------------------|---------------------------| -| [mongodb-cdc](../mongodb-cdc) | ✅ | ✅ | ✅ | ✅ | -| [mysql-cdc](../mysql-cdc) | ✅ | ✅ | ✅ | ✅ | -| [oracle-cdc](../oracle-cdc) | ✅ | ✅ | ✅ | ✅ | -| [postgres-cdc](../postgres-cdc) | ✅ | ✅ | ✅ | ✅ | -| [sqlserver-cdc](../sqlserver-cdc) | ✅ | ✅ | ✅ | ✅ | -| [oceanbase-cdc](../oceanbase-cdc) | ❌ | ❌ | ❌ | ❌ | -| [tidb-cdc](../tidb-cdc) | ✅ | ❌ | ✅ | ❌ | -| [db2-cdc](../db2-cdc) | ❌ | ❌ | ✅ | ❌ | -| [vitess-cdc](../vitess-cdc) | ✅ | ❌ | ✅ | ❌ | +| Connector | No-lock Read | Parallel Read | Exactly-once Read | Incremental Snapshot Read | +|---------------------------------------------------------------------------------------|--------------|---------------|-------------------|---------------------------| +| [mongodb-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/mongodb-cdc" >}}) | ✅ | ✅ | ✅ | ✅ | +| [mysql-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/mysql-cdc" >}}) | ✅ | ✅ | ✅ | ✅ | +| [oracle-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/oracle-cdc" >}}) | ✅ | ✅ | ✅ | ✅ | +| [postgres-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/postgres-cdc" >}}) | ✅ | ✅ | ✅ | ✅ | +| [sqlserver-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/sqlserver-cdc" >}}) | ✅ | ✅ | ✅ | ✅ | +| [oceanbase-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/oceanbase-cdc" >}}) | ❌ | ❌ | ❌ | ❌ | +| [tidb-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/tidb-cdc" >}}) | ✅ | ❌ | ✅ | ❌ | +| [db2-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/db2-cdc" >}}) | ❌ | ❌ | ✅ | ❌ | +| [vitess-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/vitess-cdc" >}}) | ✅ | ❌ | ✅ | ❌ | ## Usage for Table/SQL API diff --git a/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/vitess-cdc.md b/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/vitess-cdc.md index 6f8a2984b..4e0936f26 100644 --- a/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/vitess-cdc.md +++ b/docs/content.zh/docs/connectors/legacy-flink-cdc-sources/vitess-cdc.md @@ -261,7 +261,7 @@ Data Type Mapping <table class="colwidths-auto docutils"> <thead> <tr> - <th class="text-left">MySQL type<a href="https://dev.mysql.com/doc/man/8.0/en/data-types.html"></a></th> + <th class="text-left">MySQL type<a href="https://dev.mysql.com/doc/refman/8.0/en/data-types.html"></a></th> <th class="text-left">Flink SQL type<a href="{% link dev/table/types.md %}"></a></th> </tr> </thead> diff --git a/docs/content.zh/docs/connectors/mysql.md b/docs/content.zh/docs/connectors/mysql.md index 21dcce767..564dd3dbf 100644 --- a/docs/content.zh/docs/connectors/mysql.md +++ b/docs/content.zh/docs/connectors/mysql.md @@ -253,7 +253,7 @@ pipeline: <table class="colwidths-auto docutils"> <thead> <tr> - <th class="text-left" style="width:30%;">MySQL type<a href="https://dev.mysql.com/doc/man/8.0/en/data-types.html"></a></th> + <th class="text-left" style="width:30%;">MySQL type<a href="https://dev.mysql.com/doc/refman/8.0/en/data-types.html"></a></th> <th class="text-left" style="width:10%;">CDC type</th> <th class="text-left" style="width:60%;">NOTE</th> </tr> diff --git a/docs/content.zh/docs/developer-guide/contribute-to-flink-cdc.md b/docs/content.zh/docs/developer-guide/contribute-to-flink-cdc.md index 29d24a86d..1ec1a42ff 100644 --- a/docs/content.zh/docs/developer-guide/contribute-to-flink-cdc.md +++ b/docs/content.zh/docs/developer-guide/contribute-to-flink-cdc.md @@ -33,12 +33,12 @@ Bug报告,提议新的功能,加入社区邮件列表的讨论,贡献代 Flink CDC 社区的贡献不仅限于为项目贡献代码,下面列举了一些可以在社区贡献的内容。 -| 贡献方式 | 更多信息 | +| 贡献方式 | 更多信息 | |:------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| 提交BUG | 为了提交问题,您需要首先在 [Flink jira](https://issues.apache.org/jira/projects/FLINK/issues) 建立对应的issue,并在`Component/s`选择`Flink CDC`。然后在问题描述中详细描述遇到的问题的信息,如果可能的话,最好提供一下能够复现问题的操作步骤。 | +| 提交BUG | 为了提交问题,您需要首先在 [Flink jira](https://issues.apache.org/jira/projects/FLINK/issues) 建立对应的issue,并在`Component/s`选择`Flink CDC`。然后在问题描述中详细描述遇到的问题的信息,如果可能的话,最好提供一下能够复现问题的操作步骤。 | | 贡献代码 | 请阅读 <a href="#code-contribution-guide">贡献代码指导</a> | | 代码评审 | 请阅读 <a href="#code-review-guide">代码评审指导</a> | -| 用户支持 | 通过 [Flink 用户邮件列表](https://flink.apache.org/what-is-flink/community/#mailing-lists) 来帮助回复用户问题,在 [Flink jira](https://issues.<br/>apache.org/jira/projects/FLINK/issues) 可以查询到最新的已知问题。 | +| 用户支持 | 通过 [Flink 用户邮件列表](https://flink.apache.org/what-is-flink/community/#mailing-lists) 来帮助回复用户问题,在 [Flink jira](https://issues.apache.org/jira/projects/FLINK/issues) 可以查询到最新的已知问题。 | 如果还有其他问题,可以通过 Flink Dev 邮件列表寻求帮助。 @@ -50,7 +50,7 @@ Flink CDC 项目通过众多贡献者的代码贡献来维护,改进和拓展 如果您想要为 Flink CDC 贡献代码,可以通过如下的方式。 -1. 首先在 [Flink jira](https://issues.<br/>apache.org/jira/projects/FLINK/issues) 的想要负责的 issue +1. 首先在 [Flink jira](https://issues.apache.org/jira/projects/FLINK/issues) 的想要负责的 issue 下评论(最好在评论中解释下对于这个问题的理解,和后续的设计,如果可能的话也可以提供下 POC 的代码)。 2. 在这个 issue 被分配给你后,开始进行开发实现(提交信息请遵循`[FLINK-xxx][xxx] xxxxxxx`的格式)。 3. 开发完成后可以向 [Flink CDC](https://github.com/apache/flink-cdc) 项目提交 PR(请确保 Clone 的项目 committer 有操作权限)。 diff --git a/docs/content/_index.md b/docs/content/_index.md index b2a10cb03..15b4a314a 100644 --- a/docs/content/_index.md +++ b/docs/content/_index.md @@ -165,7 +165,7 @@ under the License. <p style="text-align: left; color: #BF74F1; font-size: x-large; padding: 0">Try Flink CDC</p> <p style="text-align: left;"> Flink CDC provides a series of quick start demos without any dependencies or java code. A Linux or MacOS computer with Docker installed is enough. - Please check out our <a href="docs/get-started/introduction">Quick Start</a> for more information. + Please check out our <a href="{{< ref "docs/get-started/introduction" >}}">Quick Start</a> for more information. </p> </div> <div style="flex: 1;"></div> diff --git a/docs/content/docs/connectors/legacy-flink-cdc-sources/db2-cdc.md b/docs/content/docs/connectors/legacy-flink-cdc-sources/db2-cdc.md index b4b4595ef..590965a90 100644 --- a/docs/content/docs/connectors/legacy-flink-cdc-sources/db2-cdc.md +++ b/docs/content/docs/connectors/legacy-flink-cdc-sources/db2-cdc.md @@ -32,9 +32,9 @@ describes how to setup the db2 CDC connector to run SQL queries against Db2 data ## Supported Databases -| Connector | Database | Driver | -|-----------------------|----------------------------------------------------|----------------------| -| [Db2-cdc](../db2-cdc) | <li> [Db2](https://www.ibm.com/products/db2): 11.5 | Db2 Driver: 11.5.0.0 | +| Connector | Database | Driver | +|-----------|----------------------------------------------------|----------------------| +| Db2-cdc | <li> [Db2](https://www.ibm.com/products/db2): 11.5 | Db2 Driver: 11.5.0.0 | Dependencies ------------ diff --git a/docs/content/docs/connectors/legacy-flink-cdc-sources/mysql-cdc.md b/docs/content/docs/connectors/legacy-flink-cdc-sources/mysql-cdc.md index 6e36106ac..bc87a43e4 100644 --- a/docs/content/docs/connectors/legacy-flink-cdc-sources/mysql-cdc.md +++ b/docs/content/docs/connectors/legacy-flink-cdc-sources/mysql-cdc.md @@ -31,9 +31,9 @@ The MySQL CDC connector allows for reading snapshot data and incremental data fr ## Supported Databases -| Connector | Database | Driver | -|---------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------| -| [mysql-cdc](../mysql-cdc) | <li> [MySQL](https://dev.mysql.com/doc): 5.6, 5.7, 8.0.x <li> [RDS MySQL](https://www.aliyun.com/product/rds/mysql): 5.6, 5.7, 8.0.x <li> [PolarDB MySQL](https://www.aliyun.com/product/polardb): 5.6, 5.7, 8.0.x <li> [Aurora MySQL](https://aws.amazon.com/cn/rds/aurora): 5.6, 5.7, 8.0.x <li> [MariaDB](https://mariadb.org): 10.x <li> [PolarDB X](https://github.com/ApsaraDB/galaxysql): 2.0.1 | JDBC Driver: 8.0.27 | +| Connector | Database | Driver | +|-----------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------| +| mysql-cdc | <li> [MySQL](https://dev.mysql.com/doc): 5.6, 5.7, 8.0.x <li> [RDS MySQL](https://www.aliyun.com/product/rds/mysql): 5.6, 5.7, 8.0.x <li> [PolarDB MySQL](https://www.aliyun.com/product/polardb): 5.6, 5.7, 8.0.x <li> [Aurora MySQL](https://aws.amazon.com/cn/rds/aurora): 5.6, 5.7, 8.0.x <li> [MariaDB](https://mariadb.org): 10.x <li> [PolarDB X](https://github.com/ApsaraDB/galaxysql): 2.0.1 | JDBC Driver: 8.0.27 | Dependencies ------------ @@ -802,7 +802,7 @@ Data Type Mapping <table class="colwidths-auto docutils"> <thead> <tr> - <th class="text-left" style="width:30%;">MySQL type<a href="https://dev.mysql.com/doc/man/8.0/en/data-types.html"></a></th> + <th class="text-left" style="width:30%;">MySQL type<a href="https://dev.mysql.com/doc/refman/8.0/en/data-types.html"></a></th> <th class="text-left" style="width:10%;">Flink SQL type<a href="{% link dev/table/types.md %}"></a></th> <th class="text-left" style="width:60%;">NOTE</th> </tr> diff --git a/docs/content/docs/connectors/legacy-flink-cdc-sources/overview.md b/docs/content/docs/connectors/legacy-flink-cdc-sources/overview.md index b718aec23..20cd61135 100644 --- a/docs/content/docs/connectors/legacy-flink-cdc-sources/overview.md +++ b/docs/content/docs/connectors/legacy-flink-cdc-sources/overview.md @@ -35,17 +35,17 @@ You can also read [tutorials]({{< ref "docs/connectors/legacy-flink-cdc-sources/ ## Supported Connectors -| Connector | Database | Driver | -|-----------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------| -| [mongodb-cdc](../mongodb-cdc) | <li> [MongoDB](https://www.mongodb.com): 3.6, 4.x, 5.0 | MongoDB Driver: 4.3.4 | -| [mysql-cdc](../mysql-cdc) | <li> [MySQL](https://dev.mysql.com/doc): 5.6, 5.7, 8.0.x <li> [RDS MySQL](https://www.aliyun.com/product/rds/mysql): 5.6, 5.7, 8.0.x <li> [PolarDB MySQL](https://www.aliyun.com/product/polardb): 5.6, 5.7, 8.0.x <li> [Aurora MySQL](https://aws.amazon.com/cn/rds/aurora): 5.6, 5.7, 8.0.x <li> [MariaDB](https://mariadb.org): 10.x <li> [PolarDB X](https://github.com/ApsaraDB/galaxysql): 2.0.1 | JDBC Driver: 8.0.28 | -| [oceanbase-cdc](../oceanbase-cdc) | <li> [OceanBase CE](https://open.oceanbase.com): 3.1.x, 4.x <li> [OceanBase EE](https://www.oceanbase.com/product/oceanbase): 2.x, 3.x, 4.x | OceanBase Driver: 2.4.x | -| [oracle-cdc](../oracle-cdc) | <li> [Oracle](https://www.oracle.com/index.html): 11, 12, 19, 21 | Oracle Driver: 19.3.0.0 | -| [postgres-cdc](../postgres-cdc) | <li> [PostgreSQL](https://www.postgresql.org): 9.6, 10, 11, 12, 13, 14 | JDBC Driver: 42.5.1 | -| [sqlserver-cdc](../sqlserver-cdc) | <li> [Sqlserver](https://www.microsoft.com/sql-server): 2012, 2014, 2016, 2017, 2019 | JDBC Driver: 9.4.1.jre8 | -| [tidb-cdc](../tidb-cdc) | <li> [TiDB](https://www.pingcap.com/): 5.1.x, 5.2.x, 5.3.x, 5.4.x, 6.0.0 | JDBC Driver: 8.0.27 | -| [db2-cdc](../db2-cdc) | <li> [Db2](https://www.ibm.com/products/db2): 11.5 | Db2 Driver: 11.5.0.0 | -| [vitess-cdc](../vitess-cdc) | <li> [Vitess](https://vitess.io/): 8.0.x, 9.0.x | MySql JDBC Driver: 8.0.26 | +| Connector | Database | Driv [...] +|---------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----- [...] +| [mongodb-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/mongodb-cdc" >}}) | <li> [MongoDB](https://www.mongodb.com): 3.6, 4.x, 5.0 | Mong [...] +| [mysql-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/mysql-cdc" >}}) | <li> [MySQL](https://dev.mysql.com/doc" >}}): 5.6, 5.7, 8.0.x <li> [RDS MySQL](https://www.aliyun.com/product/rds/mysql): 5.6, 5.7, 8.0.x <li> [PolarDB MySQL](https://www.aliyun.com/product/polardb): 5.6, 5.7, 8.0.x <li> [Aurora MySQL](https://aws.amazon.com/cn/rds/aurora): 5.6, 5.7, 8.0.x <li> [MariaDB](https://mariadb.org): 10.x <li> [PolarDB X](https://github.com/ApsaraDB/galaxysql): 2.0.1 | JDBC [...] +| [oceanbase-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/oceanbase-cdc" >}}) | <li> [OceanBase CE](https://open.oceanbase.com): 3.1.x, 4.x <li> [OceanBase EE](https://www.oceanbase.com/product/oceanbase): 2.x, 3.x, 4.x | Ocea [...] +| [oracle-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/oracle-cdc" >}}) | <li> [Oracle](https://www.oracle.com/index.html): 11, 12, 19, 21 | Orac [...] +| [postgres-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/postgres-cdc" >}}) | <li> [PostgreSQL](https://www.postgresql.org): 9.6, 10, 11, 12, 13, 14 | JDBC [...] +| [sqlserver-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/sqlserver-cdc" >}}) | <li> [Sqlserver](https://www.microsoft.com/sql-server): 2012, 2014, 2016, 2017, 2019 | JDBC [...] +| [tidb-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/tidb-cdc" >}}) | <li> [TiDB](https://www.pingcap.com/): 5.1.x, 5.2.x, 5.3.x, 5.4.x, 6.0.0 | JDBC [...] +| [db2-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/db2-cdc" >}}) | <li> [Db2](https://www.ibm.com/products/db2): 11.5 | Db2 [...] +| [vitess-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/vitess-cdc" >}}) | <li> [Vitess](https://vitess.io/): 8.0.x, 9.0.x | MySq [...] ## Supported Flink Versions The following table shows the version mapping between Flink<sup>®</sup> CDC Connectors and Flink<sup>®</sup>: @@ -72,17 +72,17 @@ The following table shows the version mapping between Flink<sup>®</sup> CDC Con The following table shows the current features of the connector: -| Connector | No-lock Read | Parallel Read | Exactly-once Read | Incremental Snapshot Read | -|--------------------------------|--------------|---------------|-------------------|---------------------------| -| [mongodb-cdc](../mongodb-cdc) | ✅ | ✅ | ✅ | ✅ | -| [mysql-cdc](../mysql-cdc) | ✅ | ✅ | ✅ | ✅ | -| [oracle-cdc](../oracle-cdc) | ✅ | ✅ | ✅ | ✅ | -| [postgres-cdc](../postgres-cdc) | ✅ | ✅ | ✅ | ✅ | -| [sqlserver-cdc](../sqlserver-cdc) | ✅ | ✅ | ✅ | ✅ | -| [oceanbase-cdc](../oceanbase-cdc) | ❌ | ❌ | ❌ | ❌ | -| [tidb-cdc](../tidb-cdc) | ✅ | ❌ | ✅ | ❌ | -| [db2-cdc](../db2-cdc) | ❌ | ❌ | ✅ | ❌ | -| [vitess-cdc](../vitess-cdc) | ✅ | ❌ | ✅ | ❌ | +| Connector | No-lock Read | Parallel Read | Exactly-once Read | Incremental Snapshot Read | +|---------------------------------------------------------------------------------------|--------------|---------------|-------------------|---------------------------| +| [mongodb-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/mongodb-cdc" >}}) | ✅ | ✅ | ✅ | ✅ | +| [mysql-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/mysql-cdc" >}}) | ✅ | ✅ | ✅ | ✅ | +| [oracle-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/oracle-cdc" >}}) | ✅ | ✅ | ✅ | ✅ | +| [postgres-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/postgres-cdc" >}}) | ✅ | ✅ | ✅ | ✅ | +| [sqlserver-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/sqlserver-cdc" >}}) | ✅ | ✅ | ✅ | ✅ | +| [oceanbase-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/oceanbase-cdc" >}}) | ❌ | ❌ | ❌ | ❌ | +| [tidb-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/tidb-cdc" >}}) | ✅ | ❌ | ✅ | ❌ | +| [db2-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/db2-cdc" >}}) | ❌ | ❌ | ✅ | ❌ | +| [vitess-cdc]({{< ref "docs/connectors/legacy-flink-cdc-sources/vitess-cdc" >}}) | ✅ | ❌ | ✅ | ❌ | ## Usage for Table/SQL API diff --git a/docs/content/docs/connectors/legacy-flink-cdc-sources/vitess-cdc.md b/docs/content/docs/connectors/legacy-flink-cdc-sources/vitess-cdc.md index 6f8a2984b..4e0936f26 100644 --- a/docs/content/docs/connectors/legacy-flink-cdc-sources/vitess-cdc.md +++ b/docs/content/docs/connectors/legacy-flink-cdc-sources/vitess-cdc.md @@ -261,7 +261,7 @@ Data Type Mapping <table class="colwidths-auto docutils"> <thead> <tr> - <th class="text-left">MySQL type<a href="https://dev.mysql.com/doc/man/8.0/en/data-types.html"></a></th> + <th class="text-left">MySQL type<a href="https://dev.mysql.com/doc/refman/8.0/en/data-types.html"></a></th> <th class="text-left">Flink SQL type<a href="{% link dev/table/types.md %}"></a></th> </tr> </thead> diff --git a/docs/content/docs/connectors/mysql.md b/docs/content/docs/connectors/mysql.md index 455e22edf..c6ef38252 100644 --- a/docs/content/docs/connectors/mysql.md +++ b/docs/content/docs/connectors/mysql.md @@ -262,7 +262,7 @@ The config option `scan.startup.mode` specifies the startup mode for MySQL CDC c <table class="colwidths-auto docutils"> <thead> <tr> - <th class="text-left" style="width:30%;"><a href="https://dev.mysql.com/doc/man/8.0/en/data-types.html">MySQL type</a></th> + <th class="text-left" style="width:30%;"><a href="https://dev.mysql.com/doc/refman/8.0/en/data-types.html">MySQL type</a></th> <th class="text-left" style="width:10%;">Flink CDC type</th> <th class="text-left" style="width:60%;">Note</th> </tr>