Sign InTry Free

Configuration Options

When you start the TiDB cluster, you can use command-line options or environment variables to configure it. This document introduces TiDB's command options. The default TiDB ports are 4000 for client requests and 10080 for status report.


  • The IP address through which to log into the TiDB server
  • Default: ""
  • This address must be accessible by the rest of the TiDB cluster and the user.


  • The TiDB services use the unix socket file for internal connections, such as the Pump service
  • Default: ""
  • You can use "/tmp/pump.sock" to accept the communication of Pump unix socket file.


  • The configuration file
  • Default: ""
  • If you have specified the configuration file, TiDB reads the configuration file. If the corresponding configuration also exists in the command line options, TiDB uses the configuration in the command line options to overwrite that in the configuration file. For detailed configuration information, see TiDB Configuration File Description.


  • The host address that the TiDB server monitors
  • Default: ""
  • The TiDB server monitors this address.
  • The "" monitors all network cards by default. If you have multiple network cards, specify the network card that provides service, such as


  • The log level
  • Default: "info"
  • You can choose from "debug", "info", "warn", "error", or "fatal".


  • The log file
  • Default: ""
  • If this option is not set, logs are output to "stderr". If this option is set, logs are output to the corresponding file, which is automatically rotated in the early morning every day, and the previous file is renamed as a backup.


  • The directory for the slow query log
  • Default: ""
  • If this option is not set, logs are written to the file specified by --log-file by default.


  • The Prometheus Pushgateway address

  • Default: ""

  • Leaving it empty stops the Prometheus client from pushing.

  • The format is:



  • The Prometheus client push interval in seconds
  • Default: 15s
  • Setting the value to 0 stops the Prometheus client from pushing.


  • The monitoring port of TiDB services
  • Default: "4000"
  • The TiDB server accepts MySQL client requests from this port.


  • The path to the data directory for local storage engine like "mocktikv"
  • For --store = tikv, you must specify the path; for --store = mocktikv, the default value is used if you do not specify the path.
  • For the distributed storage engine like TiKV, --path specifies the actual PD address. Assuming that you deploy the PD server on, and, the value of --path is ",,".
  • Default: "/tmp/tidb"
  • You can use tidb-server --store=mocktikv --path="" to enable a pure in-memory TiDB.


  • The list of proxy server's IP addresses allowed by PROXY Protocol; if you need to configure multiple addresses, separate them using ",".
  • Default: ""
  • Leaving it empty disables PROXY Protocol. The value can be the IP address ( or CIDR ( "*" means any IP addresses.


  • Timeout for the PROXY protocol header read
  • Default: 5 (seconds)
  • Generally use the default value and do not set its value to 0. The unit is second.


  • To enable(true) or disable(false) the status report and pprof tool
  • Default: true
  • The value can be (true) or (false). (true) is to enable metrics and pprof. (false) is to disable metrics and pprof.


  • To see whether the tidb-server runs DDL statements, and set when the number of tidb-server is over two in the cluster
  • Default: true
  • The value can be (true) or (false). (true) indicates the tidb-server runs DDL itself. (false) indicates the tidb-server does not run DDL itself.

--socket string

  • The TiDB services use the unix socket file for external connections.
  • Default: ""
  • You can use “/tmp/tidb.sock” to open the unix socket file.



  • To specify the storage engine used by TiDB in the bottom layer
  • Default: "mocktikv"
  • You can choose "mocktikv" or "tikv". ("mocktikv" is the local storage engine; "tikv" is a distributed storage engine)


  • The number of sessions allowed to run concurrently in TiDB. It is used for traffic control.
  • Default: 1000
  • If the number of the concurrent sessions is larger than token-limit, the request is blocked and waiting for the operations which have been finished to release tokens.


  • Output the version of TiDB
  • Default: ""
Download PDF
One-stop & interactive experience of TiDB's capabilities WITHOUT registration.
TiDB Dedicated
TiDB Serverless
Get Demo
Get Started
© 2024 PingCAP. All Rights Reserved.
Privacy Policy.