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

reference: add a new config in tidb-server config doc #2287

Merged
merged 4 commits into from
Apr 21, 2020

Conversation

TomShawn
Copy link
Contributor

@TomShawn TomShawn commented Apr 15, 2020

What is changed, added or deleted? (Required)

Add a new config temp-storage-quota in tidb-server config document.

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

  • master (the latest development version)
  • v4.0 (TiDB 4.0 versions)
  • v3.1 (TiDB 3.1 versions)
  • v3.0 (TiDB 3.0 versions)
  • v2.1 (TiDB 2.1 versions)

If you select two or more versions from above, to trigger the bot to cherry-pick this PR to your desired release version branch(es), you must add corresponding labels such as needs-cherry-pick-4.0, needs-cherry-pick-3.1, needs-cherry-pick-3.0, and needs-cherry-pick-2.1.

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

@TomShawn TomShawn added translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn. size/small Changes of a small size. needs-cherry-pick-4.0 labels Apr 15, 2020
@@ -34,6 +34,14 @@ The TiDB configuration file supports more options than command-line parameters.
+ Default value: `<TMPDIR>/tidb/tmp-storage`
+ It only takes effect when `oom-use-tmp-storage` is `true`.

### `temp-storage-quota`

+ Specifies the storage quota for the storage in `tmp-storage-path`.
Copy link
Contributor

Choose a reason for hiding this comment

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

  • Two storages seem redundant.
  • You miss the bytes description.

+ When a single SQL statement uses a temporary disk and the total volume of the temporary disk of the TiDB server exceeds this configuration value, the current SQL operation is cancelled and the `Out of Global Storage Quota!` error is returned.
+ When the value of this configuration is smaller than `0`, the above check and limit do not apply.
+ Default value: `-1`
+ When the remaining available storage in `tmp-storage-path` is lower than the value defined by `temp-storage-quota`, the TiDB server reports an error when it is started and exits.
Copy link
Contributor

Choose a reason for hiding this comment

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

To avoid ambiguity in the relationship of predicative verbs.

Suggested change
+ When the remaining available storage in `tmp-storage-path` is lower than the value defined by `temp-storage-quota`, the TiDB server reports an error when it is started and exits.
+ When the remaining available storage in `tmp-storage-path` is lower than the value defined by `temp-storage-quota`, the TiDB server reports an error when it is started, and exits.

@ran-huang ran-huang added the status/require-change Needs the author to address comments. label Apr 16, 2020
@ran-huang ran-huang added status/PTAL This PR is ready for reviewing. and removed status/require-change Needs the author to address comments. labels Apr 16, 2020
Copy link
Contributor

@ran-huang ran-huang left a comment

Choose a reason for hiding this comment

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

LGTM

@sre-bot
Copy link
Contributor

sre-bot commented Apr 18, 2020

@ran-huang, @Yisaer, PTAL.

1 similar comment
@sre-bot
Copy link
Contributor

sre-bot commented Apr 20, 2020

@ran-huang, @Yisaer, PTAL.

@TomShawn TomShawn added the status/can-merge Indicates a PR has been approved by a committer. label Apr 21, 2020
@sre-bot
Copy link
Contributor

sre-bot commented Apr 21, 2020

/run-all-tests

@sre-bot sre-bot merged commit 88002a0 into pingcap:master Apr 21, 2020
sre-bot pushed a commit to sre-bot/docs that referenced this pull request Apr 21, 2020
@sre-bot
Copy link
Contributor

sre-bot commented Apr 21, 2020

cherry pick to release-4.0 in PR #2363

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
size/small Changes of a small size. status/can-merge Indicates a PR has been approved by a committer. status/PTAL This PR is ready for reviewing. translation/from-docs-cn This PR is translated from a PR in pingcap/docs-cn.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants