2.8 KiB
2.8 KiB
The influxdb3 query
command executes a query against a running
{{< product-name >}} server.
Usage
influxdb3 query [OPTIONS] --database <DATABASE_NAME> [QUERY]...
Aliases
query
, q
Arguments
- QUERY: The query string to execute.
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 | |
-l |
--language |
Query language of the query string (sql (default) or influxql ) |
--format |
Output format (pretty (default), json , json_lines , csv , parquet ) |
|
-o |
--output |
Output query results to the specified file |
-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
- Query data using SQL
- Query data using InfluxQL
- Query data and return JSON-formatted results
- Query data and write results to a file
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
influxdb3 query --database DATABASE_NAME 'SELECT * FROM home'
Query data using InfluxQL
influxdb3 query \
--language influxql \
--database DATABASE_NAME \
'SELECT * FROM home'
Query data and return JSON-formatted results
influxdb3 query \
--format json \
--database DATABASE_NAME \
'SELECT * FROM home'
Query data and write results to a file
influxdb3 query \
--output /path/to/results.txt \
--database DATABASE_NAME \
'SELECT * FROM home'
{{% /code-placeholders %}}