influxdb3 CLI
The influxdb3 CLI runs and interacts with the InfluxDB 3 Enterprise server.
Usage
influxdb3 [GLOBAL-OPTIONS] [COMMAND]Commands
| Command | Description |
|---|---|
| create | Create resources |
| debug | Diagnostic tools |
| delete | Delete resources |
| disable | Disable resources |
| enable | Enable resources |
| import | Manage bulk Parquet imports |
| install | Install plugins |
| query | Query InfluxDB 3 Enterprise |
| serve | Run the InfluxDB 3 Enterprise server |
| show | List resources |
| stop | Mark nodes as stopped |
| test | Test plugins |
| update | Update resources |
| write | Write to InfluxDB 3 Enterprise |
Global options
| Option | Description | |
|---|---|---|
-h | --help | Print help information |
--help-all | Print detailed help information including runtime configuration options | |
-V | --version | Print version |
For advanced global configuration options (including --num-io-threads and other runtime settings), see Configuration options.
Quick-Start Mode
For development, testing, and home use, you can start InfluxDB 3 Enterprise by running influxdb3 without the serve subcommand or any configuration parameters. The system automatically generates required values:
node-id:{hostname}-node(fallback:primary-node)cluster-id:{hostname}-cluster(fallback:primary-cluster)object-store:filedata-dir:~/.influxdb
The system displays warning messages showing the auto-generated identifiers:
Using auto-generated node id: mylaptop-node. For production deployments, explicitly set --node-id
Using auto-generated cluster id: mylaptop-cluster. For production deployments, explicitly set --cluster-idProduction deployments
Quick-start mode is designed for development and testing environments.
For production deployments, use explicit configuration with the serve subcommand
and specify all required parameters as shown in the Examples below.
Configuration precedence: CLI flags > environment variables > auto-generated defaults
For more information about quick-start mode, see Get started.
Examples
In the examples below, replace the following:
my-host-01: a unique identifier for your InfluxDB 3 Enterprise server.my-cluster-01: a unique identifier for your InfluxDB 3 Enterprise cluster. The value you use must be different from--node-idvalues in the cluster.
Quick-start influxdb3 server
# Zero-config startup
influxdb3
# Override specific defaults
influxdb3 --object-store memory
# Use environment variables to override defaults
INFLUXDB3_NODE_IDENTIFIER_PREFIX=my-node influxdb3Run the InfluxDB 3 server
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01Run the InfluxDB 3 server with custom IO threads
influxdb3 --num-io-threads=8 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01Display short-form help for all commands
influxdb3 -hDisplay long-form help for all commands
influxdb3 --helpRun the InfluxDB 3 Enterprise server with extra verbose logging
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01 \
--verboseRun InfluxDB 3 Enterprise with debug logging using LOG_FILTER
LOG_FILTER=debug influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01Was this page helpful?
Thank you for your feedback!
Support and feedback
Thank you for being part of our community! We welcome and encourage your feedback and bug reports for InfluxDB 3 Enterprise and this documentation. To find support, use the following resources:
Customers with an annual or support contract can contact InfluxData Support. Customers using a trial license can email trial@influxdata.com for assistance.