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

sql: update tidb specific link description #692

Merged
merged 9 commits into from
Oct 29, 2018
Merged

sql: update tidb specific link description #692

merged 9 commits into from
Oct 29, 2018

Conversation

morgo
Copy link
Contributor

@morgo morgo commented Oct 26, 2018

The title was renamed in #666

@morgo morgo requested a review from lilin90 October 29, 2018 02:26
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

@lilin90
Copy link
Member

lilin90 commented Oct 29, 2018

By the way, two other files also contain the word "proprietary", would you please also update them in this PR?

@morgo
Copy link
Contributor Author

morgo commented Oct 29, 2018

Thanks for spotting. I've updated these pages as well.

The `Hint` syntax is included in comments like `/*+ xxx */`, and in MySQL client versions earlier than 5.7.7, the comment is removed by default. If you want to use the `Hint` syntax in these earlier versions, add the `--comments` option when starting the client. For example: `mysql -h 127.0.0.1 -P 4000 -uroot --comments`.
TiDB supports optimizer hints, based on the format of the comment-like syntax introduced in MySQL 5.7. i.e. `/*+ TIDB_XX(t1, t2) */`. Use of optimizer hints is recommended in cases where the TiDB optimizer selects a less optimal query plan.

**Note:** MySQL command-line clients earlier than 5.7.7 will strip optimizer hints by default. If you want to use the `Hint` syntax in these earlier versions, add the `--comments` option when starting the client. For example: `mysql -h 127.0.0.1 -P 4000 -uroot --comments`.
Copy link
Member

Choose a reason for hiding this comment

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

  • For a Note, please use this format > **Note:**.
  • will strip -> strip (Please limit the use of the future tense where possible.)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thx. I've updated this, and also changed the titles to plural (since there is more than one hint and more than one variable).

Let me know if this is a problem

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

@morgo morgo merged commit 4967a30 into master Oct 29, 2018
@morgo morgo deleted the morgo/update-link branch October 29, 2018 13:07
lilin90 added a commit to lilin90/docs-cn that referenced this pull request Oct 31, 2018
@sre-bot sre-bot added the contribution This PR is from a community contributor. label Dec 18, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution This PR is from a community contributor.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants