ContextQMD
Back to Influxdb

Query

content/shared/influxdb3-cli/query.md

latest5.8 KB
Original Source

The influxdb3 query command executes a query against a running {{< product-name >}} server.

Usage

<!--pytest.mark.skip-->
bash
influxdb3 query [OPTIONS] --database <DATABASE_NAME> [QUERY]...
Aliases

query, q

Arguments

  • QUERY: The query to execute. Provide the query in one of the following ways:

    • a string
    • a path to a file that contains the query using the --file option
    • from stdin

Options

OptionDescription
-H--hostHost 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
-l--languageQuery language of the query string (sql (default) or influxql)
--formatOutput format (pretty (default), json, jsonl, csv, parquet)
-o--outputOutput query results to the specified file
-f--fileA file that contains the query to execute
--tls-caPath to a custom TLS certificate authority (for testing or self-signed certificates)
--tls-no-verifyDisable TLS certificate verification (Not recommended in production, useful for self-signed certificates)
-h--helpPrint help information
--help-allPrint detailed help information

Option environment variables

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

Environment VariableOption
INFLUXDB3_HOST_URL--host
INFLUXDB3_DATABASE_NAME--database
INFLUXDB3_AUTH_TOKEN--token
INFLUXDB3_TLS_NO_VERIFY--tls-no-verify

Examples

In the examples below, replace {{% code-placeholder-key %}}DATABASE_NAME{{% /code-placeholder-key %}}: with the name of the database to query.

{{% code-placeholders "DATABASE_NAME" %}}

Query data using SQL

{{< code-tabs-wrapper >}} {{% code-tabs %}} string file stdin {{% /code-tabs %}} {{% code-tab-content %}}

<!--pytest.mark.skip-->
bash
influxdb3 query \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  'SELECT * FROM home'

{{% /code-tab-content %}} {{% code-tab-content %}}

<!--pytest.mark.skip-->
bash
influxdb3 query \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  --file ./query.sql

{{% /code-tab-content %}} {{% code-tab-content %}}

<!--pytest.mark.skip-->
bash
cat ./query.sql | influxdb3 query \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \

{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}

Query data using InfluxQL

{{< code-tabs-wrapper >}} {{% code-tabs %}} string file stdin {{% /code-tabs %}} {{% code-tab-content %}}

<!--pytest.mark.skip-->
bash
influxdb3 query \
  --language influxql \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  'SELECT * FROM home'

{{% /code-tab-content %}} {{% code-tab-content %}}

<!--pytest.mark.skip-->
bash
influxdb3 query \
  --language influxql \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  --file ./query.influxql

{{% /code-tab-content %}} {{% code-tab-content %}}

<!--pytest.mark.skip-->
bash
cat ./query.influxql | influxdb3 query \
  --language influxql \
  --database DATABASE_NAME \
  --token AUTH_TOKEN

{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}

Query data and return JSON-formatted results

{{< code-tabs-wrapper >}} {{% code-tabs %}} string file stdin {{% /code-tabs %}} {{% code-tab-content %}}

<!--pytest.mark.skip-->
bash
influxdb3 query \
  --format json \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  'SELECT * FROM home'

{{% /code-tab-content %}} {{% code-tab-content %}}

<!--pytest.mark.skip-->
bash
influxdb3 query \
  --format json \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  --file ./query.sql

{{% /code-tab-content %}} {{% code-tab-content %}}

<!--pytest.mark.skip-->
bash
cat ./query.sql | influxdb3 query \
  --format json \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \

{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}

Query data and write results to a file

{{< code-tabs-wrapper >}} {{% code-tabs %}} string file stdin {{% /code-tabs %}} {{% code-tab-content %}}

<!--pytest.mark.skip-->
bash
influxdb3 query \
  --output /path/to/results.txt \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  'SELECT * FROM home'

{{% /code-tab-content %}} {{% code-tab-content %}}

<!--pytest.mark.skip-->
bash
influxdb3 query \
  --output /path/to/results.txt \
  --database DATABASE_NAME \
  --token AUTH_TOKEN \
  --file ./query.sql

{{% /code-tab-content %}} {{% code-tab-content %}}

<!--pytest.mark.skip-->
bash
cat ./query.sql | influxdb3 query \
  --output /path/to/results.txt \
  --database DATABASE_NAME \
  --token AUTH_TOKEN

{{% /code-tab-content %}} {{< /code-tabs-wrapper >}}

{{% /code-placeholders %}}