Skip to main content

Meta Configurations

This page describes the Meta configurations available in the databend-meta.toml configuration file.

databend-meta.toml
# Usage:
# databend-meta -c databend-meta.toml

admin_api_address       = "0.0.0.0:28101"
grpc_api_address        = "0.0.0.0:9191"
# databend-query fetch this address to update its databend-meta endpoints list,
# in case databend-meta cluster changes.
grpc_api_advertise_host = "127.0.0.1"

[raft_config]
id            = 1
raft_dir      = "/var/lib/databend/raft"
raft_api_port = 28103

# Assign raft_{listen|advertise}_host in test config.
# This allows you to catch a bug in unit tests when something goes wrong in raft meta nodes communication.
raft_listen_host = "127.0.0.1"
raft_advertise_host = "localhost"

# Start up mode: single node cluster
single        = true

  • Some parameters listed in the table below may not be present in databend-meta.toml. If you require these parameters, you can manually add them to the file.

  • You can find sample configuration files on GitHub that set up Databend for various deployment environments. These files were created for internal testing ONLY. Please do NOT modify them for your own purposes. But if you have a similar deployment, it is a good idea to reference them when editing your own configuration files.

ParameterDescription
admin_api_addressIP address and port for the admin API of Databend.
admin_tls_server_certPath to the admin TLS server certificate file.
admin_tls_server_keyPath to the admin TLS server key file.
grpc_api_addressIP address and port for the gRPC API of Databend.
grpc_api_advertise_hostIP address used for advertising the gRPC API (used for updating Databend-meta endpoints).
grpc_tls_server_certPath to the gRPC TLS server certificate file.
grpc_tls_server_keyPath to the gRPC TLS server key file.
[log.file] onEnable file-based logging (true or false). Default: true
[log.file] levelLog level for file-based logging (e.g., "DEBUG", "INFO"). Default: "DEBUG"
[log.file] dirDirectory where log files will be stored. Default: "./.databend/logs"
[log.file] formatLog format for file-based logging (e.g., "json", "text"). Default: "json"
[log.stderr] onEnable stderr logging (true or false). Default: true
[log.stderr] levelLog level for stderr logging (e.g., "DEBUG", "INFO"). Default: "DEBUG"
[log.stderr] formatLog format for stderr logging (e.g., "text", "json"). Default: "text"
[raft_config] idUnique identifier for the Raft configuration.
[raft_config] raft_dirDirectory where Raft data is stored.
[raft_config] raft_api_portPort for the Raft API of Databend.
[raft_config] raft_listen_hostIP address for Raft to listen on.
[raft_config] raft_advertise_hostIP address used for advertising the Raft API.
[raft_config] singleBoolean indicating whether Databend should run in single-node cluster mode (true or false).
[raft_config] joinList of addresses (<raft_advertise_host>:<raft_api_port>) of nodes in an existing cluster that a new node is joined to.
[raft_config] heartbeat_intervalHeartbeat interval in milliseconds. Default: 1000
[raft_config] install_snapshot_timeoutInstall snapshot timeout in milliseconds. Default: 4000
[raft_config] max_applied_log_to_keepMaximum number of applied Raft logs to keep. Default: 1000
[raft_config] snapshot_logs_since_lastNumber of Raft logs since the last snapshot. Default: 1024
[raft_config] wait_leader_timeoutWait leader timeout in milliseconds. Default: 70000