Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

faq: add some faqs to documentation #10061

Merged
merged 9 commits into from
Aug 24, 2022
Merged

Conversation

TomShawn
Copy link
Contributor

What is changed, added or deleted? (Required)

  • Add some FAQs to documentation
  • Update an outdated FAQ

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.

  • master (the latest development version)
  • v6.2 (TiDB 6.2 versions)
  • v6.1 (TiDB 6.1 versions)
  • v5.4 (TiDB 5.4 versions)
  • v5.3 (TiDB 5.3 versions)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)

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

  • This PR is translated from:
  • Other reference link(s):

Do your changes match any of the following descriptions?

  • Delete files
  • Change aliases
  • Need modification after applied to another branch
  • Might cause conflicts after applied to another branch

@ti-chi-bot
Copy link
Member

ti-chi-bot commented Aug 19, 2022

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • lilin90

To complete the pull request process, please ask the reviewers in the list to review by filling /cc @reviewer in the comment.
After your PR has acquired the required number of LGTMs, you can assign this pull request to the committer in the list by filling /assign @committer in the comment to help you merge this pull request.

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

Reviewer can indicate their review by submitting an approval review.
Reviewer can cancel approval by submitting a request changes review.

@ti-chi-bot ti-chi-bot added missing-translation-status This PR does not have translation status info. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Aug 19, 2022
faq/manage-cluster-faq.md Outdated Show resolved Hide resolved
faq/sql-faq.md Outdated Show resolved Hide resolved
faq/sql-faq.md Outdated Show resolved Hide resolved
@TomShawn TomShawn self-assigned this Aug 19, 2022
@TomShawn TomShawn requested review from lilin90 and songrijie and removed request for shichun-0415 August 19, 2022 05:33
@TomShawn TomShawn added type/enhancement The issue or PR belongs to an enhancement. needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. needs-cherry-pick-release-6.2 and removed missing-translation-status This PR does not have translation status info. labels Aug 19, 2022
faq/sql-faq.md Outdated Show resolved Hide resolved
@TomShawn TomShawn mentioned this pull request Aug 19, 2022
12 tasks
@TomShawn
Copy link
Contributor Author

/verify

@TomShawn TomShawn closed this Aug 22, 2022
@TomShawn TomShawn reopened this Aug 22, 2022
@ti-chi-bot ti-chi-bot added the missing-translation-status This PR does not have translation status info. label Aug 22, 2022

You can use [Placement Rules](/placement-rules-in-sql.md) to specify the location of data for compliance or multi-tenant applications.

Placement Rules in SQL is designed to control the attributes of any continuous data range, such as the number of replicas, the Raft role, the placement location, abd the key ranges in which the rules take effect.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typo: abd -> and

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Placement Rules in SQL is designed to control the attributes of any continuous data range, such as the number of replicas, the Raft role, the placement location, abd the key ranges in which the rules take effect.
Placement Rules in SQL is designed to control the attributes of any continuous data range, such as the number of replicas, the Raft role, the placement location, and the key ranges in which the rules take effect.

faq/sql-faq.md Outdated
@@ -7,6 +7,28 @@ summary: Learn about the FAQs related to TiDB SQL.

This document summarizes the FAQs related to SQL operations in TiDB.

## Does TiDB support secondary key?

Yes. If a column in TiDB meets all of the following conditions, it can work as a secondary key:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Better not to answer this question in this way. Secondary key is not a formal terminology, but an ability to access specific row quickly by a column other than primary key. In TiDB, we can achieve it by secondary index with not null constraint.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed

faq/sql-faq.md Outdated

For some DDL operations such as adding columns, deleting columns or dropping indexes, TiDB can perform these operations quickly.

For some heavy DDL operations such as adding indexes, TiDB needs to backfill data, which takes a longer time (depending on the size of the table) and consumes additional resources. The impact on online traffic is tunable. TiDB can do the backfill with multiple threads, and you can tune the number of threads.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's better to replace , and you can tune the number of threads with , the amount of thread is set by variables

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed

faq/sql-faq.md Outdated
@@ -285,6 +307,17 @@ Generally the input data of `root task` comes from `cop task`; when `root task`

See [The TiDB Command Options](/command-line-flags-for-tidb-configuration.md).

### How to avoid hotspot issues and achieve load balancing? Is hot partition or range an issue in TiDB?

To learn the scenarios that cause hotspots, refer to [common hotpots](/troubleshoot-hot-spot-issues.md#common-hotspots). To resolve hotspot issues, you can use the following built-in TiDB features:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The solutions of hotspot issues depends on the various causes. It's not guaranteed the given solutions resolve all problems. So we can say TiDB provides a few built-in features to resolve hotspot issues.. instead of saying the issues have to be resolved by these built-in features.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addressed

faq/manage-cluster-faq.md Outdated Show resolved Hide resolved
faq/manage-cluster-faq.md Outdated Show resolved Hide resolved
faq/manage-cluster-faq.md Outdated Show resolved Hide resolved
faq/manage-cluster-faq.md Outdated Show resolved Hide resolved
faq/manage-cluster-faq.md Outdated Show resolved Hide resolved
faq/sql-faq.md Outdated Show resolved Hide resolved
faq/sql-faq.md Outdated Show resolved Hide resolved
faq/sql-faq.md Outdated Show resolved Hide resolved
faq/tidb-faq.md Outdated Show resolved Hide resolved
faq/tidb-faq.md Outdated Show resolved Hide resolved
TomShawn and others added 2 commits August 24, 2022 14:59
Co-authored-by: Lilian Lee <lilin@pingcap.com>
Co-authored-by: Lilian Lee <lilin@pingcap.com>
@TomShawn TomShawn requested a review from lilin90 August 24, 2022 07:03
Copy link
Member

@lilin90 lilin90 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ti-chi-bot ti-chi-bot added the status/LGT1 Indicates that a PR has LGTM 1. label Aug 24, 2022
@lilin90
Copy link
Member

lilin90 commented Aug 24, 2022

/verify

@TomShawn
Copy link
Contributor Author

/remove-status LGT1
/status LGT2

@ti-chi-bot ti-chi-bot added status/LGT2 Indicates that a PR has LGTM 2. and removed status/LGT1 Indicates that a PR has LGTM 1. labels Aug 24, 2022
@TomShawn
Copy link
Contributor Author

/merge

@ti-chi-bot
Copy link
Member

This pull request has been accepted and is ready to merge.

Commit hash: 1259ec6

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Aug 24, 2022
@ti-chi-bot ti-chi-bot merged commit eadb0e7 into pingcap:master Aug 24, 2022
@TomShawn TomShawn deleted the add-more-faqs branch August 24, 2022 11:30
@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created: #10149.

@ti-chi-bot
Copy link
Member

In response to a cherrypick label: new pull request created: #10150.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-cherry-pick-release-6.1 Should cherry pick this PR to release-6.1 branch. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. status/can-merge Indicates a PR has been approved by a committer. status/LGT2 Indicates that a PR has LGTM 2. translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. type/enhancement The issue or PR belongs to an enhancement.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants