Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
77 changes: 77 additions & 0 deletions ai/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@
---
title: TiDB for AI
summary: 利用 TiDB 集成的向量搜索、全文搜索和无缝 Python SDK 构建现代 AI 应用。
---

# TiDB for AI

TiDB 是一款为现代 AI 应用设计的分布式 SQL 数据库,提供集成的向量搜索、全文搜索和混合搜索能力。本文档概述了使用 TiDB 构建 AI 驱动应用可用的 AI 特性与工具。

## 快速开始

快速体验 TiDB 的 AI 能力。

| 文档 | 描述 |
| --- | --- |
| [Get Started with Python](/ai/quickstart-via-python.md) | 使用 Python 在几分钟内构建你的第一个基于 TiDB 的 AI 应用。 |
| [Get Started with SQL](/ai/quickstart-via-sql.md) | 使用 SQL 快速开始向量搜索。 |

## 概念

了解 TiDB AI 搜索的基础概念。

| 文档 | 描述 |
| --- | --- |
| [Vector Search](/ai/concepts/vector-search-overview.md) | 向量搜索的全面介绍,包括概念、工作原理和应用场景。 |

## 指南

使用 [`pytidb`](https://github.com/pingcap/pytidb) SDK 或 SQL 构建 AI 应用的分步指南。

| 文档 | 描述 |
| --- | --- |
| [Connect to TiDB](/ai/guides/connect.md) | 使用 `pytidb` 连接 TiDB Cloud 或自托管集群。 |
| [Working with Tables](/ai/guides/tables.md) | 创建、查询和管理包含向量字段的表。 |
| [Vector Search](/ai/guides/vector-search.md) | 使用 `pytidb` 进行语义相似度搜索。 |
| [Full-Text Search](/ai/guides/vector-search-full-text-search-python.md) | 基于关键字的文本搜索,支持 BM25 排序。 |
| [Hybrid Search](/ai/guides/vector-search-hybrid-search.md) | 结合向量搜索与全文搜索,获得更优结果。 |
| [Image Search](/ai/guides/image-search.md) | 使用多模态嵌入进行图片搜索。 |
| [Auto Embedding](/ai/guides/auto-embedding.md) | 数据插入时自动生成嵌入向量。 |
| [Filtering](/ai/guides/filtering.md) | 通过元信息条件过滤搜索结果。 |

## 示例

完整代码示例和演示,展示 TiDB 的 AI 能力。

| 文档 | 描述 |
| --- | --- |
| [Basic CRUD Operations](/ai/examples/basic-with-pytidb.md) | 使用 `pytidb` 进行基础表的增删改查操作。 |
| [Vector Search](/ai/examples/vector-search-with-pytidb.md) | 语义相似度搜索示例。 |
| [RAG Application](/ai/examples/rag-with-pytidb.md) | 构建检索增强生成(RAG)应用。 |
| [Image Search](/ai/examples/image-search-with-pytidb.md) | 基于 Jina AI 嵌入的多模态图片搜索。 |
| [Conversational Memory](/ai/examples/memory-with-pytidb.md) | 为 AI agent 和聊天机器人提供持久化内存。 |
| [Text-to-SQL](/ai/examples/text2sql-with-pytidb.md) | 将自然语言转换为 SQL 查询。 |

## 集成

将 TiDB 与主流 AI 框架、嵌入提供商和开发工具集成。

| 文档 | 描述 |
| --- | --- |
| [Integration Overview](/ai/integrations/vector-search-integration-overview.md) | 所有可用集成的概览。 |
| [Embedding Providers](/ai/integrations/vector-search-auto-embedding-overview.md#available-text-embedding-models) | 为 OpenAI、Cohere、Jina AI 等提供统一接口。 |
| [LangChain](/ai/integrations/vector-search-integrate-with-langchain.md) | 将 TiDB 作为 LangChain 的向量存储。 |
| [LlamaIndex](/ai/integrations/vector-search-integrate-with-llamaindex.md) | 将 TiDB 作为 LlamaIndex 的向量存储。 |
| [MCP Server](/ai/integrations/tidb-mcp-server.md) | 将 TiDB 连接到 Claude Code、Cursor 及其他 AI 驱动的 IDE。 |

## 参考

TiDB AI 与向量搜索功能的技术参考文档。

| 文档 | 描述 |
| --- | --- |
| [Vector Data Types](/ai/reference/vector-search-data-types.md) | 向量列类型及其用法。 |
| [Functions and Operators](/ai/reference/vector-search-functions-and-operators.md) | 距离函数与向量操作。 |
| [Vector Search Index](/ai/reference/vector-search-index.md) | 创建和管理向量索引以提升性能。 |
| [Performance Tuning](/ai/reference/vector-search-improve-performance.md) | 优化向量搜索性能。 |
| [Limitations](/ai/reference/vector-search-limitations.md) | 当前的限制与约束。 |
29 changes: 29 additions & 0 deletions api/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: TiDB API 概览
summary: 了解 TiDB Cloud 和 TiDB Self-Managed 可用的 API。
---

# TiDB API 概览

TiDB 提供多种 API,用于查询和操作集群、管理数据副本、监控系统状态等。本文档概述了 [TiDB Cloud](https://docs.pingcap.com/tidbcloud/) 和 [TiDB Self-Managed](https://docs.pingcap.com/tidb/stable/) 可用的 API。

## TiDB Cloud API(测试版)

[TiDB Cloud API](/api/tidb-cloud-api-overview.md) 是一种 [REST 接口](https://en.wikipedia.org/wiki/Representational_state_transfer),为你提供以编程方式管理 TiDB Cloud 内部管理对象的能力,例如项目、集群、备份、恢复、导入、账单和 Data Service 资源。

| API | 描述 |
| --- | --- |
| [v1beta1](/api/tidb-cloud-api-v1beta1.md) | 管理 TiDB Cloud Starter、Essential 和 Dedicated 集群,以及账单、Data Service 和 IAM 资源。 |
| [v1beta](/api/tidb-cloud-api-v1beta.md) | 管理 TiDB Cloud 的项目、集群、备份、导入和恢复。 |

## TiDB Self-Managed API

TiDB Self-Managed 提供多种 API,供 TiDB 工具使用,帮助你管理集群组件、监控系统状态以及控制数据副本工作流。

| API | 描述 |
| --- | --- |
| [TiProxy API](/tiproxy/tiproxy-api.md) | 访问 TiProxy 配置、健康状态和监控数据。 |
| [Data Migration API](/dm/dm-open-api.md) | 管理 DM-master 和 DM-worker 节点、数据源及数据副本任务。 |
| [Monitoring API](/tidb-monitoring-api.md) | 获取 TiDB 服务器运行状态、表存储信息和 TiKV 集群详情。 |
| [TiCDC API](/ticdc/ticdc-open-api-v2.md) | 查询 TiCDC 节点状态并管理副本任务,包括创建、暂停、恢复和更新操作。 |
| [TiDB Operator API](https://github.com/pingcap/tidb-operator/blob/{{{.tidb-operator-version}}}/docs/api-references/docs.md) | 管理 Kubernetes 上的 TiDB 集群,包括部署、升级、扩缩容、备份和故障转移。 |
29 changes: 16 additions & 13 deletions keywords.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: 关键词
summary: 关键词和保留字
title: 关键字
summary: 关键字与保留字
---

# 关键词
# 关键字

本文介绍了 TiDB 中的关键词,保留字与非保留字的区别,并总结了所有用于查询的关键词
本文介绍了 TiDB 中的关键字、保留字与非保留字的区别,并汇总了所有可用于查询的关键字

关键词是在 SQL 语句中具有特殊含义的词,例如 [`SELECT`](/sql-statements/sql-statement-select.md)、[`UPDATE`](/sql-statements/sql-statement-update.md) 和 [`DELETE`](/sql-statements/sql-statement-delete.md)。其中一些可以直接用作标识符,称为 **非保留关键词**。一些在用作标识符之前需要特殊处理,称为 **保留关键词**。
关键字是在 SQL 语句中具有特殊含义的单词,例如 [`SELECT`](/sql-statements/sql-statement-select.md)、[`UPDATE`](/sql-statements/sql-statement-update.md) 和 [`DELETE`](/sql-statements/sql-statement-delete.md)。其中有些可以直接作为标识符使用,称为**非保留关键字**。有些则需要特殊处理后才能作为标识符使用,称为**保留关键字**。

要将保留关键词用作标识符,必须用反引号 `` ` `` 将其括起来
如果要将保留关键字作为标识符使用,必须用反引号 `` ` `` 包裹

```sql
CREATE TABLE select (a INT);
Expand All @@ -27,7 +27,7 @@ CREATE TABLE `select` (a INT);
Query OK, 0 rows affected (0.09 sec)
```

非保留关键词不需要用反引号,例如 `BEGIN` 和 `END`,在以下语句中可以成功用作标识符
非保留关键字无需使用反引号,例如 `BEGIN` 和 `END`,可以在如下语句中直接作为标识符使用

```sql
CREATE TABLE `select` (BEGIN int, END int);
Expand All @@ -37,7 +37,7 @@ CREATE TABLE `select` (BEGIN int, END int);
Query OK, 0 rows affected (0.09 sec)
```

在特殊情况下,如果保留关键词与 `.` 分隔符一起使用,则不需要用反引号
在特殊情况下,如果保留关键字与 `.` 分隔符一起使用,则无需加反引号

```sql
CREATE TABLE test.select (BEGIN int, END int);
Expand All @@ -47,13 +47,13 @@ CREATE TABLE test.select (BEGIN int, END int);
Query OK, 0 rows affected (0.08 sec)
```

v7.5.3 和 v7.6.0 版本开始,TiDB 在 [`INFORMATION_SCHEMA.KEYWORDS`](/information-schema/information-schema-keywords.md) 表中提供了完整的关键词列表
v7.5.3 和 v7.6.0 ,TiDB 在 [`INFORMATION_SCHEMA.KEYWORDS`](/information-schema/information-schema-keywords.md) 表中提供了完整的关键字列表

你可以通过设置 [`tidb_enable_window_function`](/system-variables.md#tidb_enable_window_function) 系统变量,控制 [窗口函数](/functions-and-operators/window-functions.md) 中的关键词是否在语法树中生效。如果将 `tidb_enable_window_function` 设置为 `OFF`,窗口函数中的词将不再被视为关键词
你可以通过 [`tidb_enable_window_function`](/system-variables.md#tidb_enable_window_function) 系统变量控制 [窗口函数](/functions-and-operators/window-functions.md) 中的关键字是否在语法树中生效。如果将 `tidb_enable_window_function` 设置为 `OFF`,窗口函数中的单词将不再被视为关键字

## 关键词列表
## 关键字列表

以下列出了 TiDB 中的关键词。保留关键词标记为 `(R)`。用于 [窗口函数](/functions-and-operators/window-functions.md) 的保留关键词标记为 `(R-Window)`。
下表展示了 TiDB 中的关键字。保留关键字以 `(R)` 标记。用于 [窗口函数](/functions-and-operators/window-functions.md) 的保留关键字以 `(R-Window)` 标记

<TabsPanel letters="ABCDEFGHIJKLMNOPQRSTUVWXYZ" />

Expand All @@ -65,6 +65,7 @@ Query OK, 0 rows affected (0.08 sec)
- ADMIN
- ADVISE
- AFTER
- AFFINITY
- AGAINST
- AGO
- ALGORITHM
Expand Down Expand Up @@ -409,6 +410,7 @@ Query OK, 0 rows affected (0.08 sec)

<a id="M" class="letter" href="#M">M</a>

- MASKING
- MASTER
- MATCH (R)
- MAXVALUE (R)
Expand Down Expand Up @@ -512,6 +514,7 @@ Query OK, 0 rows affected (0.08 sec)
- PLUGINS
- POINT
- POLICY
- POLICIES
- PRECEDING
- PRECISION (R)
- PREPARE
Expand Down Expand Up @@ -789,4 +792,4 @@ Query OK, 0 rows affected (0.08 sec)

<a id="Z" class="letter" href="#Z">Z</a>

- ZEROFILL (R)
- ZEROFILL (R)
2 changes: 1 addition & 1 deletion latest_translation_commit.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"target": "release-8.5",
"sha": "ea728d3f449433bd0e442339b3a79cda18f453f0"
"sha": "057bc110a8eb21065dddd3dd63fdbd39ab585d5e"
}
Loading