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

55 lines
1.7 KiB
Markdown

The `influxdb3 delete table` command deletes a table from a database.
## Usage
<!--pytest.mark.skip-->
```bash
influxdb3 delete table [OPTIONS] --database <DATABASE_NAME> <TABLE_NAME>
```
## Arguments
- **TABLE_NAME**: The name of the table to delete.
## 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 |
| `-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 table
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
<!--pytest.mark.skip-->
```bash
influxdb3 delete table --database DATABASE_NAME TABLE_NAME
```
{{% /code-placeholders %}}
In the example above, replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
Database name
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
Name of the table to delete