Documentation

influxdb3 test wal_plugin

InfluxDB 3 Enterprise is in Public Alpha

InfluxDB 3 Enterprise is in public alpha and available for testing and feedback, but is not meant for production use. Both the product and this documentation are works in progress. We welcome and encourage your input about your experience with the alpha and invite you to join our public channels for updates and to share feedback.

Alpha expectations and recommendations

The influxdb3 test wal_plugin command tests a write-ahead log (WAL) plugin.

Usage

influxdb3 test wal_plugin [OPTIONS] --database <DATABASE_NAME> <PLUGIN_NAME>

Arguments

  • PLUGIN_NAME: The name of the plugin file on the server–for example: <plugin-dir>/<plugin-file-name>.py

Options

OptionDescription
-H--hostHost URL of the running InfluxDB 3 Enterprise server (default is http://127.0.0.1:8181)
-d--database(Required) Name of the database to operate on
--tokenAuthentication token
--lpLine protocol to use as input
--fileLine protocol file to use as input
--input-argumentsMap of string key-value pairs as to use as plugin input arguments
-h--helpPrint help information

Option environment variables

You can use the following environment variables to set command options:

Environment VariableOption
INFLUXDB3_HOST_URL--host
INFLUXDB3_DATABASE_NAME--database
INFLUXDB3_AUTH_TOKEN--token

Examples

In the examples below, replace the following:

  • DATABASE_NAME: Database name
  • PLUGIN_DIR: Plugin directory name
  • PLUGIN_NAME: Plugin file name

Test a WAL plugin

influxdb3 test wal_plugin \
  --database 
DATABASE_NAME
\
PLUGIN_DIR
/
PLUGIN_NAME
.py

Test a WAL plugin with a line protocol string

influxdb3 test wal_plugin \
  --lp 'home,room=Kitchen temp=21.0,hum=35.9,co=0i' \
  --database 
DATABASE_NAME
\
PLUGIN_DIR
/
PLUGIN_NAME
.py

Test a WAL plugin with a file containing line protocol

influxdb3 test wal_plugin \
  --file 
PLUGIN_DIR
/
PLUGIN_NAME
_test/input-file.lp`
--database
DATABASE_NAME
\
PLUGIN_DIR
/
PLUGIN_NAME
.py

Test a WAL plugin using input arguments

influxdb3 test wal_plugin \
  --input-arguments arg1=foo,arg2=baz \
  --database 
DATABASE_NAME
\
PLUGIN_DIR
/
PLUGIN_NAME
.py

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

InfluxDB 3 Open Source Now in Public Alpha

InfluxDB 3 Open Source is now available for alpha testing, licensed under MIT or Apache 2 licensing.

We are releasing two products as part of the alpha.

InfluxDB 3 Core, is our new open source product. It is a recent-data engine for time series and event data. InfluxDB 3 Enterprise is a commercial version that builds on Core’s foundation, adding historical query capability, read replicas, high availability, scalability, and fine-grained security.

For more information on how to get started, check out: