cloud: Polish availability and limitation of Vector Search #19494
+214
−217
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Wish <[email protected]>
ti-chi-bot
bot
added
the
missing-translation-status
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
ti-chi-bot
bot
added
the
size/XL
Signed-off-by: Wish <[email protected]>
Signed-off-by: Wish <[email protected]>
Signed-off-by: Wish <[email protected]>
Icemap
reviewed
Nov 24, 2024
| @@ -222,7 +222,7 @@ Examples: | |||
| VEC_L2_NORM(vector) | |||
| ``` | |||
|
|
|||
| Calculates the [L2 norm](https://en.wikipedia.org/wiki/Norm_(mathematics)) (Euclidean norm) of a vector using the following formula: | |||
| Calculates the [L2 norm](<https://en.wikipedia.org/wiki/Norm_(mathematics)>) (Euclidean norm) of a vector using the following formula: | |||
There was a problem hiding this comment.
Why there is a pair of '<>' at the margin of the link?
There was a problem hiding this comment.
It is added by the formatter by default. Although the rendering is fine without this <>, I believe the formatter is right for good: https://stackoverflow.com/questions/13824669/how-do-you-write-a-link-containing-a-closing-bracket-in-markdown-syntax
Comment on lines
+57
to
+60
| - **Connection Type** is set to `Public`. | ||
| - **Branch** is set to `main`. | ||
| - **Connect With** is set to `SQLAlchemy`. | ||
| - **Operating System** matches your environment. |
There was a problem hiding this comment.
Automatic formatting by the very recent version of Prettier. Considering that old prettier does not format like this, I guess this is an improvement.
There was a problem hiding this comment.
I found the feature here, which is introduced 2 months ago: prettier/prettier@6168d1e
The format rule is as follows:
=====================================input======================================
- first line
- second line indented
- third line
- fourth line
- fifth line
=====================================output=====================================
- first line
- second line indented
- third line
- fourth line
- fifth line
================================================================================
|
We need to set the spaces for each tab in the same way as other documents. |
qiancai
reviewed
Nov 25, 2024
| > | ||
| > Vector data types are only available for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. | ||
| > TiDB Vector Search is only available for TiDB (>= v8.4) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). |
There was a problem hiding this comment.
Suggested change
| > TiDB Vector Search is only available for TiDB (>= v8.4) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). | |
| > TiDB Vector Search is only available for TiDB Self-Managed (>= v8.4.0) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). |
| @@ -9,25 +9,25 @@ This document lists the functions and operators available for Vector data types. | |||
|
|
|||
| > **Note** | |||
| > | |||
| > Vector data types and these vector functions are only available for [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless) clusters. | |||
| > TiDB Vector Search is only available for TiDB (>= v8.4) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). | |||
There was a problem hiding this comment.
Suggested change
| > TiDB Vector Search is only available for TiDB (>= v8.4) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). | |
| > TiDB Vector Search is only available for TiDB Self-Managed (>= v8.4.0) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). |
| @@ -11,7 +11,7 @@ Throughout this tutorial, you will develop this AI application using [TiDB Vecto | |||
|
|
|||
| > **Note** | |||
| > | |||
| > TiDB Vector Search is currently in beta and is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. | |||
| > TiDB Vector Search is only available for TiDB (>= v8.4) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). | |||
There was a problem hiding this comment.
Suggested change
| > TiDB Vector Search is only available for TiDB (>= v8.4) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). | |
| > TiDB Vector Search is only available for TiDB Self-Managed (>= v8.4.0) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). |
| @@ -16,7 +16,7 @@ This tutorial demonstrates how to get started with TiDB Vector Search just using | |||
|
|
|||
| > **Note** | |||
| > | |||
| > TiDB Vector Search is currently in beta and is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. | |||
| > TiDB Vector Search is only available for TiDB (>= v8.4) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). | |||
There was a problem hiding this comment.
Suggested change
| > TiDB Vector Search is only available for TiDB (>= v8.4) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). | |
| > TiDB Vector Search is only available for TiDB Self-Managed (>= v8.4.0) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). |
| @@ -9,7 +9,7 @@ This tutorial walks you through how to use [Django](https://www.djangoproject.co | |||
|
|
|||
| > **Note** | |||
| > | |||
| > TiDB Vector Search is currently in beta and is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) clusters. | |||
| > TiDB Vector Search is only available for TiDB (>= v8.4) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). | |||
There was a problem hiding this comment.
Suggested change
| > TiDB Vector Search is only available for TiDB (>= v8.4) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). | |
| > TiDB Vector Search is only available for TiDB Self-Managed (>= v8.4.0) and [TiDB Cloud Serverless](/tidb-cloud/select-cluster-tier.md#tidb-cloud-serverless). It is not available for [TiDB Cloud Dedicated](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated). |
| - Currently, TiDB does not support modifying a vector column to other data types (such as `JSON` and `VARCHAR`). | ||
| - Vector columns cannot be used in primary keys, unique indexes or partition keys. To accelerate the vector search performance, use [Vector Search Index](/tidb-cloud/vector-search-index.md). | ||
| - Multiple vector columns in a table is allowed. However, there is [a limit of total number of columns in a table](/tidb-limitations.md#limitations-on-a-single-table). | ||
| - Currently TiDB does not support dropping a vector column with a vector index. To drop such column, drop the vector index first, then drop the vector column. |
There was a problem hiding this comment.
Suggested change
| - Currently TiDB does not support dropping a vector column with a vector index. To drop such column, drop the vector index first, then drop the vector column. | |
| - Currently, TiDB does not support dropping a vector column with a vector index. To drop such a column, drop the vector index first, then drop the vector column. |
| - Multiple vector indexes in a table is allowed. However, there is [a limit of total number of indexes in a table](/tidb-limitations.md#limitations-on-a-single-table). | ||
| - Multiple vector indexes on the same column is allowed only if they use different distance functions. | ||
| - Currently only `VEC_COSINE_DISTANCE()` and `VEC_L2_DISTANCE()` are supported as the distance functions for vector indexes. | ||
| - Currently TiDB does not support dropping a vector column with a vector index. To drop such column, drop the vector index first, then drop the vector column. |
There was a problem hiding this comment.
Suggested change
| - Currently TiDB does not support dropping a vector column with a vector index. To drop such column, drop the vector index first, then drop the vector column. | |
| - Currently, TiDB does not support dropping a vector column with a vector index. To drop such a column, drop the vector index first, then drop the vector column. |
| See [Vector search restrictions](/tidb-cloud/vector-search-index.md#restrictions). | ||
| - Vector index is used for vector search. It cannot accelerate other queries like range queries or equality queries. Thus, it is not possible to create a vector index on a non-vector column, or on multiple vector columns. | ||
| - Multiple vector indexes in a table is allowed. However, there is [a limit of total number of indexes in a table](/tidb-limitations.md#limitations-on-a-single-table). | ||
| - Multiple vector indexes on the same column is allowed only if they use different distance functions. |
There was a problem hiding this comment.
Suggested change
| - Multiple vector indexes on the same column is allowed only if they use different distance functions. | |
| - Creating multiple vector indexes on the same column is allowed only if they use different distance functions. |
| - Vector index is used for vector search. It cannot accelerate other queries like range queries or equality queries. Thus, it is not possible to create a vector index on a non-vector column, or on multiple vector columns. | ||
| - Multiple vector indexes in a table is allowed. However, there is [a limit of total number of indexes in a table](/tidb-limitations.md#limitations-on-a-single-table). | ||
| - Multiple vector indexes on the same column is allowed only if they use different distance functions. | ||
| - Currently only `VEC_COSINE_DISTANCE()` and `VEC_L2_DISTANCE()` are supported as the distance functions for vector indexes. |
There was a problem hiding this comment.
Suggested change
| - Currently only `VEC_COSINE_DISTANCE()` and `VEC_L2_DISTANCE()` are supported as the distance functions for vector indexes. | |
| - Currently, only `VEC_COSINE_DISTANCE()` and `VEC_L2_DISTANCE()` are supported as the distance functions for vector indexes. |
| - Multiple vector indexes on the same column is allowed only if they use different distance functions. | ||
| - Currently only `VEC_COSINE_DISTANCE()` and `VEC_L2_DISTANCE()` are supported as the distance functions for vector indexes. | ||
| - Currently TiDB does not support dropping a vector column with a vector index. To drop such column, drop the vector index first, then drop the vector column. | ||
| - Currently TiDB does not support setting vector index as [invisible](/sql-statements/sql-statement-alter-index.md). |
There was a problem hiding this comment.
Suggested change
| - Currently TiDB does not support setting vector index as [invisible](/sql-statements/sql-statement-alter-index.md). | |
| - Currently, TiDB does not support setting vector index as [invisible](/sql-statements/sql-statement-alter-index.md). |
github-actions bot
pushed a commit
to qiancai/pingcap-docsite-preview
that referenced
this pull request
Nov 25, 2024
qiancai
reviewed
Nov 25, 2024
There was a problem hiding this comment.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First-time contributors' checklist
What is changed, added or deleted? (Required)
Close #19373
To reduce confusions like Impossible to run standalone or offline autoflow#399, availability is now more precisely described, and some missing pages are also included.
Polish the limitation part. The wording is now better choosen:
Which TiDB version(s) do your changes apply to? (Required)
Tips for choosing the affected version(s):
By default, CHOOSE MASTER ONLY so your changes will be applied to the next TiDB major or minor releases. If your PR involves a product feature behavior change or a compatibility change, CHOOSE THE AFFECTED RELEASE BRANCH(ES) AND MASTER.
For details, see tips for choosing the affected versions.
What is the related PR or file link(s)?
Do your changes match any of the following descriptions?