---
title: influxdb3 test wal_plugin
description: The influxdb3 test wal_plugin command tests a write-ahead log (WAL) plugin.
url: https://docs.influxdata.com/influxdb3/enterprise/reference/cli/influxdb3/test/wal_plugin/
estimated_tokens: 1199
product: InfluxDB 3 Enterprise
version: enterprise
publisher: InfluxData
canonical: https://docs.influxdata.com/influxdb3/enterprise/reference/cli/influxdb3/test/wal_plugin/
date: '2025-01-13T07:21:11-07:00'
lastmod: '2025-01-13T07:21:11-07:00'
---

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

## Usage

```bash
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

|Option|                   |                                                 Description                                                 |
|------|-------------------|-------------------------------------------------------------------------------------------------------------|
| `-H` |     `--host`      |          Host 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                               |
|      |     `--token`     |                                      *(Required)* Authentication token                                      |
|      |      `--lp`       |                                        Line protocol to use as input                                        |
|      |     `--file`      |                                     Line protocol file to use as input                                      |
|      |`--input-arguments`|                      Map of string key-value pairs as to use as plugin input arguments                      |
|      |    `--tls-ca`     |            Path to a custom TLS certificate authority (for testing or self-signed certificates)             |
|      | `--tls-no-verify` |Disable TLS certificate verification (**Not recommended in production**, useful for self-signed certificates)|
| `-h` |     `--help`      |                                           Print help information                                            |
|      |   `--help-all`    |                                       Print detailed help information                                       |

### Option environment variables

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

|  Environment Variable   |     Option      |
|-------------------------|-----------------|
|  `INFLUXDB3_HOST_URL`   |    `--host`     |
|`INFLUXDB3_DATABASE_NAME`|  `--database`   |
| `INFLUXDB3_AUTH_TOKEN`  |    `--token`    |
|`INFLUXDB3_TLS_NO_VERIFY`|`--tls-no-verify`|

## Examples

* [Test a WAL plugin](#test-a-wal-plugin)
* [Test a WAL plugin with a line protocol string](#test-a-wal-plugin-with-a-line-protocol-string)
* [Test a WAL plugin with a file containing line protocol](#test-a-wal-plugin-with-a-file-containing-line-protocol)
* [Test a WAL plugin using input arguments](#test-a-wal-plugin-using-input-arguments)

In the examples below, replace the following:

* `DATABASE_NAME`:
  Database name
* `AUTH_TOKEN`:
  Authentication token
* `PLUGIN_DIR`:
  Plugin directory name
* `PLUGIN_NAME`:
  Plugin file name

### Test a WAL plugin

```bash
influxdb3 test wal_plugin \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  PLUGIN_DIR/PLUGIN_NAME.py
```

### Test a WAL plugin with a line protocol string

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

### Test a WAL plugin with a file containing line protocol

```bash
influxdb3 test wal_plugin \
  --file PLUGIN_DIR/PLUGIN_NAME_test/input-file.lp`
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  PLUGIN_DIR/PLUGIN_NAME.py
```

### Test a WAL plugin using input arguments

```bash
influxdb3 test wal_plugin \
  --input-arguments arg1=foo,arg2=baz \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  PLUGIN_DIR/PLUGIN_NAME.py
```
| Option |  | Description |
| --- | --- | --- |
| Option |  | Description |
| -H | --host | Host 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 |
|  | --token | ( Required )  Authentication token |
|  | --lp | Line protocol to use as input |
|  | --file | Line protocol file to use as input |
|  | --input-arguments | Map of string key-value pairs as to use as plugin input arguments |
|  | --tls-ca | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
|  | --tls-no-verify | Disable TLS certificate verification ( Not recommended in production , useful for self-signed certificates) |
| -h | --help | Print help information |
|  | --help-all | Print detailed help information |

| Environment Variable | Option |
| --- | --- |
| Environment Variable | Option |
| INFLUXDB3_HOST_URL | --host |
| INFLUXDB3_DATABASE_NAME | --database |
| INFLUXDB3_AUTH_TOKEN | --token |
| INFLUXDB3_TLS_NO_VERIFY | --tls-no-verify |
