diff --git a/.github/workflows/link-fail-fast.yaml b/.github/workflows/link-fail-fast.yaml index 04ac603a65fe2..9f3466d0c899b 100644 --- a/.github/workflows/link-fail-fast.yaml +++ b/.github/workflows/link-fail-fast.yaml @@ -19,9 +19,9 @@ jobs: - 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}} diff --git a/ai/integrations/vector-search-integration-overview.md b/ai/integrations/vector-search-integration-overview.md index 5d81d579f6403..1eafb078f0fbb 100644 --- a/ai/integrations/vector-search-integration-overview.md +++ b/ai/integrations/vector-search-integration-overview.md @@ -42,32 +42,9 @@ You can integrate TiDB Vector Search with your ORM library to interact with the The following table lists the supported ORM libraries and the corresponding integration tutorials: - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
LanguageORM/ClientHow to installTutorial
PythonTiDB Vector Clientpip install tidb-vector[client]Get Started with Vector Search Using Python
SQLAlchemypip install tidb-vectorIntegrate TiDB Vector Search with SQLAlchemy
peeweepip install tidb-vectorIntegrate TiDB Vector Search with peewee
Djangopip install django-tidb[vector]Integrate TiDB Vector Search with Django
+| Language | ORM/Client | How to install | Tutorial | +|----------|--------------------|-----------------------------------|----------| +| Python | TiDB Vector Client | `pip install tidb-vector[client]` | [Get Started with Vector Search Using Python](/ai/quickstart-via-python.md) | +| Python | SQLAlchemy | `pip install tidb-vector` | [Integrate TiDB Vector Search with SQLAlchemy](/ai/integrations/vector-search-integrate-with-sqlalchemy.md) +| Python | peewee | `pip install tidb-vector` | [Integrate TiDB Vector Search with peewee](/ai/integrations/vector-search-integrate-with-peewee.md) | +| Python | Django | `pip install django-tidb[vector]` | [Integrate TiDB Vector Search with Django](/ai/integrations/vector-search-integrate-with-django-orm.md) \ No newline at end of file diff --git a/develop/_index.md b/develop/_index.md index 9e9d5cade08c4..9fddec60eb5ea 100644 --- a/develop/_index.md +++ b/develop/_index.md @@ -21,7 +21,7 @@ Build your application with the language you use by following the guides with sa -Connect to TiDB over HTTPS from edge environments. +Connect to TiDB over HTTPS from edge environments (only applicable to TiDB Cloud). @@ -147,7 +147,7 @@ In addition to these guides, PingCAP works with the community to support [third- ## Use MySQL client software -As TiDB is a MySQL-compatible database, you can use many familiar client software tools to connect to TiDB and manage your databases. Or, you can use our command line tool to connect and manage your databases. +As TiDB is a MySQL-compatible database, you can use many familiar client software tools to connect to TiDB and manage your databases. For TiDB Cloud, you can also use our [command line tool](/tidb-cloud/get-started-with-cli.md) to connect and manage your databases. @@ -176,7 +176,6 @@ Connect and manage TiDB databases with DataGrip by JetBrains. Learn other topics about developing with TiDB. -- Use TiDB Cloud CLI to develop, manage and deploy your applications. -- Explore popular service integrations with TiDB Cloud. - Follow [TiDB database development reference](/develop/dev-guide-schema-design-overview.md) to design, interact with, optimize, and troubleshoot your data and schema. - Follow the free online course [Introduction to TiDB](https://eng.edu.pingcap.com/catalog/info/id:203/?utm_source=docs-dev-guide). +- Explore popular [service integrations](/tidb-cloud/integrate-tidbcloud-with-airbyte.md) with TiDB Cloud. diff --git a/develop/dev-guide-third-party-support.md b/develop/dev-guide-third-party-support.md index 0aac94efcdb0b..9278fe02374ec 100644 --- a/develop/dev-guide-third-party-support.md +++ b/develop/dev-guide-third-party-support.md @@ -27,161 +27,29 @@ If you encounter problems when connecting to TiDB using the tools listed in this ## Driver - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
LanguageDriverLatest tested versionSupport levelTiDB adapterTutorial
GoGo-MySQL-Driverv1.6.0FullN/AConnect to TiDB with Go-MySQL-Driver
JavaJDBC8.0Full - - Connect to TiDB with JDBC
+| Language | Driver | Latest tested version | Support level | TiDB adapter | Tutorial | +|----------|--------|-----------------------|---------------|--------------|----------| +| Go | [go-sql-driver/mysql](https://github.com/go-sql-driver/mysql) | v1.6.0 | Full | N/A | [Connect to TiDB with Go-MySQL-Driver](/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)
[pingcap/tidb-loadbalance](/develop/dev-guide-choose-driver-or-orm.md#java-client-load-balancing) | [Connect to TiDB with JDBC](/develop/dev-guide-sample-application-java-jdbc.md) | ## ORM - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
LanguageORM frameworkLatest tested versionSupport levelTiDB adapterTutorial
Gogormv1.23.5FullN/AConnect to TiDB with GORM
beegov2.0.3FullN/AN/A
upper/dbv4.5.2FullN/AN/A
xormv1.3.1FullN/AN/A
JavaHibernate6.1.0.FinalFullN/AConnect to TiDB with Hibernate
MyBatisv3.5.10FullN/AConnect to TiDB with MyBatis
Spring Data JPA2.7.2FullN/AConnect to TiDB with Spring Boot
jOOQv3.16.7 (Open Source)FullN/AN/A
RubyActive Recordv7.0FullN/AConnect to TiDB with Rails Framework and ActiveRecord ORM
JavaScript / TypeScriptSequelizev6.20.1FullN/AConnect to TiDB with Sequelize
Prisma4.16.2FullN/AConnect to TiDB with Prisma
TypeORMv0.3.17FullN/AConnect to TiDB with TypeORM
PythonDjangov4.2Fulldjango-tidbConnect to TiDB with Django
SQLAlchemyv1.4.37FullN/AConnect to TiDB with SQLAlchemy
+| Language | ORM framework | Latest tested version | Support level | TiDB adapter | Tutorial | +|-------------------------|-------------------------------------------|-----------------------|-------------|--------------|----------| +| Go | [gorm](https://github.com/go-gorm/gorm) | v1.23.5 | Full | N/A | [Connect to TiDB with GORM](/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 | [Connect to TiDB with Hibernate](/develop/dev-guide-sample-application-java-hibernate.md) | +| Java | [MyBatis](https://mybatis.org/mybatis-3/) | v3.5.10 | Full | N/A | [Connect to TiDB with MyBatis](/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 | [Connect to TiDB with Spring Boot](/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 | [Connect to TiDB with Rails Framework and ActiveRecord ORM](/develop/dev-guide-sample-application-ruby-rails.md) | +| JavaScript / TypeScript | [Sequelize](https://sequelize.org/) | v6.20.1 | Full | N/A | [Connect to TiDB with Sequelize](/develop/dev-guide-sample-application-nodejs-sequelize.md) | +| JavaScript / Typescript | [Prisma](https://www.prisma.io/) | 4.16.2 | Full | N/A | [Connect to TiDB with Prisma](/develop/dev-guide-sample-application-nodejs-prisma.md) | +| JavaScript / Typescript | [TypeORM](https://typeorm.io/) | v0.3.17 | Full | N/A | [Connect to TiDB with TypeORM](/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) | [Connect to TiDB with Django](/develop/dev-guide-sample-application-python-django.md) | +| Python | [SQLAlchemy](https://www.sqlalchemy.org/) | v1.4.37 | Full | N/A | [Connect to TiDB with SQLAlchemy](/develop/dev-guide-sample-application-python-sqlalchemy.md) | ## GUI diff --git a/tidb-cloud/releases/release-notes-2023.md b/tidb-cloud/releases/release-notes-2023.md index c6414224482d7..49418c31691c4 100644 --- a/tidb-cloud/releases/release-notes-2023.md +++ b/tidb-cloud/releases/release-notes-2023.md @@ -132,7 +132,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c - Introduce a TiDB Cloud Billing API endpoint to retrieve the bill for the given month of a specific organization. - This Billing API endpoint is released in TiDB Cloud API v1beta1, which is the latest API version of TiDB Cloud. For more information, refer to the [API documentation (v1beta1)](https://docs.pingcap.com/tidbcloud/api/v1beta1#tag/Billing). + This Billing API endpoint is released in TiDB Cloud API v1beta1, which is the latest API version of TiDB Cloud. For more information, refer to the [API documentation (v1beta1)](https://docs.pingcap.com/tidbcloud/api/v1beta1/billing). ## September 19, 2023