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

fix expression index's document again. #6950

Merged
merged 9 commits into from
Aug 26, 2021
Merged

Conversation

wjhuang2016
Copy link
Member

@wjhuang2016 wjhuang2016 commented Aug 25, 2021

Signed-off-by: wjhuang2016 huangwenjun1997@gmail.com

First-time contributors' checklist

What is changed, added or deleted? (Required)

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 (in Chinese).

  • master (the latest development version)
  • v5.2 (TiDB 5.2 versions)
  • v5.1 (TiDB 5.1 versions)
  • v5.0 (TiDB 5.0 versions)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 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

1
Signed-off-by: wjhuang2016 <huangwenjun1997@gmail.com>
@ti-chi-bot
Copy link
Member

ti-chi-bot commented Aug 25, 2021

[REVIEW NOTIFICATION]

This pull request has been approved by:

  • TomShawn

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 requested a review from TomShawn August 25, 2021 08:38
@ti-chi-bot ti-chi-bot added missing-translation-status This PR does not have translation status info. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 25, 2021
system-variables.md Outdated Show resolved Hide resolved
@TomShawn TomShawn added needs-cherry-pick-release-5.2 translation/doing This PR’s assignee is translating this PR. v5.2 This PR/issue applies to TiDB v5.2. labels Aug 25, 2021
@ti-chi-bot ti-chi-bot removed the missing-translation-status This PR does not have translation status info. label Aug 25, 2021
@TomShawn TomShawn added the type/enhancement The issue or PR belongs to an enhancement. label Aug 25, 2021
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
@@ -186,6 +186,14 @@ DROP INDEX idx1 ON t1;
```

> **注意:**
>
> 表达式索引涉及众多表达式,为了确保正确性,只有经过充分测试的函数才允许直接创建,这些函数可以查询变量 `tidb_allow_function_for_expression_index` 了解。对于未经过充分测试的函数,其存在正确性风险, 我们将其视为实验特性,不建议在生产环境中使用。如果仍然希望使用,可以在 [TiDB 配置文件](/tidb-configuration-file.md#allow-expression-index-从-v400-版本开始引入)中进行以下设置:
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
> 表达式索引涉及众多表达式,为了确保正确性,只有经过充分测试的函数才允许直接创建,这些函数可以查询变量 `tidb_allow_function_for_expression_index` 了解。对于未经过充分测试的函数,其存在正确性风险, 我们将其视为实验特性,不建议在生产环境中使用。如果仍然希望使用,可以在 [TiDB 配置文件](/tidb-configuration-file.md#allow-expression-index-从-v400-版本开始引入)中进行以下设置:
> 表达式索引涉及众多表达式,为了确保正确性,只有经过充分测试的函数才允许直接创建,这些函数可以通过查询变量 `tidb_allow_function_for_expression_index` 得到。对于未经过充分测试的函数,由于尚未完成充分的测试,我们将其视为实验特性,不建议在生产环境中使用。如果仍然希望使用,可以在 [TiDB 配置文件](/tidb-configuration-file.md#allow-expression-index-从-v400-版本开始引入)中进行以下设置:

Copy link
Member

Choose a reason for hiding this comment

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

这里直接把 GA 的函数列出来吧。

1
Signed-off-by: wjhuang2016 <huangwenjun1997@gmail.com>
Signed-off-by: wjhuang2016 <huangwenjun1997@gmail.com>
@TomShawn TomShawn requested a review from bb7133 August 25, 2021 11:05
Signed-off-by: wjhuang2016 <huangwenjun1997@gmail.com>
@ti-chi-bot
Copy link
Member

@bb7133: Thanks for your review. The bot only counts approvals from reviewers and higher roles in list, but you're still welcome to leave your comments.

In response to this:

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 ti-community-infra/tichi repository.

sql-statements/sql-statement-create-index.md Outdated Show resolved Hide resolved
sql-statements/sql-statement-create-index.md Outdated Show resolved Hide resolved
### `tidb_allow_function_for_expression_index` <span class="version-mark">从 v5.2.0 版本开始引入</span>

- 作用域:NONE
- 这个变量用于显示创建表达式索引所允许使用的函数。
Copy link
Member Author

Choose a reason for hiding this comment

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

同样,推荐很奇怪。这里有些歧义,推荐有“让用户用的意思”,如果不符合用户的需求,也“推荐” 的话就不合适了。

wjhuang2016 and others added 2 commits August 26, 2021 11:34
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
### `tidb_allow_function_for_expression_index` <span class="version-mark">从 v5.2.0 版本开始引入</span>

- 作用域:NONE
- 这个变量用于显示创建表达式索引所允许使用的函数。
Copy link
Member Author

Choose a reason for hiding this comment

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

同样,推荐很奇怪。这里有些歧义,推荐有“让用户用的意思”,如果不符合用户的需求,也“推荐” 的话就不合适了。

Co-authored-by: TomShawn <41534398+TomShawn@users.noreply.github.com>
Copy link
Contributor

@TomShawn TomShawn 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 26, 2021
@TomShawn
Copy link
Contributor

/merge

@ti-chi-bot
Copy link
Member

@TomShawn: /merge in this pull request requires 2 approval(s).

In response to this:

/merge

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 ti-community-infra/tichi repository.

@TomShawn
Copy link
Contributor

/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 26, 2021
@TomShawn
Copy link
Contributor

/merge

@ti-chi-bot
Copy link
Member

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

Commit hash: 0504bf1

@ti-chi-bot ti-chi-bot added the status/can-merge Indicates a PR has been approved by a committer. label Aug 26, 2021
@ti-chi-bot ti-chi-bot merged commit 95e9b95 into pingcap:master Aug 26, 2021
@ti-chi-bot
Copy link
Member

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

@en-jin19 en-jin19 added translation/done This PR has been translated from English into Chinese and updated to pingcap/docs-cn in a PR. and removed translation/doing This PR’s assignee is translating this PR. labels Aug 26, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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. v5.2 This PR/issue applies to TiDB v5.2.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants