influxdb3 CLI
InfluxDB 3 Enterprise is in Public Beta
InfluxDB 3 Enterprise is in public beta and available for testing and feedback, but is not meant for production use yet. Both the product and this documentation are works in progress. We welcome and encourage your input about your experience with the beta and invite you to join our public channels for updates and to share feedback.
The influxdb3 CLI runs and interacts with the InfluxDB 3 Enterprise server.
Usage
influxdb3 [GLOBAL-OPTIONS] [COMMAND]
Commands
| Command | Description |
|---|---|
| create | Create resources |
| delete | Delete resources |
| disable | Disable resources |
| enable | Enable resources |
| query | Query InfluxDB 3 Enterprise |
| serve | Run the InfluxDB 3 Enterprise server |
| show | List resources |
| test | Test plugins |
| write | Write to InfluxDB 3 Enterprise |
Global options
| Option | Description | |
|---|---|---|
--num-threads | Maximum number of IO runtime threads to use | |
--io-runtime-type | IO tokio runtime type (current-thread, multi-thread (default), or multi-thread-alt) | |
--io-runtime-disable-lifo-slot | Disable LIFO slot of IO runtime | |
--io-runtime-event-interval | Number of scheduler ticks after which the IOtokio runtime scheduler will poll for external events | |
--io-runtime-global-queue-interval | Number of scheduler ticks after which the IO runtime scheduler will poll the global task queue | |
--io-runtime-max-blocking-threads | Limit for additional threads spawned by the IO runtime | |
--io-runtime-max-io-events-per-tick | Maximum number of events to be processed per tick by the tokio IO runtime | |
--io-runtime-thread-keep-alive | Custom timeout for a thread in the blocking pool of the tokio IO runtime | |
--io-runtime-thread-priority | Set thread priority tokio IO runtime workers | |
-h | --help | Print help information |
-V | --version | Print version |
Option environment variables
You can use the following environment variables to set influxdb3 global options:
| Environment Variable | Option |
|---|---|
INFLUXDB3_NUM_THREADS | --num-threads |
INFLUXDB3_IO_RUNTIME_TYPE | --io-runtime-type |
INFLUXDB3_IO_RUNTIME_DISABLE_LIFO_SLOT | --io-runtime-disable-lifo-slot |
INFLUXDB3_IO_RUNTIME_EVENT_INTERVAL | --io-runtime-event-interval |
INFLUXDB3_IO_RUNTIME_GLOBAL_QUEUE_INTERVAL | --io-runtime-global-queue-interval |
INFLUXDB3_IO_RUNTIME_MAX_BLOCKING_THREADS | --io-runtime-max-blocking-threads |
INFLUXDB3_IO_RUNTIME_MAX_IO_EVENTS_PER_TICK | --io-runtime-max-io-events-per-tick |
INFLUXDB3_IO_RUNTIME_THREAD_KEEP_ALIVE | --io-runtime-thread-keep-alive |
INFLUXDB3_IO_RUNTIME_THREAD_PRIORITY | --io-runtime-thread-priority |
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.
Run the InfluxDB 3 server
influxdb3 serve \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01
Display short-form help for all commands
influxdb3 -h
Display long-form help for all commands
influxdb3 --help
Run the InfluxDB 3 Enterprise server with extra verbose logging
influxdb3 serve -v \
--object-store file \
--data-dir ~/.influxdb3 \
--node-id my-host-01 \
--cluster-id my-cluster-01
Run 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-01
Was 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.