Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
docs-v2/content/influxdb/v2.1/query-data/influxql.md

9.2 KiB
Raw Blame History

title description weight influxdb/v2.1/tags menu related
Query data with InfluxQL Use the [InfluxDB 1.x `/query` compatibility endpoint](/influxdb/v2.1/reference/api/influxdb-1x/query) to query data in InfluxDB Cloud and InfluxDB OSS 2.1 with **InfluxQL**. 102
influxql
query
influxdb_2_1
name parent
Query with InfluxQL Query data
/influxdb/v2.1/reference/api/influxdb-1x/
/influxdb/v2.1/reference/api/influxdb-1x/query
/influxdb/v2.1/reference/api/influxdb-1x/dbrp

In InfluxDB 1.x, data is stored in [databases](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#database) and [retention policies](/{{< latest "influxdb" "v1" >}}/concepts/glossary/#retention-policy-rp). In InfluxDB OSS {{< current-version >}}, data is stored in buckets. Because InfluxQL uses the 1.x data model, a bucket must be mapped to a database and retention policy (DBRP) before it can be queried using InfluxQL.

{{% note %}}

InfluxQL reference documentation

For complete InfluxQL reference documentation, see [Influx Query Language in the latest InfluxDB 1.x documentation](/{{< latest "influxdb" "v1" >}}/query_language/). {{% /note %}}

To use InfluxQL to query bucket data, complete the following steps:

  1. Verify buckets have a mapping.
  2. Map unmapped buckets.
  3. Query a mapped bucket with InfluxQL.

Verify buckets have a mapping

{{% note %}} When upgrading from InfluxDB 1.x to {{< current-version >}}, database and retention policy combinations are mapped to InfluxDB {{< current-version >}} buckets. For more information, see Database and retention policy mapping. If you're not sure how data was written into a bucket, verify the bucket has a mapping. {{% /note %}}

Use the influx CLI or the InfluxDB API to verify the buckets you want to query are mapped to a database and retention policy.

{{< tabs-wrapper >}} {{% tabs %}} influx CLI InfluxDB API {{% /tabs %}} {{% tab-content %}}

Use the influx v1 dbrp list command to list DBRP mappings.

{{% note %}} The examples below assume that your organization and API token are provided by the active InfluxDB connection configuration in the influx CLI. If not, include your organization (--org) and API token (--token) with each command. {{% /note %}}

View all DBRP mappings
influx v1 dbrp list
Filter DBRP mappings by database
influx v1 dbrp list --db example-db
Filter DBRP mappings by bucket ID
influx v1 dbrp list --bucket-id 00oxo0oXx000x0Xo

{{% /tab-content %}} {{% tab-content %}} Use the /api/v2/dbrps API endpoint to list DBRP mappings. Include the following:

  • Request method: GET
  • Headers:
    • Authorization: Token schema with your InfluxDB API token
  • Query parameters:
    {{< req type="key" >}}
    • {{< req "*" >}} orgID: organization ID
    • bucketID: bucket ID (to list DBRP mappings for a specific bucket)
    • database: database name (to list DBRP mappings with a specific database name)
    • rp: retention policy name (to list DBRP mappings with a specific retention policy name)
    • id: DBRP mapping ID (to list a specific DBRP mapping)
View all DBRP mappings
curl --request GET \
  http://localhost:8086/api/v2/dbrps?orgID=00oxo0oXx000x0Xo \
  --header "Authorization: Token YourAuthToken"
Filter DBRP mappings by database
curl --request GET \
  http://localhost:8086/api/v2/dbrps?orgID=00oxo0oXx000x0Xo&db=example-db \
  --header "Authorization: Token YourAuthToken"
Filter DBRP mappings by bucket ID
curl --request GET \
  https://cloud2.influxdata.com/api/v2/dbrps?organization_id=00oxo0oXx000x0Xo&bucketID=00oxo0oXx000x0Xo \
  --header "Authorization: Token YourAuthToken"

{{% /tab-content %}} {{% /tabs-wrapper %}}

If you do not find a DBRP mapping for a bucket, complete the next procedure to map the unmapped bucket. For more information on the DBRP mapping API, see the /api/v2/dbrps endpoint documentation.

Map unmapped buckets

Use the influx CLI or the InfluxDB API to manually create DBRP mappings for unmapped buckets.

{{< tabs-wrapper >}} {{% tabs %}} influx CLI InfluxDB API {{% /tabs %}} {{% tab-content %}}

Use the influx v1 dbrp create command to map an unmapped bucket to a database and retention policy. Include the following:

{{< req type="key" >}}

  • {{< req "*" >}} org and token to authenticate. We recommend setting your organization and token to your active InfluxDB connection configuration in the influx CLI, so you don't have to add these parameters to each command. To set up your active InfluxDB configuration, see influx config set.
  • {{< req "*" >}} database name to map
  • {{< req "*" >}} retention policy name to map
  • {{< req "*" >}} Bucket ID to map to
  • Default flag to set the provided retention policy as the default retention policy for the database
influx v1 dbrp create \
  --db example-db \
  --rp example-rp \
  --bucket-id 00oxo0oXx000x0Xo \
  --default

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

Use the /api/v2/dbrps API endpoint to create a new DBRP mapping. Include the following:

  • Request method: POST
  • Headers:
    • Authorization: Token schema with your InfluxDB API token
    • Content-type: application/json
  • Request body: JSON object with the following fields:
    {{< req type="key" >}}
    • {{< req "*" >}} bucketID: bucket ID
    • {{< req "*" >}} database: database name
    • default: set the provided retention policy as the default retention policy for the database
    • {{< req "*" >}} org or orgID: organization name or organization ID
    • {{< req "*" >}} retention_policy: retention policy name
curl --request POST http://localhost:8086/api/v2/dbrps \
  --header "Authorization: Token YourAuthToken" \
  --header 'Content-type: application/json' \
  --data '{
        "bucketID": "00oxo0oXx000x0Xo",
        "database": "example-db",
        "default": true,
        "orgID": "00oxo0oXx000x0Xo",
        "retention_policy": "example-rp"
      }'

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

After you've verified the bucket is mapped, query the bucket using the query 1.x compatibility endpoint.

Query a mapped bucket with InfluxQL

The InfluxDB 1.x compatibility API supports all InfluxDB 1.x client libraries and integrations in InfluxDB OSS {{< current-version >}}.

To query a mapped bucket with InfluxQL, use the /query 1.x compatibility endpoint. Include the following in your request:

  • Request method: GET
  • Headers:
  • Query parameters:
    • db: 1.x database to query
    • rp: 1.x retention policy to query (if no retention policy is specified, InfluxDB uses the default retention policy for the specified database)
    • q: URL-encoded InfluxQL query

{{% api/url-encode-note %}}

curl --get http://localhost:8086/query?db=example-db \
  --header "Authorization: Token YourAuthToken" \
  --data-urlencode "q=SELECT used_percent FROM example-db.example-rp.example-measurement WHERE host=host1"

By default, the /query compatibility endpoint returns results in JSON. To return results as CSV, include the Accept: application/csv header.

InfluxQL support

InfluxDB OSS {{< current-version >}} supports InfluxQL read-only queries. See supported and unsupported queries below. To learn more about InfluxQL, see [Influx Query Language (InfluxQL)](/{{< latest "influxdb" "v1" >}}/query_language/).

{{< flex >}} {{< flex-content >}} {{% note %}}

Supported InfluxQL queries
  • DELETE*
  • DROP MEASUREMENT*
  • EXPLAIN ANALYZE
  • SELECT (read-only)
  • SHOW DATABASES
  • SHOW MEASUREMENTS
  • SHOW TAG KEYS
  • SHOW TAG VALUES
  • SHOW FIELD KEYS

* These commands delete data. {{% /note %}} {{< /flex-content >}} {{< flex-content >}} {{% warn %}}

Unsupported InfluxQL queries
  • SELECT INTO
  • ALTER
  • CREATE
  • DROP (limited support)
  • GRANT
  • KILL
  • REVOKE {{% /warn %}} {{< /flex-content >}} {{< /flex >}}