Documentation

influxdb3 query

The influxdb3 query command executes a query against a running InfluxDB 3 Core server.

Usage

influxdb3 query [OPTIONS] --database <DATABASE_NAME> [QUERY]...
  • Copy
  • Fill window
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 InfluxDB 3 Core server (default is http://127.0.0.1:8181)
-d--database(Required) Name of the database to operate on
--token(Required) 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)
-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

Examples

In the examples below, replace DATABASE_NAME: with the name of the database to query.

Query data using SQL

influxdb3 query \
  --database 
DATABASE_NAME
\
--token AUTH_TOKEN \ 'SELECT * FROM home'
  • Copy
  • Fill window
influxdb3 query \
  --database 
DATABASE_NAME
\
--token AUTH_TOKEN \ --file ./query.sql
  • Copy
  • Fill window
cat ./query.sql | influxdb3 query \
  --database 
DATABASE_NAME
\
--token AUTH_TOKEN \
  • Copy
  • Fill window

Query data using InfluxQL

influxdb3 query \
  --language influxql \
  --database 
DATABASE_NAME
\
--token AUTH_TOKEN \ 'SELECT * FROM home'
  • Copy
  • Fill window
influxdb3 query \
  --language influxql \
  --database 
DATABASE_NAME
\
--token AUTH_TOKEN \ --file ./query.influxql
  • Copy
  • Fill window
cat ./query.influxql | influxdb3 query \
  --language influxql \
  --database 
DATABASE_NAME
\
--token AUTH_TOKEN
  • Copy
  • Fill window

Query data and return JSON-formatted results

influxdb3 query \
  --format json \
  --database 
DATABASE_NAME
\
--token AUTH_TOKEN \ 'SELECT * FROM home'
  • Copy
  • Fill window
influxdb3 query \
  --format json \
  --database 
DATABASE_NAME
\
--token AUTH_TOKEN \ --file ./query.sql
  • Copy
  • Fill window
cat ./query.sql | influxdb3 query \
  --format json \
  --database 
DATABASE_NAME
\
--token AUTH_TOKEN \
  • Copy
  • Fill window

Query data and write results to a file

influxdb3 query \
  --output /path/to/results.txt \
  --database 
DATABASE_NAME
\
--token AUTH_TOKEN \ 'SELECT * FROM home'
  • Copy
  • Fill window
influxdb3 query \
  --output /path/to/results.txt \
  --database 
DATABASE_NAME
\
--token AUTH_TOKEN \ --file ./query.sql
  • Copy
  • Fill window
cat ./query.sql | influxdb3 query \
  --output /path/to/results.txt \
  --database 
DATABASE_NAME
\
--token AUTH_TOKEN
  • Copy
  • Fill window

Was this page helpful?

Thank you for your feedback!


The future of Flux

Flux is going into maintenance mode. You can continue using it as you currently are without any changes to your code.

Read more

Now Generally Available

InfluxDB 3 Core and Enterprise

Start fast. Scale faster.

Get the Updates

InfluxDB 3 Core is an open source, high-speed, recent-data engine that collects and processes data in real-time and persists it to local disk or object storage. InfluxDB 3 Enterprise builds on Core’s foundation, adding high availability, read replicas, enhanced security, and data compaction for faster queries and optimized storage. A free tier of InfluxDB 3 Enterprise is available for non-commercial at-home or hobbyist use.

For more information, check out: