docs-v2/content/shared/influxdb3-cli/delete/file_index.md

64 lines
2.1 KiB
Markdown

The `influxdb3 delete file_index` command deletes a file index for a
database or table.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 delete file_index [OPTIONS] --database <DATABASE_NAME>
```
## Options
| Option | | Description |
| :----- | :----------- | :--------------------------------------------------------------------------------------- |
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
| | `--token` | Authentication token |
| `-t` | `--table` | Table to delete the file index from |
| `-h` | `--help` | Print 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` |
## Examples
- [Delete a file index from a database](#delete-a-file-index-from-a-database)
- [Delete a file index from a specific table](#delete-a-file-index-from-a-specific-table)
In the examples below, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Table name
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
### Delete a file index from a database
<!--pytest.mark.skip-->
```bash
influxdb3 delete file_index --database DATABASE_NAME
```
### Delete a file index from a specific table
<!--pytest.mark.skip-->
```bash
influxdb3 delete file_index --database DATABASE_NAME --table TABLE_NAME
```
{{% /code-placeholders %}}