Influxdata
/
docs-v2
mirror of https://github.com/influxdata/docs-v2.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

4806 document different ways to execute queries against iox (#4820) 

* fix(cloud-iox): typo.

* fix(cloud-iox): typo

* fix(iox): revise DATE_BIN example and link to reference.

* feat(iox): execute queries and visualize data with SQL in IOx.

* feat(cloud-iox): execute queries with Data Explorer (#4806).

- Publish steps for Execute Queries with Data Explorer.
- Remove pages not ready for IOx.
- Fix links in Get Started.
- Fix tags.

* feat(iox): Add API to IOx Reference, consolidate Cloud and OSS pages (#4788).

* fix(cloud-iox): IOx Data Explorer and Flux links.

* fix(cloud-iox): 1.x API menu.

* fix(cloud-iox): remove visualization types until we've verified links, etc.

* fix(cloud-iox): delete additional 1.x reference docs for now, revise Data Explorer.

* fix(api): replace cloud with cloud-iox in URLs, remove errant externalDocs link.

* feat(cloud-iox): add admin/accounts with data-usage and limits pages.

* fix(cloud): revise and remove outdated info from account management.

* fix(iox): punctuation.

* fix(cloud-iox): update link paths.

* fix(cloud-iox): update link paths for cloud-iox.

* patch(cloud-iox): quick fix for v1compat link paths
pull/4821/head
Jason Stirnaman 2023-03-21 16:34:13 -05:00 committed by GitHub
parent 8cc582795f
commit 6aad82f4d1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
56 changed files with 728 additions and 385 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
api-docs/cloud-iox/content/v1compat/info.yml
View File

@ -1,8 +1,8 @@
title: InfluxDB Cloud IOx v1 compatibility API documentation
title: InfluxDB Cloud (IOx) v1 compatibility API documentation
description: |
The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
If you want to use the latest InfluxDB /api/v2 API instead, see the [InfluxDB v2 API documentation](/influxdb/cloud/api/).
If you want to use the latest InfluxDB /api/v2 API instead, see the [InfluxDB v2 API documentation](/influxdb/cloud-iox/api/).
This documentation is generated from the
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml).

435
api-docs/cloud-iox/ref.yml
View File

File diff suppressed because it is too large Load Diff

4
api-docs/cloud-iox/swaggerV1Compat.yml
View File

@ -1,11 +1,11 @@
openapi: 3.0.0
info:
title: InfluxDB Cloud v1 compatibility API documentation
title: InfluxDB Cloud (IOx) v1 compatibility API documentation
version: 0.1.0
description: |
The InfluxDB 1.x compatibility /write and /query endpoints work with InfluxDB 1.x client libraries and third-party integrations like Grafana and others.
If you want to use the latest InfluxDB /api/v2 API instead, see the [InfluxDB v2 API documentation](/influxdb/cloud/api/).
If you want to use the latest InfluxDB /api/v2 API instead, see the [InfluxDB v2 API documentation](/influxdb/cloud-iox/api/).
This documentation is generated from the
[InfluxDB OpenAPI specification](https://raw.githubusercontent.com/influxdata/openapi/master/contracts/swaggerV1Compat.yml).

8
api-docs/openapi/plugins/decorators/replace-shortcodes.js
View File

@ -7,8 +7,14 @@ function replaceDocsUrl(field) {
*/
const shortcode = /\{\{%([^]|\s)*?INFLUXDB_DOCS_URL([^]|\s)*?%\}\}/g
let replacement = `/influxdb/${process.env.INFLUXDB_PLATFORM}`;
return field.replaceAll(shortcode, replacement)
field = field.replaceAll(shortcode, replacement)
.replaceAll('https://docs.influxdata.com/influxdb/', '/influxdb/');
if(process.env.INFLUXDB_PLATFORM === 'cloud-iox') {
field = field.replaceAll('/influxdb/cloud/', `${replacement}/`);
}
return field;
}
/** @type {import('@redocly/openapi-cli').OasDecorator} */

0
api-docs/openapi/plugins/decorators/replace-urls.js Normal file
View File

13
content/influxdb/cloud-iox/admin/accounts/_index.md Normal file
View File

@ -0,0 +1,13 @@
---
title: Manage your InfluxDB Cloud (IOx) Account
description: >
View and manage information related to your InfluxDB Cloud (IOx) account such as
pricing plans, data usage, account cancellation, etc.
weight: 10
menu:
influxdb_cloud_iox:
parent: Administer InfluxDB Cloud
name: Manage accounts
---
{{< children >}}

29
content/influxdb/cloud-iox/admin/accounts/data-usage.md Normal file
View File

@ -0,0 +1,29 @@
---
title: View InfluxDB Cloud (IOx) data usage
list_title: View data usage
description: >
View your InfluxDB Cloud (IOx) data usage and rate limit notifications.
weight: 103
menu:
influxdb_cloud_iox:
parent: Manage accounts
name: View data usage
related:
- /flux/v0.x/stdlib/experimental/usage/from/
- /flux/v0.x/stdlib/experimental/usage/limits/
---
View the statistics of your data usage and rate limits (reads, writes, and delete limits) on the InfluxDB Cloud UI **Usage** page. Some usage data affects monthly costs and other usage data (for example, delete limits), does not affect pricing. For more information, see [limits and adjustable quotas](/influxdb/cloud-iox/admin/accounts/limits/).
To view your {{< cloud-name >}} data usage, do the following:
1. Click on your organization in the header near the top of the page.
2. Select **Usage** from the dropdown menu.
3. Select a time range to review data usage (by default, `Past 24h`), and then select one of the following:
- **Data In:** Total data in MB written to your {{< cloud-name "short" >}} instance. Data in and write requests do not count towards your query count.
- **Query Count:** Total number of individual query operations, which include queries, tasks (alerts, notifications) and Data Explorer activity. Note, a script that includes multiple requests (for example, has multiple `from()...` lines) counts as one query.
- **Storage:** Total disk usage in gigabytes.
- **Data Out:** Total data in MB sent as responses to queries from your {{< cloud-name "short" >}} instance.
A line graph displays usage for the selected vector for the specified time period.

106
content/influxdb/cloud-iox/admin/accounts/limits.md Normal file
View File

@ -0,0 +1,106 @@
---
title: InfluxDB Cloud (IOx) limits and adjustable quotas
list_title: Limits and adjustable quotas
description: >
InfluxDB Cloud (IOx) has adjustable service quotas and global (non-adjustable) system limits.
weight: 110
menu:
influxdb_cloud_iox:
parent: Manage accounts
name: Adjustable quotas and limits
related:
- /flux/v0.x/stdlib/experimental/usage/from/
- /flux/v0.x/stdlib/experimental/usage/limits/
---
InfluxDB Cloud applies (non-adjustable) global system limits and adjustable service quotas on a per organization basis.
{{% warn %}}
All __rates__ (data-in (writes), queries (reads), and deletes) are accrued within a fixed five-minute window.
Once a rate is exceeded, an error response is returned until the current five-minute window resets.
{{% /warn %}}
Review adjustable service quotas and global limits to plan for your bandwidth needs:
- [Adjustable service quotas](#adjustable-service-quotas)
- [Global limits](#global-limits)
- [UI error messages](#ui-error-messages)
- [API error responses](#api-error-responses)
## Adjustable service quotas
To reduce the chance of unexpected charges and protect the service for all users, InfluxDB Cloud has adjustable service quotas applied per account.
_To request higher service quotas, reach out to [InfluxData Support](https://support.influxdata.com/)._
### Free Plan
- **Data-in**: Rate of 5 MB per 5 minutes (average of 17 kb/s)
- Uncompressed bytes of normalized [line protocol](/influxdb/cloud-iox/reference/syntax/line-protocol/)
- **Read**: Rate of 300 MB per 5 minutes (average of 1000 kb/s)
- Bytes in HTTP in response payload
- **Available resources**:
- 2 buckets (excluding `_monitoring` and `_tasks` buckets)
- 5 dashboards
- 5 tasks
- **Alerts**:
- 2 checks
- 2 notification rules
- Unlimited Slack notification endpoints
- **Storage**: 30 days of data retention (see [retention period](/influxdb/cloud-iox/reference/glossary/#retention-period))
{{% note %}}
To write historical data older than 30 days, retain data for more than 30 days, increase rate limits, or create additional organizations, upgrade to the Cloud [Usage-Based Plan](/influxdb/cloud-iox/admin/accounts/pricing-plans/#usage-based-plan).
{{% /note %}}
### Usage-Based Plan
- **Data-in**: Rate of 300 MB per 5 minutes
- Uncompressed bytes of normalized [line protocol](/influxdb/cloud-iox/reference/syntax/line-protocol/)
- **Read**: Rate of 3 GB data per 5 minutes
- Bytes in HTTP in response payload
- **Unlimited resources**
- dashboards
- tasks
- buckets
- users
- **Alerts**
- Unlimited checks
- Unlimited notification rules
- Unlimited notification endpoints for [all endpoints](/flux/v0.x/tags/notification-endpoints/)
- **Storage**: Set your retention period to unlimited or up to 1 year by [updating a bucket’s retention period in the InfluxDB UI](/influxdb/cloud-iox/organizations/buckets/update-bucket/#update-a-buckets-retention-period-in-the-influxdb-ui), or set a custom retention period using the [`influx bucket update command`](/influxdb/cloud-iox/reference/cli/influx/bucket/update/) with the [`influx` CLI](influxdb/cloud/reference/cli/influx/).
## Global limits
InfluxDB Cloud applies global (non-adjustable) system limits to all accounts, which protects the InfluxDB Cloud infrastructure for all users. As the service continues to evolve, we'll continue to review these global limits and adjust them as appropriate.
Limits include:
- **Write request limits**:
- 50 MB maximum HTTP request batch size (compressed or uncompressed--defined in the `Content-Encoding` header)
- 250 MB maximum HTTP request batch size after decompression
- **Query processing time**: 90 seconds
- **Total query time**: 1500 seconds of _total_ query time every 30 seconds
- **Task processing time**: 150 seconds
- **Total task time**: 1500 seconds of _total_ task time every 30 seconds
- **Delete request limit**: Rate of 300 every 5 minutes
{{% note %}}
**Tip:**
Combine delete predicate expressions (if possible) into a single request. InfluxDB limits delete requests by number of requests (not points per request).
{{% /note %}}
## UI error messages
The {{< cloud-name >}} UI displays a notification message when service quotas or limits are exceeded. The error messages correspond with the relevant [API error responses](#api-error-responses).
Errors can also be viewed in the [Usage page](/influxdb/cloud-iox/admin/accounts/data-usage/) under **Limit Events**, e.g. `event_type_limited_query`, `event_type_limited_write`,`event_type_limited_cardinality`, or `event_type_limited_delete_rate`.
## API error responses
The following API error responses occur when your plan's service quotas are exceeded.
| HTTP response code | Error message | Description |
| :----------------------------- | :----------------------------------------- | :----------- |
| `HTTP 413 "Request Too Large"` | cannot read data: points in batch is too large | If a **write** request exceeds the maximum [global limit](#global-limits) |
| `HTTP 429 "Too Many Requests"` | Retry-After: xxx (seconds to wait before retrying the request) | If a **read** or **write** request exceeds your plan's [adjustable service quotas](#adjustable-service-quotas) or if a **delete** request exceeds the maximum [global limit](#global-limits) |

8
content/influxdb/cloud-iox/admin/buckets/create-bucket.md
View File

@ -55,7 +55,7 @@ There are two places you can create a bucket in the UI.
## Create a bucket using the influx CLI
To create a bucket with the `influx` CLI, use the [`influx bucket create` command](/influxdb/cloud/reference/cli/influx/bucket/create)
To create a bucket with the `influx` CLI, use the [`influx bucket create` command](/influxdb/cloud-iox/reference/cli/influx/bucket/create)
and specify values for the following flags:
| Requirement | Include by |
@ -74,7 +74,7 @@ influx bucket create -n my-bucket -o {INFLUX_ORG} -r 72h
To create a bucket with the InfluxDB HTTP API, send a request to the following endpoint:
[{{< api-endpoint method="post" endpoint="https://cloud2.influxdata.com/api/v2/buckets" >}}](/influxdb/cloud/api/#operation/PostBuckets)
[{{< api-endpoint method="post" endpoint="https://cloud2.influxdata.com/api/v2/buckets" >}}](/influxdb/cloud-iox/api/#operation/PostBuckets)
In your request body, specify values for the following properties:
@ -91,7 +91,7 @@ The following example creates a bucket with a retention period of `86,400` secon
```
_For information about **InfluxDB API options and response codes**, see
[InfluxDB API Buckets reference documentation](/influxdb/cloud/api/#operation/PostBuckets)._
[InfluxDB API Buckets reference documentation](/influxdb/cloud-iox/api/#operation/PostBuckets)._
## Create a bucket that enforces explicit schemas
@ -119,7 +119,7 @@ Use the `influx bucket create` command and specify the `--schema-type=explicit`
<!----------------------------- BEGIN API CONTENT ----------------------------->
Use the HTTP API [`/api/v2/buckets`](/influxdb/cloud/api/#operation/PostBuckets)
Use the HTTP API [`/api/v2/buckets`](/influxdb/cloud-iox/api/#operation/PostBuckets)
endpoint and set the `schemaType` property value to `explicit` in the request body--for example:
{{< api-endpoint method="post" endpoint="https://cloud2.influxdata.com/api/v2/buckets" >}}

35
content/influxdb/cloud-iox/admin/buckets/manage-explicit-bucket-schemas.md
View File

@ -7,26 +7,25 @@ menu:
name: Manage explicit bucket schemas
parent: Manage buckets
weight: 250
influxdb/cloud/tags: [buckets, bucket-schema, bucket schemas, explicit bucket schemas, explicit measurement schema, schema]
influxdb/cloud-iox/tags: [buckets, bucket-schema, bucket schemas, explicit bucket schemas, explicit measurement schema, schema]
related:
- /influxdb/cloud/reference/key-concepts/
- /influxdb/cloud/reference/key-concepts/data-schema/
- /influxdb/cloud/reference/key-concepts/data-elements/
- /influxdb/cloud-iox/write-data/best-practices/schema-design/
- /influxdb/cloud-iox/reference/cli/influx/bucket-schema/
- /influxdb/cloud-iox/admin/buckets/create-bucket/
- /influxdb/cloud/reference/cli/influx/
- /influxdb/cloud-iox/reference/cli/influx/
---
Use [**explicit bucket schemas**](/influxdb/cloud/reference/glossary/#bucket-schema) to enforce [column names](/influxdb/cloud/reference/glossary/#column), [tags](/influxdb/cloud/reference/glossary/#tag), [fields](/influxdb/cloud/reference/glossary/#field), and
[data types](/influxdb/cloud/reference/glossary/#data-type) for your data.
Use [**explicit bucket schemas**](/influxdb/cloud-iox/reference/glossary/#bucket-schema) to enforce [column names](/influxdb/cloud-iox/reference/glossary/#column), [tags](/influxdb/cloud-iox/reference/glossary/#tag), [fields](/influxdb/cloud-iox/reference/glossary/#field), and
[data types](/influxdb/cloud-iox/reference/glossary/#data-type) for your data.
Buckets with the `explicit` schema-type, use
explicit bucket schemas to ensure measurements have specific columns and data types and to prevent non-conforming writes.
After you create a bucket schema, you're ready to [write data](/influxdb/cloud/write-data/) to your bucket.
After you create a bucket schema, you're ready to [write data](/influxdb/cloud-iox/write-data/) to your bucket.
{{% note %}}
#### Before you begin
The examples below reference **InfluxDB data elements**. We recommend reviewing [schema design best practices](/influxdb/cloud-iox/write-data/best-practices/schema-design/) and [**elements of line protocol**](/influxdb/cloud/reference/syntax/line-protocol/#elements-of-line-protocol) if you aren't familiar with these concepts.
The examples below reference **InfluxDB data elements**. We recommend reviewing [schema design best practices](/influxdb/cloud-iox/write-data/best-practices/schema-design/) and [**elements of line protocol**](/influxdb/cloud-iox/reference/syntax/line-protocol/#elements-of-line-protocol) if you aren't familiar with these concepts.
{{% /note %}}
- [Create an explicit bucket and schema](#create-an-explicit-bucket-and-schema)
@ -60,7 +59,7 @@ A measurement schema has the following properties:
To learn more about rules for measurement _names_ and _columns_, see how to [write valid schemas](#write-valid-schemas).
Use the [**`influx` CLI**](/influxdb/cloud/reference/cli/influx/) or [**InfluxDB HTTP API**](/influxdb/cloud/api) to create an explicit bucket schema for a measurement.
Use the [**`influx` CLI**](/influxdb/cloud-iox/reference/cli/influx/) or [**InfluxDB HTTP API**](/influxdb/cloud-iox/api) to create an explicit bucket schema for a measurement.
- [Create a bucket schema using the influx CLI](#create-a-bucket-schema-using-the-influx-cli)
- [Create a bucket schema using the InfluxDB HTTP API](#create-a-bucket-schema-using-the-influxdb-http-api)
@ -92,7 +91,7 @@ Use the [**`influx` CLI**](/influxdb/cloud/reference/cli/influx/) or [**InfluxDB
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
2. Use the [`influx bucket-schema create` command](/influxdb/cloud/reference/cli/influx/bucket-schema/create) to define an _explicit_ bucket measurement schema. In your command, specify values for the following flags:
2. Use the [`influx bucket-schema create` command](/influxdb/cloud-iox/reference/cli/influx/bucket-schema/create) to define an _explicit_ bucket measurement schema. In your command, specify values for the following flags:
- `--name`: the measurement name.
- `--columns-file`: the location of the file that contains *column definitions* for your measurement.
@ -117,7 +116,7 @@ Use the [**`influx` CLI**](/influxdb/cloud/reference/cli/influx/) or [**InfluxDB
```
#### Create a bucket schema using the InfluxDB HTTP API
Send a request to the HTTP API [`/api/v2/buckets/{BUCKET_ID}/schema/measurements` endpoint](/influxdb/cloud/api/#operation/createMeasurementSchema)
Send a request to the HTTP API [`/api/v2/buckets/{BUCKET_ID}/schema/measurements` endpoint](/influxdb/cloud-iox/api/#operation/createMeasurementSchema)
and set the following properties in the request body:
- `name`: the measurement name.
@ -193,7 +192,7 @@ as in the following example:
## View bucket schema type and schemas
Use the **InfluxDB UI**, [**`influx` CLI**](/influxdb/cloud/reference/cli/influx/), or [**InfluxDB HTTP API**](/influxdb/cloud/api) to view schema type and schemas for buckets.
Use the **InfluxDB UI**, [**`influx` CLI**](/influxdb/cloud-iox/reference/cli/influx/), or [**InfluxDB HTTP API**](/influxdb/cloud-iox/api) to view schema type and schemas for buckets.
### View schema type and schemas in the InfluxDB UI
@ -203,12 +202,12 @@ Use the **InfluxDB UI**, [**`influx` CLI**](/influxdb/cloud/reference/cli/influx
### View schema type and schemas using the influx CLI
To list schemas for a bucket, use the [`influx bucket-schema list` command](/influxdb/cloud/reference/cli/influx/bucket-schema/list/).
To list schemas for a bucket, use the [`influx bucket-schema list` command](/influxdb/cloud-iox/reference/cli/influx/bucket-schema/list/).
To view schema column definitions and metadata, specify the `--json` flag.
### View schema type and schemas using the InfluxDB HTTP API
To list schemas for a bucket, send a request to the InfluxDB HTTP [`/api/v2/buckets/{BUCKET_ID}/schema/measurements` endpoint](/influxdb/cloud/api/#operation/getMeasurementSchemas):
To list schemas for a bucket, send a request to the InfluxDB HTTP [`/api/v2/buckets/{BUCKET_ID}/schema/measurements` endpoint](/influxdb/cloud-iox/api/#operation/getMeasurementSchemas):
{{% api-endpoint method="get" endpoint="https://cloud2.influxdata.com/api/v2/buckets/{BUCKET_ID}/schema/measurements" %}}
@ -236,7 +235,7 @@ You can't modify or delete columns in bucket schemas.
echo '{"name": "CO2", "type": "field", "dataType": "float"}' >> sensor.ndjson
```
3. To update the bucket schema, use the [`influx bucket-schema update` command](/influxdb/cloud/reference/cli/influx/bucket-schema/update) and specify the columns file with the `--columns-file` flag.
3. To update the bucket schema, use the [`influx bucket-schema update` command](/influxdb/cloud-iox/reference/cli/influx/bucket-schema/update) and specify the columns file with the `--columns-file` flag.
```sh
influx bucket-schema update \
@ -249,7 +248,7 @@ You can't modify or delete columns in bucket schemas.
1. [View the existing measurement schema](#view-schema-type-and-schemas-using-the-influxdb-http-api) and copy the `columns` list.
2. Send a request to the HTTP API [`/api/v2/buckets/{BUCKET_ID}/schema/measurements/{MEASUREMENT_ID}` endpoint](/influxdb/cloud/api/#operation/updateMeasurementSchema).
2. Send a request to the HTTP API [`/api/v2/buckets/{BUCKET_ID}/schema/measurements/{MEASUREMENT_ID}` endpoint](/influxdb/cloud-iox/api/#operation/updateMeasurementSchema).
In the request body, set the `columns` property to a list of old and new column definitions for the measurement schema--for example, the following request appends the new column `CO2` to `columns` retrieved in the previous step:
@ -295,5 +294,5 @@ InfluxDB returns an error for the following reasons:
- data in the write request has invalid syntax.
<!-- Pending IOx troubleshoot page --
To resolve failures and partial writes, see how to [troubleshoot writes](/influxdb/cloud/write-data/troubleshoot/).
To resolve failures and partial writes, see how to [troubleshoot writes](/influxdb/cloud-iox/write-data/troubleshoot/).
-->

6
content/influxdb/cloud-iox/admin/buckets/view-buckets.md
View File

@ -22,7 +22,7 @@ weight: 202
## View buckets using the influx CLI
Use the [`influx bucket list` command](/influxdb/cloud/reference/cli/influx/bucket/list)
Use the [`influx bucket list` command](/influxdb/cloud-iox/reference/cli/influx/bucket/list)
to view buckets in an organization.
```sh
@ -30,12 +30,12 @@ influx bucket list
```
Other filtering options such as filtering by a name or ID are available.
See the [`influx bucket list` documentation](/influxdb/cloud/reference/cli/influx/bucket/list)
See the [`influx bucket list` documentation](/influxdb/cloud-iox/reference/cli/influx/bucket/list)
for information about other available flags.
## View buckets using the InfluxDB HTTP API
Send a request to the InfluxDB HTTP API [`/api/v2/buckets` endpoint](/influxdb/cloud/api/#operation/GetBuckets) to view buckets in an organization.
Send a request to the InfluxDB HTTP API [`/api/v2/buckets` endpoint](/influxdb/cloud-iox/api/#operation/GetBuckets) to view buckets in an organization.
{{% api-endpoint method="get" endpoint="https://cloud2.influxdata.com/api/v2/buckets" %}}

18
content/influxdb/cloud-iox/get-started/query.md
View File

@ -14,6 +14,8 @@ weight: 102
metadata: [3 / 3]
related:
- /influxdb/cloud-iox/query-data/
- /influxdb/cloud-iox/query-data/sql/
- /influxdb/cloud-iox/query-data/execute-queries/
---
InfluxDB Cloud backed by InfluxDB IOx supports multiple query languages:
@ -41,13 +43,13 @@ InfluxDB supports many different tools for querying data, including:
{{< req type="key" text="Covered in this tutorial" >}}
- InfluxDB user interface (UI){{< req "\* " >}}
- [InfluxDB HTTP API](/influxdb/cloud-iox/reference/api/){{< req "\* " >}}
- [`influx` CLI](/influxdb/cloud-iox/tools/influx-cli/){{< req "\* " >}}
- [InfluxDB user interface (UI)](?t=InfluxDB+UI#execute-a-sql-query){{< req "\* " >}}
- [InfluxDB HTTP API](?t=InfluxDB+API#execute-a-sql-query){{< req "\* " >}}
- [`influx` CLI](?t=influx+CLI#execute-a-sql-query){{< req "\* " >}}
- [Superset](https://superset.apache.org/)
- [Grafana](/influxdb/cloud-iox/tools/grafana/)
- [Chronograf](/{{< latest "Chronograf" >}}/)
- [InfluxDB client libraries](/influxdb/cloud-iox/api-guide/client-libraries/)
- InfluxDB client libraries
## SQL query basics
@ -183,9 +185,9 @@ WHERE
{{< tabs-wrapper >}}
{{% tabs %}}
[InfluxDB UI](#)
[influx CLI](#)
[InfluxDB API](#)
[InfluxDB UI](#influxdb-ui)
[influx CLI](#influx-cli)
[InfluxDB API](#influxdb-http-api)
{{% /tabs %}}
{{% tab-content %}}
@ -211,6 +213,8 @@ WHERE
Results are displayed under the text editor.
See [Query in the Data Explorer](/influxdb/cloud-iox/query-data/execute-queries/data-explorer/) to learn more.
<!---------------------------- END FLUX UI CONTENT ---------------------------->
{{% /tab-content %}}
{{% tab-content %}}

15
content/influxdb/cloud-iox/query-data/execute-queries/_index.md Normal file
View File

@ -0,0 +1,15 @@
---
title: Execute queries
seotitle: Different ways to query InfluxDB
description: There are multiple ways to query data from InfluxDB including the InfluxDB UI, CLI, and API.
weight: 103
menu:
influxdb_cloud_iox:
name: Execute queries
parent: Query data
influxdb/cloud-iox/tags: [query]
---
<!-- There are multiple ways to execute queries with InfluxDB. Choose from the following options: -->
{{< children >}}

156
content/influxdb/cloud-iox/query-data/execute-queries/data-explorer/_index.md Normal file
View File

@ -0,0 +1,156 @@
---
title: Query in Data Explorer
description: >
Query your data in the InfluxDB user interface (UI) Data Explorer.
weight: 201
menu:
influxdb_cloud_iox:
name: Query with Data Explorer
parent: Execute queries
influxdb/cloud-iox/tags: [query]
related:
- /influxdb/cloud-iox/query-data/sql/
- /influxdb/cloud-iox/query-data/flux-sql/
---
Build, execute, and visualize your queries in InfluxDB UI's **Data Explorer**.
<!--Need a screenshot of the SQL builder with a pretty graph-->
Query using saved scripts, the SQL builder, the Flux builder, or by manually editing the query.
Choose between **visualization types** for your query.
## Query data with SQL and the Data Explorer
1. In the navigation menu on the left, click **Data Explorer**.
{{< nav-icon "data-explorer" >}}
2. Activate the **SQL Sync** toggle in the **Schema Browser** pane to build your SQL query as you select [fields and tag values](/influxdb/cloud-iox/write-data/best-practices/schema-design/#influxdb-data-structure).
- Typing within the script editor disables **SQL Sync**.
- If you reenable **SQL Sync**, any selection changes you made in the **Schema Browser** are copied to the script editor.
3. Select a **Bucket** to define your data source.
4. Select a **Measurement** from the bucket.
Data Explorer inserts a `SELECT` statement to retrieve all columns in the selected measurement:
```sql
SELECT *
FROM home
```
5. To add filter conditions to your query, select from the **Fields** and **Tag Keys** lists.
- **Fields**: filters for rows that have a non-null value for at least one of the selected field columns.
- **Tag Keys**: filters for rows that have all the selected tag values.
To learn more, see [Query specific fields and tags](/influxdb/cloud-iox/query-data/sql/basic-query/#query-specific-fields-and-tags).
6. Use the [time range dropdown](#select-time-range) to edit the time range for your query.
7. Use the script editor to customize your query--for example, to specify what tags and fields to retrieve:
```sql
SELECT temp, time
FROM home
```
7. Click the **Run** button (or press `Control+Enter`) to run your query and [view the results](#view-sql-query-results).
See [Query data](/influxdb/cloud-iox/query-data/sql/) to learn more about building SQL queries.
{{% note %}}
#### Save your work
**Data Explorer** keeps your last change--for example, if you navigate to **Buckets**
or signout and then come back, you'll see your SQL query and selections in **Data Explorer**.
To store a query that you can retrieve and reuse, {{% caps %}}**Save**{{% /caps %}} your query as a *script*.
{{% /note %}}
## View SQL query results
After you **Run** your query, Data Explorer displays the results.
- Click {{< caps >}}Table{{< /caps >}} for a paginated tabular view of all rows and columns.
- Click {{< caps >}}Graph{{< /caps >}} to select a *visualization type* and options.
- Click {{< caps >}}CSV{{< /caps >}} to download query results in a comma-delimited file.
## Query data with Flux and the Data Explorer
Flux is a functional data scripting language designed for querying,
analyzing, and acting on time series data.
See [how to use Flux and SQL to query data](/influxdb/cloud-iox/query-data/flux-sql/).
1. In the navigation menu on the left, click **Data Explorer**.
{{< nav-icon "data-explorer" >}}
2. Activate the **Switch to old Data Explorer** toggle to display the Flux builder. By default, the Cloud IOx UI displays the **Schema Browser** and the **SQL** script editor for creating queries.
![Data Explorer with Flux](/img/influxdb/2-0-data-explorer.png)
3. Use the bottom panel to create a Flux query:
- Select a bucket to define your data source or select `+ Create Bucket` to add a new bucket.
- Edit your time range with the [time range option](#select-time-range) in the dropdown menu.
- Add filters to narrow your data by selecting attributes or columns in the dropdown menu.
- Select **Group** from the **Filter** dropdown menu to group data into tables. For more about how grouping data in Flux works, see [group()](/flux/v0.x/stdlib/universe/group/).
3. Alternatively, click **Script Editor** to manually edit the query.
To switch back to the query builder, click **Query Builder**. Note that your updates from the Script Editor will not be saved.
4. Use the **Functions** list to review the available Flux functions.
Click a function from the list to add it to your query.
5. Click **Submit** (or press `Control+Enter`) to run your query. You can then preview your graph in the above pane.
To cancel your query while it's running, click **Cancel**.
6. To work on multiple queries at once, click the {{< icon "plus" >}} to add another tab.
- Click the eye icon on a tab to hide or show a query's visualization.
- Click the name of the query in the tab to rename it.
### Visualize your query
- Select an available **visualization type** from the dropdown menu:
{{< img-hd src="/img/influxdb/2-0-visualizations-dropdown.png" title="Visualization dropdown" />}}
## Control your dashboard cell
To open the cell editor overlay, click the gear icon in the upper right of a cell and select **Configure**.
The cell editor overlay opens.
### View raw data
Toggle the **View Raw Data** {{< icon "toggle" >}} option to see your data in table format instead of a graph. Scroll through raw data using arrows, or click page numbers to find specific tables. [Group keys](/influxdb/cloud-iox/reference/glossary/#group-key) and [data types](/influxdb/cloud-iox/reference/glossary/#data-type) are easily identifiable at the top of each column underneath the headings. Use this option when data can't be visualized using a visualization type.
{{< img-hd src="/img/influxdb/cloud-controls-view-raw-data.png" alt="View raw data" />}}
### Save as CSV
Click the CSV icon to save the cells contents as a CSV file.
### Manually refresh dashboard
Click the refresh button ({{< icon "refresh" >}}) to manually refresh the dashboard's data.
### Select time range
1. Select from the time range options in the dropdown menu.
{{< img-hd src="/img/influxdb/2-0-controls-time-range.png" alt="Select time range" />}}
2. Select **Custom Time Range** to enter a custom time range with precision up to nanoseconds.
The default time range is 5m.
> The custom time range uses the selected timezone (local time or UTC).
### Query Builder or Script Editor
Click **Query Builder** to use the builder to create a Flux query. Click **Script Editor** to manually edit the query.
#### Keyboard shortcuts
In **Script Editor** mode, the following keyboard shortcuts are available:
| Key | Description |
|--------------------------------|---------------------------------------------|
| `Control + /` (`⌘ + /` on Mac) | Comment/uncomment current or selected lines |
| `Control + Enter` | Submit query |
## Save your query as a dashboard cell or task
- Click **Save as** in the upper right, and then:
- To add your query to a dashboard, click **Dashboard Cell**.
- To save your query as a task, click **Task**.
- To save your query as a variable, click **Variable**.

39
content/influxdb/cloud-iox/query-data/sql/aggregate-select.md
View File

@ -131,7 +131,7 @@ GROUP BY room
## Example aggregate queries
- [Performed an ungrouped aggregation](#performed-an-ungrouped-aggregation)
- [Perform an ungrouped aggregation](#perform-an-ungrouped-aggregation)
- [Group and aggregate data](#group-and-aggregate-data)
- [Downsample data by applying interval-based aggregates](#downsample-data-by-applying-interval-based-aggregates)
- [Query rows based on aggregate values](#query-rows-based-on-aggregate-values)
@ -150,8 +150,8 @@ to your InfluxDB Cloud bucket before running the example queries.
To aggregate _all_ queried values in a specified column:
- Use aggregate or selector functions in your `SELECT` statement
- Do not include a `GROUP BY` clause to leave your data ungrouped
- Use aggregate or selector functions in your `SELECT` statement.
- Do not include a `GROUP BY` clause to leave your data ungrouped.
```sql
SELECT avg(co) AS 'average co' from home
@ -167,11 +167,11 @@ SELECT avg(co) AS 'average co' from home
### Group and aggregate data
To apply aggregate or selector functions to data grouped:
To apply aggregate or selector functions to grouped data:
- Use aggregate or selector functions in your `SELECT` statement
- Include columns to group by in your `SELECT` statement
- Include a `GROUP BY` clause with a comma-delimited list of columns to group by
- Use aggregate or selector functions in your `SELECT` statement.
- Include columns to group by in your `SELECT` statement.
- Include a `GROUP BY` clause with a comma-delimited list of columns to group by.
```sql
SELECT
@ -198,20 +198,24 @@ groups:
- In your `SELECT` clause:
- Use `DATE_BIN` to calculate windows of time based on a specified interval
and update the timestamp in the `time` column based on the start
boundary of the window that the original timestamp is in.
For example, if you use `DATE_BIN` to window data into one day intervals,
{{% influxdb/custom-timestamps-span %}}`2022-01-01T12:34:56Z`{{% /influxdb/custom-timestamps-span %}}
will be updated to
{{% influxdb/custom-timestamps-span %}}`2022-01-01T00:00:00Z`{{% /influxdb/custom-timestamps-span %}}.
- Use aggregate or selector functions on specified columns.
- Use the [`DATE_BIN` function](/influxdb/cloud-iox/reference/sql/functions/time-and-date/#date_bin)
to calculate time intervals and return a new `time` column that contains the start of the nearest interval associated with your timestamp--for example,
the following statement calculates two-hour intervals starting at `1970-01-01T00:00:00Z` and calculates the nearest interval for `time` in each row:
```sql
SELECT DATE_BIN(INTERVAL '2 hours', time, '1970-01-01T00:00:00Z'::TIMESTAMP) AS time
FROM home
```
If the `time` timestamp in your data is
{{% influxdb/custom-timestamps-span %}}`2023-03-09T13:00:50.000Z`{{% /influxdb/custom-timestamps-span %}},
then the query returns the `time` value
{{% influxdb/custom-timestamps-span %}}`2023-03-09T12:00:00.000Z`{{% /influxdb/custom-timestamps-span %}}.
- Use [aggregate](/influxdb/cloud-iox/reference/sql/functions/aggregate/) or [selector](/influxdb/cloud-iox/reference/sql/functions/selector/) functions on specified columns.
- Include columns to group by.
- Include a `GROUP BY` clause with `time` and other columns to group by.
```sql
SELECT
DATE_BIN(INTERVAL '2 hours', time, '1970-01-01T00:00:00Z'::TIMESTAMP) AS time,
@ -246,6 +250,7 @@ GROUP BY time, room
{{% /expand %}}
{{< /expand-wrapper >}}
### Query rows based on aggregate values
To query data based on values after an aggregate operation, include a `HAVING`

25
content/influxdb/cloud-iox/reference/api/_index.md Normal file
View File

@ -0,0 +1,25 @@
---
title: InfluxDB HTTP API
description: >
The InfluxDB HTTP API provides a programmatic interface for interactions with InfluxDB.
Access the InfluxDB API using the `/api/v2/` endpoint.
menu:
influxdb_cloud_iox:
parent: Reference
name: InfluxDB HTTP API
weight: 104
influxdb/cloud-iox/tags: [api]
---
The InfluxDB HTTP API provides a programmatic interface for interactions with InfluxDB.
Access the InfluxDB HTTP API using the `/api/v2/` endpoint.
## InfluxDB HTTP API documentation
<a class="btn" href="/influxdb/cloud-iox/api/">InfluxDB {{< current-version >}} API documentation</a>
## InfluxDB v1 compatibility API documentation
The InfluxDB HTTP API includes InfluxDB 1.x compatibility endpoints
that work with InfluxDB 1.x client libraries and third-party integrations like
[Grafana](https://grafana.com) and others.
<a class="btn" href="/influxdb/cloud-iox/api/v1-compatibility/">View full v1 compatibility API documentation</a>

6
content/influxdb/cloud-iox/reference/cli/influx/apply/_index.md
View File

@ -7,11 +7,11 @@ menu:
parent: influx
weight: 101
aliases:
- /influxdb/cloud/reference/cli/influx/pkg/
- /influxdb/cloud-iox/reference/cli/influx/pkg/
influxdb/cloud-iox/tags: [templates]
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/auth/_index.md
View File

@ -9,8 +9,8 @@ weight: 101
influxdb/cloud-iox/tags: [authentication]
cascade:
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/backup/_index.md
View File

@ -8,8 +8,8 @@ menu:
weight: 101
influxdb/cloud-iox/tags: [backup]
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+, InfluxDB OSS only]
updated_in: CLI v2.0.2
---

4
content/influxdb/cloud-iox/reference/cli/influx/bucket-schema/_index.md
View File

@ -11,8 +11,8 @@ cascade:
related:
- /influxdb/cloud/organizations/buckets/bucket-schema
- /influxdb/cloud/organizations/buckets/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.1.0+]
---

6
content/influxdb/cloud-iox/reference/cli/influx/bucket/_index.md
View File

@ -9,9 +9,9 @@ weight: 101
influxdb/cloud-iox/tags: [buckets]
cascade:
related:
- /influxdb/cloud/organizations/buckets/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/organizations/buckets/
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
metadata: [influx CLI 2.0.0+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/bucket/create.md
View File

@ -10,8 +10,8 @@ aliases:
- /influxdb/cloud/reference/cli/influx/bucket/create/
related:
- /influxdb/cloud/organizations/buckets/create-buckets/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
updated_in: CLI v2.1.0
---

4
content/influxdb/cloud-iox/reference/cli/influx/bucket/delete.md
View File

@ -8,8 +8,8 @@ menu:
weight: 201
related:
- /influxdb/cloud/organizations/buckets/delete-bucket/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
---
{{< duplicate-oss >}}

4
content/influxdb/cloud-iox/reference/cli/influx/completion/_index.md
View File

@ -10,8 +10,8 @@ menu:
weight: 101
influxdb/cloud-iox/tags: [cli, tools]
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/config/_index.md
View File

@ -9,8 +9,8 @@ weight: 101
influxdb/cloud-iox/tags: [config]
cascade:
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/dashboards/_index.md
View File

@ -9,8 +9,8 @@ menu:
weight: 101
influxdb/cloud-iox/tags: [telegraf]
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/delete/_index.md
View File

@ -10,8 +10,8 @@ influxdb/cloud-iox/tags: [delete]
related:
- /influxdb/cloud/write-data/delete-data
- /influxdb/cloud/reference/syntax/delete-predicate
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.3+]
updated_in: CLI v2.2.0
---

4
content/influxdb/cloud-iox/reference/cli/influx/export/_index.md
View File

@ -8,8 +8,8 @@ weight: 101
cascade:
related:
- /influxdb/cloud/influxdb-templates/create/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+]
prepend:
block: warn

4
content/influxdb/cloud-iox/reference/cli/influx/export/all.md
View File

@ -8,8 +8,8 @@ menu:
weight: 201
related:
- /influxdb/cloud/influxdb-templates/create/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
---
{{< duplicate-oss >}}

4
content/influxdb/cloud-iox/reference/cli/influx/help/_index.md
View File

@ -7,8 +7,8 @@ menu:
parent: influx
weight: 101
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/org/_index.md
View File

@ -9,8 +9,8 @@ weight: 101
influxdb/cloud-iox/tags: [organizations]
cascade:
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/ping/_index.md
View File

@ -10,8 +10,8 @@ menu:
weight: 101
influxdb/cloud-iox/tags: [ping, health]
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+, InfluxDB OSS only]
---

4
content/influxdb/cloud-iox/reference/cli/influx/query/_index.md
View File

@ -12,8 +12,8 @@ influxdb/cloud-iox/tags: [query]
related:
- /influxdb/cloud/query-data/
- /influxdb/cloud/query-data/execute-queries/influx-query/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+]
updated_in: CLI v2.0.5
---

4
content/influxdb/cloud-iox/reference/cli/influx/restore/index.md
View File

@ -7,8 +7,8 @@ menu:
parent: influx
weight: 101
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+]
updated_in: CLI v2.0.7
---

4
content/influxdb/cloud-iox/reference/cli/influx/scripts/_index.md
View File

@ -9,8 +9,8 @@ weight: 101
influxdb/cloud-iox/tags: [scripts]
cascade:
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/api-guide/api-invokable-scripts/
metadata: [influx CLI 2.4.0+, InfluxDB Cloud only]
---

4
content/influxdb/cloud-iox/reference/cli/influx/secret/_index.md
View File

@ -10,8 +10,8 @@ cascade:
influxdb/cloud-iox/tags: [secrets]
related:
- /influxdb/cloud/security/secrets/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/setup/_index.md
View File

@ -10,8 +10,8 @@ menu:
weight: 101
influxdb/cloud-iox/tags: [get-started]
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+, InfluxDB OSS only]
updated_in: CLI v2.0.3
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/setup/

4
content/influxdb/cloud-iox/reference/cli/influx/stacks/_index.md
View File

@ -12,8 +12,8 @@ influxdb/cloud-iox/tags: [templates]
cascade:
related:
- /influxdb/cloud/influxdb-templates/stacks/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.1+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/task/_index.md
View File

@ -10,8 +10,8 @@ influxdb/cloud-iox/tags: [tasks]
cascade:
related:
- /influxdb/cloud/process-data/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/telegrafs/_index.md
View File

@ -12,8 +12,8 @@ influxdb/cloud-iox/tags: [telegraf]
cascade:
related:
- /influxdb/cloud/telegraf-configs/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/template/_index.md
View File

@ -10,8 +10,8 @@ influxdb/cloud-iox/tags: [templates]
cascade:
related:
- /influxdb/cloud/influxdb-templates/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.1+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/transpile/_index.md
View File

@ -3,8 +3,8 @@ title: influx transpile
description: >
The `influx transpile` command transpiles an InfluxQL query to Flux source code.
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0 – 2.0.5]
prepend:
block: warn

4
content/influxdb/cloud-iox/reference/cli/influx/user/_index.md
View File

@ -9,8 +9,8 @@ weight: 101
influxdb/cloud-iox/tags: [users]
cascade:
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+, InfluxDB OSS only]
prepend:
block: note

6
content/influxdb/cloud-iox/reference/cli/influx/user/password.md
View File

@ -7,9 +7,9 @@ menu:
parent: influx user
weight: 201
related:
- /influxdb/cloud/account-management/change-password/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/admin/accounts/change-password/
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
canonical: /{{< latest "influxdb" "v2" >}}/reference/cli/influx/user/password/
---

4
content/influxdb/cloud-iox/reference/cli/influx/v1/_index.md
View File

@ -9,8 +9,8 @@ menu:
weight: 101
cascade:
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+]
---

4
content/influxdb/cloud-iox/reference/cli/influx/v1/shell.md
View File

@ -9,8 +9,8 @@ menu:
weight: 101
influxdb/cloud-iox/tags: [InfluxQL]
related:
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/query-data/influxql/
- /influxdb/v2.4/tools/influxql-shell/
metadata: [influx CLI 2.4.0+, InfluxDB Cloud]

13
content/influxdb/cloud-iox/reference/cli/influx/write/_index.md
View File

@ -11,13 +11,12 @@ weight: 101
influxdb/cloud-iox/tags: [write]
cascade:
related:
- /influxdb/cloud/write-data/
- /influxdb/cloud/write-data/developer-tools/csv/
- /influxdb/cloud/reference/syntax/line-protocol/
- /influxdb/cloud/reference/syntax/annotated-csv/
- /influxdb/cloud/reference/syntax/annotated-csv/extended/
- /influxdb/cloud/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud/reference/cli/influx/#flag-patterns-and-conventions, influx CLI—Flag patterns and conventions
- /influxdb/cloud-iox/write-data/
- /influxdb/cloud-iox/reference/syntax/line-protocol/
- /influxdb/cloud-iox/reference/syntax/annotated-csv/
- /influxdb/cloud-iox/reference/syntax/annotated-csv/extended/
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
- /influxdb/cloud-iox/reference/cli/influx/#provide-required-authentication-credentials, influx CLI—Provide required authentication credentials
metadata: [influx CLI 2.0.0+]
updated_in: CLI v2.0.5
---

4
content/influxdb/cloud-iox/reference/regions.md
View File

@ -15,8 +15,8 @@ menu:
InfluxDB Cloud backed by InfluxDB IOx is available on on the following cloud providers and regions.
Each region has a unique InfluxDB Cloud URL and API endpoint.
Use the URLs below to interact with your InfluxDB Cloud instances with the
[InfluxDB API](/influxdb/cloud/reference/api/), [InfluxDB client libraries](/influxdb/cloud/api-guide/client-libraries/),
[`influx` CLI](/influxdb/cloud/reference/cli/influx/), or [Telegraf](/influxdb/cloud/write-data/no-code/use-telegraf/).
[InfluxDB API](/influxdb/cloud-iox/reference/api/), [InfluxDB client libraries](/influxdb/cloud/api-guide/client-libraries/),
[`influx` CLI](/influxdb/cloud-iox/reference/cli/influx/), or [Telegraf](/influxdb/cloud-iox/write-data/use-telegraf/).
{{% note %}}
#### InfluxDB IOx-enabled cloud regions

8
content/influxdb/cloud-iox/write-data/migrate-data/migrate-tsm-to-iox.md
View File

@ -39,10 +39,10 @@ All query and write requests are subject to your InfluxDB Cloud organization's
{{% note %}}
The migration process requires two buckets in your source InfluxDB
organization—one bucket to store the data you're migrating and a second bucket
organization: one bucket to store the data you're migrating and a second bucket
to store migration metadata.
If you're using the [InfluxDB Cloud Free Plan](/influxdb/cloud/account-management/limits/#free-plan),
and have more than one bucket to migrate, you will exceed your plans bucket limit.
and have more than one bucket to migrate, you will exceed your plan's bucket limit.
To migrate more than one bucket, you need to [upgrade to the Usage-based plan](/influxdb/cloud/account-management/billing/#upgrade-to-usage-based-plan)
to complete the migration.
{{% /note %}}
@ -273,7 +273,7 @@ from(bucket: "example-cloud-bucket")
The `migration.batchInterval` setting controls the time range queried by each batch.
The "density" of the data in your InfluxDB Cloud bucket and your InfluxDB Cloud
organization's [rate limits and quotas](/influxdb/cloud/account-management/limits/)
organization's [rate limits and quotas](/influxdb/cloud-iox/admin/accounts/limits/)
determine what your batch interval should be.
For example, if you're migrating data collected from hundreds of sensors with
@ -369,7 +369,7 @@ too many requests
a smaller interval. Each batch will then query less data.
### Invalid API token
If the API token you add as the `INFLUXDB_IOX_SECRET` doesn't have wrote access
If the API token you add as the `INFLUXDB_IOX_SECRET` doesn't have write access
to your InfluxDB Cloud (IOx) bucket, the task will return an error similar to:
```

1
content/influxdb/cloud-iox/write-data/use-telegraf/_index.md
View File

@ -9,6 +9,7 @@ aliases:
- /influxdb/cloud-iox/collect-data/advanced-telegraf
- /influxdb/cloud-iox/collect-data/use-telegraf
- /influxdb/cloud-iox/write-data/use-telegraf/
- /influxdb/cloud-iox/write-data/no-code/use-telegraf/
menu:
influxdb_cloud_iox:
name: Use Telegraf

2
content/influxdb/cloud/account-management/_index.md
View File

@ -2,7 +2,7 @@
title: Manage your InfluxDB Cloud Account
description: >
View and manage information related to your InfluxDB Cloud account such as
pricing plans, data usage, account cancelation, etc.
pricing plans, data usage, account cancellation, etc.
weight: 10
aliases:
- /influxdb/v2.0/cloud/account-management/

14
content/influxdb/cloud/account-management/limits.md
View File

@ -1,5 +1,6 @@
---
title: InfluxDB Cloud limits and adjustable quotas
list_title: Limits and adjustable quotas
description: >
InfluxDB Cloud has adjustable service quotas and global (non-adjustable) system limits.
weight: 110
@ -13,10 +14,11 @@ related:
- /influxdb/cloud/write-data/best-practices/resolve-high-cardinality/
---
InfluxDB Cloud applies (non-adjustable) global system limits and adjustable service quotas on a per organization basis. Currently, InfluxDB Cloud supports one organization per account.
InfluxDB Cloud applies (non-adjustable) global system limits and adjustable service quotas on a per organization basis.
{{% warn %}}
All __rates__ (data-in (writes), queries (reads), and deletes) are accrued within a fixed five-minute window. Once a rate is exceeded, an error response is returned until the current five-minute window resets.
All __rates__ (data-in (writes), queries (reads), and deletes) are accrued within a fixed five-minute window.
Once a rate is exceeded, an error response is returned until the current five-minute window resets.
{{% /warn %}}
Review adjustable service quotas and global limits to plan for your bandwidth needs:
@ -50,7 +52,7 @@ _To request higher service quotas, reach out to [InfluxData Support](https://sup
- **Storage**: 30 days of data retention (see [retention period](/influxdb/cloud/reference/glossary/#retention-period))
{{% note %}}
To write historical data older than 30 days, retain data for more than 30 days, or increase rate limits, upgrade to the Cloud [Usage-Based Plan](/influxdb/cloud/account-management/pricing-plans/#usage-based-plan).
To write historical data older than 30 days, retain data for more than 30 days, increase rate limits, or create additional organizations, upgrade to the Cloud [Usage-Based Plan](/influxdb/cloud/account-management/pricing-plans/#usage-based-plan).
{{% /note %}}
### Usage-Based Plan
@ -103,6 +105,6 @@ The following API error responses occur when your plan's service quotas are exce
| HTTP response code | Error message | Description |
| :----------------------------- | :----------------------------------------- | :----------- |
| `HTTP 413 "Request Too Large"` | cannot read data: points in batch is too large | If a **write** request exceeds the maximum [global limit](/influxdb/cloud/account-management/limits/#global-limits) |
| `HTTP 429 "Too Many Requests"` | Retry-After: xxx (seconds to wait before retrying the request) | If a **read** or **write** request exceeds your plan's [adjustable service quotas](/influxdb/cloud/account-management/limits/#adjustable-service-quotas) or if a **delete** request exceeds the maximum [global limit](/influxdb/cloud/account-management/limits/#global-limits) |
| `HTTP 429 "Too Many Requests"` | Series cardinality exceeds your plan's service quota | If **series cardinality** exceeds your plan's [adjustable service quotas](/influxdb/cloud/account-management/limits/#adjustable-service-quotas) |
| `HTTP 413 "Request Too Large"` | cannot read data: points in batch is too large | If a **write** request exceeds the maximum [global limit](#global-limits) |
| `HTTP 429 "Too Many Requests"` | Retry-After: xxx (seconds to wait before retrying the request) | If a **read** or **write** request exceeds your plan's [adjustable service quotas](#adjustable-service-quotas) or if a **delete** request exceeds the maximum [global limit](#global-limits) |
| `HTTP 429 "Too Many Requests"` | Series cardinality exceeds your plan's service quota | If **series cardinality** exceeds your plan's [adjustable service quotas](#adjustable-service-quotas) |

2
content/influxdb/cloud/api-guide/_index.md
View File

@ -26,4 +26,4 @@ that work with InfluxDB 1.x client libraries and third-party integrations like
<a class="btn" href="/influxdb/cloud/api/v1-compatibility/">View full v1 compatibility API documentation</a>
{{< influxdbu title="Building IoT Appls with InfluxDB" summary="Learn the basics of how to build an IoT application with InfluxDB with this **free** InfluxDB University course." action="Take the course" link="https://university.influxdata.com/courses/building-iot-apps-with-influxdb-tutorial/" >}}
{{< influxdbu title="Building IoT Apps with InfluxDB" summary="Learn the basics of how to build an IoT application with InfluxDB with this **free** InfluxDB University course." action="Take the course" link="https://university.influxdata.com/courses/building-iot-apps-with-influxdb-tutorial/" >}}

2
content/influxdb/cloud/query-data/execute-queries/_index.md
View File

@ -13,5 +13,3 @@ influxdb/cloud/tags: [query]
There are multiple ways to execute queries with InfluxDB. Choose from the following options:
{{< children >}}

27
content/influxdb/cloud/reference/api/_index.md
View File

@ -8,29 +8,4 @@ weight: 3
influxdb/cloud/tags: [api]
---
The InfluxDB v2 API provides a programmatic interface for interactions with InfluxDB.
Access the InfluxDB API using the `/api/v2/` endpoint.
## InfluxDB client libraries
[InfluxDB client libraries](/influxdb/cloud/api-guide/client-libraries/) are language-specific packages that integrate with the InfluxDB v2 API.
## Authentication
{{% cloud-token-auth %}}
Include your API token as an `Authorization` header in each request.
```sh
curl --request POST https://cloud2.influxdata.com/api/v2/write \
--header "Authorization: Token YOUR_API_TOKEN" \
--data-urlencode "org=myorg" \
--data-urlencode "bucket=example-bucket"
```
## InfluxDB Cloud API documentation
<a class="btn" href="/influxdb/cloud/api/">InfluxDB Cloud API documentation</a>
## InfluxDB v1 compatibility API documentation
The InfluxDB v2 API includes [InfluxDB 1.x compatibility endpoints](/influxdb/cloud/reference/api/influxdb-1x/)
that work with InfluxDB 1.x client libraries and third-party integrations like
[Grafana](https://grafana.com) and others.
<a class="btn" href="/influxdb/cloud/api/v1-compatibility/">View full v1 compatibility API documentation</a>
{{< duplicate-oss >}}

13
content/influxdb/v2.6/reference/api/_index.md
View File

@ -8,11 +8,15 @@ weight: 3
influxdb/v2.6/tags: [api]
aliases:
- /influxdb/v2.6/concepts/api/
related:
- /influxdb/v2.6/api-guide/
---
The InfluxDB v2 API provides a programmatic interface for interactions with InfluxDB.
Access the InfluxDB API using the `/api/v2/` endpoint.
{{% oss-only %}}
## InfluxDB v2 API documentation
<a class="btn" href="/influxdb/v2.6/api/">InfluxDB OSS {{< current-version >}} API documentation</a>
@ -22,6 +26,15 @@ the API specific to the current version of InfluxDB.
To view the API documentation locally, [start InfluxDB](/influxdb/v2.6/get-started/#start-influxdb)
and visit the `/docs` endpoint in a browser ([localhost:8086/docs](http://localhost:8086/docs)).
{{% /oss-only %}}
{{% cloud-only %}}
## InfluxDB v2 API documentation
<a class="btn" href="/influxdb/cloud/api/">InfluxDB {{< current-version >}} API documentation</a>
{{% /cloud-only %}}
## InfluxDB v1 compatibility API documentation
The InfluxDB v2 API includes [InfluxDB 1.x compatibility endpoints](/influxdb/v2.6/reference/api/influxdb-1x/)
that work with InfluxDB 1.x client libraries and third-party integrations like