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

2.7 KiB

The influxdb3 create file_index command creates a new file index for a database or table.

Usage

influxdb3 create file_index [OPTIONS] \
  --database <DATABASE_NAME> \
  --token <AUTH_TOKEN> \
  <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 ({{< req >}}) Authentication token
-t --table Table to apply the file index too
--tls-ca Path to a custom TLS certificate authority (for testing or 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

Examples

In the examples below, replace the following:

  • {{% code-placeholder-key %}}DATABASE_NAME{{% /code-placeholder-key %}}: Database name
  • {{% code-placeholder-key %}}AUTH_TOKEN{{% /code-placeholder-key %}}: Authentication token
  • {{% code-placeholder-key %}}TABLE_NAME{{% /code-placeholder-key %}}: Table name

{{% code-placeholders "(DATABASE|TABLE)_NAME|AUTH_TOKEN" %}}

Create a new file index for a database

influxdb3 create file_index \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  column1 column2 column3

Create a new file index for a specific table

influxdb3 create file_index \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  --table TABLE_NAME \
  column1 column2 column3

{{% /code-placeholders %}}