TiDB Quick Start refresh #19412

alastori · 2024-11-15T01:31:05Z

What is changed, added or deleted? (Required)

Significantly improved the Quick Start Guide to make it more user-friendly and educational:

Restructured content to follow a clear learning path
Added a sample weather monitoring application to demonstrate real-world usage
Improved monitoring and scaling sections with practical examples
Added detailed explanations of components and their roles
Included developer workflow best practices with tagged environments
Enhanced the guide with monitoring visualization tips
Added clear "What's next" section with targeted resources
Improved code examples with proper formatting and explanations
Added more contextual information about TiDB's capabilities
Improved navigation and readability

The changes aim to provide a better first-time user experience while maintaining technical accuracy and demonstrating TiDB's key features through practical examples.

Which TiDB version(s) do your changes apply to? (Required)

master (the latest development version)

What is the related PR or file link(s)?

This PR updates the existing Quick Start Guide with modern documentation best practices and a more comprehensive learning approach.

ti-chi-bot · 2024-11-15T02:43:46Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please ask for approval from lilin90, ensuring that each of them provides their approval before proceeding. For more information see the Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

Oreoxmt · 2024-11-22T10:48:10Z

quick-start-with-tidb.md

-    ===============================================
-    ```
+```shell
+source ~/.bash_profile


source ~/.bash_profile

The current description is too specific and may mislead users, as shell profile paths can vary across different Linux distributions and shell types. I recommend keeping the original, more flexible instructions:

docs/quick-start-with-tidb.md

Lines 55 to 67 in 063e85c

Note the Shell profile path in the output above. You need to use the path in the next step.

2. Declare the global environment variable:

> **Note:**

>

> After the installation, TiUP displays the absolute path of the corresponding Shell profile file. You need to modify `${your_shell_profile}` in the following `source` command according to the path. In this case, `${your_shell_profile}` is `/Users/user/.zshrc` from the output of Step 1.

{{< copyable "shell-regular" >}}

```shell

source ${your_shell_profile}

```

For example, in the installation output shown below, the shell profile is /home/codespace/.bashrc:

Successfully set mirror to https://tiup-mirrors.pingcap.com Detected shell: bash Shell profile: /home/codespace/.bashrc /home/codespace/.bashrc has been modified to add tiup to PATH open a new terminal or source /home/codespace/.bashrc to use it Installed path: /home/codespace/.tiup/bin/tiup =============================================== Have a try: tiup playground ===============================================

open a new terminal or source /home/codespace/.bashrc to use it

Oreoxmt · 2024-11-22T10:50:57Z

quick-start-with-tidb.md


-        {{< copyable "shell-regular" >}}
+You should see this output:


Suggested change

You should see this output:

The output is as follows:

should, should be link
Generally avoid.
Because should is ambiguous by definition, it can be problematic.
"If an outcome is expected: Describe the outcome in terms of what is expected. For example: "The process returns 10 items."

https://developers.google.com/style/word-list#should

pingcap/docs@690e280

quick-start-with-tidb.md

pingcap/docs@1550f45

Oreoxmt · 2024-11-29T06:05:19Z

quick-start-with-tidb.md

Preview: https://pingcap-docsite-preview-git-preview-pi-d37033-oreoxmts-projects.vercel.app/tidb/dev/quick-start-with-tidb

qiancai · 2024-11-29T07:28:05Z

quick-start-with-tidb.md


-        This command returns the access methods of the cluster:
+Select the endpoint to connect, and try your first commands:


Suggested change

Select the endpoint to connect, and try your first commands:

Press <kbd>Enter</kbd> to connect to the endpoint, and try your first statements:

Reason: It seems that pressing ↑ or ↓ is not working to switch the endpoint does not work. Users have to press Enter to connect to the default endpoint.

qiancai · 2024-11-29T07:50:57Z

quick-start-with-tidb.md

-    source ${your_shell_profile}
-    ```
+```shell
+tiup playground display


Could we guide users to run this command before introducing the concepts of TiDB, TiKV, PD, and TiFlash components? This way, they will first see which components have been installed from the output of this command, and then get the explanations of these components in our document.

A new version of playground is available: v1.14.1 -> v1.16.1 To update this component: tiup update playground To update all components: tiup update --all Pid Role Uptime --- ---- ------ 18997 pd 50m54.278572s 19089 tikv 50m6.9280185s 19353 tidb 47m42.160680084s 20593 tiflash 36m26.515627792s

hfxsd · 2024-11-29T07:55:11Z

quick-start-with-tidb.md


-    - To start a TiDB cluster of the latest version with 1 TiDB instance, 1 TiKV instance, 1 PD instance, and 1 TiFlash instance, run the following command:
+The previous steps gave you an ephemeral environment - perfect for first experiments but everything is lost when you stop the playground. Let's set up a more suitable environment for development.


Suggested change

The previous steps gave you an ephemeral environment - perfect for first experiments but everything is lost when you stop the playground. Let's set up a more suitable environment for development.

The previous steps gave you an ephemeral environment - perfect for first experiments but everything is lost when you stop the playground. You can set up a more suitable environment for development.

hfxsd · 2024-11-29T08:01:49Z

quick-start-with-tidb.md

+1. View your running queries:
+
+    - Go to "SQL Statements" to see your weather data queries
+    - Check execution times, and additional optional columns, and click on the statement for more execution details


Suggested change

- Check execution times, and additional optional columns, and click on the statement for more execution details

- Check execution times, and additional optional columns, and click the statement for more execution details

hfxsd · 2024-11-29T08:05:31Z

quick-start-with-tidb.md


-1. Download and install TiUP:
+## Scaling your cluster


Suggested change

## Scaling your cluster

## Scale your cluster

hfxsd · 2024-11-29T08:07:06Z

quick-start-with-tidb.md

-    - `user: "tidb"`: Use the `tidb` system user (automatically created during deployment) to perform the internal management of the cluster. By default, use port 22 to log in to the target machine via SSH.
-    - `replication.enable-placement-rules`: This PD parameter is set to ensure that TiFlash runs normally.
-    - `host`: The IP of the target machine.
+Let's remove one TiKV node. For these scale-in operations, we specify the exact node we want to remove using its PID. First, in your available terminal, check the TiKV nodes PIDs:


Suggested change

Let's remove one TiKV node. For these scale-in operations, we specify the exact node we want to remove using its PID. First, in your available terminal, check the TiKV nodes PIDs:

Remove one TiKV node. For these scale-in operations, you can specify the exact node you want to remove using its PID. First, in your available terminal, check the TiKV nodes PIDs:

hfxsd · 2024-11-29T08:07:52Z

quick-start-with-tidb.md

-    ```shell
-    tiup cluster deploy <cluster-name> <version> ./topo.yaml --user root -p
-    ```
+You can scale-in your cluster by removing one TiKV node of your choice using its PID. For example, run the following replacing the `--pid` value with your `tikv` PID:


Suggested change

You can scale-in your cluster by removing one TiKV node of your choice using its PID. For example, run the following replacing the `--pid` value with your `tikv` PID:

You can scale in your cluster by removing one TiKV node of your choice using its PID. For example, run the following to replace the `--pid` value with your `tikv` PID:

qiancai · 2024-11-29T08:11:39Z

quick-start-with-tidb.md

+```shell
+tiup clean dev-env
+```



move this command to the Tip (https://github.com/pingcap/docs/pull/19412/files#r1863110475), as it doesn’t need to be executed at this point.

hfxsd · 2024-11-29T08:12:20Z

quick-start-with-tidb.md


-    {{< copyable "shell-regular" >}}
+- TiDB Dashboard, "Cluster Info", "Instances". Check the new TiDB instance
+- Grafana, search for "TiProxy-Summary", and expand the "Query Summary" or "Traffic". You should see a new instance in the backend and the traffic is being balanced across them


Suggested change

- Grafana, search for "TiProxy-Summary", and expand the "Query Summary" or "Traffic". You should see a new instance in the backend and the traffic is being balanced across them

- Grafana, search for "TiProxy-Summary", and expand the "Query Summary" or "Traffic". You can see a new instance in the backend and the traffic is being balanced across them

qiancai · 2024-11-29T08:17:22Z

quick-start-with-tidb.md


-6. Access the [TiDB Dashboard](/dashboard/dashboard-intro.md) at <http://127.0.0.1:2379/dashboard>. The default username is `root`, and the password is empty.
+To add a TiProxy instance as a load balancer to your existing `sample-app-env` environment with:


Suggested change

To add a TiProxy instance as a load balancer to your existing `sample-app-env` environment with:

To add a TiProxy (a load balancer for TiDB) instance to your existing `sample-app-env` environment with:

qiancai · 2024-11-29T08:18:50Z

quick-start-with-tidb.md

-        ```shell
-        tiup playground v8.4.0 --db 2 --pd 3 --kv 3
-        ```
+Tags also makes cleanup explicit with:


Suggested change

Tags also makes cleanup explicit with:

Tags also make cleanup explicit with:

qiancai · 2024-11-29T08:37:47Z

quick-start-with-tidb.md


-8. (Optional) [Load data to TiFlash](/tiflash/tiflash-overview.md#use-tiflash) for analysis.
+```shell
+tiup playground v8.1.0 --tag sample-app-env --db 2 --kv 3 --pd 1 --tiflash 0 --tiproxy 1


Every time I execute this command, I encounter the following error. However, if I clean up the existing sample-app-env using tiup clean sample-app-env and then re-execute the command, it works fine. Therefore, I’m unsure if adding TiProxy to an existing cluster this way is correct.

Start pd instance: v8.1.0 Start tikv instance: v8.1.0 Start tikv instance: v8.1.0 Start tikv instance: v8.1.0 Start tidb instance: v8.1.0 Start tidb instance: v8.1.0 Start tiproxy instance: v1.3.0 Waiting for tidb and tiproxy instances ready 127.0.0.1:62346 ... Error 127.0.0.1:62348 ... Error

qiancai · 2024-11-29T09:01:45Z

quick-start-with-tidb.md


-> **Note:**
+See all TiUP playground options with:


Suggested change

See all TiUP playground options with:

Open a new terminal, and then see all TiUP playground options with:

reason: Avoid users closing the terminal with the Proxy connection so they can proceed with the steps in "Sample scalable database application".

qiancai · 2024-11-29T09:20:08Z

quick-start-with-tidb.md

+TiDB Playground Cluster is started, enjoy!
+Connect TiDB: mysql --host 127.0.0.1 --port 4001 -u root
+Connect TiDB: mysql --host 127.0.0.1 --port 4000 -u root
+Connect TiProxy: mysql --host 127.0.0.1 --port 6000 -u root


Suggested change

Connect TiProxy: mysql --host 127.0.0.1 --port 6000 -u root

Connect TiProxy: mysql --host 127.0.0.1 --port 6000 -u root

TiDB Dashboard: http://127.0.0.1:60434/dashboard

Grafana: http://127.0.0.1:60838

reason: We can instruct users to note the Dashboard link as it will be used in "TiDB Dashboard: SQL insights" to check "weather data queries"

qiancai · 2024-11-29T09:30:55Z

quick-start-with-tidb.md

+
+### TiDB Dashboard: SQL insights
+
+Access TiDB Dashboard by checking its URL on the terminal you are running TiUP playground (typically http://127.0.0.1:2379/dashboard - user: `root`, no password) to:


"typically http://127.0.0.1:2379/dashboard" is confusing here because this section assumes TiProxy is added. In that case, "http://127.0.0.1:60434/dashboard/" is also typical.

Suggested change

Access TiDB Dashboard by checking its URL on the terminal you are running TiUP playground (typically http://127.0.0.1:2379/dashboard - user: `root`, no password) to:

Access TiDB Dashboard by using its URL (for example, http://127.0.0.1:2379/dashboard) in the terminal where you are running TiUP playground. The default login is root with no password.

qiancai · 2024-11-29T09:38:45Z

quick-start-with-tidb.md

+
+### Grafana: system performance
+
+Access Grafana by checking its URL on the terminal you are running TiUP playground (typically http://127.0.0.1:3000 - user: `admin`, password: `admin`). Change the password or Skip. You can visualize the built-in dashboards by clicking on the Search icon and the folder "Test-Cluster":


"typically http://127.0.0.1:2379/dashboard" is confusing here because this section assumes TiProxy is added. In that case, " http://127.0.0.1:60838" is also typical.

qiancai · 2024-11-29T09:42:11Z

quick-start-with-tidb.md

+
+2. TiProxy Load Balancing:
+
+    Search for "TiProxy", and check the "Balance" row


Suggested change

Search for "TiProxy", and check the "Balance" row

Search for "TiProxy", click the search result, and then check the "Balance" row

qiancai · 2024-11-29T09:44:05Z

quick-start-with-tidb.md


-    {{< copyable "shell-regular" >}}
+    Go to "Cluster Info", "Store Topology"


Suggested change

Go to "Cluster Info", "Store Topology"

Go to "Cluster Info" -> "Store Topology"

qiancai · 2024-11-29T09:50:20Z

quick-start-with-tidb.md


-4. If the TiUP cluster is already installed on the machine, update the software version:
+```shell
+tiup playground scale-out --kv 2


Do we need to update it to tiup playground --tag sample-app-env scale-out --kv 2 because we are viewing the Dashboard for sample-app-env?

qiancai · 2024-11-29T09:51:17Z

quick-start-with-tidb.md


-7. Execute the cluster deployment command:
+```shell
+tiup playground display


same here, do we need to add --tag sample-app-env

qiancai · 2024-11-29T09:55:48Z

quick-start-with-tidb.md

-    - `<version>`: Set the TiDB cluster version, such as `v8.4.0`. You can see all the supported TiDB versions by running the `tiup list tidb` command
-    - `-p`: Specify the password used to connect to the target machine.
+```shell
+tiup playground scale-in --pid 51464


same here, do we need to add --tag sample-app-env

qiancai · 2024-11-29T09:55:53Z

quick-start-with-tidb.md

-    Input SSH password:
-    ```
+```shell
+tiup playground scale-out --db 1


same here, do we need to add --tag sample-app-env

qiancai · 2024-11-29T09:55:59Z

quick-start-with-tidb.md


    ```shell
-    tiup cluster start <cluster-name>
+    tiup playground scale-out --tiflash 1


same here, do we need to add --tag sample-app-env

qiancai · 2024-11-29T09:58:27Z

quick-start-with-tidb.md


-    - Access TiDB. The password is empty:
+Once the replica is ready (progress=1.0), you can run analytical queries that will automatically use TiFlash when beneficial. Check the in the TiDB Dashboard, SQL Statements, "#Plans" columns. If there is a new plan, you can inspect the execution details to see if there is a task performed by `mpp[tiflash]`.


Suggested change

Once the replica is ready (progress=1.0), you can run analytical queries that will automatically use TiFlash when beneficial. Check the in the TiDB Dashboard, SQL Statements, "#Plans" columns. If there is a new plan, you can inspect the execution details to see if there is a task performed by `mpp[tiflash]`.

Once the replica is ready (progress=1), you can run analytical queries that will automatically use TiFlash when beneficial. On the TiDB Dashboard, click **SQL Statements**, and then check the **#Plans**column. If there is a new plan, you can click the new plan and inspect the execution details to see if there is a task performed by `mpp[tiflash]`.

qiancai · 2024-11-29T10:19:50Z

quick-start-with-tidb.md

@@ -6,510 +6,532 @@ aliases: ['/docs/dev/quick-start-with-tidb/','/docs/dev/test-deployment-using-do



Hi @alastori, thank you for writing this detailed document. It is quite helpful for users to learn how to use the monitoring tools and scale clusters. I’ve tested the steps on my macOS, and while following the instructions, these steps guide me to set up a local cluster four times as follows 😂 , which is time-consuming.

tiup playground
tiup playground --tag dev-env
tiup playground v8.1.0 --tag sample-app-env --db 2 --kv 3 --pd 1 --tiflash 0
tiup playground v8.1.0 --tag sample-app-env --db 2 --kv 3 --pd 1 --tiflash 0 --tiproxy 1

Would it be possible to provide just one or two cluster setup commands and list the rest as a tip? This could help streamline the setup process for users.

By the way, I’m not sure if introducing the usage of --tag is necessary for first-time users, as it makes the command longer. Without introducing --tag in this doc, we can avoid concerns about whether users are scaling or monitoring the correct cluster.

quick-start-with-tidb.md

ti-chi-bot · 2024-12-02T08:30:19Z

@alastori: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-verify	`894a19c`	link	true	`/test pull-verify`

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

TiDB Quick Start refresh

6115a1a

ti-chi-bot bot added missing-translation-status This PR does not have translation status info. size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files. labels Nov 15, 2024

Merge branch 'master' into quick-start-tidb-refresh

f8d2041

lilin90 self-assigned this Nov 15, 2024

Update of fix format

2873e5b

lilin90 requested a review from likidu November 15, 2024 02:47

Update 34 files to fix broken anchor links

4a8d932

ti-chi-bot bot added the area/develop This PR relates to the area of TiDB App development. label Nov 15, 2024

lilin90 added the do-not-merge/hold Indicates that a PR should not merge because someone has issued a /hold command. label Nov 15, 2024

lilin90 and others added 3 commits November 15, 2024 13:18

Merge branch 'master' into quick-start-tidb-refresh

0ff5b98

Fix unclosed tags

927038f

Merge branch 'pingcap:master' into quick-start-tidb-refresh

690e280

lilin90 requested review from lilin90, hfxsd, Oreoxmt and qiancai November 22, 2024 10:05

Oreoxmt reviewed Nov 22, 2024

View reviewed changes

github-actions bot pushed a commit to Oreoxmt/pingcap-docsite-preview that referenced this pull request Nov 22, 2024

Preview PR pingcap/docs#19412 and this preview is triggered from commit

6015ea0

pingcap/docs@690e280

Oreoxmt reviewed Nov 29, 2024

View reviewed changes

quick-start-with-tidb.md Outdated Show resolved Hide resolved

fix build failure

1550f45

github-actions bot pushed a commit to Oreoxmt/pingcap-docsite-preview that referenced this pull request Nov 29, 2024

Preview PR pingcap/docs#19412 and this preview is triggered from commit

1dd4336

pingcap/docs@1550f45

Oreoxmt reviewed Nov 29, 2024

View reviewed changes

qiancai reviewed Nov 29, 2024

View reviewed changes

hfxsd reviewed Nov 29, 2024

View reviewed changes

qiancai reviewed Nov 29, 2024

View reviewed changes

hfxsd reviewed Nov 29, 2024

View reviewed changes

qiancai reviewed Nov 29, 2024

View reviewed changes

lilin90 reviewed Dec 2, 2024

View reviewed changes

lilin90 added 3 commits December 2, 2024 16:20

Apply suggestions from code review

ec6c0a5

Fix multiple lines that cause pull verify failure

3c21baf

Fix format

894a19c

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TiDB Quick Start refresh #19412

TiDB Quick Start refresh #19412

alastori commented Nov 15, 2024

ti-chi-bot bot commented Nov 15, 2024

Oreoxmt Nov 22, 2024 •

edited

Loading

Oreoxmt Nov 22, 2024

Oreoxmt Nov 29, 2024

qiancai Nov 29, 2024 •

edited

Loading

qiancai Nov 29, 2024

qiancai Nov 29, 2024 •

edited

Loading

hfxsd Nov 29, 2024

hfxsd Nov 29, 2024

hfxsd Nov 29, 2024

hfxsd Nov 29, 2024

hfxsd Nov 29, 2024 •

edited

Loading

qiancai Nov 29, 2024 •

edited

Loading

hfxsd Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024 •

edited

Loading

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024

qiancai Nov 29, 2024 •

edited

Loading

ti-chi-bot bot commented Dec 2, 2024

	Note the Shell profile path in the output above. You need to use the path in the next step.

	2. Declare the global environment variable:

	> Note:
	>
	> After the installation, TiUP displays the absolute path of the corresponding Shell profile file. You need to modify `${your_shell_profile}` in the following `source` command according to the path. In this case, `${your_shell_profile}` is `/Users/user/.zshrc` from the output of Step 1.

	{{< copyable "shell-regular" >}}

	```shell
	source ${your_shell_profile}
	```


		This command returns the access methods of the cluster:
		Select the endpoint to connect, and try your first commands:

	Select the endpoint to connect, and try your first commands:
	Press <kbd>Enter</kbd> to connect to the endpoint, and try your first statements:


		- To start a TiDB cluster of the latest version with 1 TiDB instance, 1 TiKV instance, 1 PD instance, and 1 TiFlash instance, run the following command:
		The previous steps gave you an ephemeral environment - perfect for first experiments but everything is lost when you stop the playground. Let's set up a more suitable environment for development.

	- Check execution times, and additional optional columns, and click on the statement for more execution details
	- Check execution times, and additional optional columns, and click the statement for more execution details

	Let's remove one TiKV node. For these scale-in operations, we specify the exact node we want to remove using its PID. First, in your available terminal, check the TiKV nodes PIDs:
	Remove one TiKV node. For these scale-in operations, you can specify the exact node you want to remove using its PID. First, in your available terminal, check the TiKV nodes PIDs:

	You can scale-in your cluster by removing one TiKV node of your choice using its PID. For example, run the following replacing the `--pid` value with your `tikv` PID:
	You can scale in your cluster by removing one TiKV node of your choice using its PID. For example, run the following to replace the `--pid` value with your `tikv` PID:

	- Grafana, search for "TiProxy-Summary", and expand the "Query Summary" or "Traffic". You should see a new instance in the backend and the traffic is being balanced across them
	- Grafana, search for "TiProxy-Summary", and expand the "Query Summary" or "Traffic". You can see a new instance in the backend and the traffic is being balanced across them


		6. Access the [TiDB Dashboard](/dashboard/dashboard-intro.md) at <http://127.0.0.1:2379/dashboard>. The default username is `root`, and the password is empty.
		To add a TiProxy instance as a load balancer to your existing `sample-app-env` environment with:

	To add a TiProxy instance as a load balancer to your existing `sample-app-env` environment with:
	To add a TiProxy (a load balancer for TiDB) instance to your existing `sample-app-env` environment with:

	Tags also makes cleanup explicit with:
	Tags also make cleanup explicit with:

	See all TiUP playground options with:
	Open a new terminal, and then see all TiUP playground options with:


		### TiDB Dashboard: SQL insights

		Access TiDB Dashboard by checking its URL on the terminal you are running TiUP playground (typically http://127.0.0.1:2379/dashboard - user: `root`, no password) to:

	Access TiDB Dashboard by checking its URL on the terminal you are running TiUP playground (typically http://127.0.0.1:2379/dashboard - user: `root`, no password) to:
	Access TiDB Dashboard by using its URL (for example, http://127.0.0.1:2379/dashboard) in the terminal where you are running TiUP playground. The default login is root with no password.


		### Grafana: system performance

		Access Grafana by checking its URL on the terminal you are running TiUP playground (typically http://127.0.0.1:3000 - user: `admin`, password: `admin`). Change the password or Skip. You can visualize the built-in dashboards by clicking on the Search icon and the folder "Test-Cluster":


		2. TiProxy Load Balancing:

		Search for "TiProxy", and check the "Balance" row

	Search for "TiProxy", and check the "Balance" row
	Search for "TiProxy", click the search result, and then check the "Balance" row


		{{< copyable "shell-regular" >}}
		Go to "Cluster Info", "Store Topology"

	Go to "Cluster Info", "Store Topology"
	Go to "Cluster Info" -> "Store Topology"


		- Access TiDB. The password is empty:
		Once the replica is ready (progress=1.0), you can run analytical queries that will automatically use TiFlash when beneficial. Check the in the TiDB Dashboard, SQL Statements, "#Plans" columns. If there is a new plan, you can inspect the execution details to see if there is a task performed by `mpp[tiflash]`.

TiDB Quick Start refresh #19412

Are you sure you want to change the base?

TiDB Quick Start refresh #19412

Conversation

alastori commented Nov 15, 2024

What is changed, added or deleted? (Required)

Which TiDB version(s) do your changes apply to? (Required)

What is the related PR or file link(s)?

ti-chi-bot bot commented Nov 15, 2024

Oreoxmt Nov 22, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qiancai Nov 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qiancai Nov 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

hfxsd Nov 29, 2024 • edited Loading

Choose a reason for hiding this comment

qiancai Nov 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qiancai Nov 29, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

qiancai Nov 29, 2024 • edited Loading

Choose a reason for hiding this comment

ti-chi-bot bot commented Dec 2, 2024

Oreoxmt Nov 22, 2024 •

edited

Loading

qiancai Nov 29, 2024 •

edited

Loading

qiancai Nov 29, 2024 •

edited

Loading

hfxsd Nov 29, 2024 •

edited

Loading

qiancai Nov 29, 2024 •

edited

Loading

qiancai Nov 29, 2024 •

edited

Loading

qiancai Nov 29, 2024 •

edited

Loading

	Once the replica is ready (progress=1.0), you can run analytical queries that will automatically use TiFlash when beneficial. Check the in the TiDB Dashboard, SQL Statements, "#Plans" columns. If there is a new plan, you can inspect the execution details to see if there is a task performed by `mpp[tiflash]`.
	Once the replica is ready (progress=1), you can run analytical queries that will automatically use TiFlash when beneficial. On the TiDB Dashboard, click SQL Statements, and then check the #Planscolumn. If there is a new plan, you can click the new plan and inspect the execution details to see if there is a task performed by `mpp[tiflash]`.

		@@ -6,510 +6,532 @@ aliases: ['/docs/dev/quick-start-with-tidb/','/docs/dev/test-deployment-using-do