docs-v2/content/shared/influxdb3-cli/_index.md

The influxdb3 CLI runs and interacts with the {{< product-name >}} server.

Usage

influxdb3 [GLOBAL-OPTIONS] [COMMAND]

Commands

Command	Description
create	Create resources
delete	Delete resources
disable	Disable resources
enable	Enable resources
query	Query {{% product-name %}}
serve	Run the {{% product-name %}} server
show	List resources
test	Test plugins
write	Write to {{% product-name %}}

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

Run the InfluxDB 3 server

influxdb3 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --writer-id MY_HOST_NAME

Display short-form help for all commands

influxdb3 -h

Display long-form help for all commands

influxdb3 --help

Run the {{< product-name >}} server with extra verbose logging

influxdb3 serve -v \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --writer-id MY_HOST_NAME

Run {{< product-name >}} with debug logging using LOG_FILTER

LOG_FILTER=debug influxdb3 serve \
  --object-store file \
  --data-dir ~/.influxdb3 \
  --writer-id MY_HOST_NAME