Skip to content

CI: Update LinkChecker URL excludes #19850

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Feb 19, 2025
Merged

CI: Update LinkChecker URL excludes #19850

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
74fe727
Add temp.md
qiancai Feb 18, 2025
38f9b0e
Delete temp.md
qiancai Feb 18, 2025
65bccae
add translation
qiancai Feb 18, 2025
8a86516
Update develop/dev-guide-third-party-support.md
qiancai Feb 19, 2025
7a1a356
Update dm/.lycheeignore
qiancai Feb 19, 2025
0fadcae
Update develop/dev-guide-third-party-support.md
qiancai Feb 19, 2025
a52a2e7
Update link-fail-fast.yaml
qiancai Feb 19, 2025
d1b2f06
move .lycheeignore to the root path
qiancai Feb 19, 2025
c0a7bb1
sync en changes
qiancai Feb 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 2 additions & 6 deletions .github/workflows/link-fail-fast.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,15 +17,11 @@ jobs:
CHANGED_FILES=$(git diff-tree --name-only --diff-filter 'AM' -r HEAD^1 HEAD -- "*.md" | sed -z "s/\n$//;s/\n/' '/g")
echo "all_changed_files=${CHANGED_FILES}" >> $GITHUB_OUTPUT

- name: Download Exclude Path
run: |
curl https://raw.githubusercontent.com/pingcap/docs/master/.lycheeignore -O

- name: Link Checker
if: ${{ steps.changed-files.outputs.all_changed_files }}
uses: lycheeverse/lychee-action@v1.6.1
uses: lycheeverse/lychee-action@v2.3.0
with:
fail: true
args: -E --exclude-mail -i -n -t 45 -- '${{ steps.changed-files.outputs.all_changed_files }}'
args: --root-dir $(pwd) -E -i -n -t 45 -- '${{ steps.changed-files.outputs.all_changed_files }}'
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
35 changes: 35 additions & 0 deletions .lycheeignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
https://mvnrepository\.com/artifact/mysql/mysql-connector-java/8\.0\.28
https://github\.com/.*/issues/?
https://github\.com/.*/pull/?
https://github\.com/.*/pull/[0-9]+
https://github\.com/.*/issues/[0-9]+
https?://\$?\{host}/dashboard.*
http://xn--\$?\{ip}-m86ht9t5l1bhz9ayu7b:3000.*
http://ip:2379.*
http://grafana_ip:3000.*
http://\$?\{remote-server-ip}:3000.*
file:///home/runner/work/(docs|docs-cn)/(docs|docs-cn)/develop/.*
file://.*https:/%7BnodeIP%7D:%7BnodePort%7D/dashboard
file://.*?http:/\$%7BPD_IP%7D:\$%7BPD_PORT%7D/dashboard.*
http://\{grafana-ip\}:3000
http://\{pd-ip\}:2379/dashboard
http://localhost:\d+/
https://github\.com/\$user/(docs|docs-cn)
https://linux\.die\.net/man.*
https://dev\.mysql\.com/doc/.+/5.7/en/.*
https://dev\.mysql\.com/doc/.+/8\.0/en/.*
https://dev\.mysql\.com/doc/.+/8\.4/en/.*
https://dev\.mysql\.com/doc/[a-z\-]+/en/.*
https://dev\.mysql\.com/doc/relnotes/[a-z\-]+/en/.*
https://dev\.mysql\.com/doc/dev/mysql-server/.*
https://dev\.mysql\.com/downloads/.*
https://bugs\.mysql\.com/bug\.php.*
https://www\.mysql\.com/products/.*
https://platform\.openai\.com/docs/.*
https://openai\.com/.*
https://jwt\.io/
https://typeorm\.io/.*
https://dash\.cloudflare\.com/.*
https://centminmod\.com/mydumper\.html
https://learn\.pingcap\.com/learner/
https://zhuanlan\.zhihu\.com/p/
172 changes: 20 additions & 152 deletions develop/dev-guide-third-party-support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,161 +27,29 @@ PingCAP 与开源社区合作，通过三方工具提供以下支持：

## Driver

<table>
<thead>
<tr>
<th>编程语言</th>
<th>驱动</th>
<th>最新已测试版本</th>
<th>支持等级</th>
<th>TiDB 适配器</th>
<th>教程</th>
</tr>
</thead>
<tbody>
<tr>
<td>Go</td>
<td><a href="https://github.com/go-sql-driver/mysql" target="_blank" referrerpolicy="no-referrer-when-downgrade">Go-MySQL-Driver</a></td>
<td>v1.6.0</td>
<td>Full</td>
<td>N/A</td>
<td><a href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-sample-application-golang-sql-driver">使用 Go-MySQL-Driver 连接到 TiDB</a></td>
</tr>
<tr>
<td>Java</td>
<td><a href="https://dev.mysql.com/downloads/connector/j/" target="_blank" referrerpolicy="no-referrer-when-downgrade">JDBC</a></td>
<td>8.0</td>
<td>Full</td>
<td>
<ul>
<li><a href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-choose-driver-or-orm#java-drivers" data-href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-choose-driver-or-orm#java-drivers">pingcap/mysql-connector-j</a></li>
<li><a href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-choose-driver-or-orm#tidb-loadbalance" data-href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-choose-driver-or-orm#tidb-loadbalance">pingcap/tidb-loadbalance</a></li>
</ul>
</td>
<td><a href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-sample-application-java-jdbc">使用 JDBC 连接到 TiDB</a></td>
</tr>
</tbody>
</table>
| 编程语言 | 驱动 | 最新已测试版本 | 支持等级 | TiDB 适配器 | 教程 |
|----------|--------|-----------------------|---------------|--------------|----------|
| Go | [go-sql-driver/mysql](https://github.com/go-sql-driver/mysql) | v1.6.0 | Full | N/A | [使用 Go-MySQL-Driver 连接到 TiDB](/develop/dev-guide-sample-application-golang-sql-driver.md) |
| Java | [MySQL Connector/J](https://dev.mysql.com/downloads/connector/j/) | 8.0 | Full | [pingcap/mysql-connector-j](/develop/dev-guide-choose-driver-or-orm.md#java-drivers) <br/> [pingcap/tidb-loadbalance](/develop/dev-guide-choose-driver-or-orm.md#java-客户端负载均衡) | [使用 JDBC 连接到 TiDB](/develop/dev-guide-sample-application-java-jdbc.md) |

## ORM

<table>
<thead>
<tr>
<th>编程语言</th>
<th>ORM 框架</th>
<th>最新已测试版本</th>
<th>支持等级</th>
<th>TiDB 适配器</th>
<th>教程</th>
</tr>
</thead>
<tbody>
<tr>
<td rowspan="4">Go</td>
<td><a href="https://github.com/go-gorm/gorm" target="_blank" referrerpolicy="no-referrer-when-downgrade">gorm</a></td>
<td>v1.23.5</td>
<td>Full</td>
<td>N/A</td>
<td><a href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-sample-application-golang-gorm">使用 GORM 连接到 TiDB</a></td>
</tr>
<tr>
<td><a href="https://github.com/beego/beego" target="_blank" referrerpolicy="no-referrer-when-downgrade">beego</a></td>
<td>v2.0.3</td>
<td>Full</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td><a href="https://github.com/upper/db" target="_blank" referrerpolicy="no-referrer-when-downgrade">upper/db</a></td>
<td>v4.5.2</td>
<td>Full</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td><a href="https://gitea.com/xorm/xorm" target="_blank" referrerpolicy="no-referrer-when-downgrade">xorm</a></td>
<td>v1.3.1</td>
<td>Full</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td rowspan="4">Java</td>
<td><a href="https://hibernate.org/orm/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Hibernate</a></td>
<td>6.1.0.Final</td>
<td>Full</td>
<td>N/A</td>
<td><a href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-sample-application-java-hibernate">使用 Hibernate 连接到 TiDB</a></td>
</tr>
<tr>
<td><a href="https://mybatis.org/mybatis-3/" target="_blank" referrerpolicy="no-referrer-when-downgrade">MyBatis</a></td>
<td>v3.5.10</td>
<td>Full</td>
<td>N/A</td>
<td><a href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-sample-application-java-mybatis">使用 MyBatis 连接到 TiDB</a></td>
</tr>
<tr>
<td><a href="https://spring.io/projects/spring-data-jpa/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Spring Data JPA</a></td>
<td>2.7.2</td>
<td>Full</td>
<td>N/A</td>
<td><a href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-sample-application-java-spring-boot">使用 Spring Boot 连接到 TiDB</a></td>
</tr>
<tr>
<td><a href="https://github.com/jOOQ/jOOQ" target="_blank" referrerpolicy="no-referrer-when-downgrade">jOOQ</a></td>
<td>v3.16.7 (Open Source)</td>
<td>Full</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td>Ruby</td>
<td><a href="https://guides.rubyonrails.org/active_record_basics.html" target="_blank" referrerpolicy="no-referrer-when-downgrade">Active Record</a></td>
<td>v7.0</td>
<td>Full</td>
<td>N/A</td>
<td><a href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-sample-application-ruby-rails">使用 Rails 框架和 ActiveRecord ORM 连接到 TiDB</a></td>
</tr>
<tr>
<td rowspan="3">JavaScript / TypeScript</td>
<td><a href="https://sequelize.org/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Sequelize</a></td>
<td>v6.20.1</td>
<td>Full</td>
<td>N/A</td>
<td>N/A</td>
</tr>
<tr>
<td><a href="https://www.prisma.io/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Prisma</a></td>
<td>4.16.2</td>
<td>Full</td>
<td>N/A</td>
<td><a href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-sample-application-nodejs-prisma">使用 Prisma 连接到 TiDB</a></td>
</tr>
<tr>
<td><a href="https://typeorm.io/" target="_blank" referrerpolicy="no-referrer-when-downgrade">TypeORM</a></td>
<td>v0.3.17</td>
<td>Full</td>
<td>N/A</td>
<td><a href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-sample-application-nodejs-typeorm">使用 TypeORM 连接到 TiDB</a></td>
</tr>
<tr>
<td rowspan="2">Python</td>
<td><a href="https://pypi.org/project/Django/" target="_blank" referrerpolicy="no-referrer-when-downgrade">Django</a></td>
<td>v4.2</td>
<td>Full</td>
<td><a href="https://github.com/pingcap/django-tidb" target="_blank" referrerpolicy="no-referrer-when-downgrade">django-tidb</a></td>
<td><a href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-sample-application-python-django">使用 Django 连接到 TiDB</a></td>
</tr>
<tr>
<td><a href="https://www.sqlalchemy.org/" target="_blank" referrerpolicy="no-referrer-when-downgrade">SQLAlchemy</a></td>
<td>v1.4.37</td>
<td>Full</td>
<td>N/A</td>
<td><a href="https://docs.pingcap.com/zh/tidb/dev/dev-guide-sample-application-python-sqlalchemy">使用 SQLAlchemy 连接到 TiDB</a></td>
</tr>
</tbody>
</table>
| 编程语言 | ORM 框架 | 最新已测试版本 | 支持等级 | TiDB 适配器 | 教程 |
|-------------------------|-------------------------------------------|-----------------------|-------------|--------------|----------|
| Go | [gorm](https://github.com/go-gorm/gorm) | v1.23.5 | Full | N/A | [使用 GORM 连接到 TiDB](/develop/dev-guide-sample-application-golang-gorm.md) |
| Go | [beego](https://github.com/beego/beego) | v2.0.3 | Full | N/A | N/A |
| Go | [upper/db](https://github.com/upper/db) | v4.5.2 | Full | N/A | N/A |
| Go | [xorm](https://gitea.com/xorm/xorm) | v1.3.1 | Full | N/A | N/A |
| Java | [Hibernate](https://hibernate.org/orm/) | 6.1.0.Final | Full | N/A | [使用 Hibernate 连接到 TiDB](/develop/dev-guide-sample-application-java-hibernate.md) |
| Java | [MyBatis](https://mybatis.org/mybatis-3/) | v3.5.10 | Full | N/A | [使用 MyBatis 连接到 TiDB](/develop/dev-guide-sample-application-java-mybatis.md) |
| Java | [Spring Data JPA](https://spring.io/projects/spring-data-jpa/) | 2.7.2 | Full | N/A | [使用 Spring Boot 连接到 TiDB](/develop/dev-guide-sample-application-java-spring-boot.md) |
| Java | [jOOQ](https://github.com/jOOQ/jOOQ) | v3.16.7 (Open Source) | Full | N/A | N/A |
| Ruby | [Active Record](https://guides.rubyonrails.org/active_record_basics.html) | v7.0 | Full | N/A | [使用 Rails 框架和 ActiveRecord ORM 连接到 TiDB](/develop/dev-guide-sample-application-ruby-rails.md) |
| JavaScript / TypeScript | [Sequelize](https://sequelize.org/) | v6.20.1 | Full | N/A | [使用 Sequelize 连接到 TiDB](/develop/dev-guide-sample-application-nodejs-sequelize.md) |
| JavaScript / Typescript | [Prisma](https://www.prisma.io/) | 4.16.2 | Full | N/A | [使用 Prisma 连接到 TiDB](/develop/dev-guide-sample-application-nodejs-prisma.md) |
| JavaScript / Typescript | [TypeORM](https://typeorm.io/) | v0.3.17 | Full | N/A | [使用 TypeORM 连接到 TiDB](/develop/dev-guide-sample-application-nodejs-typeorm.md) |
| Python | [Django](https://www.djangoproject.com/) | v4.2 | Full | [django-tidb](https://github.com/pingcap/django-tidb) | [使用 Django 连接到 TiDB](/develop/dev-guide-sample-application-python-django.md) |
| Python | [SQLAlchemy](https://www.sqlalchemy.org/) | v1.4.37 | Full | N/A | [使用 SQLAlchemy 连接到 TiDB](/develop/dev-guide-sample-application-python-sqlalchemy.md) |

## GUI

Expand Down
35 changes: 6 additions & 29 deletions vector-search/vector-search-integration-overview.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,32 +40,9 @@ TiDB 向量搜索支持存储高达 16383 维的向量，可适应大多数嵌

下表列出了支持的 ORM 库和相应的使用教程：

<table>
<tr>
<th>语言</th>
<th>ORM/客户端</th>
<th>安装说明</th>
<th>教程</th>
</tr>
<tr>
<td rowspan="4">Python</td>
<td>TiDB Vector Client</td>
<td><code>pip install tidb-vector[client]</code></td>
<td><a href="/vector-search-get-started-using-python.md">使用 Python 开始向量搜索</a></td>
</tr>
<tr>
<td>SQLAlchemy</td>
<td><code>pip install tidb-vector</code></td>
<td><a href="/vector-search-integrate-with-sqlalchemy.md">在 SQLAlchemy 中使用 TiDB 向量搜索</a></td>
</tr>
<tr>
<td>peewee</td>
<td><code>pip install tidb-vector</code></td>
<td><a href="/vector-search-integrate-with-peewee.md">在 peewee 中使用 TiDB 向量搜索</a></td>
</tr>
<tr>
<td>Django</td>
<td><code>pip install django-tidb[vector]</code></td>
<td><a href="/vector-search-integrate-with-django-orm.md">在 Django 中使用 TiDB 向量搜索</a></td>
</tr>
</table>
| 语言 | ORM/客户端 | 安装说明 | 教程 |
|----------|--------------------|-----------------------------------|----------|
| Python | TiDB Vector Client | `pip install tidb-vector[client]` | [使用 Python 开始向量搜索](/vector-search/vector-search-get-started-using-python.md) |
| Python | SQLAlchemy | `pip install tidb-vector` | [在 SQLAlchemy 中使用 TiDB 向量搜索](/vector-search/vector-search-integrate-with-sqlalchemy.md)
| Python | peewee | `pip install tidb-vector` | [在 peewee 中使用 TiDB 向量搜索](/vector-search/vector-search-integrate-with-peewee.md) |
| Python | Django | `pip install django-tidb[vector]` | [在 Django 中使用 TiDB 向量搜索](/vector-search/vector-search-integrate-with-django-orm.md)