Documentation

influxdb3 CLI

The influxdb3 CLI runs and interacts with the InfluxDB 3 Enterprise server.

Usage

influxdb3 [GLOBAL-OPTIONS] [COMMAND]

Commands

CommandDescription
createCreate resources
deleteDelete resources
disableDisable resources
enableEnable resources
queryQuery InfluxDB 3 Enterprise
serveRun the InfluxDB 3 Enterprise server
showList resources
testTest plugins
writeWrite to InfluxDB 3 Enterprise

Global options

OptionDescription
--num-threadsMaximum number of IO runtime threads to use
--io-runtime-typeIO tokio runtime type (current-thread, multi-thread (default), or multi-thread-alt)
--io-runtime-disable-lifo-slotDisable LIFO slot of IO runtime
--io-runtime-event-intervalNumber of scheduler ticks after which the IOtokio runtime scheduler will poll for external events
--io-runtime-global-queue-intervalNumber of scheduler ticks after which the IO runtime scheduler will poll the global task queue
--io-runtime-max-blocking-threadsLimit for additional threads spawned by the IO runtime
--io-runtime-max-io-events-per-tickMaximum number of events to be processed per tick by the tokio IO runtime
--io-runtime-thread-keep-aliveCustom timeout for a thread in the blocking pool of the tokio IO runtime
--io-runtime-thread-prioritySet thread priority tokio IO runtime workers
-h--helpPrint help information
--help-allPrint detailed help information
-V--versionPrint version

Option environment variables

You can use the following environment variables to set influxdb3 global options:

Environment VariableOption
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-id values 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!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

Now Generally Available

InfluxDB 3 Core and Enterprise

Start fast. Scale faster.

Get the Updates

InfluxDB 3 Core is an open source, high-speed, recent-data engine that collects and processes data in real-time and persists it to local disk or object storage. InfluxDB 3 Enterprise builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries and optimized storage. A free tier of InfluxDB 3 Enterprise is available for non-commercial at-home or hobbyist use.

For more information, check out: