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

Merge branch 'master' into jts/dar-472-catalog-terminology

pull/5885/head
Jason Stirnaman 2025-03-14 17:34:39 -05:00 committed by GitHub
parent c95ffad822 8cada04c55
commit c37e50e352
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
268 changed files with 2956 additions and 3489 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
content/influxdb3/cloud-dedicated/admin/databases/_index.md
View File

@ -24,17 +24,16 @@ alt_links:
An InfluxDB database is a named location where time series data is stored.
Each InfluxDB database has a [retention period](#retention-periods).
{{% note %}}
**If coming from InfluxDB v1**, the concepts of databases and retention policies
have been combined into a single concept--database. Retention policies are no
longer part of the InfluxDB data model.
However, {{% product-name %}} does
support InfluxQL, which requires databases and retention policies.
See [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention).
**If coming from InfluxDB v2, InfluxDB Cloud (TSM), or InfluxDB Cloud Serverless**,
_database_ and _bucket_ are synonymous.
{{% /note %}}
> [!Note]
> **If coming from InfluxDB v1**, the concepts of databases and retention policies
> have been combined into a single concept--database. Retention policies are no
> longer part of the InfluxDB data model.
> However, {{% product-name %}} does
> support InfluxQL, which requires databases and retention policies.
> See [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention).
>
> **If coming from InfluxDB v2, InfluxDB Cloud (TSM), or InfluxDB Cloud Serverless**,
> _database_ and _bucket_ are synonymous.
## Retention periods

23
content/influxdb3/cloud-dedicated/admin/databases/create.md
View File

@ -101,9 +101,8 @@ to create a database in your {{< product-name omit=" Clustered" >}} cluster.
the time interval to partition by. Default is `%Y-%m-%d`.
- Database name _(see [Database naming restrictions](#database-naming-restrictions))_
{{% note %}}
_{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
{{% /note %}}
> [!Note]
> _{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
<!--Skip tests for database create and delete: namespaces aren't reusable-->
<!--pytest.mark.skip-->
@ -232,9 +231,8 @@ _This example uses [cURL](https://curl.se/) to send a Management HTTP API reques
the time interval to partition by. Default is `%Y-%m-%d`.
- Database name _(see [Database naming restrictions](#database-naming-restrictions))_.
{{% note %}}
_{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
{{% /note %}}
> [!Note]
> _{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
The following example shows how to use the Management API to create a database with custom partitioning:
@ -343,13 +341,12 @@ For more information, see [Manage data partitioning](/influxdb3/cloud-dedicated/
{{% /tab-content %}}
{{< /tabs-wrapper >}}
{{% warn %}}
#### Partition templates can only be applied on create
You can only apply a partition template when creating a database.
You can't update a partition template on an existing database.
{{% /warn %}}
> [!Warning]
>
> #### Partition templates can only be applied on create
>
> You can only apply a partition template when creating a database.
> You can't update a partition template on an existing database.
### Database naming restrictions

19
content/influxdb3/cloud-dedicated/admin/databases/delete.md
View File

@ -31,16 +31,15 @@ related:
Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/)
or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to create a database in your {{< product-name omit=" Clustered" >}} cluster.
{{% warn %}}
#### Deleting a database cannot be undone
Once a database is deleted, data stored in that database cannot be recovered.
#### Cannot reuse database names
After a database is deleted, you cannot reuse the same name for a new database.
{{% /warn %}}
> [!Warning]
>
> #### Deleting a database cannot be undone
>
> Once a database is deleted, data stored in that database cannot be recovered.
>
> #### Cannot reuse database names
>
> After a database is deleted, you cannot reuse the same name for a new database.
{{< tabs-wrapper >}}
{{% tabs %}}

38
content/influxdb3/cloud-dedicated/admin/databases/update.md
View File

@ -79,12 +79,11 @@ Replace the following in your command:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/)
{{% warn %}}
#### Database names can't be updated
The `influxctl database update` command uses the database name to identify which
database to apply updates to. The database name itself can't be updated.
{{% /warn %}}
> [!Warning]
> #### Database names can't be updated
>
> The `influxctl database update` command uses the database name to identify which
> database to apply updates to. The database name itself can't be updated.
## Database attributes
@ -217,20 +216,19 @@ The retention period value cannot be negative or contain whitespace.
{{% /tab-content %}}
{{< /tabs-wrapper >}}
{{% warn %}}
#### Database names can't be updated
The Management API `PATCH /api/v0/database` endpoint and
the`influxctl database update` command use the database name to identify which
database to apply updates to.
The database name itself can't be updated.
#### Partition templates can't be updated
You can only apply a partition template when creating a database.
You can't update a partition template on an existing database.
{{% /warn %}}
> [!Warning]
>
> #### Database names can't be updated
>
> The Management API `PATCH /api/v0/database` endpoint and
> the`influxctl database update` command use the database name to identify which
> database to apply updates to.
> The database name itself can't be updated.
>
> #### Partition templates can't be updated
>
> You can only apply a partition template when creating a database.
> You can't update a partition template on an existing database.
### Database naming restrictions

11
content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md
View File

@ -14,12 +14,11 @@ InfluxData provides a Grafana operational dashboard that provides observability
into your {{< product-name >}} cluster.
Use the operational dashboard to monitor your cluster.
{{% note %}}
#### Not available for all clusters
{{< product-name >}} operational dashboards are not available for all clusters.
For questions about availability, [contact InfluxData support](https://support.influxdata.com).
{{% /note %}}
> [!Note]
> #### Not available for all clusters
>
> {{< product-name >}} operational dashboards are not available for all clusters.
> For questions about availability, [contact InfluxData support](https://support.influxdata.com).
- [Access your operational dashboard](#access-your-operational-dashboard)
- [Dashboard sections and cells](#dashboard-sections-and-cells)

69
content/influxdb3/cloud-dedicated/admin/query-system-data.md
View File

@ -33,30 +33,28 @@ You can query the cluster system tables for information about your cluster.
- [Storage usage](#storage-usage)
- [Compaction](#compaction)
{{% warn %}}
#### May impact cluster performance
Querying InfluxDB 3 system tables may impact write and query
performance of your {{< product-name omit=" Clustered" >}} cluster.
Use filters to [optimize queries to reduce impact to your cluster](#optimize-queries-to-reduce-impact-to-your-cluster).
<!--------------- UPDATE THE DATE BELOW AS EXAMPLES ARE UPDATED --------------->
#### System tables are subject to change
System tables are not part of InfluxDB's stable API and may change with new releases.
The provided schema information and query examples are valid as of **September 18, 2024**.
If you detect a schema change or a non-functioning query example, please
[submit an issue](https://github.com/influxdata/docs-v2/issues/new/choose).
<!--------------- UPDATE THE DATE ABOVE AS EXAMPLES ARE UPDATED --------------->
{{% /warn %}}
> [!Warning]
> #### May impact cluster performance
>
> Querying InfluxDB 3 system tables may impact write and query
> performance of your {{< product-name omit=" Clustered" >}} cluster.
> Use filters to [optimize queries to reduce impact to your cluster](#optimize-queries-to-reduce-impact-to-your-cluster).
>
> <!--------------- UPDATE THE DATE BELOW AS EXAMPLES ARE UPDATED --------------->
>
> #### System tables are subject to change
>
> System tables are not part of InfluxDB's stable API and may change with new releases.
> The provided schema information and query examples are valid as of **September 18, 2024**.
> If you detect a schema change or a non-functioning query example, please
> [submit an issue](https://github.com/influxdata/docs-v2/issues/new/choose).
>
> <!--------------- UPDATE THE DATE ABOVE AS EXAMPLES ARE UPDATED --------------->
## Query system tables
{{% note %}}
Querying system tables with `influxctl` requires **`influxctl` v2.8.0 or newer**.
{{% /note %}}
> [!Note]
> Querying system tables with `influxctl` requires **`influxctl` v2.8.0 or newer**.
Use the [`influxctl query` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/query/)
and SQL to query system tables.
@ -258,9 +256,8 @@ Use the `AND`, `OR`, or `IN` keywords to combine filters in your query.
## System tables
{{% warn %}}
_System tables are [subject to change](#system-tables-are-subject-to-change)._
{{% /warn %}}
> [!Warning]
> _System tables are [subject to change](#system-tables-are-subject-to-change)._
### Understanding system table data distribution
@ -323,11 +320,10 @@ The `system.queries` table contains the following columns:
{{% /expand %}}
{{< /expand-wrapper >}}
{{% note %}}
_When listing measurements (tables) available within a namespace,
some clients and query tools may include the `queries` table in the list of
namespace tables._
{{% /note %}}
> [!Note]
> _When listing measurements (tables) available within a namespace,
> some clients and query tools may include the `queries` table in the list of
> namespace tables._
### system.tables
@ -390,14 +386,13 @@ The `system.compactor` table contains the following columns:
## System query examples
{{% warn %}}
#### May impact cluster performance
Querying InfluxDB 3 system tables may impact write and query
performance of your {{< product-name omit=" Clustered" >}} cluster.
The examples in this section include `WHERE` filters to [optimize queries and reduce impact to your cluster](#optimize-queries-to-reduce-impact-to-your-cluster).
{{% /warn %}}
> [!Warning]
> #### May impact cluster performance
>
> Querying InfluxDB 3 system tables may impact write and query
> performance of your {{< product-name omit=" Clustered" >}} cluster.
>
> The examples in this section include `WHERE` filters to [optimize queries and reduce impact to your cluster](#optimize-queries-to-reduce-impact-to-your-cluster).
- [Query logs](#query-logs)
- [View all stored query logs](#view-all-stored-query-logs)

28
content/influxdb3/cloud-dedicated/admin/sso.md
View File

@ -101,26 +101,24 @@ properly. For example:
new secret to InfluxData support for updating in the InfluxData-managed Auth0
service.
{{% note %}}
#### Keep client secrets secure
InfluxData provides a secure method for transmitting sensitive secrets such as
an OIDC client secret. Never send your client secret to InfluxData using an
insecure method.
{{% /note %}}
> [!Important]
> #### Keep client secrets secure
>
> InfluxData provides a secure method for transmitting sensitive secrets such as
> an OIDC client secret. Never send your client secret to InfluxData using an
> insecure method.
- **You're using SAML and your identity provider certificate is rotated**:
Provide the new certificate to InfluxData support for updating in the
InfluxData-managed Auth0 service.
{{% note %}}
#### SAML certificate rotation
Some identity providers that support SAML are known to rotate certificates often.
Each time the certificate is rotated, you must provide the updated certificate
to InfluxData support. Consider this when selecting an identity provider and
protocol to use.
{{% /note %}}
> [!Important]
> #### SAML certificate rotation
>
> Some identity providers that support SAML are known to rotate certificates often.
> Each time the certificate is rotated, you must provide the updated certificate
> to InfluxData support. Consider this when selecting an identity provider and
> protocol to use.
## Troubleshooting

7
content/influxdb3/cloud-dedicated/admin/tables/_index.md
View File

@ -15,9 +15,8 @@ influxdb3/cloud-dedicated/tags: [tables]
Manage tables in your {{< product-name omit=" Clustered" >}} cluster.
A table is a collection of related data stored in table format.
{{% note %}}
In previous versions of InfluxDB and in the context of InfluxQL, tables are
known as "measurements."
{{% /note %}}
> [!Note]
> In previous versions of InfluxDB and in the context of InfluxQL, tables are
> known as "measurements."
{{< children hlevel="h2" >}}

16
content/influxdb3/cloud-dedicated/admin/tables/create.md
View File

@ -40,9 +40,8 @@ to a table, you must manually create the table before you write any data to it.
- The name of the database to create the table in
- The name of the table to create
{{% note %}}
_{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
{{% /note %}}
> [!Note]
> _{{< product-name >}} supports up to 7 total tags or tag buckets in the partition template._
{{% code-placeholders "(DATABASE|TABLE)_NAME" %}}
```sh
@ -71,9 +70,8 @@ If no template flags are provided, the table uses the partition template of the
target database.
For more information, see [Manage data partitioning](/influxdb3/cloud-dedicated/admin/custom-partitions/).
{{% warn %}}
#### Partition templates can only be applied on create
You can only apply a partition template when creating a table.
There is no way to update a partition template on an existing table.
{{% /warn %}}
> [!Warning]
> #### Partition templates can only be applied on create
>
> You can only apply a partition template when creating a table.
> There is no way to update a partition template on an existing table.

9
content/influxdb3/cloud-dedicated/admin/tables/list.md
View File

@ -29,9 +29,8 @@ Use the [`SHOW TABLES` SQL statement](/influxdb3/cloud-dedicated/query-data/sql/
or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb3/cloud-dedicated/query-data/influxql/explore-schema/#list-measurements-in-a-database)
to list tables in a database.
{{% note %}}
With {{< product-name >}}, tables and measurements are synonymous.
{{% /note %}}
> [!Note]
> With {{< product-name >}}, tables and measurements are synonymous.
###### SQL
@ -50,10 +49,6 @@ SHOW MEASUREMENTS
To list tables using the `influxctl` CLI, use the `influxctl query` command to pass
the `SHOW TABLES` SQL statement.
{{% note %}}
The `influxctl query` command only supports SQL queries; not InfluxQL.
{{% /note %}}
Provide the following with your command:
- **Database token**: [Database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens)

13
content/influxdb3/cloud-dedicated/admin/tokens/_index.md
View File

@ -37,13 +37,12 @@ Management tokens allow clients, such as the
[`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/),
to perform administrative actions.
{{% note %}}
#### Store secure tokens in a secret store
Token strings are returned _only_ on token creation.
We recommend storing database tokens in a **secure secret store**.
For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os).
{{% /note %}}
> [!Note]
> #### Store secure tokens in a secret store
>
> Token strings are returned _only_ on token creation.
> We recommend storing database tokens in a **secure secret store**.
> For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os).
---

19
content/influxdb3/cloud-dedicated/admin/tokens/database/create.md
View File

@ -169,16 +169,15 @@ The response body contains the token ID and the token string.
If a new database token doesn't immediately work (you receive a `401 Unauthorized` error) for querying or writing, wait and then try again.
- Token strings are viewable _only_ on token creation.
{{% note %}}
#### Store secure tokens in a secret store
Token strings are viewable _only_ on token creation and aren't stored by InfluxDB.
We recommend storing database tokens in a **secure secret store**.
For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os).
If you lose a token, [delete the token from InfluxDB](/influxdb3/cloud-dedicated/admin/tokens/database/delete/) and create a new one.
{{% /note %}}
> [!Note]
>
> #### Store secure tokens in a secret store
>
> Token strings are viewable _only_ on token creation and aren't stored by InfluxDB.
> We recommend storing database tokens in a **secure secret store**.
> For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os).
>
> If you lose a token, [delete the token from InfluxDB](/influxdb3/cloud-dedicated/admin/tokens/database/delete/) and create a new one.
## Output format

23
content/influxdb3/cloud-dedicated/admin/tokens/database/delete.md
View File

@ -118,15 +118,14 @@ Replace the following:
{{% /tab-content %}}
{{< /tabs-wrapper >}}
{{% warn %}}
#### Deleting a token is immediate and cannot be undone
Deleting a database token is a destructive action that takes place immediately
and cannot be undone.
#### Rotate deleted tokens
After deleting a database token, any clients using the deleted token need to be
updated with a new database token to continue to interact with your InfluxDB
Cloud Dedicated cluster.
{{% /warn %}}
> [!Warning]
> #### Deleting a token is immediate and cannot be undone
>
> Deleting a database token is a destructive action that takes place immediately
> and cannot be undone.
>
> #### Rotate deleted tokens
>
> After deleting a database token, any clients using the deleted token need to be
> updated with a new database token to continue to interact with your InfluxDB
> Cloud Dedicated cluster.

15
content/influxdb3/cloud-dedicated/admin/tokens/database/update.md
View File

@ -172,14 +172,13 @@ Replace the following in your request:
{{% /tab-content %}}
{{< /tabs-wrapper >}}
{{% note %}}
#### Existing permissions are replaced on update
When updating token permissions, the existing permissions are replaced by the
new permissions specified in the update command.
To retain existing permissions, include them in the update command.
{{% /note %}}
> [!Note]
>
> #### Existing permissions are replaced on update
>
> When updating token permissions, the existing permissions are replaced by the
> new permissions specified in the update command.
> To retain existing permissions, include them in the update command.
### Examples

34
content/influxdb3/cloud-dedicated/admin/tokens/management/_index.md
View File

@ -19,13 +19,12 @@ Management tokens grant permission to perform administrative actions such as
managing users, databases, and database tokens in your
{{< product-name omit=" Clustered">}} cluster.
{{% note %}}
Management tokens do _not_ grant permissions to write or query time series data
in your {{< product-name omit=" Clustered">}} cluster.
To grant write or query permissions, use management tokens to create
[database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/).
{{% /note %}}
> [!Note]
> Management tokens do _not_ grant permissions to write or query time series data
> in your {{< product-name omit=" Clustered">}} cluster.
>
> To grant write or query permissions, use management tokens to create
> [database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/).
By default, management tokens are short-lived tokens issued by your identity
provider for a [specific client session](/influxdb3/cloud-dedicated/reference/internals/security/#management-tokens-in-the-influxctl-cli) (for example, `influxctl`).
@ -36,17 +35,16 @@ interaction with your identity provider.
_Manually created management tokens provide full access to all account resources
and aren't affected by [user groups](/influxdb3/cloud-dedicated/reference/internals/security/#user-groups)_.
{{% warn %}}
#### For automation use cases only
The tools outlined below are meant for automation use cases and shouldn't be
used to circumvent your identity provider or user group permissions.
**Take great care when manually creating and using management tokens**.
{{< product-name >}} requires at least one [Admin user](/influxdb3/cloud-dedicated/reference/internals/security/#admin-user-group) associated with your cluster
and authorized through your OAuth2 identity provider to manually create a
management token.
{{% /warn %}}
> [!Warning]
> #### For automation use cases only
>
> The tools outlined below are meant for automation use cases and shouldn't be
> used to circumvent your identity provider or user group permissions.
> **Take great care when manually creating and using management tokens**.
>
> {{< product-name >}} requires at least one [Admin user](/influxdb3/cloud-dedicated/reference/internals/security/#admin-user-group) associated with your cluster
> and authorized through your OAuth2 identity provider to manually create a
> management token.
{{< children type="anchored-list" >}}
- [Use a management token](#use-a-management-token)

34
content/influxdb3/cloud-dedicated/admin/tokens/management/create.md
View File

@ -26,17 +26,16 @@ However, for automation purposes, you can manually create management tokens that
authenticate directly with your InfluxDB cluster and do not require human
interaction with your identity provider.
{{% warn %}}
#### For automation use cases only
The tools outlined below are meant for automation use cases and should not be
used to circumvent your identity provider. **Take great care when manually creating
and using management tokens**.
{{< product-name >}} requires that at least one user associated with your cluster
and authorized through your OAuth2 identity provider to manually create a
management token.
{{% /warn %}}
> [!Warning]
> #### For automation use cases only
>
> The tools outlined below are meant for automation use cases and should not be
> used to circumvent your identity provider. **Take great care when manually creating
> and using management tokens**.
>
> {{< product-name >}} requires that at least one user associated with your cluster
> and authorized through your OAuth2 identity provider to manually create a
> management token.
1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl).
2. Use the [`influxctl management create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/create/)
@ -65,10 +64,9 @@ Replace the following:
Once created, the command returns the management token string.
{{% note %}}
#### Store secure tokens in a secret store
Management token strings are returned _only_ on token creation.
We recommend storing database tokens in a **secure secret store**.
For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os).
{{% /note %}}
> [!Note]
> #### Store secure tokens in a secret store
>
> Management token strings are returned _only_ on token creation.
> We recommend storing database tokens in a **secure secret store**.
> For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/> telegraf/tree/master/plugins/secretstores/os).

21
content/influxdb3/cloud-dedicated/admin/tokens/management/list.md
View File

@ -29,17 +29,16 @@ to list manually-created management tokens.
influxctl management list --format json
```
{{% note %}}
#### Management token strings are not retrievable
The actual management token string is not printed and is only returned when
creating the token.
#### Revoked tokens are included in output
Revoked tokens still appear when listing management tokens, but they are no
longer valid for any operations.
{{% /note %}}
> [!Note]
> #### Management token strings are not retrievable
>
> The actual management token string is not printed and is only returned when
> creating the token.
>
> #### Revoked tokens are included in output
>
> Revoked tokens still appear when listing management tokens, but they are no
> longer valid for any operations.
### Output formats

11
content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md
View File

@ -44,9 +44,8 @@ influxctl management revoke --force TOKEN_ID
Replace {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}} with
the ID of the token you want to revoke.
{{% note %}}
#### Revoked tokens are included when listing management tokens
Revoked tokens still appear when listing management tokens, but they are no
longer valid for any operations.
{{% /note %}}
> [!Note]
> #### Revoked tokens are included when listing management tokens
>
> Revoked tokens still appear when listing management tokens, but they are no
> longer valid for any operations.

26
content/influxdb3/cloud-dedicated/admin/users/_index.md
View File

@ -39,13 +39,12 @@ A user can belong to the following groups, each with predefined privileges:
database tokens; members can't delete or create databases or management tokens.
- **Auditor**: Read permission on all resources; auditors can't modify resources.
{{% note %}}
#### Existing users are Admin by default
With the release of user groups for {{% product-name %}}, all existing users
in your account are initially assigned to the Admin group, retaining full
access to resources in your cluster.
{{% /note %}}
> [!Note]
> #### Existing users are Admin by default
>
> With the release of user groups for {{% product-name %}}, all existing users
> in your account are initially assigned to the Admin group, retaining full
> access to resources in your cluster.
## Manage users
@ -83,10 +82,9 @@ With a valid password, the user can access cluster resources by interacting with
[`influxctl`](/influxdb3/cloud-dedicated/reference/influxctl/) command line tool.
The assigned user groups determine the user's access to resources.
{{% note %}}
#### Use database tokens to authorize data reads and writes
In {{% product-name %}}, user groups control access for managing cluster resources.
[Database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/) control access
for reading and writing data in cluster databases.
{{% /note %}}
> [!Note]
> #### Use database tokens to authorize data reads and writes
>
> In {{% product-name %}}, user groups control access for managing cluster resources.
> [Database tokens](/influxdb3/cloud-dedicated/admin/tokens/database/) control access
> for reading and writing data in cluster databases.

26
content/influxdb3/cloud-dedicated/get-started/_index.md
View File

@ -64,16 +64,15 @@ Tables contain multiple tags and fields.
- **Timestamp**: Timestamp associated with the data. When stored on disk and
queried, all data is ordered by time. A timestamp is never null.
{{% note %}}
#### What about buckets and measurements?
If coming from InfluxDB Cloud Serverless or InfluxDB powered by the TSM storage
engine, you're likely familiar with the concepts _bucket_ and _measurement_.
_Bucket_ in TSM or InfluxDB Cloud Serverless is synonymous with _database_ in
{{% product-name %}}. _Measurement_ in TSM or InfluxDB Cloud Serverless is
synonymous with _table_ in {{% product-name %}}.
{{% /note %}}
> [!Note]
>
> #### What about buckets and measurements?
>
> If coming from InfluxDB Cloud Serverless or InfluxDB powered by the TSM storage
> engine, you're likely familiar with the concepts _bucket_ and _measurement_.
> _Bucket_ in TSM or InfluxDB Cloud Serverless is synonymous with _database_ in
> {{% product-name %}}. _Measurement_ in TSM or InfluxDB Cloud Serverless is
> synonymous with _table_ in {{% product-name %}}.
### Schema on write
@ -123,10 +122,9 @@ The following table compares tools that you can use to interact with
{{< req type="key" text="Covered in this tutorial" color="magenta" >}}
{{< /caption >}}
{{% warn %}}
Avoid using the `influx` CLI with {{% product-name %}}. While it
may coincidentally work, it isn't supported.
{{% /warn %}}
> [!Warning]
> Avoid using the `influx` CLI with {{% product-name %}}. While it
> may coincidentally work, it isn't supported.
### `influxctl` CLI

58
content/influxdb3/cloud-dedicated/get-started/query.md
View File

@ -33,13 +33,12 @@ a protocol for interacting with SQL databases using the Arrow in-memory format a
It leverages the performance of [Apache Arrow](https://arrow.apache.org/) with
the simplicity of SQL.
{{% note %}}
The examples in this section of the tutorial query the
[**get-started** database](/influxdb3/cloud-dedicated/get-started/setup/#create-a-database)
for data written in the
[Get started writing data](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb)
section.
{{% /note %}}
> [!Note]
> The examples in this section of the tutorial query the
> [**get-started** database](/influxdb3/cloud-dedicated/get-started/setup/#create-a-database)
> for data written in the
> [Get started writing data](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb)
> section.
## Tools to execute queries
@ -55,23 +54,20 @@ section.
- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api/)
- [Chronograf](/chronograf/v1/)
{{% warn %}}
#### /api/v2/query not supported
The `/api/v2/query` API endpoint and associated tooling, such as the `influx` CLI and InfluxDB v2 client libraries, **aren’t** supported in {{% product-name %}}.
{{% /warn %}}
> [!Warning]
>
> #### /api/v2/query not supported
>
> The `/api/v2/query` API endpoint and associated tooling, such as the `influx` CLI and InfluxDB v2 client libraries, **aren’t** supported in {{% product-name %}}.
## SQL query basics
The {{% product-name %}} SQL implementation is powered by the [Apache Arrow DataFusion](https://arrow.apache.org/datafusion/)
query engine which provides an SQL syntax similar to PostgreSQL.
{{% note %}}
This is a brief introduction to writing SQL queries for InfluxDB.
For more in-depth details, see [Query data with SQL](/influxdb3/cloud-dedicated/query-data/sql/).
{{% /note %}}
> [!Note]
> This is a brief introduction to writing SQL queries for InfluxDB.
> For more in-depth details, see [Query data with SQL](/influxdb3/cloud-dedicated/query-data/sql/).
InfluxDB SQL queries most commonly include the following clauses:
@ -242,11 +238,10 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1719950400
```
-->
{{% note %}}
Some examples in this getting started tutorial assume your InfluxDB
credentials (**URL** and **token**) are provided by
[environment variables](/influxdb3/cloud-dedicated/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials).
{{% /note %}}
> [!Note]
> Some examples in this getting started tutorial assume your InfluxDB
> credentials (**URL** and **token**) are provided by
> [environment variables](/influxdb3/cloud-dedicated/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials).
{{< tabs-wrapper >}}
{{% tabs %}}
@ -290,15 +285,14 @@ influxctl query \
{{% /code-placeholders %}}
{{% /influxdb/custom-timestamps %}}
{{% note %}}
#### Query using stored credentials
Optionally, you can configure `database` and `token` query credentials in your `influxctl`
[connection profile](/influxdb/clustered/reference/cli/influxctl/#create-a-configuration-file).
The `--database` and `--token` command line flags override credentials in your
configuration file.
{{% /note %}}
> [!Note]
> #### Query using stored credentials
>
> Optionally, you can configure `database` and `token` query credentials in your `influxctl`
> [connection profile](/influxdb/clustered/reference/cli/influxctl/#create-a-configuration-file).
>
> The `--database` and `--token` command line flags override credentials in your
> configuration file.
<!--------------------------- END influxctl CONTENT --------------------------->
{{% /tab-content %}}

42
content/influxdb3/cloud-dedicated/get-started/setup.md
View File

@ -66,12 +66,10 @@ databases and tokens.
| macOS | `~/Library/Application Support/influxctl/config.toml` |
| Windows | `%APPDATA%\influxctl\config.toml` |
{{% note %}}
If stored at a non-default location, include the `--config` flag with each
`influxctl` command and provide the path to your profile configuration file.
{{% /note %}}
> [!Note]
>
> If stored at a non-default location, include the `--config` flag with each
> `influxctl` command and provide the path to your profile configuration file.
3. **Copy and paste the sample configuration profile code** into your `config.toml`:
@ -104,15 +102,14 @@ to create a database. You can use an existing database or create a new one
specifically for this getting started tutorial.
_Examples in this getting started tutorial assume a database named `get-started`._
{{% note %}}
#### Authenticate with your cluster
The first time you run an `influxctl` CLI command, you are directed
to login to **Auth0**. Once logged in, Auth0 issues a short-lived (1 hour)
management token for the `influxctl` CLI that grants administrative access
to your {{< product-name omit="Clustered" >}} cluster.
{{% /note %}}
> [!Note]
>
> #### Authenticate with your cluster
>
> The first time you run an `influxctl` CLI command, you are directed
> to login to **Auth0**. Once logged in, Auth0 issues a short-lived (1 hour)
> management token for the `influxctl` CLI that grants administrative access
> to your {{< product-name omit="Clustered" >}} cluster.
Provide the following:
@ -170,14 +167,13 @@ Store the token string in a safe place.
You'll need it later.
**This is the only time the token string is available in plain text.**
{{% note %}}
#### Store secure tokens in a secret store
Token strings are returned _only_ on token creation.
We recommend storing database tokens in a **secure secret store**.
For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os).
{{% /note %}}
> [!Note]
>
> #### Store secure tokens in a secret store
>
> Token strings are returned _only_ on token creation.
> We recommend storing database tokens in a **secure secret store**.
> For example, see how to [authenticate Telegraf using tokens in your OS secret store](https://github.com/influxdata/telegraf/tree/master/plugins/secretstores/os).
## Configure authentication credentials

50
content/influxdb3/cloud-dedicated/get-started/write.md
View File

@ -167,11 +167,10 @@ to an {{% product-name %}} database.
To learn more about available tools and options, see
[Write data](/influxdb3/cloud-dedicated/write-data/).
{{% note %}}
Some examples in this getting started tutorial assume your InfluxDB
credentials (**URL**, **organization**, and **token**) are provided by
[environment variables](/influxdb3/cloud-dedicated/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials).
{{% /note %}}
> [!Note]
> Some examples in this getting started tutorial assume your InfluxDB
> credentials (**URL**, **organization**, and **token**) are provided by
> [environment variables](/influxdb3/cloud-dedicated/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials).
{{< tabs-wrapper >}}
@ -411,13 +410,10 @@ learn more, see how to
Write data with your existing workloads that already use the InfluxDB v1
`/write` API endpoint.
{{% note %}}
If migrating data from InfluxDB 1.x, see the
[Migrate data from InfluxDB 1.x to InfluxDB {{% product-name %}}](/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated/)
guide.
{{% /note %}}
> [!Note]
> If migrating data from InfluxDB 1.x, see the
> [Migrate data from InfluxDB 1.x to InfluxDB {{% product-name %}}](/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated/)
> guide.
To write data to InfluxDB using the
[InfluxDB v1 HTTP API](/influxdb3/cloud-dedicated/reference/api/), send a request
@ -440,14 +436,13 @@ Include the following with your request:
(default is `ns`)
- **Request body**: Line protocol as plain text
{{% note %}}
With the {{% product-name %}}
[v1 API `/write` endpoint](/influxdb3/cloud-dedicated/api/#operation/PostLegacyWrite),
`Authorization: Bearer` and `Authorization: Token` are equivalent and you can
use either scheme to pass a database token in your request. For more information
about HTTP API token schemes, see how to
[authenticate API requests](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/).
{{% /note %}}
> [!Note]
> With the {{% product-name %}}
> [v1 API `/write` endpoint](/influxdb3/cloud-dedicated/api/#operation/PostLegacyWrite),
> `Authorization: Bearer` and `Authorization: Token` are equivalent and you can
> use either scheme to pass a database token in your request. For more information
> about HTTP API token schemes, see how to
> [authenticate API requests](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/).
The following example uses cURL and the InfluxDB v1 API to write line protocol
to InfluxDB:
@ -552,14 +547,13 @@ Include the following with your request:
- **Request body**: Line protocol as plain text
<!-- vale InfluxDataDocs.v3Schema = YES -->
{{% note %}}
The {{% product-name %}} v2 API `/api/v2/write` endpoint supports
`Bearer` and `Token` authorization schemes and you can use either scheme to pass
a database token in your request.
For more information about HTTP API token
schemes, see how to
[authenticate API requests](/influxdb3/cloud-dedicated/guides/api-compatibility/v2/).
{{% /note %}}
> [!Note]
> The {{% product-name %}} v2 API `/api/v2/write` endpoint supports
> `Bearer` and `Token` authorization schemes and you can use either scheme to pass
> a database token in your request.
> For more information about HTTP API token
> schemes, see how to
> [authenticate API requests](/influxdb3/cloud-dedicated/guides/api-compatibility/v2/).
The following example uses cURL and the InfluxDB v2 API to write line protocol
to InfluxDB:

35
content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md
View File

@ -284,9 +284,8 @@ The following tools work with the {{% product-name %}} `/write` endpoint:
If you have existing v1 workloads that use Telegraf,
you can use the [InfluxDB v1.x `influxdb` Telegraf output plugin](https://github.com/influxdata/telegraf/blob/master/plugins/outputs/influxdb/README.md) to write data.
{{% note %}}
See how to [use Telegraf and the v2 API](/influxdb3/cloud-dedicated/write-data/use-telegraf/) for new workloads that don't already use the v1 API.
{{% /note %}}
> [!Note]
> See how to [use Telegraf and the v2 API](/influxdb3/cloud-dedicated/write-data/use-telegraf/) for new workloads that don't already use the v1 API.
The following table shows `outputs.influxdb` plugin parameters and values for writing to the {{% product-name %}} v1 API:
@ -439,19 +438,18 @@ Replace the following:
To learn how to query {{% product-name %}} using Flight and SQL, see the [Get started](/influxdb3/cloud-dedicated/get-started/) tutorial.
- InfluxDB v1 API `/query` request that contains an InfluxQL query. Use this endpoint with {{% product-name %}} when you bring InfluxDB 1.x workloads that already use [InfluxQL](/influxdb3/cloud-dedicated/reference/glossary/#influxql) and the v1 API `/query` endpoint.
{{% note %}}
#### Tools to execute queries
{{% product-name %}} supports many different tools for querying data, including:
- [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli)
- [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/)
- [Flight clients](/influxdb3/cloud-dedicated/reference/client-libraries/flight/)
- [Superset](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/superset/)
- [Grafana](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/grafana/)
- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api/)
- [Chronograf](/chronograf/v1/)
{{% /note %}}
> [!Note]
> #### Tools to execute queries
>
> {{% product-name %}} supports many different tools for querying data, including:
>
> - [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli)
> - [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/)
> - [Flight clients](/influxdb3/cloud-dedicated/reference/client-libraries/flight/)
> - [Superset](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/superset/)
> - [Grafana](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/grafana/)
> - [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api/)
> - [Chronograf](/chronograf/v1/)
### v1 API /query parameters
@ -469,9 +467,8 @@ Parameter | Allowed in | Ignored | Value
`p` | Query string | Honored | For [query string authentication](#query-string-authentication), a [database token](/influxdb3/cloud-dedicated/get-started/setup/#create-a-database-token) with permission to write to the database
`rp` | Query string | Honored, but discouraged | Retention policy
{{% note %}}
When bringing v1 API workloads to {{% product-name %}}, you'll need to adjust request parameters in your client configuration or code.
{{% /note %}}
> [!Note]
> When bringing v1 API workloads to {{% product-name %}}, you'll need to adjust request parameters in your client configuration or code.
#### Timestamp precision

54
content/influxdb3/cloud-dedicated/guides/api-compatibility/v2/_index.md
View File

@ -195,14 +195,12 @@ To test InfluxDB v2 API writes interactively, use the [`influx3` data CLI](https
To setup and start using interactive clients, see the [Get started](/influxdb3/cloud-dedicated/get-started/) tutorial.
{{% warn %}}
#### influx CLI not supported
Don't use the `influx` CLI with {{% product-name %}}.
While it may coincidentally work, it isn't officially supported.
{{% /warn %}}
> [!Warning]
>
> #### influx CLI not supported
>
> Don't use the `influx` CLI with {{% product-name %}}.
> While it may coincidentally work, it isn't officially supported.
#### Client libraries
@ -220,26 +218,22 @@ To setup and start using client libraries, see the [Get started](/influxdb3/clou
To learn how to query {{% product-name %}} using Flight and SQL, see the [Get started](/influxdb3/cloud-dedicated/get-started/) tutorial.
- InfluxDB v1 API `/query` request that contains an InfluxQL query.
{{% note %}}
#### Tools to execute queries
{{% product-name %}} supports many different tools for querying data, including:
- [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli)
- [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/)
- [Flight clients](/influxdb3/cloud-dedicated/reference/client-libraries/flight/)
- [Superset](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/superset/)
- [Grafana](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/grafana/)
- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/cloud-dedicated/primers/api/v1/#query-using-the-v1-api)
- [Chronograf](/chronograf/v1/)
{{% /note %}}
{{% warn %}}
#### /api/v2/query not supported
The `/api/v2/query` API endpoint and associated tooling, such as the `influx` CLI and InfluxDB v2 client libraries, **aren’t** supported in {{% product-name %}}.
{{% /warn %}}
> [!Note]
>
> #### Tools to execute queries
>
> {{% product-name %}} supports many different tools for querying data, including:
>
> - [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli)
> - [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/)
> - [Flight clients](/influxdb3/cloud-dedicated/reference/client-libraries/flight/)
> - [Superset](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/superset/)
> - [Grafana](/influxdb3/cloud-dedicated/query-data/sql/execute-queries/grafana/)
> - [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/cloud-dedicated/primers/api/v1/#query-using-the-v1-api)
> - [Chronograf](/chronograf/v1/)
> [!Warning]
> #### /api/v2/query not supported
>
> The `/api/v2/query` API endpoint and associated tooling, such as the `influx`
> CLI and InfluxDB v2 client libraries, **aren’t** supported in {{% product-name %}}.

41
content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md
View File

@ -202,11 +202,10 @@ The migration process uses the following tools:
- `-end` flag with an RFC3339 timestamp that defines the latest time to export.
Default is `2262-04-11T16:47:16-07:00`.
{{% note %}}
We recommend exporting each database and retention policy combination separately
to easily write the exported data into corresponding InfluxDB Cloud Dedicated
databases.
{{% /note %}}
> [!Note]
> We recommend exporting each database and retention policy combination separately
> to easily write the exported data into corresponding InfluxDB Cloud Dedicated
> databases.
##### Export all data in a database and retention policy to a file
@ -305,15 +304,14 @@ influx_inspect export \
2. Create InfluxDB Cloud Dedicated databases for each InfluxDB 1.x database and retention policy combination.
{{% note %}}
**If coming from InfluxDB v1**, the concepts of databases and retention policies
have been combined into a single concept--database. Retention policies are no
longer part of the InfluxDB data model. However, InfluxDB Cloud Dedicated does
support InfluxQL, which requires databases and retention policies.
See [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention).
**If coming from InfluxDB v2 or InfluxDB Cloud**, _database_ and _bucket_ are synonymous.
{{% /note %}}
> [!Note]
> **If coming from InfluxDB v1**, the concepts of databases and retention policies
> have been combined into a single concept--database. Retention policies are no
> longer part of the InfluxDB data model. However, InfluxDB Cloud Dedicated does
> support InfluxQL, which requires databases and retention policies.
> See [InfluxQL DBRP naming convention](/influxdb3/cloud-dedicated/admin/databases/create/#influxql-dbrp-naming-convention).
>
> **If coming from InfluxDB v2 or InfluxDB Cloud**, _database_ and _bucket_ are synonymous.
{{< expand-wrapper >}}
{{% expand "View example 1.x databases and retention policies as InfluxDB Cloud Dedicated databases" %}}
@ -384,11 +382,10 @@ You would create the following InfluxDB {{< current-version >}} databases:
Write each export file to the target database.
{{% warn %}}
#### v2.x influx CLI not supported
Don't use the `influx` CLI with InfluxDB Cloud Dedicated.
While it may coincidentally work, it isn't officially supported.
For help finding the best workflow for your situation, [contact Support](https://support.influxdata.com/).
{{% /warn %}}
> [!Warning]
> #### v2.x influx CLI not supported
>
> Don't use the `influx` CLI with InfluxDB Cloud Dedicated.
> While it may coincidentally work, it isn't officially supported.
>
> For help finding the best workflow for your situation, [contact Support](https://support.influxdata.com/).

30
content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated.md
View File

@ -154,15 +154,14 @@ data = () =>
## Set up the migration
{{% 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
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 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 %}}
> [!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
> 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 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.
1. **In the {{< product-name omit=" Clustered" >}} cluster you're migrating data _to_**:
@ -184,9 +183,9 @@ to complete the migration.
5. _(Optional)_ Set up [migration monitoring](#monitor-the-migration-progress).
6. Save the task.
{{% note %}}
Newly-created tasks are enabled by default, so the data migration begins when you save the task.
{{% /note %}}
> [!Note]
> Newly-created tasks are enabled by default, so the data migration
> begins when you save the task.
**After the migration is complete**, each subsequent migration task execution
will fail with the following error:
@ -424,10 +423,9 @@ curl -so /dev/null --request POST \
--write-out '%{size_download}'
```
{{% note %}}
You can also use other HTTP API tools like [Postman](https://www.postman.com/)
that provide the size of the response body.
{{% /note %}}
> [!Note]
> You can also use other HTTP API tools like [Postman](https://www.postman.com/)
> that provide the size of the response body.
Divide the output of this command by 1000000 to convert it to megabytes (MB).

7
content/influxdb3/cloud-dedicated/process-data/downsample/downsample-client-libraries.md
View File

@ -262,10 +262,9 @@ data_frame = table.to_pandas()
- **data_frame_tag_columns**: List of [tag](/influxdb3/cloud-dedicated/reference/glossary/#tag)
columns
{{% note %}}
Columns not listed in the **data_frame_tag_columns** or **data_frame_timestamp_column**
arguments are written to InfluxDB as [fields](/influxdb3/cloud-dedicated/reference/glossary/#field).
{{% /note %}}
> [!Note]
> Columns not listed in the **data_frame_tag_columns** or **data_frame_timestamp_column**
> arguments are written to InfluxDB as [fields](/influxdb3/cloud-dedicated/reference/glossary/#field).
```py
# ...

16
content/influxdb3/cloud-dedicated/process-data/downsample/downsample-quix.md
View File

@ -34,12 +34,11 @@ The following diagram illustrates how data is passed between processes as it is
{{< html-diagram/quix-downsample-pipeline >}}
{{% note %}}
It is usually more efficient to write raw data directly to Kafka rather than
writing raw data to InfluxDB first (essentially starting the Quix Streams
pipeline with the "raw-data" topic). However, this guide assumes that you
already have raw data in InfluxDB that you want to downsample.
{{% /note %}}
> [!Note]
> It is usually more efficient to write raw data directly to Kafka rather than
> writing raw data to InfluxDB first (essentially starting the Quix Streams
> pipeline with the "raw-data" topic). However, this guide assumes that you
> already have raw data in InfluxDB that you want to downsample.
---
@ -141,9 +140,8 @@ downsamples it, and then sends it to an output topic that is used to write back
The results are streamed to the Kafka topic, `downsampled-data`.
{{% note %}}
Note: "sdf" stands for "Streaming Dataframe".
{{% /note %}}
> [!Note]
> "sdf" stands for "Streaming Dataframe".
You can find the full code for this process in the
[Quix GitHub repository](https://github.com/quixio/template-influxdbv3-downsampling/blob/dev/Downsampler/main.py).

7
content/influxdb3/cloud-dedicated/process-data/send-alerts.md
View File

@ -44,10 +44,9 @@ More information is provided in the
## Install dependencies
{{% note %}}
This guide assumes you have already
[setup your Python project and virtual environment](/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment).
{{% /note %}}
> [!Note]
> This guide assumes you have already
> [setup your Python project and virtual environment](/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment).
Use `pip` to install the following dependencies:

17
content/influxdb3/cloud-dedicated/process-data/summarize.md
View File

@ -14,15 +14,14 @@ related:
Query data stored in InfluxDB and use tools like pandas to summarize the results schema and distribution.
{{% note %}}
#### Sample data
The following examples use the sample data written in the
[Get started writing data guide](/influxdb3/cloud-dedicated/get-started/write/).
To run the example queries and return results,
[write the sample data](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb)
to your {{% product-name %}} database before running the example queries.
{{% /note %}}
> [!Note]
> #### Sample data
>
> The following examples use the sample data written in the
> [Get started writing data guide](/influxdb3/cloud-dedicated/get-started/write/).
> To run the example queries and return results,
> [write the sample data](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb)
> to your {{% product-name %}} database before running the example queries.
### View data information and statistics

74
content/influxdb3/cloud-dedicated/process-data/visualize/chronograf.md
View File

@ -45,23 +45,22 @@ If you haven't already, [download and install Chronograf](/chronograf/v1/introdu
- **Default Retention Policy:** Default [retention policy](/influxdb3/cloud-dedicated/reference/glossary/#retention-policy-rp)
_**(leave blank)**_
{{% note %}}
#### DBRPs map to InfluxDB databases
In {{% product-name %}}, databases and retention-policies (DBRPs) are no longer
separate entities in the data model. Rather than having one or more retention policies,
an {{% product-name %}} database has a retention period, which defines the maximum
age of data to retain in the database.
InfluxQL queries still assume the 1.x DBRP convention, but with {{% product-name %}},
InfluxQL queries are mapped to databases using the `database-name/retention-policy`
naming convention. For example:
```sql
SELECT * FROM mydb.autogen.measurement
```
This query is routed to the {{% product-name %}} database with the name `mydb/autogen`.
{{% /note %}}
> [!Note]
> #### DBRPs map to InfluxDB databases
>
> In {{% product-name %}}, databases and retention-policies (DBRPs) are no longer
> separate entities in the data model. Rather than having one or more retention policies,
> an {{% product-name %}} database has a retention period, which defines the maximum
> age of data to retain in the database.
> InfluxQL queries still assume the 1.x DBRP convention, but with {{% product-name %}},
> InfluxQL queries are mapped to databases using the `database-name/retention-policy`
> naming convention. For example:
>
> ```sql
> SELECT * FROM mydb.autogen.measurement
> ```
>
> This query is routed to the {{% product-name %}} database with the name `mydb/autogen`.
3. Click **Add Connection**.
4. Select the dashboards you would like to create, and then click **Next**.
@ -78,27 +77,26 @@ This query is routed to the {{% product-name %}} database with the name `mydb/au
1. In Chronograf, click **{{< icon "graph" "v2" >}} Explore** in the left navigation bar.
2. Build and submit InfluxQL queries.
{{% note %}}
#### Schema information is not available
{{% product-name %}} currently offers limited support of InfluxQL metaqueries, so
schema information may not be available in the Data Explorer.
This limits the Data Explorer's query building functionality and requires you to
build queries manually using
[fully-qualified measurements](/influxdb3/cloud-dedicated/reference/influxql/select/#fully-qualified-measurement)
in the `FROM` clause. For example:
```sql
-- Fully-qualified measurement
SELECT * FROM "db-name"."rp-name"."measurement-name"
-- Fully-qualified measurement shorthand (use the default retention policy)
SELECT * FROM "db-name".."measurement-name"
```
For more information about available InfluxQL functionality, see
[InfluxQL feature support](/influxdb3/cloud-dedicated/reference/influxql/feature-support/).
{{% /note %}}
> [!Note]
> #### Schema information is not available
>
> {{% product-name %}} currently offers limited support of InfluxQL metaqueries, so
> schema information may not be available in the Data Explorer.
> This limits the Data Explorer's query building functionality and requires you to
> build queries manually using
> [fully-qualified measurements](/influxdb3/cloud-dedicated/reference/influxql/select/#fully-qualified-measurement)
> in the `FROM` clause. For example:
>
> ```sql
> -- Fully-qualified measurement
> SELECT * FROM "db-name"."rp-name"."measurement-name"
>
> -- Fully-qualified measurement shorthand (use the default retention policy)
> SELECT * FROM "db-name".."measurement-name"
> ```
>
> For more information about available InfluxQL functionality, see
> [InfluxQL feature support](/influxdb3/cloud-dedicated/reference/influxql/feature-support/).
## Important notes

22
content/influxdb3/cloud-dedicated/process-data/visualize/grafana.md
View File

@ -55,14 +55,13 @@ The InfluxDB data source plugin is included in the Grafana core distribution.
Use the plugin to query and visualize data stored in {{< product-name >}} with
both InfluxQL and SQL.
{{% note %}}
#### Grafana 10.3+
The instructions below are for **Grafana 10.3+** which introduced the newest
version of the InfluxDB core plugin.
The updated plugin includes **SQL support** for InfluxDB 3-based products such
as {{< product-name >}}.
{{% /note %}}
> [!Note]
> #### Grafana 10.3+
>
> The instructions below are for **Grafana 10.3+** which introduced the newest
> version of the InfluxDB core plugin.
> The updated plugin includes **SQL support** for InfluxDB 3-based products such
> as {{< product-name >}}.
## Create an InfluxDB data source
@ -150,10 +149,9 @@ use Grafana to build, run, and inspect queries against your InfluxDB database.
{{% tab-content %}}
<!--------------------------------- BEGIN SQL --------------------------------->
{{% note %}}
{{% sql/sql-schema-intro %}}
To learn more, see [Query Data](/influxdb3/cloud-dedicated/query-data/sql/).
{{% /note %}}
> [!Note]
> {{% sql/sql-schema-intro %}}
> To learn more, see [Query Data](/influxdb3/cloud-dedicated/query-data/sql/).
1. Click **Explore**.
2. In the dropdown, select the saved InfluxDB data source to query.

16
content/influxdb3/cloud-dedicated/process-data/visualize/superset.md
View File

@ -54,11 +54,10 @@ stored in an InfluxDB database.
We recommend using **Docker and docker-compose** to run Superset.
To set up Superset to run in Docker containers with Flight SQL, follow these steps:
{{% warn %}}
**Superset** is not officially supported on Windows. For more information about running Superset with
Windows and Docker, see the
[Superset documentation](https://superset.apache.org/docs/installation/installing-superset-using-docker-compose#1-install-a-docker-engine-and-docker-compose).
{{% /warn %}}
> [!Warning]
> **Superset** is not officially supported on Windows. For more information about running Superset with
> Windows and Docker, see the
> [Superset documentation](https://superset.apache.org/docs/installation/installing-superset-using-docker-compose#1-install-a-docker-engine-and-docker-compose).
1. Follow the instructions to download and install Docker and docker-compose for your system:
@ -121,10 +120,9 @@ pip3 install flightsql-dbapi
[Flight SQL](https://arrow.apache.org/docs/format/FlightSql.html).
Later, you'll add `flightsql-dbapi` to Superset's Docker configuration.
{{% warn %}}
The `flightsql-dbapi` library is experimental and under active development.
The APIs it provides could change at any time.
{{% /warn %}}
> [!Warning]
> The `flightsql-dbapi` library is experimental and under active development.
> The APIs it provides could change at any time.
4. Use Git to clone the Apache Superset repository:

21
content/influxdb3/cloud-dedicated/process-data/visualize/tableau.md
View File

@ -30,13 +30,12 @@ stored in {{< product-name >}}. Tableau supports multiple SQL dialects.
>
> {{% cite %}}[tableau.com](https://www.tableau.com/why-tableau/what-is-tableau){{% /cite %}}
{{% note %}}
#### Tableau Desktop
These instructions are for **Tableau Desktop**.
Tableau Cloud and other Tableau products have not been tested, but may support
connecting to {{< product-name >}} through the **Flight SQL JDBC driver**.
{{% /note %}}
> [!Note]
> #### Tableau Desktop
>
> These instructions are for **Tableau Desktop**.
> Tableau Cloud and other Tableau products have not been tested, but may support
> connecting to {{< product-name >}} through the **Flight SQL JDBC driver**.
## Install Tableau Desktop
@ -79,9 +78,11 @@ To query {{< product-name >}} from Tableau, use the **Flight SQL protocol** and
- **Port**: `443`
- **Query parameters**:
- **useSystemTrustStore**: `false`
{{% note %}}
Setting `useSystemTrustStore=false` is only necessary on macOS and doesn't actually affect the security of the connection to Tableau.
{{% /note %}}
> [!Note]
> Setting `useSystemTrustStore=false` is only necessary on macOS and
> doesn't actually affect the security of the connection to Tableau.
- **database**: InfluxDB database name to query
_See an [example connection URL](#example-connection-url)._

14
content/influxdb3/cloud-dedicated/query-data/_index.md
View File

@ -11,13 +11,11 @@ influxdb3/cloud-dedicated/tags: [query]
Learn to query data stored in InfluxDB.
{{% note %}}
#### Choose the query method for your workload
- For new query workloads, use one of the many available [Flight clients](/influxdb3/cloud-dedicated/tags/flight-client/) and SQL or InfluxQL.
- [Use the HTTP API `/query` endpoint and InfluxQL](/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api/) when you bring existing v1 query workloads to {{% product-name %}}.
{{% /note %}}
> [!Note]
>
> #### Choose the query method for your workload
>
> - For new query workloads, use one of the many available [Flight clients](/influxdb3/cloud-dedicated/tags/flight-client/) and SQL or InfluxQL.
> - [Use the HTTP API `/query` endpoint and InfluxQL](/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api/) when you bring existing v1 query workloads to {{% product-name %}}.
{{< children >}}

38
content/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api.md
View File

@ -31,14 +31,13 @@ with InfluxQL.
The examples below use **cURL** to send HTTP requests to the InfluxDB v1 HTTP API,
but you can use any HTTP client.
{{% warn %}}
#### InfluxQL feature support
InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine.
This process is ongoing and some InfluxQL features are still being implemented.
For information about the current implementation status of InfluxQL features,
see [InfluxQL feature support](/influxdb3/cloud-dedicated/reference/influxql/feature-support/).
{{% /warn %}}
> [!Warning]
> #### InfluxQL feature support
>
> InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine.
> This process is ongoing and some InfluxQL features are still being implemented.
> For information about the current implementation status of InfluxQL features,
> see [InfluxQL feature support](/influxdb3/cloud-dedicated/reference/influxql/feature-support/).
Use the v1 `/query` endpoint and the `GET` request method to query data with InfluxQL:
@ -70,17 +69,17 @@ Replace the following configuration values:
a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens)
with _read_ access to the specified database.
{{% note %}}
#### Authenticate with username and password
If using basic authentication or query string authentication (username and password)
to interact with the v1 HTTP query API, provide the following credentials:
- **username**: an arbitrary string _({{< product-name >}} ignores the username)_
- **password**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens)
with _read_ access to the specified database.
{{< code-tabs-wrapper >}}
> [!Note]
> #### Authenticate with username and password
>
> If using basic authentication or query string authentication (username and password)
> to interact with the v1 HTTP query API, provide the following credentials:
>
> - **username**: an arbitrary string _({{< product-name >}} ignores the username)_
> - **password**: a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens)
> with _read_ access to the specified database.
>
> {{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Basic Auth](#)
[Query String Auth](#)
@ -110,7 +109,6 @@ curl --get https://{{< influxdb/host >}}/query \
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
{{% /note %}}
## Return results as JSON or CSV

15
content/influxdb3/cloud-dedicated/query-data/execute-queries/visualization-tools.md
View File

@ -37,11 +37,10 @@ The following visualization tools support querying InfluxDB with InfluxQL:
- [Grafana](/influxdb3/cloud-dedicated/process-data/visualize/grafana/?t=InfluxQL)
- [Chronograf](/influxdb3/cloud-dedicated/process-data/visualize/chronograf/)
{{% warn %}}
#### InfluxQL feature support
InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine.
This process is ongoing and some InfluxQL features are still being implemented.
For information about the current implementation status of InfluxQL features,
see [InfluxQL feature support](/influxdb3/cloud-dedicated/reference/influxql/feature-support/).
{{% /warn %}}
> [!Warning]
> #### InfluxQL feature support
>
> InfluxQL is being rearchitected to work with the InfluxDB 3 storage engine.
> This process is ongoing and some InfluxQL features are still being implemented.
> For information about the current implementation status of InfluxQL features,
> see [InfluxQL feature support](/influxdb3/cloud-dedicated/reference/influxql/feature-support/).

24
content/influxdb3/cloud-dedicated/query-data/influxql/aggregate-select.md
View File

@ -48,10 +48,9 @@ An InfluxQL query that aggregates data includes the following clauses:
a specified range.
- `GROUP BY`: Group data by tag values and time intervals.
{{% note %}}
For simplicity, the term _"aggregate"_ in this guide refers to applying
both aggregate and selector functions to a dataset.
{{% /note %}}
> [!Note]
> For simplicity, the term _"aggregate"_ in this guide refers to applying
> both aggregate and selector functions to a dataset.
Learn how to apply aggregate operations to your queried data:
@ -101,15 +100,14 @@ SELECT TOP(co, 3) from home
- [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)
{{% note %}}
#### Sample data
The following examples use the sample data written in the
[Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
To run the example queries and return results,
[write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-home-sensor-data-to-influxdb)
to your {{% product-name %}} database before running the example queries.
{{% /note %}}
> [!Note]
> #### Sample data
>
> The following examples use the sample data written in the
> [Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
> To run the example queries and return results,
> [write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-home-sensor-data-to-influxdb)
> to your {{% product-name %}} database before running the example queries.
### Perform an ungrouped aggregation

37
content/influxdb3/cloud-dedicated/query-data/influxql/basic-query.md
View File

@ -90,16 +90,15 @@ groups are based on the
- [Query points based on field values](#query-points-based-on-field-values)
- [Alias queried fields and tags](#alias-queried-fields-and-tags)
{{% note %}}
#### Sample data
The following examples use the
[Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
To run the example queries and return results,
[write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb)
to your {{% product-name %}} database before running the example queries.
{{% /note %}}
> [!Note]
>
> #### Sample data
>
> The following examples use the
> [Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
> To run the example queries and return results,
> [write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb)
> to your {{% product-name %}} database before running the example queries.
### Query data within time boundaries
@ -181,10 +180,9 @@ in your `WHERE` clause.
If a time range is not defined in the `WHERE` clause,
the default time range is the Unix epoch (`1970-01-01T00:00:00Z`) to _now_.
{{% warn %}}
Querying data _without time bounds_ can return an unexpected amount of data.
The query may take a long time to complete and results may be truncated.
{{% /warn %}}
> [!Warning]
> Querying data _without time bounds_ can return an unexpected amount of data.
> The query may take a long time to complete and results may be truncated.
```sql
SELECT * FROM home
@ -239,9 +237,8 @@ spaces or special characters)--for example:
SELECT temp AS temperature, hum AS "humidity (%)" FROM home
```
{{% note %}}
When aliasing columns in **InfluxQL**, use the `AS` clause and an
[identifier](/influxdb3/cloud-dedicated/reference/influxql/#identifiers). When
[aliasing columns in **SQL**](/influxdb3/cloud-dedicated/query-data/sql/basic-query/#alias-queried-fields-and-tags),
you can use the `AS` clause to define the alias, but it isn't necessary.
{{% /note %}}
> [!Note]
> When aliasing columns in **InfluxQL**, use the `AS` clause and an
> [identifier](/influxdb3/cloud-dedicated/reference/influxql/#identifiers). When
> [aliasing columns in **SQL**](/influxdb3/cloud-dedicated/query-data/sql/basic-query/#alias-queried-fields-and-tags),
> you can use the `AS` clause to define the alias, but it isn't necessary.

43
content/influxdb3/cloud-dedicated/query-data/influxql/explore-schema.md
View File

@ -35,15 +35,14 @@ list_code_example: |
Use InfluxQL `SHOW` statements to return information about your data schema.
{{% note %}}
#### Sample data
The following examples use data provided in [sample data sets](/influxdb3/cloud-dedicated/reference/sample-data/).
To run the example queries and return identical results, follow the instructions
provided for each sample data set to write the data to your {{% product-name %}}
database.
{{% /note %}}
> [!Note]
>
> #### Sample data
>
> The following examples use data provided in [sample data sets](/influxdb3/cloud-dedicated/reference/sample-data/).
> To run the example queries and return identical results, follow the instructions
> provided for each sample data set to write the data to your {{% product-name %}}
> database.
- [List measurements in a database](#list-measurements-in-a-database)
- [List measurements that contain specific tag key-value pairs](#list-measurements-that-contain-specific-tag-key-value-pairs)
@ -233,20 +232,18 @@ to return all values for specific tags in a measurement.
SHOW TAG VALUES FROM weather WITH KEY = location
```
{{% note %}}
#### Include a FROM clause
We strongly recommend including a `FROM` clause with the `SHOW TAG VALUES`
statement that specifies 1-50 tables to query.
Without a `FROM` clause, the InfluxDB query engine must read data from all
tables and return unique tag values from each.
Depending on the number of tables in your database and the number of unique tag
values in each table, excluding a `FROM` clause can result in poor query performance,
query timeouts, or unnecessary resource allocation that may affect other queries.
{{% /note %}}
> [!Note]
>
> #### Include a FROM clause
>
> We strongly recommend including a `FROM` clause with the `SHOW TAG VALUES`
> statement that specifies 1-50 tables to query.
> Without a `FROM` clause, the InfluxDB query engine must read data from all
> tables and return unique tag values from each.
>
> Depending on the number of tables in your database and the number of unique tag
> values in each table, excluding a `FROM` clause can result in poor query performance,
> query timeouts, or unnecessary resource allocation that may affect other queries.
{{< expand-wrapper >}}
{{% expand "View example output" "5" %}}

65
content/influxdb3/cloud-dedicated/query-data/influxql/parameterized-queries.md
View File

@ -45,12 +45,11 @@ Parameterized queries:
- help prevent injection attacks, which can occur if input is executed as code
- help make queries more reusable
{{% note %}}
#### Prevent injection attacks
For more information on security and query parameterization,
see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries).
{{% /note %}}
> [!Note]
> #### Prevent injection attacks
>
> For more information on security and query parameterization,
> see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries).
In InfluxDB 3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data.
@ -65,17 +64,15 @@ In InfluxDB 3, a parameterized query is an InfluxQL or SQL query that contains o
- [Client support for parameterized queries](#client-support-for-parameterized-queries)
- [Not supported](#not-supported)
{{% note %}}
#### Parameters only supported in `WHERE` expressions
InfluxDB 3 supports parameters in `WHERE` clause **predicate expressions**.
Parameter values must be one of the [allowed parameter data types](#parameter-data-types).
If you use parameters in other expressions or clauses,
such as function arguments, `SELECT`, or `GROUP BY`, then your query might not work as you expect.
{{% /note %}}
> [!Note]
>
> #### Parameters only supported in `WHERE` expressions
>
> InfluxDB 3 supports parameters in `WHERE` clause **predicate expressions**.
> Parameter values must be one of the [allowed parameter data types](#parameter-data-types).
>
> If you use parameters in other expressions or clauses,
> such as function arguments, `SELECT`, or `GROUP BY`, then your query might not work as you expect.
## Use parameters in `WHERE` expressions
@ -165,15 +162,14 @@ If you use parameters for the following, your query might not work as you expect
## Parameterize an SQL query
{{% note %}}
#### Sample data
The following examples use the
[Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
To run the example queries and return results,
[write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb)
to your {{% product-name %}} database before running the example queries.
{{% /note %}}
> [!Note]
> #### Sample data
>
> The following examples use the
> [Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
> To run the example queries and return results,
> [write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb)
> to your {{% product-name %}} database before running the example queries.
To use a parameterized query, do the following:
@ -223,15 +219,14 @@ AND room = 'Kitchen'
## Execute parameterized InfluxQL queries
{{% note %}}
#### Sample data
The following examples use the
[Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
To run the example queries and return results,
[write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb)
to your {{% product-name %}} database before running the example queries.
{{% /note %}}
> [!Note]
> #### Sample data
>
> The following examples use the
> [Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
> To run the example queries and return results,
> [write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb)
> to your {{% product-name %}} database before running the example queries.
### Use InfluxDB Flight RPC clients

18
content/influxdb3/cloud-dedicated/query-data/influxql/troubleshoot.md
View File

@ -11,10 +11,9 @@ weight: 230
Learn how to troubleshoot and fix common InfluxQL errors.
{{% note %}}
**Disclaimer:** This document does not contain an exhaustive list of all
possible InfluxQL errors.
{{% /note %}}
> [!Note]
> **Disclaimer:** This document does not contain an exhaustive list of all
> possible InfluxQL errors.
- [error: database name required](#error-database-name-required)
- [error parsing query: found ..., expected identifier at ...](#error-parsing-query-found--expected-identifier-at-)
@ -148,12 +147,11 @@ are character sequences reserved for specific functionality in the InfluxQL synt
It is possible to use a keyword as an identifier, but the identifier must be
wrapped in double quotes (`""`).
{{% note %}}
While wrapping identifiers that are InfluxQL keywords in double quotes is an
acceptable workaround, for simplicity, you should avoid using
[InfluxQL keywords](/influxdb3/cloud-dedicated/reference/influxql/#keywords)
as identifiers.
{{% /note %}}
> [!Note]
> While wrapping identifiers that are InfluxQL keywords in double quotes is an
> acceptable workaround, for simplicity, you should avoid using
> [InfluxQL keywords](/influxdb3/cloud-dedicated/reference/influxql/#keywords)
> as identifiers.
```sql
SELECT duration FROM runs

61
content/influxdb3/cloud-dedicated/query-data/sql/aggregate-select.md
View File

@ -49,10 +49,9 @@ An SQL query that aggregates data includes the following clauses:
a time range, contains specific tag values, or contains a field value outside a specified range.
- `GROUP BY`: Group data that have the same values for specified columns and expressions (for example, an aggregate function result).
{{% note %}}
For simplicity, the term **"aggregate"** in this guide refers to applying
both aggregate and selector functions to a dataset.
{{% /note %}}
> [!Note]
> For simplicity, the term **"aggregate"** in this guide refers to applying
> both aggregate and selector functions to a dataset.
Learn how to apply aggregate operations to your queried data:
@ -132,15 +131,14 @@ GROUP BY room
- [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)
{{% note %}}
#### Sample data
The following examples use the sample data written in the
[Get started writing data guide](/influxdb3/cloud-dedicated/get-started/write/).
To run the example queries and return results,
[write the sample data](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb)
to your InfluxDB Cloud dedicated database before running the example queries.
{{% /note %}}
> [!Note]
> #### Sample data
>
> The following examples use the sample data written in the
> [Get started writing data guide](/influxdb3/cloud-dedicated/get-started/write/).
> To run the example queries and return results,
> [write the sample data](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb)
> to your InfluxDB Cloud dedicated database before running the example queries.
### Perform an ungrouped aggregation
@ -280,25 +278,24 @@ ORDER BY room, 1
{{% /expand %}}
{{< /expand-wrapper >}}
{{% note %}}
#### GROUP BY time
In the `GROUP BY` clause, the name "time" always refers to the `time` column in the source table.
If you want to reference a calculated time column by name, use an alias different from "time"--for example:
```sql
SELECT
DATE_BIN(INTERVAL '2 hours', time, '1970-01-01T00:00:00Z')
AS _time,
room,
selector_max(temp, time)['value'] AS 'max temp',
selector_min(temp, time)['value'] AS 'min temp',
avg(temp) AS 'average temp'
FROM home
GROUP BY _time, room
ORDER BY room, _time
```
{{% /note %}}
> [!Note]
> #### GROUP BY time
>
> In the `GROUP BY` clause, the name "time" always refers to the `time` column in the source table.
> If you want to reference a calculated time column by name, use an alias different from "time"--for example:
>
> ```sql
> SELECT
> DATE_BIN(INTERVAL '2 hours', time, '1970-01-01T00:00:00Z')
> AS _time,
> room,
> selector_max(temp, time)['value'] AS 'max temp',
> selector_min(temp, time)['value'] AS 'min temp',
> avg(temp) AS 'average temp'
> FROM home
> GROUP BY _time, room
> ORDER BY room, _time
> ```
### Query rows based on aggregate values

37
content/influxdb3/cloud-dedicated/query-data/sql/basic-query.md
View File

@ -59,15 +59,14 @@ An SQL query result set includes columns listed in the query's `SELECT` statemen
- [Query points based on field values](#query-points-based-on-field-values)
- [Alias queried fields and tags](#alias-queried-fields-and-tags)
{{% note %}}
#### Sample data
The following examples use the sample data written in the
[Get started writing data guide](/influxdb3/cloud-dedicated/get-started/write/).
To run the example queries and return results,
[write the sample data](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb)
to your {{% product-name %}} database before running the example queries.
{{% /note %}}
> [!Note]
> #### Sample data
>
> The following examples use the sample data written in the
> [Get started writing data guide](/influxdb3/cloud-dedicated/get-started/write/).
> To run the example queries and return results,
> [write the sample data](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb)
> to your {{% product-name %}} database before running the example queries.
### Query data within time boundaries
@ -139,13 +138,12 @@ To query data using a time zone offset, use the
[`AT TIME ZONE` operator](/influxdb3/cloud-dedicated/reference/sql/operators/other/#at-time-zone)
to apply a time zone offset to timestamps in the `WHERE` clause.
{{% note %}}
Timestamp types in InfluxDB always represent a UTC time. `AT TIME ZONE` returns
a UTC timestamp adjusted for the offset of the specified time zone.
Timestamps in the `time` column are not updated.
If you need to display the timestamps in your current timezone, this should be handled
client-side.
{{% /note %}}
> [!Note]
> Timestamp types in InfluxDB always represent a UTC time. `AT TIME ZONE` returns
> a UTC timestamp adjusted for the offset of the specified time zone.
> Timestamps in the `time` column are not updated.
> If you need to display the timestamps in your current timezone, this should be handled
> client-side.
{{% influxdb/custom-timestamps %}}
```sql
@ -166,10 +164,9 @@ WHERE
To query data without time boundaries, do not include any time-based predicates
in your `WHERE` clause.
{{% warn %}}
Querying data _without time bounds_ can return an unexpected amount of data.
The query may take a long time to complete and results may be truncated.
{{% /warn %}}
> [!Warning]
> Querying data _without time bounds_ can return an unexpected amount of data.
> The query may take a long time to complete and results may be truncated.
```sql
SELECT * FROM home

19
content/influxdb3/cloud-dedicated/query-data/sql/cast-types.md
View File

@ -308,15 +308,15 @@ SQL supports casting the following to a timestamp:
- **Unsigned integers**: Parses the unsigned integer as a Unix nanosecond timestamp
and returns the equivalent timestamp.
{{% note %}}
#### Cast Unix nanosecond timestamps to a timestamp type
To cast a Unix nanosecond timestamp to a timestamp type, first cast the numeric
value to an unsigned integer (`BIGINT UNSIGNED`) and then a timestamp.
You can also use the [`to_timestamp_nanos`](/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp_nanos)
function.
{{< code-tabs-wrapper >}}
> [!Note]
> #### Cast Unix nanosecond timestamps to a timestamp type
>
> To cast a Unix nanosecond timestamp to a timestamp type, first cast the numeric
> value to an unsigned integer (`BIGINT UNSIGNED`) and then a timestamp.
> You can also use the [`to_timestamp_nanos`](/influxdb3/cloud-dedicated/reference/sql/functions/time-and-date/#to_timestamp_nanos)
> function.
>
> {{< code-tabs-wrapper >}}
{{% code-tabs %}}
[:: shorthand](#)
[CAST()](#)
@ -338,7 +338,6 @@ to_timestamp_nanos(1704067200000000000)
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
{{% /note %}}
### Timestamp functions

7
content/influxdb3/cloud-dedicated/query-data/sql/fill-gaps.md
View File

@ -44,10 +44,9 @@ gaps with interpolated values or by carrying forward the last available observat
- **interpolate**: fills null values by interpolating values between non-null values.
- **locf**: fills null values by carrying the last observed value forward.
{{% note %}}
The expression passed to `interpolate` or `locf` must use an
[aggregate function](/influxdb3/cloud-dedicated/reference/sql/functions/aggregate/).
{{% /note %}}
> [!Note]
> The expression passed to `interpolate` or `locf` must use an
> [aggregate function](/influxdb3/cloud-dedicated/reference/sql/functions/aggregate/).
3. Include a `WHERE` clause that sets upper and lower time bounds.
For example:

65
content/influxdb3/cloud-dedicated/query-data/sql/parameterized-queries.md
View File

@ -42,12 +42,11 @@ Parameterized queries:
- help prevent injection attacks, which can occur if input is executed as code
- help make queries more reusable
{{% note %}}
#### Prevent injection attacks
For more information on security and query parameterization,
see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries).
{{% /note %}}
> [!Note]
> #### Prevent injection attacks
>
> For more information on security and query parameterization,
> see the [OWASP SQL Injection Prevention Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/SQL_Injection_Prevention_Cheat_Sheet.html#defense-option-1-prepared-statements-with-parameterized-queries).
In InfluxDB 3, a parameterized query is an InfluxQL or SQL query that contains one or more named parameter placeholders–variables that represent input data.
@ -62,17 +61,15 @@ In InfluxDB 3, a parameterized query is an InfluxQL or SQL query that contains o
- [Client support for parameterized queries](#client-support-for-parameterized-queries)
- [Not supported](#not-supported)
{{% note %}}
#### Parameters only supported in `WHERE` expressions
InfluxDB 3 supports parameters in `WHERE` clause **predicate expressions**.
Parameter values must be one of the [allowed parameter data types](#parameter-data-types).
If you use parameters in other expressions or clauses,
such as function arguments, `SELECT`, or `GROUP BY`, then your query might not work as you expect.
{{% /note %}}
> [!Note]
>
> #### Parameters only supported in `WHERE` expressions
>
> InfluxDB 3 supports parameters in `WHERE` clause **predicate expressions**.
> Parameter values must be one of the [allowed parameter data types](#parameter-data-types).
>
> If you use parameters in other expressions or clauses,
> such as function arguments, `SELECT`, or `GROUP BY`, then your query might not work as you expect.
## Use parameters in `WHERE` expressions
@ -162,15 +159,14 @@ If you use parameters for the following, your query might not work as you expect
## Parameterize an SQL query
{{% note %}}
#### Sample data
The following examples use the
[Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
To run the example queries and return results,
[write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb)
to your {{% product-name %}} database before running the example queries.
{{% /note %}}
> [!Note]
> #### Sample data
>
> The following examples use the
> [Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
> To run the example queries and return results,
> [write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb)
> to your {{% product-name %}} database before running the example queries.
To use a parameterized query, do the following:
@ -220,15 +216,14 @@ AND room = 'Kitchen'
## Execute parameterized SQL queries
{{% note %}}
#### Sample data
The following examples use the
[Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
To run the example queries and return results,
[write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb)
to your {{% product-name %}} database before running the example queries.
{{% /note %}}
> [!Note]
> #### Sample data
>
> The following examples use the
> [Get started home sensor data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
> To run the example queries and return results,
> [write the sample data](/influxdb3/cloud-dedicated/reference/sample-data/#write-the-home-sensor-data-to-influxdb)
> to your {{% product-name %}} database before running the example queries.
### Use InfluxDB Flight RPC clients

32
content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md
View File

@ -422,9 +422,8 @@ The `plan` column for the row contains the physical plan.
The following sections follow the steps to [read a query plan](#read-a-query-plan) and examine the physical plan nodes and their input and output.
{{% note %}}
To [read the execution flow of a query plan](#read-a-query-plan), always start from the innermost (leaf) nodes and read up toward the top outermost root node.
{{% /note %}}
> [!Note]
> To [read the execution flow of a query plan](#read-a-query-plan), always start from the innermost (leaf) nodes and read up toward the top outermost root node.
#### Physical plan leaf nodes
@ -529,15 +528,14 @@ _By design, [`RecordBatchesExec`](#recordbatchesexec) data isn't sorted._
In the example, the planner specifies that ParquetExec_A use the existing sort order `state ASC, city ASC, time ASC,` for output.
{{% note %}}
To view the sort order of your stored data, generate an `EXPLAIN` report for a `SELECT ALL` query--for example:
```sql
EXPLAIN SELECT * FROM TABLE_NAME WHERE time > now() - interval '1 hour'
```
Reduce the time range if the query returns too much data.
{{% /note %}}
> [!Note]
> To view the sort order of your stored data, generate an `EXPLAIN` report for a `SELECT ALL` query--for example:
>
> ```sql
> EXPLAIN SELECT * FROM TABLE_NAME WHERE time > now() - interval '1 hour'
> ```
>
> Reduce the time range if the query returns too much data.
##### `predicate`
@ -591,9 +589,8 @@ The `projection` list specifies the columns or expressions for the node to read
- `__chunk_order`: orders chunks and files for deduplication
- `city, state, time`: the same columns specified in [`ParquetExec_A projection`](#projection-1)
{{% note %}}
The presence of `__chunk_order` in data scanning nodes indicates that data overlaps, and is possibly duplicated, among the nodes.
{{% /note %}}
> [!Note]
> The presence of `__chunk_order` in data scanning nodes indicates that data overlaps, and is possibly duplicated, among the nodes.
#### ParquetExec_B
@ -615,9 +612,8 @@ ParquetExec:
Because ParquetExec_B has overlaps, the `projection` and `output_ordering` expressions use the `__chunk_order` column used in [`RecordBatchesExec` `projection`](#projection-1).
{{% note %}}
The presence of `__chunk_order` in data scanning nodes indicates that data overlaps, and is possibly duplicated, among the nodes.
{{% /note %}}
> [!Note]
> The presence of `__chunk_order` in data scanning nodes indicates that data overlaps, and is possibly duplicated, among the nodes.
The remaining ParquetExec_B expressions are similar to those in [ParquetExec_A](#parquetexec_a).

20
content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md
View File

@ -23,14 +23,13 @@ When you enable trace logging for a query, InfluxDB propagates your _trace ID_ t
InfluxData Support can then use the trace ID that you provide to filter, collate, and analyze log information for the query run.
The tracing system follows the [OpenTelemetry traces](https://opentelemetry.io/docs/concepts/signals/traces/) model for providing observability into a request.
{{% warn %}}
#### Avoid unnecessary tracing
Only enable tracing for a query when you need to request troubleshooting help from InfluxDB Support.
To manage resources, InfluxDB has an upper limit for the number of trace requests.
Too many traces can cause InfluxDB to evict log information.
{{% /warn %}}
> [!Warning]
>
> #### Avoid unnecessary tracing
>
> Only enable tracing for a query when you need to request troubleshooting help from InfluxDB Support.
> To manage resources, InfluxDB has an upper limit for the number of trace requests.
> Too many traces can cause InfluxDB to evict log information.
To enable tracing for a query, include the `influx-trace-id` header in your query request.
@ -238,9 +237,8 @@ Replace the following:
a [database token](/influxdb3/cloud-dedicated/admin/tokens/#database-tokens)
with sufficient permissions to the specified database
{{% note %}}
Store or log your query trace ID to ensure you can provide it to InfluxData Support for troubleshooting.
{{% /note %}}
> [!Note]
> Store or log your query trace ID to ensure you can provide it to InfluxData Support for troubleshooting.
After you run your query with tracing enabled, do the following:

40
content/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create.md
View File

@ -60,28 +60,26 @@ into a specified number of "buckets."
Each of these can be used as part of the partition template.
Be sure to follow [partitioning best practices](/influxdb3/cloud-dedicated/admin/custom-partitions/best-practices/).
{{% note %}}
#### Always provide a time format when using custom partitioning
> [!Note]
> #### Always provide a time format when using custom partitioning
>
> If defining a custom partition template for your database with any of the
> `--template-*` flags, always include the `--template-timeformat` flag with a
> time format to use in your partition template.
> Otherwise, InfluxDB omits time from the partition template and won't compact partitions.
If defining a custom partition template for your database with any of the
`--template-*` flags, always include the `--template-timeformat` flag with a
time format to use in your partition template.
Otherwise, InfluxDB omits time from the partition template and won't compact partitions.
{{% /note %}}
{{% warn %}}
#### Cannot reuse deleted database names
You cannot reuse the name of a deleted database when creating a new database.
If you try to reuse the name, the API response status code
is `400` and the `message` field contains the following:
```text
'iox_proxy.app.CreateDatabase failed to create database: \
rpc error: code = AlreadyExists desc = A namespace with the
name `<DATABASE_NAME>` already exists'
```
{{% /warn %}}
> [!Warning]
> #### Cannot reuse deleted database names
>
> You cannot reuse the name of a deleted database when creating a new database.
> If you try to reuse the name, the API response status code
> is `400` and the `message` field contains the following:
>
> ```text
> 'iox_proxy.app.CreateDatabase failed to create database: \
> rpc error: code = AlreadyExists desc = A namespace with the
> name `<DATABASE_NAME>` already exists'
> ```
## Usage

19
content/influxdb3/cloud-dedicated/reference/cli/influxctl/database/delete.md
View File

@ -21,16 +21,15 @@ Cloud Dedicated cluster.
influxctl database delete [command options] [--force] <DATABASE_NAME> [<DATABASE_NAME_N>...]
```
{{% warn %}}
#### Cannot be undone
Deleting a database is a destructive action that cannot be undone.
#### Cannot reuse deleted database names
After deleting a database, you cannot reuse the name of the deleted database
when creating a new database.
{{% /warn %}}
> [!Warning]
> #### Cannot be undone
>
> Deleting a database is a destructive action that cannot be undone.
>
> #### Cannot reuse deleted database names
>
> After deleting a database, you cannot reuse the name of the deleted database
> when creating a new database.
## Arguments

20
content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/create.md
View File

@ -17,11 +17,10 @@ Management tokens authorize a user to perform administrative tasks on the
InfluxDB instance such as creating and deleting databases, managing users, and
other administrative tasks.
{{% note %}}
Management tokens do not provide access to databases or data in databases.
Only _database tokens_ with "read" or "write" permissions can access data in
databases.
{{% /note %}}
> [!Note]
> Management tokens do not provide access to databases or data in databases.
> Only _database tokens_ with "read" or "write" permissions can access data in
> databases.
The optional `--expires-at` flag defines the token expiration date and time.
Provide an RFC3999 date string--for example: `{{< datetime/current-date offset=1 >}}`.
@ -31,12 +30,11 @@ The `--format` flag lets you print the output in other formats.
The `json` format is available for programmatic parsing by other tooling.
Default: `table`.
{{% note %}}
#### Store secure tokens in a secret store
Management token strings are returned _only_ on token creation.
We recommend storing management tokens in a **secure secret store**.
{{% /note %}}
> [!Note]
> #### Store secure tokens in a secret store
>
> Management token strings are returned _only_ on token creation.
> We recommend storing management tokens in a **secure secret store**.
## Usage

21
content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list.md
View File

@ -15,17 +15,16 @@ The `influxctl management list` command lists all management tokens used to
perform administrative tasks in an {{< product-name omit=" Clustered" >}} cluster.
It returns the token description and other relevant information.
{{% note %}}
#### Management token strings are not retrievable
The actual management token string is not printed and is only returned when
creating the token.
#### Revoked tokens are included in output
Revoked tokens still appear when listing management tokens, but they are no
longer valid for any operations.
{{% /note %}}
> [!Note]
> #### Management token strings are not retrievable
>
> The actual management token string is not printed and is only returned when
> creating the token.
>
> #### Revoked tokens are included in output
>
> Revoked tokens still appear when listing management tokens, but they are no
> longer valid for any operations.
The `--format` flag lets you print the output in other formats.
The `json` format is available for programmatic parsing by other tooling.

13
content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/revoke.md
View File

@ -15,13 +15,12 @@ The `influxctl management revoke` command revokes management token access
to your {{< product-name omit=" Clustered" >}} cluster.
**This operation cannot be undone**.
{{% note %}}
#### Revoked tokens are included when listing tokens
Revoked tokens still appear when
[listing management tokens](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list/),
but they are no longer valid for any operations.
{{% /note %}}
> [!Note]
> #### Revoked tokens are included when listing tokens
>
> Revoked tokens still appear when
> [listing management tokens](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list/),
> but they are no longer valid for any operations.
## Usage

27
content/influxdb3/cloud-dedicated/reference/cli/influxctl/query.md
View File

@ -24,13 +24,12 @@ Provide the query in one of the following ways:
- a path to a file that contains the query
- as a single dash (`-`) to read the query from stdin
{{% note %}}
#### Important to note
- This command supports only one query per execution.
- This command is not meant to be a full, feature-rich query tool.
It's meant for debug, triage, and basic data exploration.
{{% /note %}}
> [!Note]
> #### Important to note
>
> - This command supports only one query per execution.
> - This command is not meant to be a full, feature-rich query tool.
> It's meant for debug, triage, and basic data exploration.
### InfluxDB connection configuration
@ -410,15 +409,13 @@ influxctl query "SELECT * FROM home WHERE time >= '2022-01-01T08:00:00Z'"
### Query data from InfluxDB 3 system tables
{{% note %}}
You must use **SQL** to query InfluxDB 3 system tables.
{{% /note %}}
> [!Note]
> You must use **SQL** to query InfluxDB 3 system tables.
{{% warn %}}
Querying system tables can impact the overall performance of your
{{< product-name omit=" Clustered" >}} cluster. System tables are not part of
InfluxDB's stable API and are subject to change.
{{% /warn %}}
> [!Warning]
> Querying system tables can impact the overall performance of your
> {{< product-name omit=" Clustered" >}} cluster. System tables are not part of
> InfluxDB's stable API and are subject to change.
{{% code-placeholders "DATABASE_(TOKEN|NAME)|TABLE_NAME" %}}

15
content/influxdb3/cloud-dedicated/reference/cli/influxctl/table/create.md
View File

@ -24,14 +24,13 @@ into a specified number of "buckets."
Each of these can be used as part of the partition template.
Be sure to follow [partitioning best practices](/influxdb3/cloud-dedicated/admin/custom-partitions/best-practices/).
{{% note %}}
#### Always provide a time format when using custom partitioning
If defining a custom partition template for your table with any of the
`--template-*` flags, always include the `--template-timeformat` flag with a
time format to use in your partition template.
Otherwise, InfluxDB omits time from the partition template and won't compact partitions.
{{% /note %}}
> [!Note]
> #### Always provide a time format when using custom partitioning
>
> If defining a custom partition template for your table with any of the
> `--template-*` flags, always include the `--template-timeformat` flag with a
> time format to use in your partition template.
> Otherwise, InfluxDB omits time from the partition template and won't compact partitions.
## Usage

29
content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create.md
View File

@ -27,15 +27,12 @@ Default: `table`.
If a new database token doesn't immediately work (you receive a `401 Unauthorized` error) for querying or writing, wait and then try again.
- Token strings are viewable _only_ on token creation.
{{% note %}}
#### Store secure tokens in a secret store
Token strings are viewable _only_ on token creation and aren't stored by InfluxDB.
We recommend storing database tokens in a **secure secret store**.
{{% /note %}}
> [!Note]
>
> #### Store secure tokens in a secret store
>
> Token strings are viewable _only_ on token creation and aren't stored by InfluxDB.
> We recommend storing database tokens in a **secure secret store**.
## Usage
@ -65,14 +62,12 @@ influxctl token create \
_Also see [`influxctl` global flags](/influxdb3/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
{{% note %}}
#### Using a new token
InfluxDB might take some time to synchronize new tokens.
If a new database token doesn't immediately work for querying or writing, wait a few seconds and try again.
{{% /note %}}
> [!Note]
>
> #### Using a new token
>
> InfluxDB might take some time to synchronize new tokens.
> If a new database token doesn't immediately work for querying or writing, wait a few seconds and try again.
## Examples

23
content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/delete.md
View File

@ -18,18 +18,17 @@ Cloud Dedicated cluster and revokes all permissions associated with the token.
influxctl token delete <TOKEN_ID> [<TOKEN_ID_N>...]
```
{{% warn %}}
#### Deleting a token is immediate and cannot be undone
Deleting a database token is a destructive action that takes place immediately
and cannot be undone.
#### Rotate deleted tokens
After deleting a database token, any clients using the deleted token need to be
updated with a new database token to continue to interact with your InfluxDB
Cloud Dedicated cluster.
{{% /warn %}}
> [!Warning]
> #### Deleting a token is immediate and cannot be undone
>
> Deleting a database token is a destructive action that takes place immediately
> and cannot be undone.
>
> #### Rotate deleted tokens
>
> After deleting a database token, any clients using the deleted token need to be
> updated with a new database token to continue to interact with your InfluxDB
> Cloud Dedicated cluster.
## Arguments

13
content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/update.md
View File

@ -25,13 +25,12 @@ influxctl token update \
<TOKEN_ID>
```
{{% note %}}
#### Existing permissions are replaced on update
When updating token permissions, the existing permissions are replaced by the
new permissions specified in the update command.
To retain existing permissions, include them in the update command.
{{% /note %}}
> [!Note]
> #### Existing permissions are replaced on update
>
> When updating token permissions, the existing permissions are replaced by the
> new permissions specified in the update command.
> To retain existing permissions, include them in the update command.
## Arguments

22
content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/delete.md
View File

@ -9,12 +9,11 @@ weight: 301
draft: true
---
{{% warn %}}
#### InfluxData internal use only
This command is for InfluxData internal use only and won't work when run by
a user account.
{{% /warn %}}
> [!Warning]
> #### InfluxData internal use only
>
> This command is for InfluxData internal use only and won't work when run by
> a user account.
The `influxctl user delete` command deletes a user from your {{< product-name >}}
account.
@ -25,12 +24,11 @@ account.
influxctl user delete <USER_ID>
```
{{% warn %}}
#### Deleting a user is immediate and cannot be undone
Deleting a user is a destructive action that takes place immediately
and cannot be undone.
{{% /warn %}}
> [!Warning]
> #### Deleting a user is immediate and cannot be undone
>
> Deleting a user is a destructive action that takes place immediately
> and cannot be undone.
## Arguments

11
content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/invite.md
View File

@ -10,12 +10,11 @@ weight: 301
draft: true
---
{{% warn %}}
#### InfluxData internal use only
This command is for InfluxData internal use only and won't work when run by
a user account.
{{% /warn %}}
> [!Warning]
> #### InfluxData internal use only
>
> This command is for InfluxData internal use only and won't work when run by
> a user account.
The `influxctl user invite` command invites a user to an {{< product-name >}}
account.

15
content/influxdb3/cloud-dedicated/reference/cli/influxctl/write.md
View File

@ -21,14 +21,13 @@ Provide line protocol in one of the following ways:
- a path to a file that contains line protocol
- as a single dash (`-`) to read line protocol from stdin
{{% note %}}
#### Important to note
- This command supports only one write request per execution, but does support
multiple lines of line protocol and will batch data based on the `--batch-size`.
- This command is not meant to be a full, feature-rich write tool.
It's meant for debug, triage, and initial exploration.
{{% /note %}}
> [!Note]
> #### Important to note
>
> - This command supports only one write request per execution, but does support
> multiple lines of line protocol and will batch data based on the `--batch-size`.
> - This command is not meant to be a full, feature-rich write tool.
> It's meant for debug, triage, and initial exploration.
### InfluxDB connection configuration

13
content/influxdb3/cloud-dedicated/reference/client-libraries/flight/_index.md
View File

@ -18,13 +18,12 @@ aliases:
Flight RPC and Flight SQL clients are language-specific drivers that interact with databases using the Arrow in-memory format and the Flight RPC protocol.
Apache Arrow Flight RPC and Flight SQL protocols define APIs for servers and clients.
{{% note %}}
#### Use InfluxDB 3 client libraries
We recommend using [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) for integrating InfluxDB 3 with your application code.
Client libraries wrap Apache Arrow Flight clients
and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
{{% /note %}}
> [!Note]
> #### Use InfluxDB 3 client libraries
>
> We recommend using [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) for integrating InfluxDB 3 with your application code.
> Client libraries wrap Apache Arrow Flight clients
> and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
**Flight RPC clients** can use SQL or InfluxQL to query data stored in an {{% product-name %}} database.
Using InfluxDB 3's IOx-specific Flight RPC protocol, clients send a single `DoGet()` request to authenticate, query, and retrieve data.

17
content/influxdb3/cloud-dedicated/reference/client-libraries/flight/csharp-flight.md
View File

@ -16,12 +16,11 @@ weight: 201
For more information, see the [C# client example on GitHub](https://github.com/apache/arrow/tree/main/csharp/examples/FlightClientExample).
{{% note %}}
#### Use InfluxDB 3 client libraries
We recommend using the [`influxdb3-csharp` C# client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/csharp/) for integrating InfluxDB 3 with your C# application code.
[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
Client libraries can query using SQL or InfluxQL.
{{% /note %}}
> [!Note]
> #### Use InfluxDB 3 client libraries
>
> We recommend using the [`influxdb3-csharp` C# client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/csharp/) for integrating InfluxDB 3 with your C# application code.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
> and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
> Client libraries can query using SQL or InfluxQL.

17
content/influxdb3/cloud-dedicated/reference/client-libraries/flight/go-flight.md
View File

@ -16,15 +16,14 @@ weight: 201
[Apache Arrow for Go](https://pkg.go.dev/github.com/apache/arrow/go/v12) integrates with Go scripts and applications to query data stored in InfluxDB.
{{% note %}}
#### Use InfluxDB 3 client libraries
We recommend using the [`influxdb3-go` Go client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/go/) for integrating InfluxDB 3 with your Go application code.
[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
Client libraries can query using SQL or InfluxQL.
{{% /note %}}
> [!Note]
> #### Use InfluxDB 3 client libraries
>
> We recommend using the [`influxdb3-go` Go client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/go/) for integrating InfluxDB 3 with your Go application code.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
> and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
> Client libraries can query using SQL or InfluxQL.
## Flight SQL client

17
content/influxdb3/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md
View File

@ -41,15 +41,14 @@ list_code_example: |
[Apache Arrow Flight SQL for Java](https://arrow.apache.org/docs/java/reference/org/apache/arrow/flight/sql/package-summary.html) integrates with Java applications to query and retrieve data from Flight database servers using RPC and SQL.
{{% note %}}
#### Use InfluxDB 3 client libraries
We recommend using the [`influxdb3-java` Java client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/java/) for integrating InfluxDB 3 with your Java application code.
[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
Client libraries can query using SQL or InfluxQL.
{{% /note %}}
> [!Note]
> #### Use InfluxDB 3 client libraries
>
> We recommend using the [`influxdb3-java` Java client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/java/) for integrating InfluxDB 3 with your Java application code.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
> and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
> Client libraries can query using SQL or InfluxQL.
<!-- TOC -->

17
content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flight.md
View File

@ -49,15 +49,14 @@ list_code_example: |
[Apache Arrow Python bindings](https://arrow.apache.org/docs/python/index.html) integrate with Python scripts and applications to query data stored in InfluxDB.
{{% note %}}
#### Use InfluxDB 3 client libraries
We recommend using the [`influxdb3-python` Python client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code.
[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
Client libraries can query using SQL or InfluxQL.
{{% /note %}}
> [!Note]
> #### Use InfluxDB 3 client libraries
>
> We recommend using the [`influxdb3-python` Python client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
> and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
> Client libraries can query using SQL or InfluxQL.
The following examples show how to use the `pyarrow.flight` and `pandas` Python modules to query and format data stored in an {{% product-name %}} database:

17
content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flightsql-dbapi.md
View File

@ -14,15 +14,14 @@ aliases:
The [Python `flightsql-dbapi` Flight SQL DBAPI library](https://github.com/influxdata/flightsql-dbapi) integrates with Python applications using SQL to query data stored in an {{% product-name %}} database. The `flightsql-dbapi` library uses the [Flight SQL protocol](https://arrow.apache.org/docs/format/FlightSql.html) to query and retrieve data.
{{% note %}}
#### Use InfluxDB 3 client libraries
We recommend using the [`influxdb3-python` Python client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code.
[InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
Client libraries can query using SQL or InfluxQL.
{{% /note %}}
> [!Note]
> #### Use InfluxDB 3 client libraries
>
> We recommend using the [`influxdb3-python` Python client library](/influxdb3/cloud-dedicated/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
> and provide convenient methods for [writing](/influxdb3/cloud-dedicated/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
> Client libraries can query using SQL or InfluxQL.
## Installation

5
content/influxdb3/cloud-dedicated/reference/client-libraries/v1/_index.md
View File

@ -14,9 +14,8 @@ influxdb3/cloud-dedicated/tags: [client libraries, API, developer tools]
InfluxDB client libraries are language-specific tools that integrate with InfluxDB APIs.
Client libraries for InfluxDB v1 work with the InfluxDB 1.7 API and should be fully compatible with InfluxDB 1.5+.
{{% note %}}
Upgrade to InfluxDB 3 to use new client libraries compatible with InfluxDB write APIs, SQL, and InfluxQL. For more information, see [InfluxDB client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/).
{{% /note %}}
> [!Note]
> Upgrade to InfluxDB 3 to use new client libraries compatible with InfluxDB write APIs, SQL, and InfluxQL. For more information, see [InfluxDB client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/).
Functionality varies among client libraries.
For specifics about a client library, see the library's GitHub repository.

8
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/browser.md
View File

@ -41,10 +41,10 @@ This guide presumes some familiarity with JavaScript, browser environments, and
If you're just getting started with InfluxDB, see [Get started with InfluxDB](/influxdb/v2/get-started/).
{{% warn %}}
### Tokens in production applications
{{% api/browser-token-warning %}}
{{% /warn %}}
> [!Warning]
> ### Tokens in production applications
>
> {{% api/browser-token-warning %}}
* [Before you begin](#before-you-begin)
* [Use with module bundlers](#use-with-module-bundlers)

5
content/influxdb3/cloud-dedicated/reference/client-libraries/v3/python.md
View File

@ -61,9 +61,8 @@ The `influxdb3-python` Python client library wraps the Apache Arrow `pyarrow.fli
in a convenient InfluxDB 3 interface for executing SQL and InfluxQL queries, requesting
server metadata, and retrieving data from {{% product-name %}} using the Flight protocol with gRPC.
{{% note %}}
Code samples in this page use the [Get started home sensor sample data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
{{% /note %}}
> [!Note]
> Code samples in this page use the [Get started home sensor sample data](/influxdb3/cloud-dedicated/reference/sample-data/#get-started-home-sensor-data).
- [Installation](#installation)
- [Importing the module](#importing-the-module)

11
content/influxdb3/cloud-dedicated/reference/internals/data-retention.md
View File

@ -30,12 +30,11 @@ Retention periods can be as short as an hour or infinite.
timestamps beyond the defined retention period (relative to now) are not queryable,
but may still exist in storage until [fully deleted](#when-does-data-actually-get-deleted).
{{% note %}}
#### View database retention periods
Use the [`influxctl database list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/list/)
to view your databases' retention periods.
{{% /note %}}
> [!Note]
> #### View database retention periods
>
> Use the [`influxctl database list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/list/)
> to view your databases' retention periods.
## When does data actually get deleted?

11
content/influxdb3/cloud-dedicated/reference/internals/storage-engine.md
View File

@ -191,13 +191,10 @@ runs out of memory.
The following scaling strategies can be applied to components of the InfluxDB 3
storage architecture.
{{% note %}}
<!-- Cloud Dedicated-specific -->
For information about scaling your {{< product-name >}} infrastructure,
[contact InfluxData support](https://support.influxdata.com).
{{% /note %}}
> [!Note]
>
> For information about scaling your {{< product-name >}} infrastructure,
> [contact InfluxData support](https://support.influxdata.com).
### Vertical scaling

14
content/influxdb3/cloud-dedicated/write-data/_index.md
View File

@ -18,14 +18,12 @@ influxdb3/cloud-dedicated/tags: [write, line protocol]
Write data to {{% product-name %}} using the following tools and methods:
{{% note %}}
#### Choose the write endpoint for your workload
When bringing existing v1 write workloads, use the {{% product-name %}} HTTP API [`/write` endpoint](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/).
When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb3/cloud-dedicated/guides/api-compatibility/v2/).
{{% /note %}}
> [!Note]
>
> #### Choose the write endpoint for your workload
>
> When bringing existing v1 write workloads, use the {{% product-name %}} HTTP API [`/write` endpoint](/influxdb3/cloud-dedicated/guides/api-compatibility/v1/).
> When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb3/cloud-dedicated/guides/api-compatibility/v2/).
{{< children >}}

18
content/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes.md
View File

@ -33,21 +33,19 @@ Use these tips to optimize performance and system overhead when writing data to
- [Avoid sending duplicate data](#avoid-sending-duplicate-data)
- [Run custom preprocessing code](#run-custom-preprocessing-code)
{{% note %}}
The following tools write to InfluxDB and employ _most_ write optimizations by default:
- [Telegraf](/influxdb3/cloud-dedicated/write-data/use-telegraf/)
- [InfluxDB client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/)
{{% /note %}}
> [!Note]
> The following tools write to InfluxDB and employ _most_ write optimizations by default:
>
> - [Telegraf](/influxdb3/cloud-dedicated/write-data/use-telegraf/)
> - [InfluxDB client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/)
## Batch writes
Write data in batches to minimize network overhead when writing data to InfluxDB.
{{% note %}}
The optimal batch size is 10,000 lines of line protocol or 10 MBs,
whichever threshold is met first.
{{% /note %}}
> [!Note]
> The optimal batch size is 10,000 lines of line protocol or 10 MBs,
> whichever threshold is met first.
## Sort tags by key

30
content/influxdb3/cloud-dedicated/write-data/best-practices/schema-design.md
View File

@ -64,17 +64,16 @@ Tables contain multiple tags and fields.
in UTC.
A timestamp is never null.
{{% note %}}
#### What happened to buckets and measurements?
If coming from InfluxDB Cloud Serverless or InfluxDB powered by the TSM storage engine, you're likely familiar
with the concepts _bucket_ and _measurement_.
_Bucket_ in TSM or InfluxDB Cloud Serverless is synonymous with
_database_ in {{% product-name %}}.
_Measurement_ in TSM or InfluxDB Cloud Serverless is synonymous with
_table_ in {{% product-name %}}.
{{% /note %}}
> [!Note]
>
> #### What happened to buckets and measurements?
>
> If coming from InfluxDB Cloud Serverless or InfluxDB powered by the TSM storage engine, you're likely familiar
> with the concepts _bucket_ and _measurement_.
> _Bucket_ in TSM or InfluxDB Cloud Serverless is synonymous with
> _database_ in {{% product-name %}}.
> _Measurement_ in TSM or InfluxDB Cloud Serverless is synonymous with
> _table_ in {{% product-name %}}.
<!-- vale InfluxDataDocs.v3Schema = YES -->
@ -104,11 +103,10 @@ question as you design your schema.
to optimize performance.
It doesn't index tag values or field values.
{{% note %}}
The InfluxDB 3 storage engine supports infinite tag value and series cardinality.
Unlike InfluxDB backed by the TSM storage engine, **tag value**
cardinality doesn't affect the overall performance of your database.
{{% /note %}}
> [!Note]
> The InfluxDB 3 storage engine supports infinite tag value and series cardinality.
> Unlike InfluxDB backed by the TSM storage engine, **tag value**
> cardinality doesn't affect the overall performance of your database.
---

18
content/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/_index.md
View File

@ -27,10 +27,9 @@ Learn how to enable the plugin in new and
existing Telegraf configurations,
and then start Telegraf using the custom configuration file.
{{% note %}}
_View the [requirements](/influxdb3/cloud-dedicated/write-data/use-telegraf#requirements)
for using Telegraf with {{< product-name >}}._
{{% /note %}}
> [!Note]
> _View the [requirements](/influxdb3/cloud-dedicated/write-data/use-telegraf#requirements)
> for using Telegraf with {{< product-name >}}._
<!-- TOC -->
@ -115,12 +114,11 @@ For {{% product-name %}}, set this to an empty string (`""`).
The name of the {{% product-name %}} database to write data to.
{{% note %}}
##### Write to InfluxDB v1.x and {{< product-name >}}
If a Telegraf agent is already writing to an InfluxDB v1.x database,
enabling the InfluxDB v2 output plugin will write data to both v1.x and your {{< product-name omit="Clustered" >}} cluster.
{{% /note %}}
> [!Note]
> ##### Write to InfluxDB v1.x and {{< product-name >}}
>
> If a Telegraf agent is already writing to an InfluxDB v1.x database,
> enabling the InfluxDB v2 output plugin will write data to both v1.x and your {{< product-name omit="Clustered" >}} cluster.
### Other Telegraf configuration options

27
content/influxdb3/cloud-serverless/admin/billing/limits.md
View File

@ -23,10 +23,9 @@ aliases:
InfluxDB Cloud Serverless applies (non-adjustable) global system limits and
adjustable service quotas on a per organization basis.
{{% warn %}}
All __rates__ (data-in (writes), and queries (reads)) 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 %}}
> [!Warning]
> All __rates__ (data-in (writes), and queries (reads)) 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.
Review adjustable service quotas and global limits to plan for your bandwidth needs:
@ -67,10 +66,9 @@ The v3 storage engine enforces the following storage-level limits:
- **Maximum number of tables per database**: 500
- **Maximum number of columns per table**: 200
{{% note %}}
Storage-level limits apply to Free Plan and Usage-Based Plan accounts.
If you need higher storage-level limits, [contact InfluxData Sales](https://www.influxdata.com/contact-sales/).
{{% /note %}}
> [!Note]
> Storage-level limits apply to Free Plan and Usage-Based Plan accounts.
> If you need higher storage-level limits, [contact InfluxData Sales](https://www.influxdata.com/contact-sales/).
### Free Plan
@ -86,9 +84,8 @@ If you need higher storage-level limits, [contact InfluxData Sales](https://www.
- [Storage-level limits](#storage-level-limits)
- 30 days of data retention (see [retention period](/influxdb3/cloud-serverless/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](/influxdb3/cloud-serverless/admin/billing/pricing-plans/#usage-based-plan).
{{% /note %}}
> [!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](/influxdb3/cloud-serverless/admin/billing/pricing-plans/#usage-based-plan).
### Usage-Based Plan
@ -129,10 +126,10 @@ Limits include:
- **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 %}} -->
> [!Note]
> **Tip:**
> Combine delete predicate expressions (if possible) into a single request. InfluxDB limits delete requests by number of requests (not points per request).
-->
## Error messages when exceeding quotas or limits

23
content/influxdb3/cloud-serverless/admin/buckets/_index.md
View File

@ -25,18 +25,17 @@ All buckets have a [retention period](#retention-period), a duration of time tha
InfluxDB drops all points with timestamps older than the bucket's retention period.
A bucket belongs to an organization.
{{% note %}}
**If coming from InfluxDB v1**, the concepts of databases and retention policies
have been combined into a single concept--_bucket_.
Retention policies are no longer part of the InfluxDB data model.
However, {{% product-name %}} does
support InfluxQL and the InfluxDB v1 API `/write` and `/query` endpoints, which require databases and retention policies.
See how to [map v1 databases and retention policies to buckets](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets).
**If coming from InfluxDB v2 or InfluxDB Cloud**, _buckets_ are functionally equivalent.
**If coming from InfluxDB Cloud Dedicated or InfluxDB Clustered**, _database_ and _bucket_ are synonymous.
{{% /note %}}
> [!Note]
> **If coming from InfluxDB v1**, the concepts of databases and retention policies
> have been combined into a single concept--_bucket_.
> Retention policies are no longer part of the InfluxDB data model.
> However, {{% product-name %}} does
> support InfluxQL and the InfluxDB v1 API `/write` and `/query` endpoints, which require databases and retention policies.
> See how to [map v1 databases and retention policies to buckets](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets).
>
> **If coming from InfluxDB v2 or InfluxDB Cloud**, _buckets_ are functionally equivalent.
>
> **If coming from InfluxDB Cloud Dedicated or InfluxDB Clustered**, _database_ and _bucket_ are synonymous.
## Retention period

11
content/influxdb3/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas.md
View File

@ -16,12 +16,11 @@ alt_links:
cloud: /influxdb/cloud/admin/buckets/bucket-schema/
---
{{% warn %}}
#### Don't use explicit schemas with InfluxDB 3
Don't use **explicit bucket schemas** with InfluxDB 3.
The sections on this page provide help for managing and troubleshooting `explicit` buckets you may already have.
{{% /warn %}}
> [!Warning]
> #### Don't use explicit schemas with InfluxDB 3
>
> Don't use **explicit bucket schemas** with InfluxDB 3.
> The sections on this page provide help for managing and troubleshooting `explicit` buckets you may already have.
In InfluxDB 2.x, 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.

20
content/influxdb3/cloud-serverless/admin/buckets/update-bucket.md
View File

@ -17,10 +17,9 @@ alt_links:
Use the InfluxDB user interface (UI), the `influx` command line interface (CLI),
or the InfluxDB HTTP API to update a bucket.
{{% note %}}
If you change a bucket name, be sure to update the bucket connection credential
in clients that connect to your bucket.
{{% /note %}}
> [!Note]
> If you change a bucket name, be sure to update the bucket connection credential
> in clients that connect to your bucket.
## Update a bucket's name in the InfluxDB UI
@ -45,10 +44,10 @@ in clients that connect to your bucket.
- **{{< caps >}}Never{{< /caps >}}**: data in the bucket is retained indefinitely.
- **{{< caps >}}Older Than{{< /caps >}}**: select a predefined retention period from the dropdown menu.
{{% note %}}
Use the [`influx bucket update` command](#update-a-buckets-retention-period)
or the [InfluxDB HTTP API `PATCH /api/v2/buckets` endpoint](/influxdb3/cloud-serverless/api/#operation/PatchBucketsID) to set a custom retention period.
{{% /note %}}
> [!Note]
> Use the [`influx bucket update` command](#update-a-buckets-retention-period)
> or the [InfluxDB HTTP API `PATCH /api/v2/buckets` endpoint](/influxdb3/cloud-serverless/api/#operation/PatchBucketsID) to set a custom retention period.
5. Click **{{< caps >}}Save Changes{{< /caps >}}**.
## Update a bucket using the influx CLI
@ -84,9 +83,8 @@ Valid retention period duration units:
- days (`d`)
- weeks (`w`)
{{% note %}}
The minimum retention period is **one hour**.
{{% /note %}}
> [!Note]
> The minimum retention period is **one hour**.
```sh
# Syntax

7
content/influxdb3/cloud-serverless/admin/organizations/update-org.md
View File

@ -14,10 +14,9 @@ weight: 103
Use the InfluxDB user interface (UI) or the `influx` command line interface (CLI)
to update an organization.
{{% note %}}
If you change an organization name, be sure to update the organization connection
credential in clients that connect to your {{< product-name >}} organization.
{{% /note %}}
> [!Note]
> If you change an organization name, be sure to update the organization connection
> credential in clients that connect to your {{< product-name >}} organization.
## Update an organization in the InfluxDB UI

25
content/influxdb3/cloud-serverless/admin/organizations/users.md
View File

@ -19,11 +19,10 @@ By default, each user has full permissions on resources in your organization.
- [Withdraw an invitation](#withdraw-an-invitation)
- [Remove a user from your organization](#remove-a-user-from-your-organization)
{{% note %}}
If you have multiple users, we recommend creating a system account for administrative purposes.
For example, if you have applications writing to InfluxDB, ensure the applications
use the system account credentials.
{{% /note %}}
> [!Note]
> If you have multiple users, we recommend creating a system account for administrative purposes.
> For example, if you have applications writing to InfluxDB, ensure the applications
> use the system account credentials.
## Members page
@ -38,12 +37,11 @@ menu with your organization's name in the top navigation menu and select
2. Under **Add a new user to your organization**, enter the email address of
the user to invite and select their role in your organization.
{{% note %}}
#### Available roles
Currently, InfluxDB Cloud has only one permission level for users: **Owner**.
With Owner permissions, a user can delete resources and other users from your organization.
Take care when inviting a user.
{{% /note %}}
> [!Note]
> #### Available roles
> Currently, InfluxDB Cloud has only one permission level for users: **Owner**.
> With Owner permissions, a user can delete resources and other users from your organization.
> Take care when inviting a user.
_Users must be invited one at a time._
3. Click **{{< icon "plus" >}} {{< caps >}}Add{{< /caps >}}**.
@ -67,9 +65,8 @@ Accounts can have up to 50 pending invitations at one time.
## Remove a user from your organization
{{% warn %}}
For security purposes, once an InfluxDB user account is deleted, the user (and their token) cannot be reactivated.
{{% /warn %}}
> [!Warning]
> For security purposes, once an InfluxDB user account is deleted, the user (and their token) cannot be reactivated.
1. Navigate to your organization's [Members page](#members-page).
2. Click the **{{< icon "delete" >}}** icon next to the user you want to remove.

27
content/influxdb3/cloud-serverless/admin/tokens/create-token.md
View File

@ -14,21 +14,18 @@ alt_links:
Create API tokens using the InfluxDB user interface (UI), the `influx`
command line interface (CLI), or the InfluxDB API.
{{% note %}}
To follow best practices for secure API token generation and retrieval, InfluxDB enforces access restrictions on API tokens.
- Tokens are visible to the user who created the token.
- InfluxDB only allows access to the API token value immediately after the token is created.
- You can't change access (**read/write**) permissions for an API token after it's created.
- Tokens stop working when the user who created the token is deleted.
**We recommend the following for managing your tokens:**
- Create a generic user to create and manage tokens for writing data.
- Store your tokens in a secure password vault for future access.
{{% /note %}}
> [!Note]
> To follow best practices for secure API token generation and retrieval, InfluxDB enforces access restrictions on API tokens.
>
> - Tokens are visible to the user who created the token.
> - InfluxDB only allows access to the API token value immediately after the token is created.
> - You can't change access (**read/write**) permissions for an API token after it's created.
> - Tokens stop working when the user who created the token is deleted.
>
> **We recommend the following for managing your tokens:**
>
> - Create a generic user to create and manage tokens for writing data.
> - Store your tokens in a secure password vault for future access.
{{< tabs-wrapper >}}
{{% tabs %}}

22
content/influxdb3/cloud-serverless/admin/tokens/view-tokens.md
View File

@ -12,16 +12,18 @@ weight: 202
View API tokens and permissions using the InfluxDB user interface (UI),
the `influx` command line interface (CLI), or the InfluxDB API.
{{% note %}}
To follow best practices for secure API token generation and retrieval, {{% product-name %}} enforces access restrictions on API tokens.
- InfluxDB UI only allows access to the API token value immediately after the token is created.
- You can't change access (**read/write**) permissions for an API token after it's created.
- Tokens stop working when the user who created the token is deleted.
We recommend the following for managing your tokens:
- Create a generic user to create and manage tokens for writing data.
- Store your tokens in a secure password vault for future access.
{{% /note %}}
> [!Note]
> To follow best practices for secure API token generation and retrieval,
> {{% product-name %}} enforces access restrictions on API tokens.
>
> - InfluxDB UI only allows access to the API token value immediately after the token is created.
> - You can't change access (**read/write**) permissions for an API token after it's created.
> - Tokens stop working when the user who created the token is deleted.
>
> We recommend the following for managing your tokens:
>
> - Create a generic user to create and manage tokens for writing data.
> - Store your tokens in a secure password vault for future access.
{{< tabs-wrapper >}}
{{% tabs %}}

9
content/influxdb3/cloud-serverless/get-started/_index.md
View File

@ -112,12 +112,9 @@ This tutorial covers many of the recommended tools.
{{< req type="key" text="Covered in this tutorial" color="magenta" >}}
{{% warn %}}
The `influxctl` admin CLI isn't available for {{% product-name %}}.
It only works with InfluxDB Cloud Dedicated and InfluxDB Clustered.
{{% /warn %}}
> [!Warning]
> The `influxctl` admin CLI isn't available for {{% product-name %}}.
> It only works with InfluxDB Cloud Dedicated and InfluxDB Clustered.
### InfluxDB user interface

49
content/influxdb3/cloud-serverless/get-started/query.md
View File

@ -33,10 +33,9 @@ a protocol for interacting with SQL databases using the Arrow in-memory format a
It leverages the performance of [Apache Arrow](https://arrow.apache.org/) with
the simplicity of SQL.
{{% note %}}
The examples in this section of the tutorial query the [**get-started** bucket](/influxdb3/cloud-serverless/get-started/setup/) for data written in the
[Get started writing data](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) section.
{{% /note %}}
> [!Note]
> The examples in this section of the tutorial query the [**get-started** bucket](/influxdb3/cloud-serverless/get-started/setup/) for data written in the
> [Get started writing data](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb) section.
## Tools to execute queries
@ -53,23 +52,20 @@ The examples in this section of the tutorial query the [**get-started** bucket](
- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/cloud-serverless/query-data/execute-queries/influxdb-v1-api/)
- [Chronograf](/chronograf/v1/)
{{% warn %}}
#### Avoid using /api/v2/query
Avoid using the `/api/v2/query` API endpoint and associated tooling, such as the `influx query` CLI command and InfluxDB v2 client libraries, with {{% product-name %}}.
{{% /warn %}}
> [!Warning]
>
> #### Avoid using /api/v2/query
>
> Avoid using the `/api/v2/query` API endpoint and associated tooling, such as the `influx query` CLI command and > InfluxDB v2 client libraries, with {{% product-name %}}.
## SQL query basics
The {{% product-name %}} SQL implementation is powered by the [Apache Arrow DataFusion](https://arrow.apache.org/datafusion/)
query engine which provides an SQL syntax similar to PostgreSQL.
{{% note %}}
This is a brief introduction to writing SQL queries for InfluxDB.
For more in-depth details, see [Query data with SQL](/influxdb3/cloud-serverless/query-data/sql/).
{{% /note %}}
> [!Note]
> This is a brief introduction to writing SQL queries for InfluxDB.
> For more in-depth details, see [Query data with SQL](/influxdb3/cloud-serverless/query-data/sql/).
InfluxDB SQL queries most commonly include the following clauses:
@ -182,14 +178,12 @@ Get started with one of the following tools for querying data stored in an {{% p
- **influx3 data CLI**: Send queries from your terminal command-line.
- **Grafana**: Use the [FlightSQL Data Source plugin](https://grafana.com/grafana/plugins/influxdata-flightsql-datasource/), to query, connect, and visualize data.
{{% warn %}}
#### Avoid using /api/v2/query
Avoid using the `/api/v2/query` API endpoint in {{% product-name %}} and associated tooling, such as the `influx query` CLI command and InfluxDB v2 client libraries.
You can't use SQL or InfluxQL with these tools.
{{% /warn %}}
> [!Warning]
>
> #### Avoid using /api/v2/query
>
> Avoid using the `/api/v2/query` API endpoint in {{% product-name %}} and associated tooling, such as the `influx > query` CLI command and InfluxDB v2 client libraries.
> You can't use SQL or InfluxQL with these tools.
For this example, use the following query to select all the data written to the
**get-started** bucket between
@ -209,11 +203,10 @@ WHERE
```
{{% /influxdb/custom-timestamps %}}
{{% note %}}
Some examples in this getting started tutorial assume your InfluxDB
credentials (**URL**, **organization**, and **token**) are provided by
[environment variables](/influxdb3/cloud-serverless/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials).
{{% /note %}}
> [!Note]
> Some examples in this getting started tutorial assume your InfluxDB
> credentials (**URL**, **organization**, and **token**) are provided by
> [environment variables](/influxdb3/cloud-serverless/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials).
{{< tabs-wrapper >}}
{{% tabs %}}

35
content/influxdb3/cloud-serverless/get-started/setup.md
View File

@ -55,12 +55,11 @@ you need is in place.
4. Enter a description for the API token and click **{{< icon "check" >}} {{% caps %}}Save{{% /caps %}}**.
5. Copy the generated token and store it for safe keeping.
{{% note %}}
We recommend using a password manager or a secret store to securely store
sensitive tokens.
{{% /note %}}
> [!Note]
> We recommend using a password manager or a secret store to securely store
> sensitive tokens.
3. **Configure authentication credentials**.
3. **Configure authentication credentials**.
<span id="configure-authentication-credentials"></span>
As you go through this tutorial, interactions with InfluxDB {{< current-version >}}
@ -68,10 +67,9 @@ sensitive tokens.
There are different methods for providing these credentials depending on
which client you use to interact with InfluxDB.
{{% note %}}
When configuring your token, if you [created an all access token](#create-an-all-access-api-token),
use that token to interact with InfluxDB. Otherwise, use your operator token.
{{% /note %}}
> [!Note]
> When configuring your token, if you [created an all access token](#create-an-all-access-api-token),
> use that token to interact with InfluxDB. Otherwise, use your operator token.
{{< tabs-wrapper >}}
{{% tabs %}}
@ -192,12 +190,11 @@ Use the following `influx` CLI flags to provide required credentials to commands
{{% /expand %}}
{{< /expand-wrapper >}}
{{% note %}}
All `influx` CLI examples in this getting started tutorial assume your InfluxDB
**host**, **organization**, and **token** are provided by either the
[active `influx` CLI configuration](/influxdb3/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials)
or by environment variables.
{{% /note %}}
> [!Note]
> All `influx` CLI examples in this getting started tutorial assume your InfluxDB
> **host**, **organization**, and **token** are provided by either the
> [active `influx` CLI configuration](/influxdb3/cloud-serverless/reference/cli/influx/#provide-required-authentication-credentials)
> or by environment variables.
<!------------------------------ END CLI CONTENT ------------------------------>
{{% /tab-content %}}
@ -324,10 +321,10 @@ Keep the following in mind when using API clients and client libraries:
[{{% product-name %}} region URL](/influxdb3/cloud-serverless/reference/regions/)
without `https://`.
{{% note %}}
All API, cURL, and client library examples in this getting started tutorial assume your InfluxDB
**host**, **organization**, **url**, and **token** are provided by environment variables.
{{% /note %}}
> [!Note]
> All API, cURL, and client library examples in this getting started tutorial assume your InfluxDB
> **host**, **organization**, **url**, and **token** are provided by environment variables.
<!------------------------------ END API CONTENT ------------------------------>
{{% /tab-content %}}
{{< /tabs-wrapper >}}

22
content/influxdb3/cloud-serverless/get-started/write.md
View File

@ -152,11 +152,10 @@ to an {{% product-name %}} bucket.
To learn more about available tools and options, see [Write data](/influxdb3/cloud-serverless/write-data/).
{{% note %}}
Some examples in this getting started tutorial assume your InfluxDB
credentials (**URL**, **organization**, and **token**) are provided by
[environment variables](/influxdb3/cloud-serverless/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials).
{{% /note %}}
> [!Note]
> Some examples in this getting started tutorial assume your InfluxDB
> credentials (**URL**, **organization**, and **token**) are provided by
> [environment variables](/influxdb3/cloud-serverless/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials).
{{< tabs-wrapper >}}
{{% tabs %}}
@ -399,14 +398,11 @@ To learn more, see how to [use Telegraf to write data](/influxdb3/cloud-serverle
Write data with your existing workloads that already use the InfluxDB v1 `/write`
API endpoint.
{{% note %}}
If migrating data from InfluxDB 1.x, see the
[Migrate data from InfluxDB 1.x to InfluxDB
{{% product-name %}}](/influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless/)
guide.
{{% /note %}}
> [!Note]
> If migrating data from InfluxDB 1.x, see the
> [Migrate data from InfluxDB 1.x to InfluxDB
> {{% product-name %}}](/influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless/)
> guide.
To write data to InfluxDB using the
[InfluxDB v1 HTTP API](/influxdb3/cloud-serverless/reference/api/), send a request

34
content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md
View File

@ -232,11 +232,8 @@ Response body messages may differ across {{% product-name %}} v1 API, v2 API, In
Before you can write data using the InfluxDB v1 `/write` endpoint or query data using the v1 `/query` endpoint, the bucket must be mapped to a [database retention policy (DBRP)](/influxdb3/cloud-serverless/admin/dbrps/) combination.
{{% note %}}
To query using Flight with InfluxQL or SQL, you don't need to map DBRPs to buckets.
{{% /note %}}
> [!Note]
> To query using Flight with InfluxQL or SQL, you don't need to map DBRPs to buckets.
In InfluxDB 1.x, data is stored in [databases](/influxdb3/cloud-serverless/reference/glossary/#database)
and [retention policies](/influxdb3/cloud-serverless/reference/glossary/#retention-period).
@ -267,11 +264,10 @@ Managing DBRP mappings requires a [token](/influxdb3/cloud-serverless/admin/toke
- **read dbrp**: to list DBRP mappings
- **write bucket**: to automatically create a bucket for a DBRP mapping when using the v1 write API
{{% note %}}
#### Permission required to create mapped buckets
If you use the v1 write API to write to a database (`db`) and retention policy (`rp`) combination that doesn't exist, InfluxDB tries to create a new bucket using the specified parameter values.
If the token doesn't have permission to create a bucket, then the write request fails with an authorization error.
{{% /note %}}
> [!Note]
> #### Permission required to create mapped buckets
> If you use the v1 write API to write to a database (`db`) and retention policy (`rp`) combination that doesn't exist, InfluxDB tries to create a new bucket using the specified parameter values.
> If the token doesn't have permission to create a bucket, then the write request fails with an authorization error.
### Default DBRP
@ -308,9 +304,8 @@ DATABASE_NAME/RETENTION_POLICY_NAME
| telegraf | autogen | telegraf/autogen |
| webmetrics | 1w-downsampled | webmetrics/1w-downsampled |
{{% note %}}
To avoid having to add configuration parameters to each CLI command, [set up an active InfluxDB configuration](/influxdb3/cloud-serverless/reference/cli/influx/config/set/).
{{% /note %}}
> [!Note]
> To avoid having to add configuration parameters to each CLI command, [set up an active InfluxDB configuration](/influxdb3/cloud-serverless/reference/cli/influx/config/set/).
### Manage DBRPs
@ -319,13 +314,12 @@ DATABASE_NAME/RETENTION_POLICY_NAME
To create DBRP mappings, use the `influx` CLI or the
InfluxDB HTTP API.
{{% note %}}
#### A DBRP combination can only be mapped to a single bucket
Each unique DBRP combination can only be mapped to a single bucket.
If you map a DBRP combination that is already mapped to another bucket,
it overwrites the existing DBRP mapping.
{{% /note %}}
> [!Note]
> #### A DBRP combination can only be mapped to a single bucket
>
> Each unique DBRP combination can only be mapped to a single bucket.
> If you map a DBRP combination that is already mapped to another bucket,
> it overwrites the existing DBRP mapping.
{{< tabs-wrapper >}}
{{% tabs %}}

44
content/influxdb3/cloud-serverless/guides/api-compatibility/v2/_index.md
View File

@ -189,28 +189,24 @@ InfluxDB 3 provides the following protocols for executing a query:
To learn how to query {{% product-name %}} using Flight and SQL, see the [Get started](/influxdb3/cloud-serverless/get-started/) tutorial.
- InfluxDB v1 API `/query` request that contains an InfluxQL query.
{{% note %}}
#### Tools to execute queries
{{% product-name %}} supports many different tools for querying data, including:
- [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli)
- [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/)
- [Flight clients](/influxdb3/cloud-serverless/reference/client-libraries/flight/)
- [Superset](/influxdb3/cloud-serverless/query-data/sql/execute-queries/superset/)
- [Grafana](/influxdb3/cloud-serverless/query-data/sql/execute-queries/grafana/)
- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/cloud-serverless/primers/api/v1/#query-using-the-v1-api)
- [Chronograf](/chronograf/v1/)
{{% /note %}}
{{% warn %}}
#### Avoid using /api/v2/query
Avoid using the `/api/v2/query` API endpoint in {{% product-name %}} and associated tooling, such as the `influx query` CLI command and InfluxDB v2 client libraries.
You can't use SQL or InfluxQL with these tools.
{{% /warn %}}
> [!Note]
>
> #### Tools to execute queries
>
> {{% product-name %}} supports many different tools for querying data, including:
>
> - [`influx3` data CLI](https://github.com/InfluxCommunity/influxdb3-python-cli)
> - [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/)
> - [Flight clients](/influxdb3/cloud-serverless/reference/client-libraries/flight/)
> - [Superset](/influxdb3/cloud-serverless/query-data/sql/execute-queries/superset/)
> - [Grafana](/influxdb3/cloud-serverless/query-data/sql/execute-queries/grafana/)
> - [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/cloud-serverless/primers/api/v1/#query-using-the-v1-api)
> - [Chronograf](/chronograf/v1/)
> [!Warning]
>
> #### Avoid using /api/v2/query
>
> Avoid using the `/api/v2/query` API endpoint in {{% product-name %}} and
> associated tooling, such as the `influx query` CLI command and InfluxDB v2
> client libraries. You can't use SQL or InfluxQL with these tools.

21
content/influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless.md
View File

@ -171,12 +171,12 @@ The migration process uses the following tools:
Visit [cloud2.influxdata.com](https://cloud2.influxdata.com) to access the
InfluxDB Cloud UI.
{{% note %}}
#### InfluxDB 1.x and 2.x CLIs are unique
If both the **InfluxDB 1.x and 2.x `influx` CLIs** are installed in your `$PATH`,
rename one of the the binaries to ensure you're executing commands with the
correct CLI.
{{% /note %}}
> [!Note]
> #### InfluxDB 1.x and 2.x CLIs are unique
>
> If both the **InfluxDB 1.x and 2.x `influx` CLIs** are installed in your `$PATH`,
> rename one of the the binaries to ensure you're executing commands with the
> correct CLI.
## Migrate data
@ -212,11 +212,10 @@ correct CLI.
- `-end` flag with an RFC3339 timestamp that defines the latest time to export.
Default is `2262-04-11T16:47:16-07:00`.
{{% note %}}
We recommend exporting each database and retention policy combination separately
to easily write the exported data into corresponding InfluxDB {{< current-version >}}
buckets.
{{% /note %}}
> [!Note]
> We recommend exporting each database and retention policy combination separately
> to easily write the exported data into corresponding InfluxDB {{< current-version >}}
> buckets.
##### Export all data in a database and retention policy to a file
```sh

30
content/influxdb3/cloud-serverless/guides/migrate-data/migrate-tsm-to-serverless.md
View File

@ -152,15 +152,14 @@ data = () =>
## Set up the migration
{{% 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
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 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 %}}
> [!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
> 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 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.
1. **In the InfluxDB Cloud Serverless organization you're migrating data _to_**:
@ -182,9 +181,9 @@ to complete the migration.
5. _(Optional)_ Set up [migration monitoring](#monitor-the-migration-progress).
6. Save the task.
{{% note %}}
Newly-created tasks are enabled by default, so the data migration begins when you save the task.
{{% /note %}}
> [!Note]
> Newly-created tasks are enabled by default, so the data migration
> begins when you save the task.
**After the migration is complete**, each subsequent migration task execution
will fail with the following error:
@ -422,10 +421,9 @@ curl -so /dev/null --request POST \
--write-out '%{size_download}'
```
{{% note %}}
You can also use other HTTP API tools like [Postman](https://www.postman.com/)
that provide the size of the response body.
{{% /note %}}
> [!Note]
> You can also use other HTTP API tools like [Postman](https://www.postman.com/)
> that provide the size of the response body.
Divide the output of this command by 1000000 to convert it to megabytes (MB).

7
content/influxdb3/cloud-serverless/process-data/downsample/client-libraries.md
View File

@ -265,10 +265,9 @@ data_frame = table.to_pandas()
- **data_frame_tag_columns**: List of [tag](/influxdb3/cloud-serverless/reference/glossary/#tag)
columns
{{% note %}}
Columns not listed in the **data_frame_tag_columns** or **data_frame_timestamp_column**
arguments are written to InfluxDB as [fields](/influxdb3/cloud-serverless/reference/glossary/#field).
{{% /note %}}
> [!Note]
> Columns not listed in the **data_frame_tag_columns** or **data_frame_timestamp_column**
> arguments are written to InfluxDB as [fields](/influxdb3/cloud-serverless/reference/glossary/#field).
```py
# ...

16
content/influxdb3/cloud-serverless/process-data/downsample/quix.md
View File

@ -36,12 +36,11 @@ The following diagram illustrates how data is passed between processes as it is
{{< html-diagram/quix-downsample-pipeline >}}
{{% note %}}
It is usually more efficient to write raw data directly to Kafka rather than
writing raw data to InfluxDB first (essentially starting the Quix Streams
pipeline with the "raw-data" topic). However, this guide assumes that you
already have raw data in InfluxDB that you want to downsample.
{{% /note %}}
> [!Note]
> It is usually more efficient to write raw data directly to Kafka rather than
> writing raw data to InfluxDB first (essentially starting the Quix Streams
> pipeline with the "raw-data" topic). However, this guide assumes that you
> already have raw data in InfluxDB that you want to downsample.
---
@ -143,9 +142,8 @@ downsamples it, and then sends it to an output topic that is used to write back
The results are streamed to the Kafka topic, `downsampled-data`.
{{% note %}}
Note: "sdf" stands for "Streaming Dataframe".
{{% /note %}}
> [!Note]
> "sdf" stands for "Streaming Dataframe".
You can find the full code for this process in the
[Quix GitHub repository](https://github.com/quixio/template-influxdbv3-downsampling/blob/dev/Downsampler/main.py).

7
content/influxdb3/cloud-serverless/process-data/send-alerts.md
View File

@ -44,10 +44,9 @@ More information is provided in the
## Install dependencies
{{% note %}}
This guide assumes you have already
[setup your Python project and virtual environment](/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment).
{{% /note %}}
> [!Note]
> This guide assumes you have already
> [setup your Python project and virtual environment](/influxdb3/cloud-serverless/query-data/execute-queries/client-libraries/python/#create-a-python-virtual-environment).
Use `pip` to install the following dependencies:

17
content/influxdb3/cloud-serverless/process-data/summarize.md
View File

@ -14,15 +14,14 @@ related:
Query data stored in InfluxDB and use tools like pandas to summarize the results schema and distribution.
{{% note %}}
#### Sample data
The following examples use the sample data written in the
[Get started writing data guide](/influxdb3/cloud-serverless/get-started/write/).
To run the example queries and return results,
[write the sample data](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb)
to your {{% product-name %}} bucket before running the example queries.
{{% /note %}}
> [!Note]
> #### Sample data
>
> The following examples use the sample data written in the
> [Get started writing data guide](/influxdb3/cloud-serverless/get-started/write/).
> To run the example queries and return results,
> [write the sample data](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb)
> to your {{% product-name %}} bucket before running the example queries.
### View data information and statistics

60
content/influxdb3/cloud-serverless/process-data/visualize/chronograf.md
View File

@ -45,16 +45,15 @@ If you haven't already, [download and install Chronograf](/chronograf/v1/introdu
- **Default Retention Policy:** Default [retention policy](/influxdb3/cloud-serverless/reference/glossary/#retention-policy-rp)
_**(leave blank)**_
{{% note %}}
#### DBRPs map to InfluxDB buckets
In {{% product-name %}}, database and retention-policy (DBRP) combinations
are mapped to buckets using the `database-name/retention-policy` naming convention
or using manually created DBRP mappings.
**DBRP mappings are required to query InfluxDB Cloud using InfluxQL.**
For information, see [Create DBRP mappings](/influxdb3/cloud-serverless/query-data/influxql/dbrp/).
{{% /note %}}
> [!Note]
> #### DBRPs map to InfluxDB buckets
>
> In {{% product-name %}}, database and retention-policy (DBRP) combinations
> are mapped to buckets using the `database-name/retention-policy` naming convention
> or using manually created DBRP mappings.
> **DBRP mappings are required to query InfluxDB Cloud using InfluxQL.**
>
> For information, see [Create DBRP mappings](/influxdb3/cloud-serverless/query-data/influxql/dbrp/).
3. Click **Add Connection**.
4. Select the dashboards you would like to create, and then click **Next**.
@ -71,27 +70,26 @@ For information, see [Create DBRP mappings](/influxdb3/cloud-serverless/query-da
1. In Chronograf, click **{{< icon "graph" "v2" >}} Explore** in the left navigation bar.
2. Build and submit InfluxQL queries.
{{% note %}}
#### Schema information is not available
{{% product-name %}} currently offers limited support of InfluxQL metaqueries, so
schema information may not be available in the Data Explorer.
This limits the Data Explorer's query building functionality and requires you to
build queries manually using
[fully-qualified measurements](/influxdb3/cloud-serverless/reference/influxql/select/#fully-qualified-measurement)
in the `FROM` clause. For example:
```sql
-- Fully-qualified measurement
SELECT * FROM "db-name"."rp-name"."measurement-name"
-- Fully-qualified measurement shorthand (use the default retention policy)
SELECT * FROM "db-name".."measurement-name"
```
For more information about available InfluxQL functionality, see
[InfluxQL feature support](/influxdb3/cloud-serverless/reference/influxql/feature-support/).
{{% /note %}}
> [!Note]
> #### Schema information is not available
>
> {{% product-name %}} currently offers limited support of InfluxQL metaqueries, so
> schema information may not be available in the Data Explorer.
> This limits the Data Explorer's query building functionality and requires you to
> build queries manually using
> [fully-qualified measurements](/influxdb3/cloud-serverless/reference/influxql/select/#fully-qualified-measurement)
> in the `FROM` clause. For example:
>
> ```sql
> -- Fully-qualified measurement
> SELECT * FROM "db-name"."rp-name"."measurement-name"
>
> -- Fully-qualified measurement shorthand (use the default retention policy)
> SELECT * FROM "db-name".."measurement-name"
> ```
>
> For more information about available InfluxQL functionality, see
> [InfluxQL feature support](/influxdb3/cloud-serverless/reference/influxql/feature-support/).
## Important notes

35
content/influxdb3/cloud-serverless/process-data/visualize/grafana.md
View File

@ -56,14 +56,13 @@ The InfluxDB data source plugin is included in the Grafana core distribution.
Use the plugin to query and visualize data stored in {{< product-name >}} with
both InfluxQL and SQL.
{{% note %}}
#### Grafana 10.3+
The instructions below are for **Grafana 10.3+** which introduced the newest
version of the InfluxDB core plugin.
The updated plugin includes **SQL support** for InfluxDB 3-based products such
as {{< product-name >}}.
{{% /note %}}
> [!Note]
> #### Grafana 10.3+
>
> The instructions below are for **Grafana 10.3+** which introduced the newest
> version of the InfluxDB core plugin.
> The updated plugin includes **SQL support** for InfluxDB 3-based products such
> as {{< product-name >}}.
## Create an InfluxDB data source
@ -113,13 +112,12 @@ When creating an InfluxDB data source that uses SQL to query data:
When creating an InfluxDB data source that uses InfluxQL to query data:
{{% note %}}
#### Map databases and retention policies to buckets
To query {{% product-name %}} with InfluxQL, first map database and retention policy
(DBRP) combinations to your InfluxDB Cloud buckets. For more information, see
[Map databases and retention policies to buckets](/influxdb3/cloud-serverless/query-data/influxql/dbrp/).
{{% /note %}}
> [!Note]
> #### Map databases and retention policies to buckets
>
> To query {{% product-name %}} with InfluxQL, first map database and retention policy
> (DBRP) combinations to your InfluxDB Cloud buckets. For more information, see
> [Map databases and retention policies to buckets](/influxdb3/cloud-serverless/query-data/influxql/dbrp/).
1. Under **HTTP**:
@ -164,10 +162,9 @@ use Grafana to build, run, and inspect queries against your InfluxDB bucket.
{{% tab-content %}}
<!--------------------------------- BEGIN SQL --------------------------------->
{{% note %}}
{{% sql/sql-schema-intro %}}
To learn more, see [Query Data](/influxdb3/cloud-serverless/query-data/sql/).
{{% /note %}}
> [!Note]
> {{% sql/sql-schema-intro %}}
> To learn more, see [Query Data](/influxdb3/cloud-serverless/query-data/sql/).
1. Click **Explore**.
2. In the dropdown, select the saved InfluxDB data source to query.

Some files were not shown because too many files have changed in this diff Show More