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

*: Add tidb flags document #1

Merged
merged 8 commits into from
Jul 25, 2016
Merged
Changes from 2 commits
Commits
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
50 changes: 50 additions & 0 deletions op-guide/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Configuration flags

TiDB is configurable through command-line flags and environment variables.
Copy link
Member

Choose a reason for hiding this comment

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

add ## TiDB


The official TiDB ports are 4000 for client requests and 10080 for status report.

### --store
+ Storage type
+ Human-readable name for this member.
+ default: "goleveldb"
+ You can choose from memory, goleveldb, boltdb and tikv. The first three are all local storage. TiKV is a distributed storage.

### --path
+ Path to the data directory for local storage (goleveldb, boltdb, memory). DSN to the distributed storage (TiKV).
+ default: "/tmp/tidb"
+ If use TiKV, the path should be in this format: $Host:$Port/pd?cluster=$ClusterID

### -L
+ Log level
+ default: "debug"
+ You can choose from debug, info, warn, error, fatal.

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

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

### --lease
+ Schema lease time in second.
+ default: "1"
+ It is schema lease time used in online schema change. Its value will affact DDL statement running time. It is very dangerous to change it if you don't understand the internal mechanism.

### --socket
+ The socket file to use for connection.
+ default: ""
+ example: "/tmp/tidb.sock"

### --perfschema
+ Enable(1) or disable(0) performance schema.
+ default: "0"
+ If set this to 1, it will affect performance.

### TIDB_PPROF environment variable
+ Enable runtime profiling data via HTTP server. Address is at client URL + "/debug/pprof/"
+ If set $TIDB_PPROF to 0, TiDB will disable pprof. Otherwise TiDB will enable pprof.