Skip to content
Merged
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
2 changes: 1 addition & 1 deletion TOC-develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

## QUICK START

- [Create a {{{ .starter }}} Cluster](/develop/dev-guide-build-cluster-in-cloud.md)
- [Create a {{{ .starter }}} Instance](/develop/dev-guide-build-cluster-in-cloud.md)
- [TiDB Basics](/develop/dev-guide-tidb-basics.md)
- [CRUD SQL in TiDB](/develop/dev-guide-tidb-crud-sql.md)

Expand Down
2 changes: 1 addition & 1 deletion ai/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Step-by-step guides for building AI applications with TiDB using the [`pytidb`](

| Document | Description |
| --- | --- |
| [Connect to TiDB](/ai/guides/connect.md) | Connect to TiDB Cloud or self-managed clusters using `pytidb`. |
| [Connect to TiDB](/ai/guides/connect.md) | Connect to TiDB Cloud or TiDB Self-Managed using `pytidb`. |
| [Working with Tables](/ai/guides/tables.md) | Create, query, and manage tables with vector fields. |
| [Vector Search](/ai/guides/vector-search.md) | Perform semantic similarity searches using `pytidb`. |
| [Full-Text Search](/ai/guides/vector-search-full-text-search-python.md) | Keyword-based text search with BM25 ranking. |
Expand Down
4 changes: 2 additions & 2 deletions ai/examples/auto-embedding-with-pytidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This example shows how to use the [Auto Embedding](/ai/integrations/vector-searc
Before you begin, ensure you have the following:

- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).

## How to run

Expand All @@ -38,7 +38,7 @@ pip install -r reqs.txt

### Step 3. Set environment variables

1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
3. Set environment variables according to the connection parameters as follows:

Expand Down
4 changes: 2 additions & 2 deletions ai/examples/basic-with-pytidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ This example demonstrates basic CRUD (Create, Read, Update, Delete) operations u
Before you begin, ensure you have the following:

- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).

## How to run

Expand All @@ -37,7 +37,7 @@ pip install -r reqs.txt

### Step 3. Set environment variables

1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
3. Set environment variables according to the connection parameters as follows:

Expand Down
4 changes: 2 additions & 2 deletions ai/examples/fulltext-search-with-pytidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This example demonstrates how to build an e-commerce product search app using Ti
Before you begin, ensure you have the following:

- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).

## How to run

Expand All @@ -40,7 +40,7 @@ pip install -r reqs.txt

### Step 3. Set environment variables

1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
3. Set environment variables according to the connection parameters as follows:

Expand Down
4 changes: 2 additions & 2 deletions ai/examples/hybrid-search-with-pytidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This demo shows how to combine vector search and full-text search to improve the
Before you begin, ensure you have the following:

- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **OpenAI API key**: Get an OpenAI API key from [OpenAI](https://platform.openai.com/api-keys).

> **Note**
Expand Down Expand Up @@ -47,7 +47,7 @@ pip install -r reqs.txt

### Step 3. Set environment variables

1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
3. Set environment variables according to the connection parameters as follows:

Expand Down
4 changes: 2 additions & 2 deletions ai/examples/image-search-with-pytidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ With just a few lines of code, you can create a search system that understands b
Before you begin, ensure you have the following:

- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **Jina AI API key**: You can get a free API key from [Jina AI Embeddings](https://jina.ai/embeddings/).

## How to run
Expand All @@ -46,7 +46,7 @@ pip install -r reqs.txt

### Step 3. Set environment variables

1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
3. Set environment variables according to the connection parameters as follows:

Expand Down
4 changes: 2 additions & 2 deletions ai/examples/memory-with-pytidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ With just a few lines of code, you can create a conversational AI that remembers
Before you begin, ensure you have the following:

- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **OpenAI API key**: Get an OpenAI API key from [OpenAI](https://platform.openai.com/api-keys).

## How to run
Expand All @@ -48,7 +48,7 @@ pip install -r reqs.txt

### Step 3. Set environment variables

1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
3. Set environment variables according to the connection parameters as follows:

Expand Down
4 changes: 2 additions & 2 deletions ai/examples/rag-with-pytidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The application uses [Ollama](https://ollama.com/download) for local embedding g
Before you begin, ensure you have the following:

- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **Ollama**: Install from [Ollama](https://ollama.com/download).

## How to run
Expand Down Expand Up @@ -67,7 +67,7 @@ pip install -r reqs.txt

### Step 4. Set environment variables

1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
3. Set environment variables according to the connection parameters as follows:

Expand Down
2 changes: 1 addition & 1 deletion ai/examples/text2sql-with-pytidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This demo shows how to build an AI-powered interface that converts natural-langu
Before you begin, ensure you have the following:

- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **OpenAI API key**: Get an OpenAI API key from [OpenAI](https://platform.openai.com/api-keys).

## How to run
Expand Down
4 changes: 2 additions & 2 deletions ai/examples/vector-search-with-pytidb.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The application uses [Ollama](https://ollama.com/download) for local embedding g
Before you begin, ensure you have the following:

- **Python (>=3.10)**: Install [Python](https://www.python.org/downloads/) 3.10 or a later version.
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **Ollama**: Install from [Ollama](https://ollama.com/download).

## How to run
Expand Down Expand Up @@ -58,7 +58,7 @@ pip install -r reqs.txt

### Step 4. Set environment variables

1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**Clusters**](https://tidbcloud.com/clusters) page, and then click the name of your target cluster to go to its overview page.
1. In the [TiDB Cloud console](https://tidbcloud.com/), navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
3. Set environment variables according to the connection parameters as follows:

Expand Down
10 changes: 5 additions & 5 deletions ai/guides/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,9 @@ Choose the steps based on your TiDB deployment type:
<SimpleTab>
<div label="TiDB Cloud Starter">

You can [create a TiDB Cloud Starter cluster](https://tidbcloud.com/free-trial/), and then get the connection parameters from the web console as follows:
You can [create a TiDB Cloud Starter instance](https://tidbcloud.com/free-trial/), and then get the connection parameters from the web console as follows:

1. Navigate to the [Clusters page](https://tidbcloud.com/clusters), and then click the name of your target cluster to go to its overview page.
1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.
3. Copy the connection parameters to your code or environment variables.

Expand All @@ -46,7 +46,7 @@ db = TiDBClient.connect(

> **Note:**
>
> For TiDB Cloud Starter, [TLS connection to the database](https://docs.pingcap.com/tidbcloud/secure-connections-to-starter-clusters/) is required when using a public endpoint. The `pytidb` client **automatically** enables TLS for TiDB Cloud Starter clusters.
> For TiDB Cloud Starter, [TLS connection to the database](https://docs.pingcap.com/tidbcloud/secure-connections-to-starter-clusters/) is required when using a public endpoint. The `pytidb` client **automatically** enables TLS for TiDB Cloud Starter instances.

</div>
<div label="TiDB Self-Managed">
Expand Down Expand Up @@ -83,9 +83,9 @@ If you prefer to use a connection string (database URL), you can follow the form
<SimpleTab>
<div label="TiDB Cloud Starter">

You can [create a TiDB Cloud Starter cluster](https://tidbcloud.com/free-trial/), and then get the connection parameters from the web console as follows:
You can [create a TiDB Cloud Starter instance](https://tidbcloud.com/free-trial/), and then get the connection parameters from the web console as follows:

1. Navigate to the [Clusters page](https://tidbcloud.com/clusters), and then click the name of your target cluster to go to its overview page.
1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} instance to go to its overview page.
2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with the connection parameters listed.
3. Copy the connection parameters and construct a connection string in the following format:

Expand Down
6 changes: 3 additions & 3 deletions ai/guides/vector-search-full-text-search-python.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Full-text search is still in the early stages, and we are continuously rolling i

- TiDB Cloud Serverless: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)`

To complete this tutorial, make sure you have a TiDB Cloud Serverless cluster in a supported region. If you don't have one, follow [Creating a TiDB Cloud Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create it.
To complete this tutorial, make sure you have a {{{ .starter }}} instance in a supported region. If you don't have one, follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create it.

## Get started

Expand Down Expand Up @@ -66,7 +66,7 @@ db = TiDBClient.connect(

You can get these connection parameters from the [TiDB Cloud console](https://tidbcloud.com) as follows:

1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page.
1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page.
Comment thread
qiancai marked this conversation as resolved.

2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.

Expand All @@ -81,7 +81,7 @@ You can get these connection parameters from the [TiDB Cloud console](https://ti
CA: /etc/ssl/cert.pem
```

The corresponding Python code to connect to the TiDB Cloud Serverless cluster would be as follows:
The corresponding Python code to connect to the {{{ .starter }}} instance would be as follows:

```python
db = TiDBClient.connect(
Expand Down
2 changes: 1 addition & 1 deletion ai/guides/vector-search-full-text-search-sql.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Full-text search is still in the early stages, and we are continuously rolling i

- TiDB Cloud Serverless: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)`

Before using full-text search, make sure your TiDB Cloud Serverless cluster is created in a supported region. If you don't have one, follow [Creating a TiDB Cloud Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create it.
Before using full-text search, make sure your {{{ .starter }}} instance is created in a supported region. If you don't have one, follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create it.

To perform a full-text search, follow these steps:

Expand Down
6 changes: 3 additions & 3 deletions ai/guides/vector-search-hybrid-search.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ Full-text search is still in the early stages, and we are continuously rolling i

- TiDB Cloud Serverless: `Frankfurt (eu-central-1)` and `Singapore (ap-southeast-1)`

To complete this tutorial, make sure you have a TiDB Cloud Serverless cluster in a supported region. If you don't have one, follow [Creating a TiDB Cloud Serverless cluster](/develop/dev-guide-build-cluster-in-cloud.md) to create it.
To complete this tutorial, make sure you have a {{{ .starter }}} instance in a supported region. If you don't have one, follow [Creating a {{{ .starter }}} instance](/develop/dev-guide-build-cluster-in-cloud.md) to create it.

## Get started

Expand Down Expand Up @@ -55,7 +55,7 @@ db = TiDBClient.connect(

You can get these connection parameters from the [TiDB Cloud console](https://tidbcloud.com) as follows:

1. Navigate to the [**Clusters**](https://tidbcloud.com/project/clusters) page, and then click the name of your target cluster to go to its overview page.
1. Navigate to the [**My TiDB**](https://tidbcloud.com/tidbs) page, and then click the name of your target {{{ .starter }}} or Essential instance to go to its overview page.

2. Click **Connect** in the upper-right corner. A connection dialog is displayed, with connection parameters listed.

Expand All @@ -70,7 +70,7 @@ You can get these connection parameters from the [TiDB Cloud console](https://ti
CA: /etc/ssl/cert.pem
```

The corresponding Python code to connect to the TiDB Cloud Serverless cluster would be as follows:
The corresponding Python code to connect to the {{{ .starter }}} instance would be as follows:

```python
db = TiDBClient.connect(
Expand Down
2 changes: 1 addition & 1 deletion ai/integrations/embedding-openai-compatible.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ This tutorial demonstrates how to use OpenAI-compatible embedding services to ge

> **Note:**
>
> Currently, [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} clusters hosted on AWS.
> Currently, [Auto Embedding](/ai/integrations/vector-search-auto-embedding-overview.md) is only available on {{{ .starter }}} instances hosted on AWS.

## OpenAI-compatible embedding services

Expand Down
6 changes: 3 additions & 3 deletions ai/integrations/tidb-mcp-claude-code.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,14 +13,14 @@ Before you begin, ensure you have the following:

- **Claude Code**: Install it from [claude.com](https://claude.com/product/claude-code).
- **Python (>=3.10) and uv**: Ensure Python (3.10 or later) and `uv` are installed. Follow the [installation guide](https://docs.astral.sh/uv/getting-started/installation/) to install `uv`.
- **A TiDB Cloud Starter cluster**: You can create a free TiDB cluster on [TiDB Cloud](https://tidbcloud.com/free-trial).
- **A {{{ .starter }}} instance**: You can create a free {{{ .starter }}} instance on [TiDB Cloud](https://tidbcloud.com/free-trial).

## Connect to TiDB Cloud Starter (recommended)

Use the TiDB Cloud console to generate a ready-to-run Claude Code command.

1. Go to the [Clusters](https://tidbcloud.com/console/clusters) page, select your cluster, and then click **Use with AI Tools** in the upper-right corner.
2. In the **Access `your_cluster_name` with AI tools** dialog, select the **Branch** and **Database** that Claude Code should access.
1. On the [**My TiDB**](https://tidbcloud.com/tidbs) page, click the name of your target {{{ .starter }}} instance to go to its overview page, and then click **Use with AI Tools** in the upper-right corner.
2. In the displayed dialog, select the **Branch** and **Database** that Claude Code should access.
3. Review the **Prerequisites** list in the dialog and install any missing dependencies.
4. Configure the root password:

Expand Down
Loading
Loading