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.

Sign up for GitHub

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

Jump to bottom

*: Add tidb flags document #1

Merged
merged 8 commits into from
Jul 25, 2016
Merged

*: Add tidb flags document #1

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
b575b81
*: Add tidb flags document
shenli Jul 23, 2016
5e9ac82
op-guide: Add configuration docs in op-guide
shenli Jul 23, 2016
8f42234
op-guide: Address comment
shenli Jul 23, 2016
75868b9
*: Address comment
shenli Jul 23, 2016
9ee0ec3
*: address comment
shenli Jul 23, 2016
5ed4fe8
*: Address comments
shenli Jul 25, 2016
6584a40
op-guid: Address comment
shenli Jul 25, 2016
aef2728
*: Address comment
shenli Jul 25, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions op-guide/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ TiDB/TiKV/PD are configurable through command-line flags and environment variabl
The default TiDB ports are 4000 for client requests and 10080 for status report.

### --store
+ Storage engine type
+ the storage engine type
+ Human-readable name for this member.
+ default: "goleveldb"
+ You can choose from "memory", "goleveldb", "BoltDB" or "TiKV". The first three are all local storage engines. TiKV is a distributed storage engine.
Expand All @@ -18,34 +18,34 @@ The default TiDB ports are 4000 for client requests and 10080 for status report.
+ default: "/tmp/tidb"

### -L
+ The log level
+ the log level
+ default: "debug"
+ You can choose from debug, info, warn, error, or fatal.

### -P
+ The listening port for TiDB server.
+ the listening port for TiDB server
+ default: "4000"
+ TiDB server will accept MySQL client request from this port.

### --status
+ The status report port for TiDB server
+ the status report port for TiDB server
+ default: "10080"
+ This is used to get server status.

### --lease
+ The schema lease time in seconds.
+ the schema lease time in seconds
+ default: "1"
+ This is the schema lease time that is used in online schema changes. The value will affect the DDL statement running time. You cannot change it unless you understand the internal mechanism.
Copy link
Member

Choose a reason for hiding this comment

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

You should not change it

Copy link
Contributor

Choose a reason for hiding this comment

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

We should avoid using "should" in any technical documents. We can use either “must not” or "cannot".

Copy link
Member

Choose a reason for hiding this comment

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

How about Do not?

Copy link
Contributor

Choose a reason for hiding this comment

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

Much better!

Copy link
Member Author

Choose a reason for hiding this comment

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

PTAL @coocood


### --socket
+ The socket file for connection.
+ the socket file for connection
+ default: ""
+ You can use the "/tmp/tidb.sock" file.

### --perfschema
+ Enable(1) or disable(0) the performance schema.
+ enable(1) or disable(0) the performance schema
+ default: "0"
+ The value can be (1) or (0). (1) is to enable and (0) is to disable. If the value is set to be (1), the performance will be affected.
+ The value can be (1) or (0). (1) is to enable and (0) is to disable. The Performance Schema provides a way to inspect internal execution of the server at runtime. See [performance schema](http://dev.mysql.com/doc/refman/5.7/en/performance-schema.html) for more information. If enable performance schema, the performance will be affected.
Copy link
Contributor

Choose a reason for hiding this comment

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

If you enable the performance schema, the performance will be affected.


### $TIDB_PPROF environment variable
+ An environment variable that is used to enable or disable the runtime profiling data via the HTTP server. The Address is at client URL + "/debug/pprof/".
Expand Down