Skip to content

Commit

Permalink
This is an automated cherry-pick of pingcap#18779
Browse files Browse the repository at this point in the history
Signed-off-by: ti-chi-bot <[email protected]>
  • Loading branch information
qiancai authored and ti-chi-bot committed Oct 23, 2024
1 parent 34232dc commit 5733a6e
Show file tree
Hide file tree
Showing 28 changed files with 1,397 additions and 553 deletions.
32 changes: 16 additions & 16 deletions TOC-tidb-cloud.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
- [Roadmap](/tidb-cloud/tidb-cloud-roadmap.md)
- Get Started
- [Try Out TiDB Cloud](/tidb-cloud/tidb-cloud-quickstart.md)
- [Try Out TiDB + AI](/tidb-cloud/vector-search-get-started-using-python.md)
- [Try Out TiDB + AI](/vector-search-get-started-using-python.md)
- [Try Out HTAP](/tidb-cloud/tidb-cloud-htap-quickstart.md)
- [Try Out TiDB Cloud CLI](/tidb-cloud/get-started-with-cli.md)
- [Perform a PoC](/tidb-cloud/tidb-cloud-poc.md)
Expand Down Expand Up @@ -242,27 +242,27 @@
- Explore Data
- [Chat2Query (Beta) in SQL Editor](/tidb-cloud/explore-data-with-chat2query.md)
- Vector Search (Beta)
- [Overview](/tidb-cloud/vector-search-overview.md)
- [Overview](/vector-search-overview.md)
- Get Started
- [Get Started with SQL](/tidb-cloud/vector-search-get-started-using-sql.md)
- [Get Started with Python](/tidb-cloud/vector-search-get-started-using-python.md)
- [Get Started with SQL](/vector-search-get-started-using-sql.md)
- [Get Started with Python](/vector-search-get-started-using-python.md)
- Integrations
- [Overview](/tidb-cloud/vector-search-integration-overview.md)
- [Overview](/vector-search-integration-overview.md)
- AI Frameworks
- [LlamaIndex](/tidb-cloud/vector-search-integrate-with-llamaindex.md)
- [Langchain](/tidb-cloud/vector-search-integrate-with-langchain.md)
- [LlamaIndex](/vector-search-integrate-with-llamaindex.md)
- [Langchain](/vector-search-integrate-with-langchain.md)
- Embedding Models/Services
- [Jina AI](/tidb-cloud/vector-search-integrate-with-jinaai-embedding.md)
- [Jina AI](/vector-search-integrate-with-jinaai-embedding.md)
- ORM Libraries
- [SQLAlchemy](/tidb-cloud/vector-search-integrate-with-sqlalchemy.md)
- [peewee](/tidb-cloud/vector-search-integrate-with-peewee.md)
- [Django ORM](/tidb-cloud/vector-search-integrate-with-django-orm.md)
- [SQLAlchemy](/vector-search-integrate-with-sqlalchemy.md)
- [peewee](/vector-search-integrate-with-peewee.md)
- [Django ORM](/vector-search-integrate-with-django-orm.md)
- Reference
- [Vector Data Types](/tidb-cloud/vector-search-data-types.md)
- [Vector Functions and Operators](/tidb-cloud/vector-search-functions-and-operators.md)
- [Vector Index](/tidb-cloud/vector-search-index.md)
- [Improve Performance](/tidb-cloud/vector-search-improve-performance.md)
- [Limitations](/tidb-cloud/vector-search-limitations.md)
- [Vector Data Types](/vector-search-data-types.md)
- [Vector Functions and Operators](/vector-search-functions-and-operators.md)
- [Vector Index](/vector-search-index.md)
- [Improve Performance](/vector-search-improve-performance.md)
- [Limitations](/vector-search-limitations.md)
- [Changelogs](/tidb-cloud/vector-search-changelogs.md)
- Data Service (Beta)
- [Overview](/tidb-cloud/data-service-overview.md)
Expand Down
33 changes: 33 additions & 0 deletions TOC.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,24 @@
- [Follower Read](/develop/dev-guide-use-follower-read.md)
- [Stale Read](/develop/dev-guide-use-stale-read.md)
- [HTAP Queries](/develop/dev-guide-hybrid-oltp-and-olap-queries.md)
- Vector Search
- [Overview](/vector-search-overview.md)
- Get Started
- [Get Started with SQL](/vector-search-get-started-using-sql.md)
- [Get Started with Python](/vector-search-get-started-using-python.md)
- Integrations
- [Overview](/vector-search-integration-overview.md)
- AI Frameworks
- [LlamaIndex](/vector-search-integrate-with-llamaindex.md)
- [Langchain](/vector-search-integrate-with-langchain.md)
- Embedding Models/Services
- [Jina AI](/vector-search-integrate-with-jinaai-embedding.md)
- ORM Libraries
- [SQLAlchemy](/vector-search-integrate-with-sqlalchemy.md)
- [peewee](/vector-search-integrate-with-peewee.md)
- [Django](/vector-search-integrate-with-django-orm.md)
- [Improve Performance](/vector-search-improve-performance.md)
- [Limitations](/vector-search-limitations.md)
- Transaction
- [Overview](/develop/dev-guide-transaction-overview.md)
- [Optimistic and Pessimistic Transactions](/develop/dev-guide-optimistic-and-pessimistic-transaction.md)
Expand Down Expand Up @@ -866,6 +884,7 @@
- [Date and Time Types](/data-type-date-and-time.md)
- [String Types](/data-type-string.md)
- [JSON Type](/data-type-json.md)
- [Vector Types](/vector-search-data-types.md)
- Functions and Operators
- [Overview](/functions-and-operators/functions-and-operators-overview.md)
- [Type Conversion in Expression Evaluation](/functions-and-operators/type-conversion-in-expression-evaluation.md)
Expand All @@ -879,7 +898,20 @@
- [Encryption and Compression Functions](/functions-and-operators/encryption-and-compression-functions.md)
- [Locking Functions](/functions-and-operators/locking-functions.md)
- [Information Functions](/functions-and-operators/information-functions.md)
<<<<<<< HEAD
- [JSON Functions](/functions-and-operators/json-functions.md)
=======
- [Vector Functions and Operators](/vector-search-functions-and-operators.md)
- JSON Functions
- [Overview](/functions-and-operators/json-functions.md)
- [Functions That Create JSON](/functions-and-operators/json-functions/json-functions-create.md)
- [Functions That Search JSON](/functions-and-operators/json-functions/json-functions-search.md)
- [Functions That Modify JSON](/functions-and-operators/json-functions/json-functions-modify.md)
- [Functions That Return JSON](/functions-and-operators/json-functions/json-functions-return.md)
- [JSON Utility Functions](/functions-and-operators/json-functions/json-functions-utility.md)
- [Functions That Aggregate JSON](/functions-and-operators/json-functions/json-functions-aggregate.md)
- [Functions That Validate JSON](/functions-and-operators/json-functions/json-functions-validate.md)
>>>>>>> 3add5b552b (update vector search docs (#18779))
- [Aggregate (GROUP BY) Functions](/functions-and-operators/aggregate-group-by-functions.md)
- [GROUP BY Modifiers](/functions-and-operators/group-by-modifier.md)
- [Window Functions](/functions-and-operators/window-functions.md)
Expand All @@ -891,6 +923,7 @@
- [TiDB Specific Functions](/functions-and-operators/tidb-functions.md)
- [Comparisons between Functions and Syntax of Oracle and TiDB](/oracle-functions-to-tidb.md)
- [Clustered Indexes](/clustered-indexes.md)
- [Vector Index](/vector-search-index.md)
- [Constraints](/constraints.md)
- [Generated Columns](/generated-columns.md)
- [SQL Mode](/sql-mode.md)
Expand Down
5 changes: 5 additions & 0 deletions br/backup-and-restore-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,11 @@ Backup and restore might go wrong when some TiDB features are enabled or disable
| New collation | [#352](https://github.com/pingcap/br/issues/352) | Make sure that the value of the `new_collation_enabled` variable in the `mysql.tidb` table during restore is consistent with that during backup. Otherwise, inconsistent data index might occur and checksum might fail to pass. For more information, see [FAQ - Why does BR report `new_collations_enabled_on_first_bootstrap` mismatch?](/faq/backup-and-restore-faq.md#why-is-new_collation_enabled-mismatch-reported-during-restore). |
| Global temporary tables | | Make sure that you are using v5.3.0 or a later version of BR to back up and restore data. Otherwise, an error occurs in the definition of the backed global temporary tables. |
| TiDB Lightning Physical Import| | If the upstream database uses the physical import mode of TiDB Lightning, data cannot be backed up in log backup. It is recommended to perform a full backup after the data import. For more information, see [When the upstream database imports data using TiDB Lightning in the physical import mode, the log backup feature becomes unavailable. Why?](/faq/backup-and-restore-faq.md#when-the-upstream-database-imports-data-using-tidb-lightning-in-the-physical-import-mode-the-log-backup-feature-becomes-unavailable-why).|
<<<<<<< HEAD
=======
| TiCDC | | BR v8.2.0 and later: if the target cluster to be restored has a changefeed and the changefeed [CheckpointTS](/ticdc/ticdc-architecture.md#checkpointts) is earlier than the BackupTS, BR does not perform the restoration. BR versions before v8.2.0: if the target cluster to be restored has any active TiCDC changefeeds, BR does not perform the restoration. |
| Vector search | | Make sure that you are using v8.4.0 or a later version of BR to back up and restore data. Restoring tables with [vector data types](/vector-search-data-types.md) to TiDB clusters earlier than v8.4.0 is not supported. |
>>>>>>> 3add5b552b (update vector search docs (#18779))
### Version compatibility

Expand Down
11 changes: 11 additions & 0 deletions dm/dm-overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,17 @@ Before using the DM tool, note the following restrictions:

- DM does not support migrating `charset=GBK` tables to TiDB clusters earlier than v5.4.0.

<<<<<<< HEAD
=======
+ Binlog compatibility

- DM does not support the MySQL 8.0 new feature binlog [Transaction_payload_event](https://dev.mysql.com/doc/refman/8.0/en/binary-log-transaction-compression.html). Using binlog Transaction_payload_event might result in data inconsistency between upstream and downstream.

+ Vector data type replication

- DM does not support migrating or replicating MySQL 9.0 vector data types to TiDB.

>>>>>>> 3add5b552b (update vector search docs (#18779))
## Contributing

You are welcome to participate in the DM open sourcing project. Your contribution would be highly appreciated. For more details, see [CONTRIBUTING.md](https://github.com/pingcap/tiflow/blob/release-7.5/dm/CONTRIBUTING.md).
Expand Down
8 changes: 8 additions & 0 deletions ticdc/ticdc-compatibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,3 +64,11 @@ The `sort-dir` configuration is used to specify the temporary file directory for
Since v5.3.0, TiCDC supports [global temporary tables](/temporary-tables.md#global-temporary-tables). Replicating global temporary tables to the downstream using TiCDC of a version earlier than v5.3.0 causes table definition error.

If the upstream cluster contains a global temporary table, the downstream TiDB cluster is expected to be v5.3.0 or a later version. Otherwise, an error occurs during the replication process.

### Compatibility with vector data types

Starting from v8.4.0, TiCDC supports replicating tables with [vector data types](/vector-search-data-types.md) to downstream (experimental).

When the downstream is Kafka or a storage service (such as Amazon S3, GCS, Azure Blob Storage, or NFS), TiCDC converts vector data types into string types before writing to the downstream.

When the downstream is a MySQL-compatible database that does not support vector data types, TiCDC fails to write DDL events involving vector types to the downstream. In this case, add the `has-vector-type=true` parameter to `sink-url`, which allows TiCDC to convert vector data types into the `LONGTEXT` type before writing.
2 changes: 1 addition & 1 deletion tidb-cloud/data-service-manage-endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ In TiDB Cloud Data Service, you can generate one or multiple endpoints automatic

For each operation you select, TiDB Cloud Data Service will generate a corresponding endpoint. If you select a batch operation (such as `POST (Batch Create)`), the generated endpoint lets you operate on multiple rows in a single request.

If the table you selected contains [vector data types](/tidb-cloud/vector-search-data-types.md), you can enable the **Vector Search Operations** option and select a vector distance function to generate a vector search endpoint that automatically calculates vector distances based on your selected distance function. The supported [vector distance functions](/tidb-cloud/vector-search-functions-and-operators.md) include the following:
If the table you selected contains [vector data types](/vector-search-data-types.md), you can enable the **Vector Search Operations** option and select a vector distance function to generate a vector search endpoint that automatically calculates vector distances based on your selected distance function. The supported [vector distance functions](/vector-search-functions-and-operators.md) include the following:

- `VEC_L2_DISTANCE` (default): calculates the L2 distance (Euclidean distance) between two vectors.
- `VEC_COSINE_DISTANCE`: calculates the cosine distance between two vectors.
Expand Down
12 changes: 6 additions & 6 deletions tidb-cloud/tidb-cloud-release-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c

- [Data Service (beta)](https://tidbcloud.com/console/data-service) supports automatically generating vector search endpoints.

If your table contains [vector data types](/tidb-cloud/vector-search-data-types.md), you can automatically generate a vector search endpoint that calculates vector distances based on your selected distance function.
If your table contains [vector data types](/vector-search-data-types.md), you can automatically generate a vector search endpoint that calculates vector distances based on your selected distance function.

This feature enables seamless integration with AI platforms such as [Dify](https://docs.dify.ai/guides/tools) and [GPTs](https://openai.com/blog/introducing-gpts), enhancing your applications with advanced natural language processing and AI capabilities for more complex tasks and intelligent solutions.

Expand Down Expand Up @@ -166,12 +166,12 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c

The vector search (beta) feature provides an advanced search solution for performing semantic similarity searches across various data types, including documents, images, audio, and video. This feature enables developers to easily build scalable applications with generative artificial intelligence (AI) capabilities using familiar MySQL skills. Key features include:

- [Vector data types](/tidb-cloud/vector-search-data-types.md), [vector index](/tidb-cloud/vector-search-index.md), and [vector functions and operators](/tidb-cloud/vector-search-functions-and-operators.md).
- Ecosystem integrations with [LangChain](/tidb-cloud/vector-search-integrate-with-langchain.md), [LlamaIndex](/tidb-cloud/vector-search-integrate-with-llamaindex.md), and [JinaAI](/tidb-cloud/vector-search-integrate-with-jinaai-embedding.md).
- Programming language support for Python: [SQLAlchemy](/tidb-cloud/vector-search-integrate-with-sqlalchemy.md), [Peewee](/tidb-cloud/vector-search-integrate-with-peewee.md), and [Django ORM](/tidb-cloud/vector-search-integrate-with-django-orm.md).
- Sample applications and tutorials: perform semantic searches for documents using [Python](/tidb-cloud/vector-search-get-started-using-python.md) or [SQL](/tidb-cloud/vector-search-get-started-using-sql.md).
- [Vector data types](/vector-search-data-types.md), [vector index](/vector-search-index.md), and [vector functions and operators](/vector-search-functions-and-operators.md).
- Ecosystem integrations with [LangChain](/vector-search-integrate-with-langchain.md), [LlamaIndex](/vector-search-integrate-with-llamaindex.md), and [JinaAI](/vector-search-integrate-with-jinaai-embedding.md).
- Programming language support for Python: [SQLAlchemy](/vector-search-integrate-with-sqlalchemy.md), [Peewee](/vector-search-integrate-with-peewee.md), and [Django ORM](/vector-search-integrate-with-django-orm.md).
- Sample applications and tutorials: perform semantic searches for documents using [Python](/vector-search-get-started-using-python.md) or [SQL](/vector-search-get-started-using-sql.md).

For more information, see [Vector search (beta) overview](/tidb-cloud/vector-search-overview.md).
For more information, see [Vector search (beta) overview](/vector-search-overview.md).

- [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) now offers weekly email reports for organization owners.

Expand Down
Loading

0 comments on commit 5733a6e

Please sign in to comment.