Documentation

influxdb3 query

InfluxDB 3 Enterprise is in Public Alpha

InfluxDB 3 Enterprise is in public alpha and available for testing and feedback, but is not meant for production use. Both the product and this documentation are works in progress. We welcome and encourage your input about your experience with the alpha and invite you to join our public channels for updates and to share feedback.

Alpha expectations and recommendations

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

Usage

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 InfluxDB 3 Enterprise server (default is http://127.0.0.1:8181)
-d--database(Required) Name of the database to operate on
--tokenAuthentication 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
-h--helpPrint 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
'SELECT * FROM home'
influxdb3 query --database 
DATABASE_NAME
--file ./query.sql
cat ./query.sql | influxdb3 query --database 
DATABASE_NAME

Query data using InfluxQL

influxdb3 query \
  --language influxql \
  --database 
DATABASE_NAME
\
'SELECT * FROM home'
influxdb3 query \
  --language influxql \
  --database 
DATABASE_NAME
\
--file ./query.influxql
cat ./query.influxql | influxdb3 query \
  --language influxql \
  --database 
DATABASE_NAME

Query data and return JSON-formatted results

influxdb3 query \
  --format json \
  --database 
DATABASE_NAME
\
'SELECT * FROM home'
influxdb3 query \
  --format json \
  --database 
DATABASE_NAME
\
--file ./query.sql
cat ./query.sql | influxdb3 query \
  --format json \
  --database 
DATABASE_NAME

Query data and write results to a file

influxdb3 query \
  --output /path/to/results.txt \
  --database 
DATABASE_NAME
\
'SELECT * FROM home'
influxdb3 query \
  --output /path/to/results.txt \
  --database 
DATABASE_NAME
\
--file ./query.sql
cat ./query.sql | influxdb3 query \
  --output /path/to/results.txt \
  --database 
DATABASE_NAME

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

InfluxDB 3 Open Source Now in Public Alpha

InfluxDB 3 Open Source is now available for alpha testing, licensed under MIT or Apache 2 licensing.

We are releasing two products as part of the alpha.

InfluxDB 3 Core, is our new open source product. It is a recent-data engine for time series and event data. InfluxDB 3 Enterprise is a commercial version that builds on Core’s foundation, adding historical query capability, read replicas, high availability, scalability, and fine-grained security.

For more information on how to get started, check out: