73 lines
2.3 KiB
Markdown
73 lines
2.3 KiB
Markdown
|
|
The `influxdb3 create file_index` command creates a new file index for a
|
|
database or table.
|
|
|
|
## Usage
|
|
|
|
<!--pytest.mark.skip-->
|
|
|
|
```bash
|
|
influxdb3 create file_index [OPTIONS] --database <DATABASE_NAME> <COLUMNS>...
|
|
```
|
|
|
|
## Arguments
|
|
|
|
- **COLUMNS**: The columns to use for the file index.
|
|
|
|
## 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 apply the file index too |
|
|
| `-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
|
|
|
|
- [Create a new file index for a database](#create-a-new-file-index-for-a-database)
|
|
- [Create a new file index for a specific table](#create-a-new-file-index-for-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" %}}
|
|
|
|
### Create a new file index for a database
|
|
|
|
<!--pytest.mark.skip-->
|
|
|
|
```bash
|
|
influxdb3 create file_index \
|
|
--database DATABASE_NAME \
|
|
column1 column2 column3
|
|
```
|
|
|
|
### Create a new file index for a specific table
|
|
|
|
<!--pytest.mark.skip-->
|
|
|
|
```bash
|
|
influxdb3 create file_index \
|
|
--database DATABASE_NAME \
|
|
--table TABLE_NAME \
|
|
column1 column2 column3
|
|
```
|
|
|
|
{{% /code-placeholders %}}
|