diff --git a/content/influxdb3/cloud-dedicated/admin/databases/_index.md b/content/influxdb3/cloud-dedicated/admin/databases/_index.md index fa09c6e8b..5f0c04b84 100644 --- a/content/influxdb3/cloud-dedicated/admin/databases/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/_index.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/admin/databases/create.md b/content/influxdb3/cloud-dedicated/admin/databases/create.md index c5ae29e02..b6a3df965 100644 --- a/content/influxdb3/cloud-dedicated/admin/databases/create.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/create.md @@ -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._ @@ -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 diff --git a/content/influxdb3/cloud-dedicated/admin/databases/delete.md b/content/influxdb3/cloud-dedicated/admin/databases/delete.md index 04b0668e9..29066543e 100644 --- a/content/influxdb3/cloud-dedicated/admin/databases/delete.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/delete.md @@ -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 %}} diff --git a/content/influxdb3/cloud-dedicated/admin/databases/update.md b/content/influxdb3/cloud-dedicated/admin/databases/update.md index 82a9ae1a2..f8fc40fff 100644 --- a/content/influxdb3/cloud-dedicated/admin/databases/update.md +++ b/content/influxdb3/cloud-dedicated/admin/databases/update.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md b/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md index b8353b526..27ccd7c2a 100644 --- a/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md +++ b/content/influxdb3/cloud-dedicated/admin/monitor-your-cluster.md @@ -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) diff --git a/content/influxdb3/cloud-dedicated/admin/query-system-data.md b/content/influxdb3/cloud-dedicated/admin/query-system-data.md index 57c7eafd8..d6393b3ba 100644 --- a/content/influxdb3/cloud-dedicated/admin/query-system-data.md +++ b/content/influxdb3/cloud-dedicated/admin/query-system-data.md @@ -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). - - - -#### 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). - - -{{% /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). +> +> +> +> #### 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). +> +> ## 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) diff --git a/content/influxdb3/cloud-dedicated/admin/sso.md b/content/influxdb3/cloud-dedicated/admin/sso.md index 7ba57b9ce..684ba08bd 100644 --- a/content/influxdb3/cloud-dedicated/admin/sso.md +++ b/content/influxdb3/cloud-dedicated/admin/sso.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/admin/tables/_index.md b/content/influxdb3/cloud-dedicated/admin/tables/_index.md index 64d4046de..564aff167 100644 --- a/content/influxdb3/cloud-dedicated/admin/tables/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/tables/_index.md @@ -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" >}} diff --git a/content/influxdb3/cloud-dedicated/admin/tables/create.md b/content/influxdb3/cloud-dedicated/admin/tables/create.md index e755521b4..4a5ec8784 100644 --- a/content/influxdb3/cloud-dedicated/admin/tables/create.md +++ b/content/influxdb3/cloud-dedicated/admin/tables/create.md @@ -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. diff --git a/content/influxdb3/cloud-dedicated/admin/tables/list.md b/content/influxdb3/cloud-dedicated/admin/tables/list.md index 864c7c3ec..73737fe93 100644 --- a/content/influxdb3/cloud-dedicated/admin/tables/list.md +++ b/content/influxdb3/cloud-dedicated/admin/tables/list.md @@ -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) diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/_index.md b/content/influxdb3/cloud-dedicated/admin/tokens/_index.md index 384f49834..3381e2412 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/_index.md @@ -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). --- diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md index cecddba2b..efd83b5d7 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/create.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/delete.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/delete.md index 8bc3cde9a..3f7ba6b88 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/delete.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/delete.md @@ -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. diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md b/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md index 3f458913e..e4f968056 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/database/update.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/management/_index.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/_index.md index b2174cd11..163ab8bd5 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/management/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/_index.md @@ -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) diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/management/create.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/create.md index efa5c39b4..27ae83db6 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/management/create.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/create.md @@ -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). diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md index 180e85d54..b568e2c1f 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/list.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md b/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md index 1cfbedebe..3886fbf52 100644 --- a/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md +++ b/content/influxdb3/cloud-dedicated/admin/tokens/management/revoke.md @@ -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. diff --git a/content/influxdb3/cloud-dedicated/admin/users/_index.md b/content/influxdb3/cloud-dedicated/admin/users/_index.md index ec7c59819..2f29c4ec1 100644 --- a/content/influxdb3/cloud-dedicated/admin/users/_index.md +++ b/content/influxdb3/cloud-dedicated/admin/users/_index.md @@ -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. diff --git a/content/influxdb3/cloud-dedicated/get-started/_index.md b/content/influxdb3/cloud-dedicated/get-started/_index.md index 3075bd84f..4b794a66a 100644 --- a/content/influxdb3/cloud-dedicated/get-started/_index.md +++ b/content/influxdb3/cloud-dedicated/get-started/_index.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/get-started/query.md b/content/influxdb3/cloud-dedicated/get-started/query.md index 814cdd107..a4d0a63b3 100644 --- a/content/influxdb3/cloud-dedicated/get-started/query.md +++ b/content/influxdb3/cloud-dedicated/get-started/query.md @@ -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. {{% /tab-content %}} diff --git a/content/influxdb3/cloud-dedicated/get-started/setup.md b/content/influxdb3/cloud-dedicated/get-started/setup.md index e973f54f9..6def4564c 100644 --- a/content/influxdb3/cloud-dedicated/get-started/setup.md +++ b/content/influxdb3/cloud-dedicated/get-started/setup.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/get-started/write.md b/content/influxdb3/cloud-dedicated/get-started/write.md index 07f9e280e..501752a76 100644 --- a/content/influxdb3/cloud-dedicated/get-started/write.md +++ b/content/influxdb3/cloud-dedicated/get-started/write.md @@ -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 -{{% 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: diff --git a/content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md b/content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md index e646c077e..3fd780328 100644 --- a/content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md +++ b/content/influxdb3/cloud-dedicated/guides/api-compatibility/v1/_index.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/guides/api-compatibility/v2/_index.md b/content/influxdb3/cloud-dedicated/guides/api-compatibility/v2/_index.md index d41b067ad..ccdbec76f 100644 --- a/content/influxdb3/cloud-dedicated/guides/api-compatibility/v2/_index.md +++ b/content/influxdb3/cloud-dedicated/guides/api-compatibility/v2/_index.md @@ -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 %}}. diff --git a/content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md b/content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md index 47c4432f9..5bcf8b9eb 100644 --- a/content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md +++ b/content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-1x-to-cloud-dedicated.md @@ -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/). diff --git a/content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated.md b/content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated.md index 638651d37..9a6f91593 100644 --- a/content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated.md +++ b/content/influxdb3/cloud-dedicated/guides/migrate-data/migrate-tsm-to-cloud-dedicated.md @@ -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). diff --git a/content/influxdb3/cloud-dedicated/process-data/downsample/downsample-client-libraries.md b/content/influxdb3/cloud-dedicated/process-data/downsample/downsample-client-libraries.md index 8f6670238..d895f0aa5 100644 --- a/content/influxdb3/cloud-dedicated/process-data/downsample/downsample-client-libraries.md +++ b/content/influxdb3/cloud-dedicated/process-data/downsample/downsample-client-libraries.md @@ -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 # ... diff --git a/content/influxdb3/cloud-dedicated/process-data/downsample/downsample-quix.md b/content/influxdb3/cloud-dedicated/process-data/downsample/downsample-quix.md index a9dcfae45..280f0f07a 100644 --- a/content/influxdb3/cloud-dedicated/process-data/downsample/downsample-quix.md +++ b/content/influxdb3/cloud-dedicated/process-data/downsample/downsample-quix.md @@ -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). diff --git a/content/influxdb3/cloud-dedicated/process-data/send-alerts.md b/content/influxdb3/cloud-dedicated/process-data/send-alerts.md index d4c8183d1..e145b4ce8 100644 --- a/content/influxdb3/cloud-dedicated/process-data/send-alerts.md +++ b/content/influxdb3/cloud-dedicated/process-data/send-alerts.md @@ -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: diff --git a/content/influxdb3/cloud-dedicated/process-data/summarize.md b/content/influxdb3/cloud-dedicated/process-data/summarize.md index 456d254b3..384a2bbd7 100644 --- a/content/influxdb3/cloud-dedicated/process-data/summarize.md +++ b/content/influxdb3/cloud-dedicated/process-data/summarize.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/process-data/visualize/chronograf.md b/content/influxdb3/cloud-dedicated/process-data/visualize/chronograf.md index ea37355f7..207a9be33 100644 --- a/content/influxdb3/cloud-dedicated/process-data/visualize/chronograf.md +++ b/content/influxdb3/cloud-dedicated/process-data/visualize/chronograf.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/process-data/visualize/grafana.md b/content/influxdb3/cloud-dedicated/process-data/visualize/grafana.md index aa7d64e05..e5b168e5e 100644 --- a/content/influxdb3/cloud-dedicated/process-data/visualize/grafana.md +++ b/content/influxdb3/cloud-dedicated/process-data/visualize/grafana.md @@ -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 %}} -{{% 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. diff --git a/content/influxdb3/cloud-dedicated/process-data/visualize/superset.md b/content/influxdb3/cloud-dedicated/process-data/visualize/superset.md index 0beea4002..887fb8d64 100644 --- a/content/influxdb3/cloud-dedicated/process-data/visualize/superset.md +++ b/content/influxdb3/cloud-dedicated/process-data/visualize/superset.md @@ -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: diff --git a/content/influxdb3/cloud-dedicated/process-data/visualize/tableau.md b/content/influxdb3/cloud-dedicated/process-data/visualize/tableau.md index 6bf5e838e..4ca2ce9ba 100644 --- a/content/influxdb3/cloud-dedicated/process-data/visualize/tableau.md +++ b/content/influxdb3/cloud-dedicated/process-data/visualize/tableau.md @@ -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)._ diff --git a/content/influxdb3/cloud-dedicated/query-data/_index.md b/content/influxdb3/cloud-dedicated/query-data/_index.md index bbfbb78ef..41a40c4e9 100644 --- a/content/influxdb3/cloud-dedicated/query-data/_index.md +++ b/content/influxdb3/cloud-dedicated/query-data/_index.md @@ -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 >}} diff --git a/content/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api.md b/content/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api.md index c27dd332d..f64352dff 100644 --- a/content/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api.md +++ b/content/influxdb3/cloud-dedicated/query-data/execute-queries/influxdb-v1-api.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/query-data/execute-queries/visualization-tools.md b/content/influxdb3/cloud-dedicated/query-data/execute-queries/visualization-tools.md index 1e72b4c2a..846a82984 100644 --- a/content/influxdb3/cloud-dedicated/query-data/execute-queries/visualization-tools.md +++ b/content/influxdb3/cloud-dedicated/query-data/execute-queries/visualization-tools.md @@ -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 %}} \ No newline at end of file +> [!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/). diff --git a/content/influxdb3/cloud-dedicated/query-data/influxql/aggregate-select.md b/content/influxdb3/cloud-dedicated/query-data/influxql/aggregate-select.md index 1c3866591..10bddb0b3 100644 --- a/content/influxdb3/cloud-dedicated/query-data/influxql/aggregate-select.md +++ b/content/influxdb3/cloud-dedicated/query-data/influxql/aggregate-select.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/query-data/influxql/basic-query.md b/content/influxdb3/cloud-dedicated/query-data/influxql/basic-query.md index ed2c48cf0..5fddae577 100644 --- a/content/influxdb3/cloud-dedicated/query-data/influxql/basic-query.md +++ b/content/influxdb3/cloud-dedicated/query-data/influxql/basic-query.md @@ -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. diff --git a/content/influxdb3/cloud-dedicated/query-data/influxql/explore-schema.md b/content/influxdb3/cloud-dedicated/query-data/influxql/explore-schema.md index d498ac24a..d21c8199c 100644 --- a/content/influxdb3/cloud-dedicated/query-data/influxql/explore-schema.md +++ b/content/influxdb3/cloud-dedicated/query-data/influxql/explore-schema.md @@ -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" %}} diff --git a/content/influxdb3/cloud-dedicated/query-data/influxql/parameterized-queries.md b/content/influxdb3/cloud-dedicated/query-data/influxql/parameterized-queries.md index cea109f13..18045b4be 100644 --- a/content/influxdb3/cloud-dedicated/query-data/influxql/parameterized-queries.md +++ b/content/influxdb3/cloud-dedicated/query-data/influxql/parameterized-queries.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/query-data/influxql/troubleshoot.md b/content/influxdb3/cloud-dedicated/query-data/influxql/troubleshoot.md index 4467b7056..9beaa5d13 100644 --- a/content/influxdb3/cloud-dedicated/query-data/influxql/troubleshoot.md +++ b/content/influxdb3/cloud-dedicated/query-data/influxql/troubleshoot.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/query-data/sql/aggregate-select.md b/content/influxdb3/cloud-dedicated/query-data/sql/aggregate-select.md index 57f9320b3..504d7be97 100644 --- a/content/influxdb3/cloud-dedicated/query-data/sql/aggregate-select.md +++ b/content/influxdb3/cloud-dedicated/query-data/sql/aggregate-select.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/query-data/sql/basic-query.md b/content/influxdb3/cloud-dedicated/query-data/sql/basic-query.md index 610bea139..1db655ecf 100644 --- a/content/influxdb3/cloud-dedicated/query-data/sql/basic-query.md +++ b/content/influxdb3/cloud-dedicated/query-data/sql/basic-query.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/query-data/sql/cast-types.md b/content/influxdb3/cloud-dedicated/query-data/sql/cast-types.md index b8545a2cf..58f641b40 100644 --- a/content/influxdb3/cloud-dedicated/query-data/sql/cast-types.md +++ b/content/influxdb3/cloud-dedicated/query-data/sql/cast-types.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/query-data/sql/fill-gaps.md b/content/influxdb3/cloud-dedicated/query-data/sql/fill-gaps.md index ac78e5862..2e41692aa 100644 --- a/content/influxdb3/cloud-dedicated/query-data/sql/fill-gaps.md +++ b/content/influxdb3/cloud-dedicated/query-data/sql/fill-gaps.md @@ -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: diff --git a/content/influxdb3/cloud-dedicated/query-data/sql/parameterized-queries.md b/content/influxdb3/cloud-dedicated/query-data/sql/parameterized-queries.md index a3cfdfbc0..44308d2a8 100644 --- a/content/influxdb3/cloud-dedicated/query-data/sql/parameterized-queries.md +++ b/content/influxdb3/cloud-dedicated/query-data/sql/parameterized-queries.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md b/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md index de52765f0..61b38728d 100644 --- a/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md +++ b/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/analyze-query-plan.md @@ -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). diff --git a/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md b/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md index cd9c91f26..22c47297e 100644 --- a/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md +++ b/content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/trace.md @@ -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: diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create.md index 48e1aca22..b74e8c593 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/database/create.md @@ -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 `` 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 `` already exists' +> ``` ## Usage diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/database/delete.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/database/delete.md index 10f05b3aa..2fc657513 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/database/delete.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/database/delete.md @@ -21,16 +21,15 @@ Cloud Dedicated cluster. influxctl database delete [command options] [--force] [...] ``` -{{% 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 diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/create.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/create.md index c491f4283..724a7008a 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/create.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/create.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list.md index 8fc5069b5..5ac4a6ae4 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list.md @@ -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. diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/revoke.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/revoke.md index bfb2228d6..6e7948120 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/revoke.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/management/revoke.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/query.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/query.md index c03580485..4c8312568 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/query.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/query.md @@ -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" %}} diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/table/create.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/table/create.md index c76d4f2ad..8367e4926 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/table/create.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/table/create.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create.md index c7d8ecbc9..d744d331d 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/delete.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/delete.md index e9e76fc1d..b719afc21 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/delete.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/delete.md @@ -18,18 +18,17 @@ Cloud Dedicated cluster and revokes all permissions associated with the token. influxctl token delete [...] ``` -{{% 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 diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/update.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/update.md index 4d7f1eed0..8f41b49d9 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/update.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/update.md @@ -25,13 +25,12 @@ influxctl token update \ ``` -{{% 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 diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/delete.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/delete.md index ca9e1e812..dc29cc740 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/delete.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/delete.md @@ -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 ``` -{{% 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 diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/invite.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/invite.md index 2ad44fa04..2e48d6f53 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/invite.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/user/invite.md @@ -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. diff --git a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/write.md b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/write.md index 365e40cfb..da64f97bd 100644 --- a/content/influxdb3/cloud-dedicated/reference/cli/influxctl/write.md +++ b/content/influxdb3/cloud-dedicated/reference/cli/influxctl/write.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/_index.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/_index.md index b25bf9822..daff44f3b 100644 --- a/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/_index.md @@ -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. diff --git a/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/csharp-flight.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/csharp-flight.md index b66f18e8c..549ce4aed 100644 --- a/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/csharp-flight.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/csharp-flight.md @@ -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. diff --git a/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/go-flight.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/go-flight.md index a9363d07c..8e1c158ea 100644 --- a/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/go-flight.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/go-flight.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md index d5c98bc34..cc22cfd00 100644 --- a/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/java-flightsql.md @@ -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. diff --git a/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flight.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flight.md index f50fe2bed..840a62b21 100644 --- a/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flight.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flight.md @@ -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: diff --git a/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flightsql-dbapi.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flightsql-dbapi.md index 2147a8807..ffe5d92b5 100644 --- a/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flightsql-dbapi.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/flight/python-flightsql-dbapi.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/reference/client-libraries/v1/_index.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v1/_index.md index 8bae64050..0d4bb4881 100644 --- a/content/influxdb3/cloud-dedicated/reference/client-libraries/v1/_index.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v1/_index.md @@ -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. diff --git a/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/browser.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/browser.md index 4433534fb..564ffbac6 100644 --- a/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/browser.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/browser.md @@ -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) diff --git a/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/python.md b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/python.md index d8c9ad94e..1925b22a4 100644 --- a/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/python.md +++ b/content/influxdb3/cloud-dedicated/reference/client-libraries/v3/python.md @@ -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) diff --git a/content/influxdb3/cloud-dedicated/reference/internals/data-retention.md b/content/influxdb3/cloud-dedicated/reference/internals/data-retention.md index 85a04b494..7a01ee972 100644 --- a/content/influxdb3/cloud-dedicated/reference/internals/data-retention.md +++ b/content/influxdb3/cloud-dedicated/reference/internals/data-retention.md @@ -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? diff --git a/content/influxdb3/cloud-dedicated/reference/internals/storage-engine.md b/content/influxdb3/cloud-dedicated/reference/internals/storage-engine.md index 85904ed32..3ecf79a4b 100644 --- a/content/influxdb3/cloud-dedicated/reference/internals/storage-engine.md +++ b/content/influxdb3/cloud-dedicated/reference/internals/storage-engine.md @@ -191,13 +191,10 @@ runs out of memory. The following scaling strategies can be applied to components of the InfluxDB 3 storage architecture. -{{% note %}} - - - -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 diff --git a/content/influxdb3/cloud-dedicated/write-data/_index.md b/content/influxdb3/cloud-dedicated/write-data/_index.md index 5433fb7b9..0d4b6b22b 100644 --- a/content/influxdb3/cloud-dedicated/write-data/_index.md +++ b/content/influxdb3/cloud-dedicated/write-data/_index.md @@ -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 >}} \ No newline at end of file diff --git a/content/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes.md b/content/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes.md index 1f228fd89..71917fe4c 100644 --- a/content/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes.md +++ b/content/influxdb3/cloud-dedicated/write-data/best-practices/optimize-writes.md @@ -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 diff --git a/content/influxdb3/cloud-dedicated/write-data/best-practices/schema-design.md b/content/influxdb3/cloud-dedicated/write-data/best-practices/schema-design.md index af63f7f9e..dbc871615 100644 --- a/content/influxdb3/cloud-dedicated/write-data/best-practices/schema-design.md +++ b/content/influxdb3/cloud-dedicated/write-data/best-practices/schema-design.md @@ -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 %}}. @@ -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. --- diff --git a/content/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/_index.md b/content/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/_index.md index 271f7a7d1..8d68f0b14 100644 --- a/content/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/_index.md +++ b/content/influxdb3/cloud-dedicated/write-data/use-telegraf/configure/_index.md @@ -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 >}}._ @@ -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 diff --git a/content/influxdb3/cloud-serverless/admin/billing/limits.md b/content/influxdb3/cloud-serverless/admin/billing/limits.md index c0f0039f6..cc14d2fb5 100644 --- a/content/influxdb3/cloud-serverless/admin/billing/limits.md +++ b/content/influxdb3/cloud-serverless/admin/billing/limits.md @@ -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 + > [!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 diff --git a/content/influxdb3/cloud-serverless/admin/buckets/_index.md b/content/influxdb3/cloud-serverless/admin/buckets/_index.md index 7701c6f7e..3b276a5a7 100644 --- a/content/influxdb3/cloud-serverless/admin/buckets/_index.md +++ b/content/influxdb3/cloud-serverless/admin/buckets/_index.md @@ -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 diff --git a/content/influxdb3/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas.md b/content/influxdb3/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas.md index 99f319322..dd5d8f761 100644 --- a/content/influxdb3/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas.md +++ b/content/influxdb3/cloud-serverless/admin/buckets/manage-explicit-bucket-schemas.md @@ -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. diff --git a/content/influxdb3/cloud-serverless/admin/buckets/update-bucket.md b/content/influxdb3/cloud-serverless/admin/buckets/update-bucket.md index d8fa031f9..bdd8eef51 100644 --- a/content/influxdb3/cloud-serverless/admin/buckets/update-bucket.md +++ b/content/influxdb3/cloud-serverless/admin/buckets/update-bucket.md @@ -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 diff --git a/content/influxdb3/cloud-serverless/admin/organizations/update-org.md b/content/influxdb3/cloud-serverless/admin/organizations/update-org.md index 7675955e8..fe3b1cc07 100644 --- a/content/influxdb3/cloud-serverless/admin/organizations/update-org.md +++ b/content/influxdb3/cloud-serverless/admin/organizations/update-org.md @@ -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 diff --git a/content/influxdb3/cloud-serverless/admin/organizations/users.md b/content/influxdb3/cloud-serverless/admin/organizations/users.md index f6c0d7fc5..0880485d5 100644 --- a/content/influxdb3/cloud-serverless/admin/organizations/users.md +++ b/content/influxdb3/cloud-serverless/admin/organizations/users.md @@ -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. diff --git a/content/influxdb3/cloud-serverless/admin/tokens/create-token.md b/content/influxdb3/cloud-serverless/admin/tokens/create-token.md index 32d889d76..47063dec7 100644 --- a/content/influxdb3/cloud-serverless/admin/tokens/create-token.md +++ b/content/influxdb3/cloud-serverless/admin/tokens/create-token.md @@ -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 %}} diff --git a/content/influxdb3/cloud-serverless/admin/tokens/view-tokens.md b/content/influxdb3/cloud-serverless/admin/tokens/view-tokens.md index 8220ff162..65134f5ea 100644 --- a/content/influxdb3/cloud-serverless/admin/tokens/view-tokens.md +++ b/content/influxdb3/cloud-serverless/admin/tokens/view-tokens.md @@ -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 %}} diff --git a/content/influxdb3/cloud-serverless/get-started/_index.md b/content/influxdb3/cloud-serverless/get-started/_index.md index 19789f2de..c0b6cb525 100644 --- a/content/influxdb3/cloud-serverless/get-started/_index.md +++ b/content/influxdb3/cloud-serverless/get-started/_index.md @@ -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 diff --git a/content/influxdb3/cloud-serverless/get-started/query.md b/content/influxdb3/cloud-serverless/get-started/query.md index e6df25880..a9207de82 100644 --- a/content/influxdb3/cloud-serverless/get-started/query.md +++ b/content/influxdb3/cloud-serverless/get-started/query.md @@ -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 %}} diff --git a/content/influxdb3/cloud-serverless/get-started/setup.md b/content/influxdb3/cloud-serverless/get-started/setup.md index a099a3418..7939c5bb8 100644 --- a/content/influxdb3/cloud-serverless/get-started/setup.md +++ b/content/influxdb3/cloud-serverless/get-started/setup.md @@ -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**. 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. {{% /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. + {{% /tab-content %}} {{< /tabs-wrapper >}} diff --git a/content/influxdb3/cloud-serverless/get-started/write.md b/content/influxdb3/cloud-serverless/get-started/write.md index 66ba71149..8ac6bcf54 100644 --- a/content/influxdb3/cloud-serverless/get-started/write.md +++ b/content/influxdb3/cloud-serverless/get-started/write.md @@ -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 diff --git a/content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md b/content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md index 0449bab4f..886d052fb 100644 --- a/content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md +++ b/content/influxdb3/cloud-serverless/guides/api-compatibility/v1/_index.md @@ -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 %}} diff --git a/content/influxdb3/cloud-serverless/guides/api-compatibility/v2/_index.md b/content/influxdb3/cloud-serverless/guides/api-compatibility/v2/_index.md index 4fd2bbd9a..1f05f4416 100644 --- a/content/influxdb3/cloud-serverless/guides/api-compatibility/v2/_index.md +++ b/content/influxdb3/cloud-serverless/guides/api-compatibility/v2/_index.md @@ -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. diff --git a/content/influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless.md b/content/influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless.md index e7bdb4649..5d5d51110 100644 --- a/content/influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless.md +++ b/content/influxdb3/cloud-serverless/guides/migrate-data/migrate-1x-to-serverless.md @@ -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 diff --git a/content/influxdb3/cloud-serverless/guides/migrate-data/migrate-tsm-to-serverless.md b/content/influxdb3/cloud-serverless/guides/migrate-data/migrate-tsm-to-serverless.md index 1eb518656..d0d2ed471 100644 --- a/content/influxdb3/cloud-serverless/guides/migrate-data/migrate-tsm-to-serverless.md +++ b/content/influxdb3/cloud-serverless/guides/migrate-data/migrate-tsm-to-serverless.md @@ -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). diff --git a/content/influxdb3/cloud-serverless/process-data/downsample/client-libraries.md b/content/influxdb3/cloud-serverless/process-data/downsample/client-libraries.md index 876966d6e..5d9add96f 100644 --- a/content/influxdb3/cloud-serverless/process-data/downsample/client-libraries.md +++ b/content/influxdb3/cloud-serverless/process-data/downsample/client-libraries.md @@ -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 # ... diff --git a/content/influxdb3/cloud-serverless/process-data/downsample/quix.md b/content/influxdb3/cloud-serverless/process-data/downsample/quix.md index 41d39e7ba..69264a410 100644 --- a/content/influxdb3/cloud-serverless/process-data/downsample/quix.md +++ b/content/influxdb3/cloud-serverless/process-data/downsample/quix.md @@ -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). diff --git a/content/influxdb3/cloud-serverless/process-data/send-alerts.md b/content/influxdb3/cloud-serverless/process-data/send-alerts.md index f10966a45..de21fa305 100644 --- a/content/influxdb3/cloud-serverless/process-data/send-alerts.md +++ b/content/influxdb3/cloud-serverless/process-data/send-alerts.md @@ -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: diff --git a/content/influxdb3/cloud-serverless/process-data/summarize.md b/content/influxdb3/cloud-serverless/process-data/summarize.md index 0e035a627..46222c38a 100644 --- a/content/influxdb3/cloud-serverless/process-data/summarize.md +++ b/content/influxdb3/cloud-serverless/process-data/summarize.md @@ -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 diff --git a/content/influxdb3/cloud-serverless/process-data/visualize/chronograf.md b/content/influxdb3/cloud-serverless/process-data/visualize/chronograf.md index 99c12cf14..6c526fac2 100644 --- a/content/influxdb3/cloud-serverless/process-data/visualize/chronograf.md +++ b/content/influxdb3/cloud-serverless/process-data/visualize/chronograf.md @@ -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 diff --git a/content/influxdb3/cloud-serverless/process-data/visualize/grafana.md b/content/influxdb3/cloud-serverless/process-data/visualize/grafana.md index 4e33d31b8..959570f23 100644 --- a/content/influxdb3/cloud-serverless/process-data/visualize/grafana.md +++ b/content/influxdb3/cloud-serverless/process-data/visualize/grafana.md @@ -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 %}} -{{% 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. diff --git a/content/influxdb3/cloud-serverless/process-data/visualize/superset.md b/content/influxdb3/cloud-serverless/process-data/visualize/superset.md index 9eb365d07..87760d823 100644 --- a/content/influxdb3/cloud-serverless/process-data/visualize/superset.md +++ b/content/influxdb3/cloud-serverless/process-data/visualize/superset.md @@ -50,11 +50,10 @@ stored in an InfluxDB Cloud Serverless bucket. 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: @@ -117,10 +116,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: diff --git a/content/influxdb3/cloud-serverless/process-data/visualize/tableau.md b/content/influxdb3/cloud-serverless/process-data/visualize/tableau.md index 3ff76c2b4..11876b5bc 100644 --- a/content/influxdb3/cloud-serverless/process-data/visualize/tableau.md +++ b/content/influxdb3/cloud-serverless/process-data/visualize/tableau.md @@ -25,13 +25,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 @@ -75,9 +74,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 bucket name to query _See an [example connection URL](#example-connection-url)._ diff --git a/content/influxdb3/cloud-serverless/query-data/_index.md b/content/influxdb3/cloud-serverless/query-data/_index.md index 03ceab146..358352b8d 100644 --- a/content/influxdb3/cloud-serverless/query-data/_index.md +++ b/content/influxdb3/cloud-serverless/query-data/_index.md @@ -14,13 +14,11 @@ aliases: 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-serverless/tags/flight-client/) and SQL or InfluxQL. -- [Use the HTTP API `/query` endpoint and InfluxQL](/influxdb3/cloud-serverless/query-data/execute-queries/v1-http/) 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-serverless/tags/flight-client/) and SQL or InfluxQL. +> - [Use the HTTP API `/query` endpoint and InfluxQL](/influxdb3/cloud-serverless/query-data/execute-queries/v1-http/) when you bring existing v1 query workloads to {{% product-name %}}. {{< children >}} diff --git a/content/influxdb3/cloud-serverless/query-data/execute-queries/_index.md b/content/influxdb3/cloud-serverless/query-data/execute-queries/_index.md index 5a6b7e700..745ab309d 100644 --- a/content/influxdb3/cloud-serverless/query-data/execute-queries/_index.md +++ b/content/influxdb3/cloud-serverless/query-data/execute-queries/_index.md @@ -25,12 +25,11 @@ InfluxDB 3 supports the following APIs and languages for querying data: - HTTP `/query` endpoint for InfluxDB v1 compatibility when you bring workloads and code from v1.x to v3. Use the `/query` endpoint with InfluxQL and tools such as Telegraf, HTTP clients, and InfluxDB v1 client libraries to query and retrieve data in JSON or CSV format. -{{% warn %}} -#### /api/v2/query endpoint can't query InfluxDB 3 - -{{% product-name %}} doesn't support the InfluxDB v2 HTTP `/api/v2/query` endpoint and isn't optimized for the Flux query language. -Use SQL or InfluxQL to query data stored in InfluxDB 3. -{{% /warn %}} +> [!Warning] +> #### /api/v2/query endpoint can't query InfluxDB 3 +> +> {{% product-name %}} doesn't support the InfluxDB v2 HTTP `/api/v2/query` endpoint and isn't optimized for the Flux query language. +> Use SQL or InfluxQL to query data stored in InfluxDB 3. Learn how to connect to InfluxDB and query your data using the following tools: diff --git a/content/influxdb3/cloud-serverless/query-data/execute-queries/data-explorer.md b/content/influxdb3/cloud-serverless/query-data/execute-queries/data-explorer.md index 7dd9cac2a..a06ac9c7a 100644 --- a/content/influxdb3/cloud-serverless/query-data/execute-queries/data-explorer.md +++ b/content/influxdb3/cloud-serverless/query-data/execute-queries/data-explorer.md @@ -55,16 +55,15 @@ Choose between **visualization types** for your query. See [Query data](/influxdb3/cloud-serverless/query-data/sql/) to learn more about building SQL queries. -{{% note %}} +> [!Note] +> +> #### Save your work +> +> **Data Explorer** keeps your last change--for example, if you navigate to **Buckets** +> or signout and then come back, you'll see your SQL query and selections in **Data Explorer**. +> +> To store a query that you can retrieve and reuse, {{% caps %}}**Save**{{% /caps %}} your query as a *script*. -#### Save your work - -**Data Explorer** keeps your last change--for example, if you navigate to **Buckets** -or signout and then come back, you'll see your SQL query and selections in **Data Explorer**. - -To store a query that you can retrieve and reuse, {{% caps %}}**Save**{{% /caps %}} your query as a *script*. - -{{% /note %}} ## View SQL query results After you **Run** your query, Data Explorer displays the results. diff --git a/content/influxdb3/cloud-serverless/query-data/execute-queries/v1-http.md b/content/influxdb3/cloud-serverless/query-data/execute-queries/v1-http.md index 1886f3106..a57599842 100644 --- a/content/influxdb3/cloud-serverless/query-data/execute-queries/v1-http.md +++ b/content/influxdb3/cloud-serverless/query-data/execute-queries/v1-http.md @@ -32,13 +32,12 @@ The `/query` endpoint provides compatibility for InfluxDB 1.x workloads that you _Before you can use the v1 query API, [databases and retention policies must be mapped to buckets](/influxdb3/cloud-serverless/guides/api-compatibility/v1/#map-v1-databases-and-retention-policies-to-buckets)._ -{{% note %}} -#### Flight queries don't use DBRP mappings - -When using Flight RPC or Flight SQL to query InfluxDB, specify the **bucket name**. -Flight queries don't use DBRP mappings. -See how to [get started querying with Flight and SQL or InfluxQL](/influxdb3/cloud-serverless/get-started/query/). -{{% /note %}} +> [!Note] +> #### Flight queries don't use DBRP mappings +> +> When using Flight RPC or Flight SQL to query InfluxDB, specify the **bucket name**. +> Flight queries don't use DBRP mappings. +> See how to [get started querying with Flight and SQL or InfluxQL](/influxdb3/cloud-serverless/get-started/query/). - [Query the v1 /query endpoint](#query-the-v1-query-endpoint) - [Parameters](#parameters) @@ -71,9 +70,8 @@ Parameter | Allowed in | Ignored | Value `q` | Query string | Honored | [InfluxQL](/influxdb3/cloud-serverless/query-data/influxql/) [`Authorization` header or `u` and `p`](#authorization) | | | [Token](#authorization) -{{% 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 diff --git a/content/influxdb3/cloud-serverless/query-data/execute-queries/visualization-tools.md b/content/influxdb3/cloud-serverless/query-data/execute-queries/visualization-tools.md index bd5bf3e29..765c28176 100644 --- a/content/influxdb3/cloud-serverless/query-data/execute-queries/visualization-tools.md +++ b/content/influxdb3/cloud-serverless/query-data/execute-queries/visualization-tools.md @@ -37,11 +37,10 @@ The following visualization tools support querying InfluxDB with InfluxQL: - [Grafana](/influxdb3/cloud-serverless/process-data/visualize/grafana/?t=InfluxQL) - [Chronograf](/influxdb3/cloud-serverless/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-serverless/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-serverless/reference/influxql/feature-support/). diff --git a/content/influxdb3/cloud-serverless/query-data/influxql/aggregate-select.md b/content/influxdb3/cloud-serverless/query-data/influxql/aggregate-select.md index dbcb5ea24..113ecfc94 100644 --- a/content/influxdb3/cloud-serverless/query-data/influxql/aggregate-select.md +++ b/content/influxdb3/cloud-serverless/query-data/influxql/aggregate-select.md @@ -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-serverless/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-home-sensor-data-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 home sensor data](/influxdb3/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +> To run the example queries and return results, +> [write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-home-sensor-data-to-influxdb) +> to your {{% product-name %}} bucket before running the example queries. ### Perform an ungrouped aggregation diff --git a/content/influxdb3/cloud-serverless/query-data/influxql/basic-query.md b/content/influxdb3/cloud-serverless/query-data/influxql/basic-query.md index 3b9e70bee..46b8d1238 100644 --- a/content/influxdb3/cloud-serverless/query-data/influxql/basic-query.md +++ b/content/influxdb3/cloud-serverless/query-data/influxql/basic-query.md @@ -74,15 +74,14 @@ If a query uses `GROUP BY` and the `WHERE` clause doesn't filter by time, then g - [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-serverless/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/cloud-serverless/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-serverless/reference/sample-data/#get-started-home-sensor-data). +> To run the example queries and return results, +> [write the sample data](/influxdb3/cloud-serverless/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 @@ -158,10 +157,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 @@ -209,7 +207,6 @@ After the tag, field, or expression you want to alias, pass `AS` followed by the SELECT temp AS temperature, hum AS "humidity (%)" FROM home ``` -{{% note %}} -When aliasing columns in **InfluxQL**, use the `AS` clause and an [identifier](/influxdb3/cloud-serverless/reference/influxql/#identifiers). -When [aliasing columns in **SQL**](/influxdb3/cloud-serverless/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-serverless/reference/influxql/#identifiers). +> When [aliasing columns in **SQL**](/influxdb3/cloud-serverless/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. diff --git a/content/influxdb3/cloud-serverless/query-data/influxql/explore-schema.md b/content/influxdb3/cloud-serverless/query-data/influxql/explore-schema.md index 6de9a5b94..fb0d2099c 100644 --- a/content/influxdb3/cloud-serverless/query-data/influxql/explore-schema.md +++ b/content/influxdb3/cloud-serverless/query-data/influxql/explore-schema.md @@ -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-serverless/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 %}} -bucket. -{{% /note %}} +> [!Note] +> +> #### Sample data +> +> The following examples use data provided in [sample data sets](/influxdb3/cloud-serverless/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 %}} +> bucket. - [List measurements in a bucket](#list-measurements-in-a-bucket) - [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" %}} diff --git a/content/influxdb3/cloud-serverless/query-data/influxql/parameterized-queries.md b/content/influxdb3/cloud-serverless/query-data/influxql/parameterized-queries.md index bc72db2e7..e5e791620 100644 --- a/content/influxdb3/cloud-serverless/query-data/influxql/parameterized-queries.md +++ b/content/influxdb3/cloud-serverless/query-data/influxql/parameterized-queries.md @@ -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-serverless/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) -to your {{% product-name %}} bucket before running the example queries. -{{% /note %}} +> [!Note] +> #### Sample data +> +> The following examples use the +> [Get started home sensor data](/influxdb3/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +> To run the example queries and return results, +> [write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +> to your {{% product-name %}} bucket 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-serverless/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) -to your {{% product-name %}} bucket before running the example queries. -{{% /note %}} +> [!Note] +> #### Sample data +> +> The following examples use the +> [Get started home sensor data](/influxdb3/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +> To run the example queries and return results, +> [write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +> to your {{% product-name %}} bucket before running the example queries. ### Use InfluxDB Flight RPC clients diff --git a/content/influxdb3/cloud-serverless/query-data/influxql/troubleshoot.md b/content/influxdb3/cloud-serverless/query-data/influxql/troubleshoot.md index f3d8a40d0..f4914855b 100644 --- a/content/influxdb3/cloud-serverless/query-data/influxql/troubleshoot.md +++ b/content/influxdb3/cloud-serverless/query-data/influxql/troubleshoot.md @@ -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-serverless/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-serverless/reference/influxql/#keywords) +> as identifiers. ```sql SELECT duration FROM runs diff --git a/content/influxdb3/cloud-serverless/query-data/sql/aggregate-select.md b/content/influxdb3/cloud-serverless/query-data/sql/aggregate-select.md index 1ab2e08a4..f673381d6 100644 --- a/content/influxdb3/cloud-serverless/query-data/sql/aggregate-select.md +++ b/content/influxdb3/cloud-serverless/query-data/sql/aggregate-select.md @@ -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-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 InfluxDB Cloud Serverless 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 InfluxDB Cloud Serverless bucket before running the example queries. ### Perform an ungrouped aggregation @@ -279,25 +277,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 diff --git a/content/influxdb3/cloud-serverless/query-data/sql/basic-query.md b/content/influxdb3/cloud-serverless/query-data/sql/basic-query.md index 94643060c..255963a80 100644 --- a/content/influxdb3/cloud-serverless/query-data/sql/basic-query.md +++ b/content/influxdb3/cloud-serverless/query-data/sql/basic-query.md @@ -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-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 InfluxDB Cloud Serverless 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 InfluxDB Cloud Serverless bucket before running the example queries. ### Query data within time boundaries @@ -140,13 +139,12 @@ To query data using a time zone offset, use the [`AT TIME ZONE` operator](/influxdb3/cloud-serverless/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 @@ -167,10 +165,9 @@ WHERE To query data without time boundaries, don't include any time-based predicates in your `WHERE` clause. -{{% warn %}} -Querying data _without time bounds_ can return a large number of rows. -The query may take a long time to complete and results may be truncated. -{{% /warn %}} +> [!Warning] +> Querying data _without time bounds_ can return a large number of rows. +> The query may take a long time to complete and results may be truncated. ```sql SELECT * FROM home diff --git a/content/influxdb3/cloud-serverless/query-data/sql/cast-types.md b/content/influxdb3/cloud-serverless/query-data/sql/cast-types.md index 46507d981..bba77e82f 100644 --- a/content/influxdb3/cloud-serverless/query-data/sql/cast-types.md +++ b/content/influxdb3/cloud-serverless/query-data/sql/cast-types.md @@ -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 Unixnanosecond 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-serverless/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 Unixnanosecond 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-serverless/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 diff --git a/content/influxdb3/cloud-serverless/query-data/sql/fill-gaps.md b/content/influxdb3/cloud-serverless/query-data/sql/fill-gaps.md index 7d9c9b88b..8ee3b2c58 100644 --- a/content/influxdb3/cloud-serverless/query-data/sql/fill-gaps.md +++ b/content/influxdb3/cloud-serverless/query-data/sql/fill-gaps.md @@ -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-serverless/reference/sql/functions/aggregate/). - {{% /note %}} + > [!Note] + > The expression passed to `interpolate` or `locf` must use an + > [aggregate function](/influxdb3/cloud-serverless/reference/sql/functions/aggregate/). 3. Include a `WHERE` clause that sets upper and lower time bounds. For example: diff --git a/content/influxdb3/cloud-serverless/query-data/sql/parameterized-queries.md b/content/influxdb3/cloud-serverless/query-data/sql/parameterized-queries.md index 0a6bb131c..62b42de0e 100644 --- a/content/influxdb3/cloud-serverless/query-data/sql/parameterized-queries.md +++ b/content/influxdb3/cloud-serverless/query-data/sql/parameterized-queries.md @@ -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-serverless/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) -to your {{% product-name %}} bucket before running the example queries. -{{% /note %}} +> [!Note] +> #### Sample data +> +> The following examples use the +> [Get started home sensor data](/influxdb3/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +> To run the example queries and return results, +> [write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +> to your {{% product-name %}} bucket 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-serverless/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) -to your {{% product-name %}} bucket before running the example queries. -{{% /note %}} +> [!Note] +> #### Sample data +> +> The following examples use the +> [Get started home sensor data](/influxdb3/cloud-serverless/reference/sample-data/#get-started-home-sensor-data). +> To run the example queries and return results, +> [write the sample data](/influxdb3/cloud-serverless/reference/sample-data/#write-the-home-sensor-data-to-influxdb) +> to your {{% product-name %}} bucket before running the example queries. ### Use InfluxDB Flight RPC clients diff --git a/content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md b/content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md index 4cde1781f..1c6c264a5 100644 --- a/content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md +++ b/content/influxdb3/cloud-serverless/query-data/troubleshoot-and-optimize/analyze-query-plan.md @@ -418,9 +418,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 @@ -525,15 +524,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` @@ -587,9 +585,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 @@ -611,9 +608,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). diff --git a/content/influxdb3/cloud-serverless/reference/cli/influx/apply/_index.md b/content/influxdb3/cloud-serverless/reference/cli/influx/apply/_index.md index 6f6a58d9a..2d845024f 100644 --- a/content/influxdb3/cloud-serverless/reference/cli/influx/apply/_index.md +++ b/content/influxdb3/cloud-serverless/reference/cli/influx/apply/_index.md @@ -15,12 +15,11 @@ related: metadata: [influx CLI 2.0.0+] --- -{{% warn %}} -#### Not supported in InfluxDB Cloud Serverless - -While this command is included in the `influx` CLI {{< latest-cli >}}, this -functionality is not available in InfluxDB Cloud Serverless organizations -powered by the InfluxDB 3 storage engine. -{{% /warn %}} +> [!Warning] +> #### Not supported in InfluxDB Cloud Serverless +> +> While this command is included in the `influx` CLI {{< latest-cli >}}, this +> functionality is not available in InfluxDB Cloud Serverless organizations +> powered by the InfluxDB 3 storage engine. {{< duplicate-oss >}} \ No newline at end of file diff --git a/content/influxdb3/cloud-serverless/reference/cli/influx/backup/_index.md b/content/influxdb3/cloud-serverless/reference/cli/influx/backup/_index.md index b6ef206aa..d7f34c0bc 100644 --- a/content/influxdb3/cloud-serverless/reference/cli/influx/backup/_index.md +++ b/content/influxdb3/cloud-serverless/reference/cli/influx/backup/_index.md @@ -14,12 +14,11 @@ metadata: [influx CLI 2.0.0+, InfluxDB OSS only] updated_in: CLI v2.0.2 --- -{{% note %}} -#### Works with InfluxDB OSS 2.x - -The `influx backup` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**. -For information about backing up data in InfluxDB Cloud, see -[InfluxDB Cloud Serverless durability](/influxdb3/cloud-serverless/reference/internals/durability/). -{{% /note %}} +> [!Note] +> #### Works with InfluxDB OSS 2.x +> +> The `influx backup` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**. +> For information about backing up data in InfluxDB Cloud, see +> [InfluxDB Cloud Serverless durability](/influxdb3/cloud-serverless/reference/internals/durability/). {{< duplicate-oss >}} diff --git a/content/influxdb3/cloud-serverless/reference/cli/influx/dashboards/_index.md b/content/influxdb3/cloud-serverless/reference/cli/influx/dashboards/_index.md index 8a777eed8..23fd3f997 100644 --- a/content/influxdb3/cloud-serverless/reference/cli/influx/dashboards/_index.md +++ b/content/influxdb3/cloud-serverless/reference/cli/influx/dashboards/_index.md @@ -14,12 +14,11 @@ related: metadata: [influx CLI 2.0.0+] --- -{{% warn %}} -#### Not supported in InfluxDB Cloud Serverless - -While this command is included in the `influx` CLI {{< latest-cli >}}, this -functionality is not available in InfluxDB Cloud Serverless organizations -powered by the InfluxDB 3 storage engine. -{{% /warn %}} +> [!Warning] +> #### Not supported in InfluxDB Cloud Serverless +> +> While this command is included in the `influx` CLI {{< latest-cli >}}, this +> functionality is not available in InfluxDB Cloud Serverless organizations +> powered by the InfluxDB 3 storage engine. {{< duplicate-oss >}} diff --git a/content/influxdb3/cloud-serverless/reference/cli/influx/delete/_index.md b/content/influxdb3/cloud-serverless/reference/cli/influx/delete/_index.md index d92ea544f..5eeeb1031 100644 --- a/content/influxdb3/cloud-serverless/reference/cli/influx/delete/_index.md +++ b/content/influxdb3/cloud-serverless/reference/cli/influx/delete/_index.md @@ -15,20 +15,18 @@ metadata: [influx CLI 2.0.3+] updated_in: CLI v2.2.0 --- -{{% warn %}} -#### InfluxDB Cloud Serverless does not support data deletion - -InfluxDB Cloud Serverless does not currently support deleting data. -This command is only supported when used with **InfluxDB OSS v2** and -**InfluxDB Cloud (TSM)**. -{{% /warn %}} +> [!Warning] +> #### InfluxDB Cloud Serverless does not support data deletion +> +> InfluxDB Cloud Serverless does not currently support deleting data. +> This command is only supported when used with **InfluxDB OSS v2** and +> **InfluxDB Cloud (TSM)**. {{< duplicate-oss >}} -{{% warn %}} -#### InfluxDB Cloud Serverless does not support data deletion - -InfluxDB Cloud Serverless does not currently support deleting data. -This command is only supported when used with **InfluxDB OSS v2** and -**InfluxDB Cloud (TSM)**. -{{% /warn %}} +> [!Warning] +> #### InfluxDB Cloud Serverless does not support data deletion +> +> InfluxDB Cloud Serverless does not currently support deleting data. +> This command is only supported when used with **InfluxDB OSS v2** and +> **InfluxDB Cloud (TSM)**. diff --git a/content/influxdb3/cloud-serverless/reference/cli/influx/org/create.md b/content/influxdb3/cloud-serverless/reference/cli/influx/org/create.md index 06ac7063e..c41a397da 100644 --- a/content/influxdb3/cloud-serverless/reference/cli/influx/org/create.md +++ b/content/influxdb3/cloud-serverless/reference/cli/influx/org/create.md @@ -9,14 +9,13 @@ weight: 201 metadata: [influx CLI 2.0.0+, InfluxDB OSS only] --- -{{% note %}} -#### Works with InfluxDB OSS 2.x - -The `influx org create` command works with **InfluxDB OSS 2.x**, but does not -work with **InfluxDB Cloud Serverless**. -New organizations are created for each new InfluxDB account. -For information about creating an InfluxDB Cloud Serverless account, see -[sign up for InfluxDB Cloud Serverless](/influxdb3/cloud-serverless/sign-up/). -{{% /note %}} +> [!Note] +> #### Works with InfluxDB OSS 2.x +> +> The `influx org create` command works with **InfluxDB OSS 2.x**, but does not +> work with **InfluxDB Cloud Serverless**. +> New organizations are created for each new InfluxDB account. +> For information about creating an InfluxDB Cloud Serverless account, see +> [sign up for InfluxDB Cloud Serverless](/influxdb3/cloud-serverless/sign-up/). {{< duplicate-oss >}} diff --git a/content/influxdb3/cloud-serverless/reference/cli/influx/org/delete.md b/content/influxdb3/cloud-serverless/reference/cli/influx/org/delete.md index d04bbf211..ca09a4509 100644 --- a/content/influxdb3/cloud-serverless/reference/cli/influx/org/delete.md +++ b/content/influxdb3/cloud-serverless/reference/cli/influx/org/delete.md @@ -9,13 +9,13 @@ weight: 201 metadata: [influx CLI 2.0.0+, InfluxDB OSS only] --- -{{% note %}} -#### Works with InfluxDB OSS 2.x -The `influx org delete` command works with **InfluxDB OSS 2.x**, but does not -work with **InfluxDB Cloud Serverless**. -An organization is associated with your InfluxDB account. -For information about removing your InfluxDB Cloud Serverless account and its organization, -see [Cancel your InfluxDB Cloud Serverless subscription](/influxdb3/cloud-serverless/admin/accounts/cancel-account/). -{{% /note %}} +> [!Note] +> #### Works with InfluxDB OSS 2.x +> +> The `influx org delete` command works with **InfluxDB OSS 2.x**, but does not +> work with **InfluxDB Cloud Serverless**. +> An organization is associated with your InfluxDB account. +> For information about removing your InfluxDB Cloud Serverless account and its organization, +> see [Cancel your InfluxDB Cloud Serverless subscription](/influxdb3/cloud-serverless/admin/accounts/cancel-account/). {{< duplicate-oss >}} diff --git a/content/influxdb3/cloud-serverless/reference/cli/influx/org/members/_index.md b/content/influxdb3/cloud-serverless/reference/cli/influx/org/members/_index.md index 04a285b47..b408f9b57 100644 --- a/content/influxdb3/cloud-serverless/reference/cli/influx/org/members/_index.md +++ b/content/influxdb3/cloud-serverless/reference/cli/influx/org/members/_index.md @@ -9,12 +9,12 @@ weight: 201 metadata: [influx CLI 2.0.0+, InfluxDB OSS only] --- -{{% note %}} -#### Works with InfluxDB OSS 2.x -The `influx org members` command works with **InfluxDB OSS 2.x**, but does not -work with **InfluxDB Cloud Serverless**. -For information about managing users in your InfluxDB Cloud Serverless organization, -see [Manage users](/influxdb3/cloud-serverless/admin/organizations/users/). -{{% /note %}} +> [!Note] +> #### Works with InfluxDB OSS 2.x +> +> The `influx org members` command works with **InfluxDB OSS 2.x**, but does not +> work with **InfluxDB Cloud Serverless**. +> For information about managing users in your InfluxDB Cloud Serverless organization, +> see [Manage users](/influxdb3/cloud-serverless/admin/organizations/users/). {{< duplicate-oss >}} diff --git a/content/influxdb3/cloud-serverless/reference/cli/influx/org/members/add.md b/content/influxdb3/cloud-serverless/reference/cli/influx/org/members/add.md index af31fd812..6bb9150cb 100644 --- a/content/influxdb3/cloud-serverless/reference/cli/influx/org/members/add.md +++ b/content/influxdb3/cloud-serverless/reference/cli/influx/org/members/add.md @@ -10,12 +10,12 @@ updated_in: CLI v2.4.0 metadata: [influx CLI 2.0.0+, InfluxDB OSS only] --- -{{% note %}} -#### Available with InfluxDB OSS 2.x only -The `influx org members add` command adds members to organizations in **InfluxDB OSS 2.x**, -but cannot add organization members to **InfluxDB Cloud Serverless**. -For information about inviting users into your InfluxDB Cloud Serverless organization, -see [Manage users](/influxdb3/cloud-serverless/admin/organizations/users/). -{{% /note %}} +> [!Note] +> #### Available with InfluxDB OSS 2.x only +> +> The `influx org members add` command adds members to organizations in **InfluxDB OSS 2.x**, +> but cannot add organization members to **InfluxDB Cloud Serverless**. +> For information about inviting users into your InfluxDB Cloud Serverless organization, +> see [Manage users](/influxdb3/cloud-serverless/admin/organizations/users/). {{< duplicate-oss >}} diff --git a/content/influxdb3/cloud-serverless/reference/cli/influx/org/members/remove.md b/content/influxdb3/cloud-serverless/reference/cli/influx/org/members/remove.md index 520b1ba9f..eaeed2218 100644 --- a/content/influxdb3/cloud-serverless/reference/cli/influx/org/members/remove.md +++ b/content/influxdb3/cloud-serverless/reference/cli/influx/org/members/remove.md @@ -9,12 +9,12 @@ weight: 301 metadata: [influx CLI 2.0.0+, InfluxDB OSS only] --- -{{% note %}} -#### Available with InfluxDB OSS 2.x only -The `influx org members remove` command removes organization members in **InfluxDB OSS 2.x**, -but cannot remove organization members in **InfluxDB Cloud Serverless**. -For information about removing a user from your InfluxDB Cloud Serverless organization, see -[Remove a user](/influxdb3/cloud-serverless/admin/organizations/users/#remove-a-user-from-your-organization/). -{{% /note %}} +> [!Note] +> #### Available with InfluxDB OSS 2.x only +> +> The `influx org members remove` command removes organization members in **InfluxDB OSS 2.x**, +> but cannot remove organization members in **InfluxDB Cloud Serverless**. +> For information about removing a user from your InfluxDB Cloud Serverless organization, see +> [Remove a user](/influxdb3/cloud-serverless/admin/organizations/users/#remove-a-user-from-your-organization/). {{< duplicate-oss >}} diff --git a/content/influxdb3/cloud-serverless/reference/cli/influx/ping/_index.md b/content/influxdb3/cloud-serverless/reference/cli/influx/ping/_index.md index c4fbadcc9..fb537e77f 100644 --- a/content/influxdb3/cloud-serverless/reference/cli/influx/ping/_index.md +++ b/content/influxdb3/cloud-serverless/reference/cli/influx/ping/_index.md @@ -15,10 +15,9 @@ related: metadata: [influx CLI 2.0.0+, InfluxDB OSS only] --- -{{% note %}} -#### Works with InfluxDB OSS 2.x - -The `influx ping` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**. -{{% /note %}} +> [!Note] +> #### Works with InfluxDB OSS 2.x +> +> The `influx ping` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**. {{< duplicate-oss >}} diff --git a/content/influxdb3/cloud-serverless/reference/cli/influx/restore/index.md b/content/influxdb3/cloud-serverless/reference/cli/influx/restore/index.md index 1e1f5f2c0..ccfd8aabe 100644 --- a/content/influxdb3/cloud-serverless/reference/cli/influx/restore/index.md +++ b/content/influxdb3/cloud-serverless/reference/cli/influx/restore/index.md @@ -13,12 +13,11 @@ metadata: [influx CLI 2.0.0+] updated_in: CLI v2.0.7 --- -{{% note %}} -#### Works with InfluxDB OSS 2.x - -The `influx restore` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**. -For information about restoring data in InfluxDB Cloud, see -[InfluxDB Cloud durability](/influxdb3/cloud-serverless/reference/internals/durability/). -{{% /note %}} +> [!Note] +> #### Works with InfluxDB OSS 2.x +> +> The `influx restore` command works with **InfluxDB OSS 2.x**, but does not work with **InfluxDB Cloud**. +> For information about restoring data in InfluxDB Cloud, see +> [InfluxDB Cloud durability](/influxdb3/cloud-serverless/reference/internals/durability/). {{< duplicate-oss >}} \ No newline at end of file diff --git a/content/influxdb3/cloud-serverless/reference/cli/influx/setup/_index.md b/content/influxdb3/cloud-serverless/reference/cli/influx/setup/_index.md index cf82f39c5..00db2c5d4 100644 --- a/content/influxdb3/cloud-serverless/reference/cli/influx/setup/_index.md +++ b/content/influxdb3/cloud-serverless/reference/cli/influx/setup/_index.md @@ -17,11 +17,10 @@ updated_in: CLI v2.0.3 canonical: /influxdb/v2/reference/cli/influx/setup/ --- -{{% note %}} -#### Works with InfluxDB OSS 2.x - -The `influx setup` command initiates the setup process for **InfluxDB OSS 2.x** instances. -The command does not work with **InfluxDB Cloud**. -{{% /note %}} +> [!Note] +> #### Works with InfluxDB OSS 2.x +> +> The `influx setup` command initiates the setup process for **InfluxDB OSS 2.x** instances. +> The command does not work with **InfluxDB Cloud**. {{< duplicate-oss >}} diff --git a/content/influxdb3/cloud-serverless/reference/client-libraries/flight/_index.md b/content/influxdb3/cloud-serverless/reference/client-libraries/flight/_index.md index 056845e56..835631c2c 100644 --- a/content/influxdb3/cloud-serverless/reference/client-libraries/flight/_index.md +++ b/content/influxdb3/cloud-serverless/reference/client-libraries/flight/_index.md @@ -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-serverless/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-serverless/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-serverless/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-serverless/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-serverless/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-serverless/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 %}} bucket. Using InfluxDB 3's IOx-specific Flight RPC protocol, clients send a single `DoGet()` request to authenticate, query, and retrieve data. diff --git a/content/influxdb3/cloud-serverless/reference/client-libraries/flight/csharp-flight.md b/content/influxdb3/cloud-serverless/reference/client-libraries/flight/csharp-flight.md index 5203b44e1..5f10b8924 100644 --- a/content/influxdb3/cloud-serverless/reference/client-libraries/flight/csharp-flight.md +++ b/content/influxdb3/cloud-serverless/reference/client-libraries/flight/csharp-flight.md @@ -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-serverless/reference/client-libraries/v3/csharp/) for integrating InfluxDB 3 with your C# application code. - -[InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-serverless/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-serverless/reference/client-libraries/v3/csharp/) for integrating InfluxDB 3 with your C# application code. +> +> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +> and provide convenient methods for [writing](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-serverless/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +> Client libraries can query using SQL or InfluxQL. diff --git a/content/influxdb3/cloud-serverless/reference/client-libraries/flight/go-flight.md b/content/influxdb3/cloud-serverless/reference/client-libraries/flight/go-flight.md index 89a4813d4..b190462aa 100644 --- a/content/influxdb3/cloud-serverless/reference/client-libraries/flight/go-flight.md +++ b/content/influxdb3/cloud-serverless/reference/client-libraries/flight/go-flight.md @@ -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-serverless/reference/client-libraries/v3/go/) for integrating InfluxDB 3 with your Go application code. - -[InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-serverless/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-serverless/reference/client-libraries/v3/go/) for integrating InfluxDB 3 with your Go application code. +> +> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +> and provide convenient methods for [writing](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-serverless/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 diff --git a/content/influxdb3/cloud-serverless/reference/client-libraries/flight/java-flightsql.md b/content/influxdb3/cloud-serverless/reference/client-libraries/flight/java-flightsql.md index 7b029159b..545d8c366 100644 --- a/content/influxdb3/cloud-serverless/reference/client-libraries/flight/java-flightsql.md +++ b/content/influxdb3/cloud-serverless/reference/client-libraries/flight/java-flightsql.md @@ -40,15 +40,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-serverless/reference/client-libraries/v3/java/) for integrating InfluxDB 3 with your Java application code. - -[InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-serverless/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-serverless/reference/client-libraries/v3/java/) for integrating InfluxDB 3 with your Java application code. +> +> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +> and provide convenient methods for [writing](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-serverless/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +> Client libraries can query using SQL or InfluxQL. diff --git a/content/influxdb3/cloud-serverless/reference/client-libraries/flight/python-flight.md b/content/influxdb3/cloud-serverless/reference/client-libraries/flight/python-flight.md index cafe2f59d..2b33c778d 100644 --- a/content/influxdb3/cloud-serverless/reference/client-libraries/flight/python-flight.md +++ b/content/influxdb3/cloud-serverless/reference/client-libraries/flight/python-flight.md @@ -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-serverless/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code. - -[InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-serverless/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-serverless/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code. +> +> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +> and provide convenient methods for [writing](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-serverless/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 %}} bucket: diff --git a/content/influxdb3/cloud-serverless/reference/client-libraries/flight/python-flightsql-dbapi.md b/content/influxdb3/cloud-serverless/reference/client-libraries/flight/python-flightsql-dbapi.md index a2efbbe50..caf5678de 100644 --- a/content/influxdb3/cloud-serverless/reference/client-libraries/flight/python-flightsql-dbapi.md +++ b/content/influxdb3/cloud-serverless/reference/client-libraries/flight/python-flightsql-dbapi.md @@ -12,15 +12,14 @@ weight: 201 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 %}} bucket. 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-serverless/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code. - -[InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-serverless/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-serverless/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code. +> +> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +> and provide convenient methods for [writing](/influxdb3/cloud-serverless/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/cloud-serverless/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +> Client libraries can query using SQL or InfluxQL. ## Installation diff --git a/content/influxdb3/cloud-serverless/reference/client-libraries/v1/_index.md b/content/influxdb3/cloud-serverless/reference/client-libraries/v1/_index.md index 77102d6e4..bfbd02af3 100644 --- a/content/influxdb3/cloud-serverless/reference/client-libraries/v1/_index.md +++ b/content/influxdb3/cloud-serverless/reference/client-libraries/v1/_index.md @@ -14,9 +14,8 @@ influxdb3/cloud-serverless/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-serverless/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-serverless/reference/client-libraries/v3/). Functionality varies among client libraries. InfluxDB client libraries are maintained by the InfluxDB community. diff --git a/content/influxdb3/cloud-serverless/reference/client-libraries/v2/javascript/browser.md b/content/influxdb3/cloud-serverless/reference/client-libraries/v2/javascript/browser.md index 1f72431ce..911e25369 100644 --- a/content/influxdb3/cloud-serverless/reference/client-libraries/v2/javascript/browser.md +++ b/content/influxdb3/cloud-serverless/reference/client-libraries/v2/javascript/browser.md @@ -39,10 +39,10 @@ This library supports both front-end and server-side environments and provides t This guide presumes some familiarity with JavaScript, browser environments, and InfluxDB. 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) diff --git a/content/influxdb3/cloud-serverless/reference/client-libraries/v3/python.md b/content/influxdb3/cloud-serverless/reference/client-libraries/v3/python.md index c7cb28063..e0634c3a0 100644 --- a/content/influxdb3/cloud-serverless/reference/client-libraries/v3/python.md +++ b/content/influxdb3/cloud-serverless/reference/client-libraries/v3/python.md @@ -62,9 +62,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-serverless/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-serverless/reference/sample-data/#get-started-home-sensor-data). - [Installation](#installation) - [Importing the module](#importing-the-module) diff --git a/content/influxdb3/cloud-serverless/reference/internals/data-retention.md b/content/influxdb3/cloud-serverless/reference/internals/data-retention.md index fd5b7b4fb..a389dfc1f 100644 --- a/content/influxdb3/cloud-serverless/reference/internals/data-retention.md +++ b/content/influxdb3/cloud-serverless/reference/internals/data-retention.md @@ -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 bucket retention periods - -Use the [`influx bucket list` command](/influxdb3/cloud-serverless/reference/cli/influx/bucket/list/) -to view your buckets' retention periods. -{{% /note %}} +> [!Note] +> #### View bucket retention periods +> +> Use the [`influx bucket list` command](/influxdb3/cloud-serverless/reference/cli/influx/bucket/list/) +> to view your buckets' retention periods. ## When does data actually get deleted? diff --git a/content/influxdb3/cloud-serverless/reference/regions.md b/content/influxdb3/cloud-serverless/reference/regions.md index a449dce63..eaeb89b2e 100644 --- a/content/influxdb3/cloud-serverless/reference/regions.md +++ b/content/influxdb3/cloud-serverless/reference/regions.md @@ -20,30 +20,29 @@ Use the URLs below to interact with your InfluxDB Cloud Serverless instances wit [`influx` CLI](/influxdb3/cloud-serverless/reference/cli/influx/), or [Telegraf](/influxdb3/cloud-serverless/write-data/use-telegraf/). -{{% note %}} -#### InfluxDB 3 cloud regions - -We are in the process of deploying and enabling the InfluxDB 3 storage engine -on other cloud providers and regions. -{{% /note %}} +> [!Note] +> #### InfluxDB 3 cloud regions +> +> We are in the process of deploying and enabling the InfluxDB 3 storage engine +> on other cloud providers and regions. Request a cloud region +--> {{< cloud_regions type="iox-table" >}} diff --git a/content/influxdb3/cloud-serverless/reference/syntax/delete-predicate.md b/content/influxdb3/cloud-serverless/reference/syntax/delete-predicate.md index 9e7f5f882..67eb5b02d 100644 --- a/content/influxdb3/cloud-serverless/reference/syntax/delete-predicate.md +++ b/content/influxdb3/cloud-serverless/reference/syntax/delete-predicate.md @@ -13,10 +13,10 @@ related: - /influxdb3/cloud-serverless/write-data/delete-data/ - /influxdb3/cloud-serverless/reference/cli/influx/delete/ --- -{{% warn %}} -#### InfluxDB Cloud Serverless does not support data deletion -InfluxDB Cloud Serverless does not currently support deleting data. -This command is only supported when used with **InfluxDB OSS v2** and -**InfluxDB Cloud (TSM)**. -{{% /warn %}} +> [!Warning] +> #### InfluxDB Cloud Serverless does not support data deletion +> +> InfluxDB Cloud Serverless does not currently support deleting data. +> This command is only supported when used with **InfluxDB OSS v2** and +> **InfluxDB Cloud (TSM)**. diff --git a/content/influxdb3/cloud-serverless/sign-up.md b/content/influxdb3/cloud-serverless/sign-up.md index 0c3f53d62..229563967 100644 --- a/content/influxdb3/cloud-serverless/sign-up.md +++ b/content/influxdb3/cloud-serverless/sign-up.md @@ -27,9 +27,8 @@ Use it as much and as long as you like within the plan's rate-limits. [Limits](/influxdb3/cloud-serverless/admin/account/limits/) are designed to let you monitor 5-10 sensors, stacks or servers comfortably. -{{% note %}} -Users on the Free Plan are limited to one organization. -{{% /note %}} +> [!Note] +> Users on the Free Plan are limited to one organization. ## Sign up @@ -165,9 +164,8 @@ prefix the executable with `./` to run in place. If the binary is on your $PATH, sudo cp influxdb2-client-{{< latest-patch cli=true >}}-darwin-amd64/influx /usr/local/bin/ ``` -{{% note %}} -If you rename the binary, all references to `influx` in this documentation refer to the renamed binary. -{{% /note %}} +> [!Note] +> If you rename the binary, all references to `influx` in this documentation refer to the renamed binary. #### Step 4: (macOS Catalina and newer) Authorize InfluxDB binaries @@ -230,9 +228,8 @@ prefix the executable with `./` to run in place. If the binary is on your $PATH, sudo cp influxdb2-client-{{< latest-cli >}}-linux-amd64/influx /usr/local/bin/ ``` -{{% note %}} -If you rename the binary, all references to `influx` in this documentation refer to the renamed binary. -{{% /note %}} +> [!Note] +> If you rename the binary, all references to `influx` in this documentation refer to the renamed binary. #### Step 4: Set up a configuration profile diff --git a/content/influxdb3/cloud-serverless/write-data/_index.md b/content/influxdb3/cloud-serverless/write-data/_index.md index 99833c913..d2edc5114 100644 --- a/content/influxdb3/cloud-serverless/write-data/_index.md +++ b/content/influxdb3/cloud-serverless/write-data/_index.md @@ -16,13 +16,11 @@ related: 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-serverless/guides/api-compatibility/v1/). -When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb3/cloud-serverless/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-serverless/guides/api-compatibility/v1/). +> When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb3/cloud-serverless/guides/api-compatibility/v2/). {{< children >}} diff --git a/content/influxdb3/cloud-serverless/write-data/api/v1-http.md b/content/influxdb3/cloud-serverless/write-data/api/v1-http.md index 885141ae8..0f0088dd9 100644 --- a/content/influxdb3/cloud-serverless/write-data/api/v1-http.md +++ b/content/influxdb3/cloud-serverless/write-data/api/v1-http.md @@ -123,9 +123,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-serverless/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-serverless/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: @@ -169,9 +168,8 @@ For more plugin options, see [`influxdb`](https://github.com/influxdata/telegraf To test InfluxDB v1 API writes interactively from the command line, use common HTTP clients such as cURL and Postman. -{{% note %}} -For production use cases, use tools such as [client libraries](#client-libraries) that construct line protocol for you and provide batch writing options. -{{% /note %}} +> [!Note] +> For production use cases, use tools such as [client libraries](#client-libraries) that construct line protocol for you and provide batch writing options. {{< code-tabs-wrapper >}} {{% code-tabs %}} diff --git a/content/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes.md b/content/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes.md index fa0f74cca..bb4c9fe92 100644 --- a/content/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes.md +++ b/content/influxdb3/cloud-serverless/write-data/best-practices/optimize-writes.md @@ -33,22 +33,20 @@ Use these tips to optimize performance and system overhead when writing data to - [Avoid sending duplicate data](#avoid-sending-duplicate-data) - [Run custom processing code](#run-custom-preprocessing-code) -{{% note %}} -The following tools write to InfluxDB and employ _most_ write optimizations by default: - -- [`influx` CLI](/influxdb3/cloud-serverless/reference/cli/influx/write/) -- [Telegraf](/influxdb3/cloud-serverless/write-data/use-telegraf/) -- [InfluxDB client libraries](/influxdb3/cloud-serverless/reference/client-libraries/) -{{% /note %}} +> [!Note] +> The following tools write to InfluxDB and employ _most_ write optimizations by default: +> +> - [`influx` CLI](/influxdb3/cloud-serverless/reference/cli/influx/write/) +> - [Telegraf](/influxdb3/cloud-serverless/write-data/use-telegraf/) +> - [InfluxDB client libraries](/influxdb3/cloud-serverless/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 diff --git a/content/influxdb3/cloud-serverless/write-data/best-practices/schema-design.md b/content/influxdb3/cloud-serverless/write-data/best-practices/schema-design.md index 4c8e1df87..eb4bfbea9 100644 --- a/content/influxdb3/cloud-serverless/write-data/best-practices/schema-design.md +++ b/content/influxdb3/cloud-serverless/write-data/best-practices/schema-design.md @@ -84,11 +84,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 bucket. -{{% /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 bucket. --- diff --git a/content/influxdb3/cloud-serverless/write-data/csv/influx-cli.md b/content/influxdb3/cloud-serverless/write-data/csv/influx-cli.md index e7d1e3d6f..b93569a7e 100644 --- a/content/influxdb3/cloud-serverless/write-data/csv/influx-cli.md +++ b/content/influxdb3/cloud-serverless/write-data/csv/influx-cli.md @@ -53,10 +53,9 @@ mem,host=host1 used_percent=63.40 1577836820000000000 mem,host=host2 used_percent=73.77 1577836820000000000 ``` -{{% note %}} -To test the CSV to line protocol conversion process, use the `influx write dryrun` -command to print the resulting line protocol to stdout rather than write to InfluxDB. -{{% /note %}} +> [!Note] +> To test the CSV to line protocol conversion process, use the `influx write dryrun` +> command to print the resulting line protocol to stdout rather than write to InfluxDB. - [CSV Annotations](#csv-annotations) - [Inject annotation headers](#inject-annotation-headers) @@ -207,10 +206,9 @@ influx write -b example-bucket \ --format csv ``` -{{% note %}} -The `influx write` command assumes all input files are line protocol unless they -include the `.csv` extension or you declare the `csv`. -{{% /note %}} +> [!Note] +> The `influx write` command assumes all input files are line protocol unless they +> include the `.csv` extension or you declare the `csv`. ## Specify CSV character encoding @@ -238,9 +236,8 @@ influx write -b example-bucket \ --skipRowOnError ``` -{{% warn %}} -Skipped rows are ignored and are not written to InfluxDB. -{{% /warn %}} +> [!Warning] +> Skipped rows are ignored and are not written to InfluxDB. Use the `--errors-file` flag to record errors to a file. The error file identifies all rows that cannot be imported and includes error messages for debugging. @@ -407,11 +404,10 @@ If your CSV data contains numeric values that use a non-default fraction separat or contain group separators, [define your numeric format](/influxdb3/cloud-serverless/reference/syntax/annotated-csv/extended/#double) in the `double`, `long`, and `unsignedLong` datatype annotations. -{{% note %}} -If your **numeric format separators** include a comma (`,`), wrap the column annotation in double -quotes (`""`) to prevent the comma from being parsed as a column separator or delimiter. -You can also [define a custom column separator](/influxdb3/cloud-serverless/reference/syntax/annotated-csv/extended/#define-custom-column-separator). -{{% /note %}} +> [!Note] +> If your **numeric format separators** include a comma (`,`), wrap the column annotation in double +> quotes (`""`) to prevent the comma from being parsed as a column separator or delimiter. +> You can also [define a custom column separator](/influxdb3/cloud-serverless/reference/syntax/annotated-csv/extended/#define-custom-column-separator). {{< tabs-wrapper >}} {{% tabs %}} diff --git a/content/influxdb3/cloud-serverless/write-data/use-telegraf/configure/_index.md b/content/influxdb3/cloud-serverless/write-data/use-telegraf/configure/_index.md index feacd07d5..a207a9961 100644 --- a/content/influxdb3/cloud-serverless/write-data/use-telegraf/configure/_index.md +++ b/content/influxdb3/cloud-serverless/write-data/use-telegraf/configure/_index.md @@ -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-serverless/write-data/use-telegraf#requirements) -for using Telegraf with {{< product-name >}}._ -{{% /note %}} +> [!Note] +> _View the [requirements](/influxdb3/cloud-serverless/write-data/use-telegraf#requirements) +> for using Telegraf with {{< product-name >}}._ @@ -110,12 +109,11 @@ For {{% product-name %}}, set this to an empty string (`""`). The name of the {{% product-name %}} bucket 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 >}} bucket. -{{% /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 >}} bucket. ## Start Telegraf diff --git a/content/influxdb3/clustered/admin/bypass-identity-provider.md b/content/influxdb3/clustered/admin/bypass-identity-provider.md index d8fd49bd4..ab719a7cc 100644 --- a/content/influxdb3/clustered/admin/bypass-identity-provider.md +++ b/content/influxdb3/clustered/admin/bypass-identity-provider.md @@ -16,12 +16,11 @@ InfluxDB namespace. You can use the admin token with the [`influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/) in lieu of configuring and using an OAuth2 identity provider. -{{% warn %}} -#### Do not use in production - -This feature is for development and testing purposes only and should not be used -in a production InfluxDB cluster. -{{% /warn %}} +> [!Warning] +> #### Do not use in production +> +> This feature is for development and testing purposes only and should not be used +> in a production InfluxDB cluster. ## Configure influxctl to use the admin token @@ -102,7 +101,6 @@ In the examples above, replace the following: - {{% code-placeholder-key %}}`KEY_GEN_JOB`{{% /code-placeholder-key %}}: The name of the key-gen job pod. -{{% note %}} -To create a new admin token after revoking the existing one, rerun the -`create-admin-token` job. -{{% /note %}} +> [!Note] +> To create a new admin token after revoking the existing one, rerun the +> `create-admin-token` job. diff --git a/content/influxdb3/clustered/admin/databases/_index.md b/content/influxdb3/clustered/admin/databases/_index.md index 32f70b901..f37eeb678 100644 --- a/content/influxdb3/clustered/admin/databases/_index.md +++ b/content/influxdb3/clustered/admin/databases/_index.md @@ -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/clustered/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/clustered/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 diff --git a/content/influxdb3/clustered/admin/databases/create.md b/content/influxdb3/clustered/admin/databases/create.md index 7bdc4c602..bb1b942cd 100644 --- a/content/influxdb3/clustered/admin/databases/create.md +++ b/content/influxdb3/clustered/admin/databases/create.md @@ -42,9 +42,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._ @@ -230,9 +229,8 @@ Use the `--template-tag`, `--template-tag-bucket, and `--template-timeformat` flags to define partition template parts used to generate partition keys for the database. For more information, see [Manage data partitioning](/influxdb3/clustered/admin/custom-partitions/). -{{% 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. diff --git a/content/influxdb3/clustered/admin/databases/delete.md b/content/influxdb3/clustered/admin/databases/delete.md index c88fa1633..72c42b14c 100644 --- a/content/influxdb3/clustered/admin/databases/delete.md +++ b/content/influxdb3/clustered/admin/databases/delete.md @@ -32,17 +32,16 @@ influxctl database delete DATABASE_NAME ``` {{% /code-placeholders %}} -{{% 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. - -#### Never directly modify the Catalog store - -Never directly modify the [PostgreSQL-compatible Catalog store](/influxdb3/clustered/reference/internals/storage-engine/#catalog-store). -Doing so will result in an undefined state for various components and may lead to data loss and crashes. -{{% /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. +> +> #### Never directly modify the Catalog +> +> Never directly modify the [PostgreSQL-compatible Catalog](/influxdb3/clustered/reference/internals/storage-engine/#catalog). +> Doing so will result in an undefined state for various components and may lead to data loss and crashes. diff --git a/content/influxdb3/clustered/admin/databases/update.md b/content/influxdb3/clustered/admin/databases/update.md index dedc749fc..3fafb3ee9 100644 --- a/content/influxdb3/clustered/admin/databases/update.md +++ b/content/influxdb3/clustered/admin/databases/update.md @@ -49,12 +49,11 @@ Replace the following in your command: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/clustered/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 diff --git a/content/influxdb3/clustered/admin/env-vars.md b/content/influxdb3/clustered/admin/env-vars.md index 75defd836..9ce161676 100644 --- a/content/influxdb3/clustered/admin/env-vars.md +++ b/content/influxdb3/clustered/admin/env-vars.md @@ -18,16 +18,15 @@ InfluxDB Clustered components support various environment variables. While many of these variables have default settings, you can customize them by setting your own values. -{{% warn %}} -#### Overriding default settings may affect overall cluster performance - -{{% product-name %}} components have complex interactions that can be affected -when overriding default configuration settings. -Changing these settings may impact overall cluster performance. -Before making configuration changes using environment variables, consider -consulting [InfluxData Support](https://support.influxdata.com/) to identify any -potential unintended consequences. -{{% /warn %}} +> [!Warning] +> #### Overriding default settings may affect overall cluster performance +> +> {{% product-name %}} components have complex interactions that can be affected +> when overriding default configuration settings. +> Changing these settings may impact overall cluster performance. +> Before making configuration changes using environment variables, consider +> consulting [InfluxData Support](https://support.influxdata.com/) to identify any +> potential unintended consequences. ## AppInstance component schema @@ -172,21 +171,20 @@ helm upgrade \ {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -{{% note %}} -#### Update environment variables instead of removing them - -Most configuration settings that can be overridden by environment variables have -default values that are used if the environment variable is unset. Removing -environment variables from your `AppInstance` resource configuration will not -remove those environment variables entirely; instead, they will revert to their -default settings. To revert to the default settings, simply unset the -environment variable or update the value in your `AppInstance` resource to the -default value. - -In the preceding example, the `INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF` environment -variable is set to `6h`. If you remove `INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF` from -the `env` property, the cutoff reverts to its default setting of `30d`. -{{% /note %}} +> [!Note] +> #### Update environment variables instead of removing them +> +> Most configuration settings that can be overridden by environment variables have +> default values that are used if the environment variable is unset. Removing +> environment variables from your `AppInstance` resource configuration will not +> remove those environment variables entirely; instead, they will revert to their +> default settings. To revert to the default settings, simply unset the +> environment variable or update the value in your `AppInstance` resource to the +> default value. +> +> In the preceding example, the `INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF` environment +> variable is set to `6h`. If you remove `INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF` from +> the `env` property, the cutoff reverts to its default setting of `30d`. {{< expand-wrapper >}} {{% expand "View example of environment variables in all components" %}} diff --git a/content/influxdb3/clustered/admin/licensing.md b/content/influxdb3/clustered/admin/licensing.md index 2e16eb5f1..b345457b2 100644 --- a/content/influxdb3/clustered/admin/licensing.md +++ b/content/influxdb3/clustered/admin/licensing.md @@ -33,13 +33,12 @@ the InfluxDB Clustered software. ## Install your InfluxDB license -{{% note %}} -If setting up an InfluxDB Clustered deployment for the first time, first -[set up the prerequisites](/influxdb3/clustered/install/set-up-cluster/licensing/) and -[configure your cluster](/influxdb3/clustered/install/set-up-cluster/configure-cluster/). -After your InfluxDB namespace is created and prepared, you can -install your license. -{{% /note %}} +> [!Note] +> If setting up an InfluxDB Clustered deployment for the first time, first +> [set up the prerequisites](/influxdb3/clustered/install/set-up-cluster/licensing/) and +> [configure your cluster](/influxdb3/clustered/install/set-up-cluster/configure-cluster/). +> After your InfluxDB namespace is created and prepared, you can +> install your license. 1. If you haven't already, [request an InfluxDB Clustered license](https://influxdata.com/contact-sales). diff --git a/content/influxdb3/clustered/admin/query-system-data.md b/content/influxdb3/clustered/admin/query-system-data.md index 5ed427ba1..84f45899f 100644 --- a/content/influxdb3/clustered/admin/query-system-data.md +++ b/content/influxdb3/clustered/admin/query-system-data.md @@ -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). - - - -#### 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). - - -{{% /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). +> +> +> +> #### 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). +> +> ## 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/clustered/reference/cli/influxctl/query/) and SQL to query system tables. @@ -268,9 +266,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 @@ -333,11 +330,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 @@ -400,14 +396,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) diff --git a/content/influxdb3/clustered/admin/scale-cluster.md b/content/influxdb3/clustered/admin/scale-cluster.md index f28faece3..0c8b2d9b2 100644 --- a/content/influxdb3/clustered/admin/scale-cluster.md +++ b/content/influxdb3/clustered/admin/scale-cluster.md @@ -72,14 +72,13 @@ properties in your `AppInstance` resource: - Garbage collector - Catalog service -{{% note %}} -#### Scale your Catalog store and Object store - -Your InfluxDB [Catalog store](/influxdb3/clustered/reference/internals/storage-engine/#catalog-store) -and [Object store](/influxdb3/clustered/reference/internals/storage-engine/#object-store) -are managed outside of your `AppInstance` resource. Scaling mechanisms for these -components depend on the technology and underlying provider used for each. -{{% /note %}} +> [!Note] +> #### Scale your Catalog and Object store +> +> Your InfluxDB [Catalog](/influxdb3/clustered/reference/internals/storage-engine/#catalog) +> and [Object store](/influxdb3/clustered/reference/internals/storage-engine/#object-store) +> are managed outside of your `AppInstance` resource. Scaling mechanisms for these +> components depend on the technology and underlying provider used for each. {{< tabs-wrapper >}} {{% tabs "small" %}} @@ -318,11 +317,10 @@ replicas per component: {{% /tab-content %}} {{< /tabs-wrapper >}} -{{% note %}} -Applying resource limits to pods is optional, but provides better resource -isolation and protects against pods using more resources than intended. For -information, see [Kubernetes resource requests and limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits). -{{% /note %}} +> [!Note] +> Applying resource limits to pods is optional, but provides better resource +> isolation and protects against pods using more resources than intended. For +> information, see [Kubernetes resource requests and limits](https://kubernetes.io/docs/concepts/configuration/manage-resources-containers/#requests-and-limits). ##### Related Kubernetes documentation @@ -334,12 +332,11 @@ information, see [Kubernetes resource requests and limits](https://kubernetes.io To horizontally scale a component in your InfluxDB cluster, increase or decrease the number of replicas for the component and [apply the change](#apply-your-changes). -{{% warn %}} -#### Only use the AppInstance to scale component replicas - -Only use the `AppInstance` resource to scale component replicas. -Manually scaling replicas may cause errors. -{{% /warn %}} +> [!Warning] +> #### Only use the AppInstance to scale component replicas +> +> Only use the `AppInstance` resource to scale component replicas. +> Manually scaling replicas may cause errors. For example--to horizontally scale your [Ingester](/influxdb3/clustered/reference/internals/storage-engine/#ingester): diff --git a/content/influxdb3/clustered/admin/tables/_index.md b/content/influxdb3/clustered/admin/tables/_index.md index 0e563844c..4065afde6 100644 --- a/content/influxdb3/clustered/admin/tables/_index.md +++ b/content/influxdb3/clustered/admin/tables/_index.md @@ -15,9 +15,8 @@ influxdb3/clustered/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" >}} diff --git a/content/influxdb3/clustered/admin/tables/create.md b/content/influxdb3/clustered/admin/tables/create.md index 98a77855f..4ea6ceb56 100644 --- a/content/influxdb3/clustered/admin/tables/create.md +++ b/content/influxdb3/clustered/admin/tables/create.md @@ -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/clustered/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. diff --git a/content/influxdb3/clustered/admin/tables/list.md b/content/influxdb3/clustered/admin/tables/list.md index cd61c03dc..228155434 100644 --- a/content/influxdb3/clustered/admin/tables/list.md +++ b/content/influxdb3/clustered/admin/tables/list.md @@ -29,9 +29,8 @@ Use the [`SHOW TABLES` SQL statement](/influxdb3/clustered/query-data/sql/explor or the [`SHOW MEASUREMENTS` InfluxQL statement](/influxdb3/clustered/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,9 +49,8 @@ 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 %}} +> [!Note] +> The `influxctl query` command only supports SQL queries; not InfluxQL. Provide the following with your command: diff --git a/content/influxdb3/clustered/admin/tokens/_index.md b/content/influxdb3/clustered/admin/tokens/_index.md index ae755d3ca..938dd0dba 100644 --- a/content/influxdb3/clustered/admin/tokens/_index.md +++ b/content/influxdb3/clustered/admin/tokens/_index.md @@ -35,13 +35,12 @@ Management tokens allow clients, such as the [`influxctl` CLI](/influxdb3/clustered/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). --- diff --git a/content/influxdb3/clustered/admin/tokens/database/create.md b/content/influxdb3/clustered/admin/tokens/database/create.md index 1e3cae680..91f0fcc9d 100644 --- a/content/influxdb3/clustered/admin/tokens/database/create.md +++ b/content/influxdb3/clustered/admin/tokens/database/create.md @@ -62,17 +62,15 @@ The output is 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/clustered/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/clustered/admin/tokens/database/delete/) and create a new one. ## Output format diff --git a/content/influxdb3/clustered/admin/tokens/database/delete.md b/content/influxdb3/clustered/admin/tokens/database/delete.md index 6395e1dd9..cef34cba3 100644 --- a/content/influxdb3/clustered/admin/tokens/database/delete.md +++ b/content/influxdb3/clustered/admin/tokens/database/delete.md @@ -42,15 +42,14 @@ influxctl token delete TOKEN_ID ``` {{% /code-placeholders %}} -{{% 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 -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 +> cluster. diff --git a/content/influxdb3/clustered/admin/tokens/database/update.md b/content/influxdb3/clustered/admin/tokens/database/update.md index 39fe4fa47..ce62ae245 100644 --- a/content/influxdb3/clustered/admin/tokens/database/update.md +++ b/content/influxdb3/clustered/admin/tokens/database/update.md @@ -51,13 +51,12 @@ Replace the following: - {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{< product-name >}} database - {{% code-placeholder-key %}}`TOKEN ID`{{% /code-placeholder-key %}}: ID of the token to update -{{% 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 diff --git a/content/influxdb3/clustered/admin/tokens/management/_index.md b/content/influxdb3/clustered/admin/tokens/management/_index.md index e51adf754..44df19e63 100644 --- a/content/influxdb3/clustered/admin/tokens/management/_index.md +++ b/content/influxdb3/clustered/admin/tokens/management/_index.md @@ -17,12 +17,11 @@ 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/clustered/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/clustered/admin/tokens/database/). By default, management tokens are short-lived tokens issued by an OAuth provider that grant a specific user administrative access to your @@ -31,16 +30,15 @@ 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 OAuth 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 OAuth provider. **Take great care when manually creating -and using management tokens**. - -{{< product-name >}} requires at least one user associated with your cluster -and authorized through OAuth 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 OAuth provider. **Take great care when manually creating +> and using management tokens**. +> +> {{< product-name >}} requires at least one user associated with your cluster +> and authorized through OAuth to manually create a management token. {{< children type="anchored-list" >}} - [Use a management token](#use-a-management-token) diff --git a/content/influxdb3/clustered/admin/tokens/management/create.md b/content/influxdb3/clustered/admin/tokens/management/create.md index 976817024..2e5919a5d 100644 --- a/content/influxdb3/clustered/admin/tokens/management/create.md +++ b/content/influxdb3/clustered/admin/tokens/management/create.md @@ -26,16 +26,15 @@ 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 OAuth 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 OAuth provider. **Take great care when manually creating -and using management tokens**. - -{{< product-name >}} requires at least one user associated with your cluster -and authorized through OAuth 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 OAuth provider. **Take great care when manually creating +> and using management tokens**. +> +> {{< product-name >}} requires at least one user associated with your cluster +> and authorized through OAuth to manually create a management token. 1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl). 2. Use the [`influxctl management create` command](/influxdb3/clustered/reference/cli/influxctl/management/create/) @@ -64,10 +63,9 @@ Replace the following: The output contains 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). diff --git a/content/influxdb3/clustered/admin/tokens/management/list.md b/content/influxdb3/clustered/admin/tokens/management/list.md index 59d0192f3..191520cbe 100644 --- a/content/influxdb3/clustered/admin/tokens/management/list.md +++ b/content/influxdb3/clustered/admin/tokens/management/list.md @@ -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 diff --git a/content/influxdb3/clustered/admin/tokens/management/revoke.md b/content/influxdb3/clustered/admin/tokens/management/revoke.md index 62ac17496..acc564480 100644 --- a/content/influxdb3/clustered/admin/tokens/management/revoke.md +++ b/content/influxdb3/clustered/admin/tokens/management/revoke.md @@ -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. diff --git a/content/influxdb3/clustered/admin/upgrade.md b/content/influxdb3/clustered/admin/upgrade.md index 5b79d9eea..1664e9a72 100644 --- a/content/influxdb3/clustered/admin/upgrade.md +++ b/content/influxdb3/clustered/admin/upgrade.md @@ -81,14 +81,12 @@ identified at [oci.influxdata.com](https://oci.influxdata.com). **When upgrading, always upgrade to each checkpoint release first, before proceeding to newer versions.** -{{% warn %}} - -#### Upgrade to checkpoint releases first - -Upgrading past a checkpoint release without first upgrading to it may result -in corrupt or lost data. - -{{% /warn %}} +> [!Warning] +> +> #### Upgrade to checkpoint releases first +> +> Upgrading past a checkpoint release without first upgrading to it may result +> in corrupt or lost data. {{< expand-wrapper >}} {{% expand "View checkpoint release upgrade example" %}} diff --git a/content/influxdb3/clustered/admin/users/_index.md b/content/influxdb3/clustered/admin/users/_index.md index fdee53ffd..a83778870 100644 --- a/content/influxdb3/clustered/admin/users/_index.md +++ b/content/influxdb3/clustered/admin/users/_index.md @@ -19,14 +19,13 @@ Manage users with administrative access to your InfluxDB cluster through your `AppInstance` resource. Administrative access lets users perform actions like creating databases and tokens. -{{% note %}} -#### Users versus database tokens - -All _users_ have administrative access to your cluster and can perform -administrative actions in your InfluxDB cluster. -_Database tokens_ authorize read and write access to databases in your InfluxDB -cluster. A person or client doesn't need to be a user to read and write data in your cluster, -but they must have a database token. -{{% /note %}} +> [!Note] +> #### Users versus database tokens +> +> All _users_ have administrative access to your cluster and can perform +> administrative actions in your InfluxDB cluster. +> _Database tokens_ authorize read and write access to databases in your InfluxDB +> cluster. A person or client doesn't need to be a user to read and write data in your cluster, +> but they must have a database token. {{< children >}} diff --git a/content/influxdb3/clustered/admin/users/remove.md b/content/influxdb3/clustered/admin/users/remove.md index a86597e86..c315aaee6 100644 --- a/content/influxdb3/clustered/admin/users/remove.md +++ b/content/influxdb3/clustered/admin/users/remove.md @@ -124,8 +124,7 @@ helm upgrade \ {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -{{% note %}} -After you complete step 1 above, the removed user no longer has administrative -access to your InfluxDB cluster. -However, you should still remove them from your `AppInstance` resource. -{{% /note %}} +> [!Note] +> After you complete step 1 above, the removed user no longer has administrative +> access to your InfluxDB cluster. +> However, you should still remove them from your `AppInstance` resource. diff --git a/content/influxdb3/clustered/get-started/_index.md b/content/influxdb3/clustered/get-started/_index.md index 7e464a5d7..108f944b2 100644 --- a/content/influxdb3/clustered/get-started/_index.md +++ b/content/influxdb3/clustered/get-started/_index.md @@ -64,17 +64,16 @@ 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 @@ This tutorial covers many of the recommended tools. {{< 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` admin CLI diff --git a/content/influxdb3/clustered/get-started/query.md b/content/influxdb3/clustered/get-started/query.md index 697618535..340eb26f0 100644 --- a/content/influxdb3/clustered/get-started/query.md +++ b/content/influxdb3/clustered/get-started/query.md @@ -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/clustered/get-started/setup/#create-a-database) -for data written in the -[Get started writing data](/influxdb3/clustered/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/clustered/get-started/setup/#create-a-database) +> for data written in the +> [Get started writing data](/influxdb3/clustered/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/clustered/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/clustered/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/clustered/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/clustered/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/clustered/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](/influxdb3/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](/influxdb3/clustered/reference/cli/influxctl/#create-a-configuration-file). +> +> The `--database` and `--token` command line flags override credentials in your +> configuration file. {{% /tab-content %}} diff --git a/content/influxdb3/clustered/get-started/setup.md b/content/influxdb3/clustered/get-started/setup.md index c883c4961..c83430db8 100644 --- a/content/influxdb3/clustered/get-started/setup.md +++ b/content/influxdb3/clustered/get-started/setup.md @@ -55,12 +55,9 @@ 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. 1. **Copy and paste the sample configuration profile code** into your `config.toml`: @@ -101,15 +98,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 your **OAuth provider**. Once logged in, your OAuth provider 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 your **OAuth provider**. Once logged in, your OAuth provider 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: @@ -181,14 +177,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 diff --git a/content/influxdb3/clustered/get-started/write.md b/content/influxdb3/clustered/get-started/write.md index be1f74528..19bff124a 100644 --- a/content/influxdb3/clustered/get-started/write.md +++ b/content/influxdb3/clustered/get-started/write.md @@ -161,11 +161,10 @@ to an {{% product-name %}} database. To learn more about available tools and options, see [Write data](/influxdb3/clustered/write-data/). -{{% note %}} -Some examples in this getting started tutorial assume your InfluxDB -credentials (**URL**, **organization**, and **token**) are provided by -[environment variables](/influxdb3/clustered/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/clustered/get-started/setup/?t=InfluxDB+API#configure-authentication-credentials). {{< tabs-wrapper >}} @@ -418,14 +417,11 @@ 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/clustered/guides/migrate-data/migrate-1x-to-clustered/) -guide. - -{{% /note %}} +> [!Note] +> If migrating data from InfluxDB 1.x, see the +> [Migrate data from InfluxDB 1.x to InfluxDB +> {{% product-name %}}](/influxdb3/clustered/guides/migrate-data/migrate-1x-to-clustered/) +> guide. To write data to InfluxDB using the [InfluxDB v1 HTTP API](/influxdb3/clustered/reference/api/), send a @@ -446,16 +442,15 @@ Include the following with your request: - **precision**:[timestamp precision](/influxdb3/clustered/reference/glossary/#timestamp-precision) (default is `ns`) - **Request body**: Line protocol as plain text -{{% note %}} -With the {{% product-name %}} -[v1 API `/write` endpoint](/influxdb3/clustered/api/#operation/PostLegacyWrite), -`Authorization: Bearer` and `Authorization: Token` are equivalent and you can -use either scheme to pass a database token in your request. -Include the word `Bearer` or `Token`, a space, and your **token** value (all case-sensitive). -For more information -about HTTP API token schemes, see how to -[authenticate API requests](/influxdb3/clustered/guides/api-compatibility/v1/). -{{% /note %}} +> [!Note] +> With the {{% product-name %}} +> [v1 API `/write` endpoint](/influxdb3/clustered/api/#operation/PostLegacyWrite), +> `Authorization: Bearer` and `Authorization: Token` are equivalent and you can +> use either scheme to pass a database token in your request. +> Include the word `Bearer` or `Token`, a space, and your **token** value (all case-sensitive). +> For more information +> about HTTP API token schemes, see how to +> [authenticate API requests](/influxdb3/clustered/guides/api-compatibility/v1/). The following example uses cURL and the InfluxDB v1 API to write line protocol to InfluxDB: @@ -559,14 +554,13 @@ Include the following with your request: - **Request body**: Line protocol as plain text -{{% 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/clustered/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/clustered/guides/api-compatibility/v2/). The following example uses cURL and the InfluxDB v2 API to write line protocol to InfluxDB: diff --git a/content/influxdb3/clustered/guides/api-compatibility/v1/_index.md b/content/influxdb3/clustered/guides/api-compatibility/v1/_index.md index 3b49c7609..575866681 100644 --- a/content/influxdb3/clustered/guides/api-compatibility/v1/_index.md +++ b/content/influxdb3/clustered/guides/api-compatibility/v1/_index.md @@ -290,9 +290,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/clustered/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/clustered/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: @@ -438,19 +437,18 @@ Replace the following: To learn how to query {{% product-name %}} using Flight and SQL, see the [Get started](/influxdb3/clustered/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/clustered/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/clustered/reference/client-libraries/v3/) -- [Flight clients](/influxdb3/clustered/reference/client-libraries/flight/) -- [Superset](/influxdb3/clustered/query-data/sql/execute-queries/superset/) -- [Grafana](/influxdb3/clustered/query-data/sql/execute-queries/grafana/) -- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/clustered/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/clustered/reference/client-libraries/v3/) +> - [Flight clients](/influxdb3/clustered/reference/client-libraries/flight/) +> - [Superset](/influxdb3/clustered/query-data/sql/execute-queries/superset/) +> - [Grafana](/influxdb3/clustered/query-data/sql/execute-queries/grafana/) +> - [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/clustered/query-data/execute-queries/influxdb-v1-api/) +> - [Chronograf](/chronograf/v1/) ### v1 API /query parameters @@ -468,9 +466,8 @@ Parameter | Allowed in | Ignored | Value `p` | Query string | Honored | For [query string authentication](#query-string-authentication), a [database token](/influxdb3/clustered/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 diff --git a/content/influxdb3/clustered/guides/api-compatibility/v2/_index.md b/content/influxdb3/clustered/guides/api-compatibility/v2/_index.md index 4053bd071..07e1e4c8f 100644 --- a/content/influxdb3/clustered/guides/api-compatibility/v2/_index.md +++ b/content/influxdb3/clustered/guides/api-compatibility/v2/_index.md @@ -196,14 +196,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/clustered/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 @@ -221,28 +219,23 @@ To setup and start using client libraries, see the [Get started](/influxdb3/clus To learn how to query {{% product-name %}} using Flight and SQL, see the [Get started](/influxdb3/clustered/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/clustered/reference/client-libraries/v3/) -- [Flight clients](/influxdb3/clustered/reference/client-libraries/flight/) -- [Superset](/influxdb3/clustered/query-data/sql/execute-queries/superset/) -- [Grafana](/influxdb3/clustered/query-data/sql/execute-queries/grafana/) -- [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/clustered/primers/api/v1/#query-using-the-v1-api) -- [Chronograf](/chronograf/v1/) - -{{% /note %}} - -{{% warn %}} - -#### /api/v2/query not supported - -The InfluxDB API `/api/v2/query` endpoint can't query an {{% product-name omit=" Clustered" %}} cluster. -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/clustered/reference/client-libraries/v3/) +> - [Flight clients](/influxdb3/clustered/reference/client-libraries/flight/) +> - [Superset](/influxdb3/clustered/query-data/sql/execute-queries/superset/) +> - [Grafana](/influxdb3/clustered/query-data/sql/execute-queries/grafana/) +> - [InfluxQL with InfluxDB v1 HTTP API](/influxdb3/clustered/primers/api/v1/#query-using-the-v1-api) +> - [Chronograf](/chronograf/v1/) +> [!Warning] +> +> #### /api/v2/query not supported +> +> The InfluxDB API `/api/v2/query` endpoint can't query an {{% product-name omit=" Clustered" %}} cluster. +> 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 %}}. diff --git a/content/influxdb3/clustered/guides/migrate-data/migrate-1x-to-clustered.md b/content/influxdb3/clustered/guides/migrate-data/migrate-1x-to-clustered.md index 7abec4490..727e9c369 100644 --- a/content/influxdb3/clustered/guides/migrate-data/migrate-1x-to-clustered.md +++ b/content/influxdb3/clustered/guides/migrate-data/migrate-1x-to-clustered.md @@ -198,11 +198,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 Clustered -databases. - {{% /note %}} + > [!Note] + > We recommend exporting each database and retention policy combination separately + > to easily write the exported data into corresponding InfluxDB Clustered + > databases. ##### Export all data in a database and retention policy to a file ```sh @@ -286,16 +285,15 @@ influx_inspect export \ 2. Create InfluxDB Clustered 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 Clustered does -support InfluxQL, which requires databases and retention policies. -See [InfluxQL DBRP naming convention](/influxdb3/clustered/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, InfluxDB Clustered does + > support InfluxQL, which requires databases and retention policies. + > See [InfluxQL DBRP naming convention](/influxdb3/clustered/admin/databases/create/#influxql-dbrp-naming-convention). + > + > **If coming from InfluxDB v2, InfluxDB Cloud (TSM), or InfluxDB Cloud Serverless**, + > _database_ and _bucket_ are synonymous. {{< expand-wrapper >}} {{% expand "View example 1.x databases and retention policies as InfluxDB Clustered databases" %}} @@ -363,11 +361,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 Clustered. - 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 Clustered. + > 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/). diff --git a/content/influxdb3/clustered/guides/migrate-data/migrate-tsm-to-clustered.md b/content/influxdb3/clustered/guides/migrate-data/migrate-tsm-to-clustered.md index f644ed803..9f2385beb 100644 --- a/content/influxdb3/clustered/guides/migrate-data/migrate-tsm-to-clustered.md +++ b/content/influxdb3/clustered/guides/migrate-data/migrate-tsm-to-clustered.md @@ -151,15 +151,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_**: @@ -181,9 +180,8 @@ 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: @@ -421,10 +419,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). diff --git a/content/influxdb3/clustered/install/customize-cluster/config.md b/content/influxdb3/clustered/install/customize-cluster/config.md index 08394cef4..9b9d4a731 100644 --- a/content/influxdb3/clustered/install/customize-cluster/config.md +++ b/content/influxdb3/clustered/install/customize-cluster/config.md @@ -99,12 +99,11 @@ components: For more information, see [Manage environment variables in your InfluxDB Cluster](/influxdb3/clustered/admin/env-vars/). -{{% note %}} -#### Configurable settings - -For information about what settings are configurable and their associated -environment variables, [contact InfluxData Support](https://support.influxdata.com). -{{% /note %}} +> [!Note] +> #### Configurable settings +> +> For information about what settings are configurable and their associated +> environment variables, [contact InfluxData Support](https://support.influxdata.com). -{{% note %}} -{{% sql/sql-schema-intro %}} -To learn more, see [Query Data](/influxdb3/clustered/query-data/sql/). -{{% /note %}} +> [!Note] +> {{% sql/sql-schema-intro %}} +> To learn more, see [Query Data](/influxdb3/clustered/query-data/sql/). 1. Click **Explore**. 2. In the dropdown, select the saved InfluxDB data source to query. diff --git a/content/influxdb3/clustered/process-data/visualize/superset.md b/content/influxdb3/clustered/process-data/visualize/superset.md index d591e4629..baf5433e4 100644 --- a/content/influxdb3/clustered/process-data/visualize/superset.md +++ b/content/influxdb3/clustered/process-data/visualize/superset.md @@ -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: diff --git a/content/influxdb3/clustered/process-data/visualize/tableau.md b/content/influxdb3/clustered/process-data/visualize/tableau.md index ab00f929b..0e3cbaadd 100644 --- a/content/influxdb3/clustered/process-data/visualize/tableau.md +++ b/content/influxdb3/clustered/process-data/visualize/tableau.md @@ -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)._ diff --git a/content/influxdb3/clustered/query-data/_index.md b/content/influxdb3/clustered/query-data/_index.md index bb0da0c54..3032b5ec4 100644 --- a/content/influxdb3/clustered/query-data/_index.md +++ b/content/influxdb3/clustered/query-data/_index.md @@ -11,13 +11,11 @@ influxdb3/clustered/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/clustered/tags/flight-client/) and SQL or InfluxQL. -- [Use the HTTP API `/query` endpoint and InfluxQL](/influxdb3/clustered/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/clustered/tags/flight-client/) and SQL or InfluxQL. +> - [Use the HTTP API `/query` endpoint and InfluxQL](/influxdb3/clustered/query-data/execute-queries/influxdb-v1-api/) when you bring existing v1 query workloads to {{% product-name %}}. {{< children >}} diff --git a/content/influxdb3/clustered/query-data/execute-queries/influxdb-v1-api.md b/content/influxdb3/clustered/query-data/execute-queries/influxdb-v1-api.md index 9f1104c84..170e3e24a 100644 --- a/content/influxdb3/clustered/query-data/execute-queries/influxdb-v1-api.md +++ b/content/influxdb3/clustered/query-data/execute-queries/influxdb-v1-api.md @@ -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/clustered/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/clustered/reference/influxql/feature-support/). Use the v1 `/query` endpoint and the `GET` request method to query data with InfluxQL: @@ -69,16 +68,16 @@ Replace the following configuration values: - {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}: a [database token](/influxdb3/clustered/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/clustered/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/clustered/admin/tokens/#database-tokens) with _read_ access to the specified database. +> +> {{< code-tabs-wrapper >}} {{% code-tabs %}} [Basic Auth](#) [Query String Auth](#) @@ -108,7 +107,6 @@ curl --get https://{{< influxdb/host >}}/query \ {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -{{% /note %}} ## Return results as JSON or CSV diff --git a/content/influxdb3/clustered/query-data/execute-queries/visualization-tools.md b/content/influxdb3/clustered/query-data/execute-queries/visualization-tools.md index 15d19a1cf..74115ab12 100644 --- a/content/influxdb3/clustered/query-data/execute-queries/visualization-tools.md +++ b/content/influxdb3/clustered/query-data/execute-queries/visualization-tools.md @@ -37,11 +37,10 @@ The following visualization tools support querying InfluxDB with InfluxQL: - [Grafana](/influxdb3/clustered/process-data/visualize/grafana/?t=InfluxQL) - [Chronograf](/influxdb3/clustered/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/clustered/reference/influxql/feature-support/). -{{% /warn %}} \ No newline at end of file +> [!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/clustered/reference/influxql/feature-support/). diff --git a/content/influxdb3/clustered/query-data/influxql/aggregate-select.md b/content/influxdb3/clustered/query-data/influxql/aggregate-select.md index 01c63e769..19c7b8d85 100644 --- a/content/influxdb3/clustered/query-data/influxql/aggregate-select.md +++ b/content/influxdb3/clustered/query-data/influxql/aggregate-select.md @@ -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/clustered/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/clustered/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/clustered/reference/sample-data/#get-started-home-sensor-data). +> To run the example queries and return results, +> [write the sample data](/influxdb3/clustered/reference/sample-data/#write-home-sensor-data-to-influxdb) +> to your {{% product-name %}} database before running the example queries. ### Perform an ungrouped aggregation diff --git a/content/influxdb3/clustered/query-data/influxql/basic-query.md b/content/influxdb3/clustered/query-data/influxql/basic-query.md index 41740f6b4..b0dd13b6c 100644 --- a/content/influxdb3/clustered/query-data/influxql/basic-query.md +++ b/content/influxdb3/clustered/query-data/influxql/basic-query.md @@ -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/clustered/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/clustered/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/clustered/reference/sample-data/#get-started-home-sensor-data). +> To run the example queries and return results, +> [write the sample data](/influxdb3/clustered/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 @@ -182,10 +181,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 @@ -240,9 +238,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/clustered/reference/influxql/#identifiers). When -[aliasing columns in **SQL**](/influxdb3/clustered/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/clustered/reference/influxql/#identifiers). When +> [aliasing columns in **SQL**](/influxdb3/clustered/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. diff --git a/content/influxdb3/clustered/query-data/influxql/explore-schema.md b/content/influxdb3/clustered/query-data/influxql/explore-schema.md index 247278bfb..516631ba3 100644 --- a/content/influxdb3/clustered/query-data/influxql/explore-schema.md +++ b/content/influxdb3/clustered/query-data/influxql/explore-schema.md @@ -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/clustered/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/clustered/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" %}} diff --git a/content/influxdb3/clustered/query-data/influxql/parameterized-queries.md b/content/influxdb3/clustered/query-data/influxql/parameterized-queries.md index 01cf7fcbc..06e98da20 100644 --- a/content/influxdb3/clustered/query-data/influxql/parameterized-queries.md +++ b/content/influxdb3/clustered/query-data/influxql/parameterized-queries.md @@ -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/clustered/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/clustered/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/clustered/reference/sample-data/#get-started-home-sensor-data). +> To run the example queries and return results, +> [write the sample data](/influxdb3/clustered/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/clustered/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/clustered/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/clustered/reference/sample-data/#get-started-home-sensor-data). +> To run the example queries and return results, +> [write the sample data](/influxdb3/clustered/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 diff --git a/content/influxdb3/clustered/query-data/influxql/troubleshoot.md b/content/influxdb3/clustered/query-data/influxql/troubleshoot.md index 9dbd84163..2a443fb2e 100644 --- a/content/influxdb3/clustered/query-data/influxql/troubleshoot.md +++ b/content/influxdb3/clustered/query-data/influxql/troubleshoot.md @@ -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/clustered/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/clustered/reference/influxql/#keywords) +> as identifiers. ```sql SELECT duration FROM runs diff --git a/content/influxdb3/clustered/query-data/sql/aggregate-select.md b/content/influxdb3/clustered/query-data/sql/aggregate-select.md index 46bc39d30..64073195f 100644 --- a/content/influxdb3/clustered/query-data/sql/aggregate-select.md +++ b/content/influxdb3/clustered/query-data/sql/aggregate-select.md @@ -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/clustered/get-started/write/). -To run the example queries and return results, -[write the sample data](/influxdb3/clustered/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/clustered/get-started/write/). +> To run the example queries and return results, +> [write the sample data](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb) +> to your {{% product-name %}} 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'::TIMESTAMP) - 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'::TIMESTAMP) +> 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 diff --git a/content/influxdb3/clustered/query-data/sql/basic-query.md b/content/influxdb3/clustered/query-data/sql/basic-query.md index 5f5c670e9..848651aa4 100644 --- a/content/influxdb3/clustered/query-data/sql/basic-query.md +++ b/content/influxdb3/clustered/query-data/sql/basic-query.md @@ -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/clustered/get-started/write/). -To run the example queries and return results, -[write the sample data](/influxdb3/clustered/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/clustered/get-started/write/). +> To run the example queries and return results, +> [write the sample data](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb) +> to your {{% product-name %}} database before running the example queries. ### Query data within time boundaries @@ -140,13 +139,12 @@ To query data using a time zone offset, use the [`AT TIME ZONE` operator](/influxdb3/clustered/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 @@ -167,10 +165,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 diff --git a/content/influxdb3/clustered/query-data/sql/cast-types.md b/content/influxdb3/clustered/query-data/sql/cast-types.md index 4fcc9ad92..9ba3146ab 100644 --- a/content/influxdb3/clustered/query-data/sql/cast-types.md +++ b/content/influxdb3/clustered/query-data/sql/cast-types.md @@ -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/clustered/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/clustered/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 diff --git a/content/influxdb3/clustered/query-data/sql/fill-gaps.md b/content/influxdb3/clustered/query-data/sql/fill-gaps.md index fd2884ba6..f8b557f6f 100644 --- a/content/influxdb3/clustered/query-data/sql/fill-gaps.md +++ b/content/influxdb3/clustered/query-data/sql/fill-gaps.md @@ -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/clustered/reference/sql/functions/aggregate/). - {{% /note %}} + > [!Note] + > The expression passed to `interpolate` or `locf` must use an + > [aggregate function](/influxdb3/clustered/reference/sql/functions/aggregate/). 3. Include a `WHERE` clause that sets upper and lower time bounds. For example: diff --git a/content/influxdb3/clustered/query-data/sql/parameterized-queries.md b/content/influxdb3/clustered/query-data/sql/parameterized-queries.md index 8fc0fa870..925d09d24 100644 --- a/content/influxdb3/clustered/query-data/sql/parameterized-queries.md +++ b/content/influxdb3/clustered/query-data/sql/parameterized-queries.md @@ -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/clustered/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/clustered/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/clustered/reference/sample-data/#get-started-home-sensor-data). +> To run the example queries and return results, +> [write the sample data](/influxdb3/clustered/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/clustered/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/clustered/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/clustered/reference/sample-data/#get-started-home-sensor-data). +> To run the example queries and return results, +> [write the sample data](/influxdb3/clustered/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 diff --git a/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md b/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md index 7e2d67274..d1b95278a 100644 --- a/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md +++ b/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/analyze-query-plan.md @@ -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). diff --git a/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues.md b/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues.md index b9e2496bf..c362a5814 100644 --- a/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues.md +++ b/content/influxdb3/clustered/query-data/troubleshoot-and-optimize/report-query-performance-issues.md @@ -41,10 +41,9 @@ Use these guidelines to work with InfluxData engineers to troubleshoot and resol - [Collect compaction information for the table](#collect-compaction-information-for-the-table) - [Collect partition information for multiple tables](#collect-partition-information-for-multiple-tables) -{{% note %}} -Please note that this document may change from one support engagement to the -next as our process and tooling improves. -{{% /note %}} +> [!Note] +> Please note that this document may change from one support engagement to the +> next as our process and tooling improves. ### Send InfluxData output artifacts @@ -83,14 +82,13 @@ including the following: Clustered product - If so, describe the network-level topology of your setup -{{% note %}} -#### If possible, provide a synthetic dataset - -If you can reproduce the performance issue with a synthetic dataset, and your -process and environment are well-documented, InfluxData engineers _may_ -be able to reproduce the issue, shorten the feedback cycle, and resolve the -issue sooner. -{{% /note %}} +> [!Note] +> #### If possible, provide a synthetic dataset +> +> If you can reproduce the performance issue with a synthetic dataset, and your +> process and environment are well-documented, InfluxData engineers _may_ +> be able to reproduce the issue, shorten the feedback cycle, and resolve the +> issue sooner. ### Document your data schema diff --git a/content/influxdb3/clustered/reference/cli/influxctl/cluster/create.md b/content/influxdb3/clustered/reference/cli/influxctl/cluster/create.md index c607c4959..d38b3f965 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/cluster/create.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/cluster/create.md @@ -11,11 +11,10 @@ draft: true The `influxctl cluster create` command creates an {{% product-name omit=" Clustered" %}} cluster. -{{% warn %}} -This command is not supported by InfluxDB Clustered. - -{{% /warn %}} +> [!Warning] +> This command is not supported by InfluxDB Clustered. +> For information about create an InfluxDB Cluster, see +> [Install InfluxDB Clustered](/influxdb3/clustered/install/). ## Usage diff --git a/content/influxdb3/clustered/reference/cli/influxctl/cluster/list.md b/content/influxdb3/clustered/reference/cli/influxctl/cluster/list.md index 56db52e23..e28c99f6d 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/cluster/list.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/cluster/list.md @@ -9,15 +9,13 @@ menu: weight: 301 --- -{{% warn %}} - -#### Doesn't work with InfluxDB Clustered - -The `influxctl cluster list` command won't work with {{% product-name %}}. -To retrieve cluster information, use the [`influxctl cluster get ` -command](/influxdb3/clustered/reference/cli/influxctl/cluster/get/). - -{{% /warn %}} +> [!Warning] +> +> #### Doesn't work with InfluxDB Clustered +> +> The `influxctl cluster list` command won't work with {{% product-name %}}. +> To retrieve cluster information, use the [`influxctl cluster get ` +> command](/influxdb3/clustered/reference/cli/influxctl/cluster/get/). The `influxctl cluster list` command returns information about all InfluxDB clusters associated with your account ID. diff --git a/content/influxdb3/clustered/reference/cli/influxctl/cluster/update.md b/content/influxdb3/clustered/reference/cli/influxctl/cluster/update.md index d9897d927..015b3136f 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/cluster/update.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/cluster/update.md @@ -11,11 +11,8 @@ draft: true The `influxctl cluster update` command updates an {{% product-name omit=" Clustered" %}} cluster. -{{% warn %}} -This command is not supported by InfluxDB Clustered. - -{{% /warn %}} +> [!Warning] +> This command is not supported by InfluxDB Clustered. ## Usage diff --git a/content/influxdb3/clustered/reference/cli/influxctl/database/create.md b/content/influxdb3/clustered/reference/cli/influxctl/database/create.md index 7b38b27f2..ce9d00750 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/database/create.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/database/create.md @@ -59,28 +59,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/clustered/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 `` 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 `` already exists' +> ``` ## Usage diff --git a/content/influxdb3/clustered/reference/cli/influxctl/database/delete.md b/content/influxdb3/clustered/reference/cli/influxctl/database/delete.md index abb2a72ad..21ee800f0 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/database/delete.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/database/delete.md @@ -19,16 +19,15 @@ The `influxctl database delete` command deletes a database from an InfluxDB clus influxctl database delete [command options] [--force] [...] ``` -{{% 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 diff --git a/content/influxdb3/clustered/reference/cli/influxctl/management/create.md b/content/influxdb3/clustered/reference/cli/influxctl/management/create.md index 7c9d62f0e..b86b13821 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/management/create.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/management/create.md @@ -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 diff --git a/content/influxdb3/clustered/reference/cli/influxctl/management/list.md b/content/influxdb3/clustered/reference/cli/influxctl/management/list.md index 42cba4435..bac3fd9bd 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/management/list.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/management/list.md @@ -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. diff --git a/content/influxdb3/clustered/reference/cli/influxctl/management/revoke.md b/content/influxdb3/clustered/reference/cli/influxctl/management/revoke.md index 01ea9d960..a8874790e 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/management/revoke.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/management/revoke.md @@ -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/clustered/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/clustered/reference/cli/influxctl/management/list/), +> but they are no longer valid for any operations. ## Usage diff --git a/content/influxdb3/clustered/reference/cli/influxctl/query.md b/content/influxdb3/clustered/reference/cli/influxctl/query.md index 15b714930..d09a45f2d 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/query.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/query.md @@ -22,13 +22,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 @@ -408,15 +407,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" %}} diff --git a/content/influxdb3/clustered/reference/cli/influxctl/table/create.md b/content/influxdb3/clustered/reference/cli/influxctl/table/create.md index 7ee3f390a..31bc72495 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/table/create.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/table/create.md @@ -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/clustered/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 diff --git a/content/influxdb3/clustered/reference/cli/influxctl/token/create.md b/content/influxdb3/clustered/reference/cli/influxctl/token/create.md index 20b36ec91..326cd3e8c 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/token/create.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/token/create.md @@ -27,14 +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 diff --git a/content/influxdb3/clustered/reference/cli/influxctl/token/delete.md b/content/influxdb3/clustered/reference/cli/influxctl/token/delete.md index 42b9b2bc0..a6cb01ef6 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/token/delete.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/token/delete.md @@ -18,17 +18,16 @@ cluster and revokes all permissions associated with the token. influxctl token delete [...] ``` -{{% 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 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 cluster. ## Arguments diff --git a/content/influxdb3/clustered/reference/cli/influxctl/token/update.md b/content/influxdb3/clustered/reference/cli/influxctl/token/update.md index 0b4b7607e..ecd3a0362 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/token/update.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/token/update.md @@ -25,13 +25,12 @@ influxctl token update \ ``` -{{% 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 diff --git a/content/influxdb3/clustered/reference/cli/influxctl/user/delete.md b/content/influxdb3/clustered/reference/cli/influxctl/user/delete.md index cde3b0a6e..006aafea2 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/user/delete.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/user/delete.md @@ -18,12 +18,11 @@ account. influxctl user delete ``` -{{% 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 diff --git a/content/influxdb3/clustered/reference/cli/influxctl/write.md b/content/influxdb3/clustered/reference/cli/influxctl/write.md index 586950705..37cbaa81a 100644 --- a/content/influxdb3/clustered/reference/cli/influxctl/write.md +++ b/content/influxdb3/clustered/reference/cli/influxctl/write.md @@ -21,14 +21,13 @@ Provide line protocol in one of the following ways: - a path to a file that contains line protocol - 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 diff --git a/content/influxdb3/clustered/reference/client-libraries/flight/_index.md b/content/influxdb3/clustered/reference/client-libraries/flight/_index.md index 84cf545ad..0702154dd 100644 --- a/content/influxdb3/clustered/reference/client-libraries/flight/_index.md +++ b/content/influxdb3/clustered/reference/client-libraries/flight/_index.md @@ -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/clustered/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/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/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/clustered/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/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/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. diff --git a/content/influxdb3/clustered/reference/client-libraries/flight/csharp-flight.md b/content/influxdb3/clustered/reference/client-libraries/flight/csharp-flight.md index f9985162b..b996c6c16 100644 --- a/content/influxdb3/clustered/reference/client-libraries/flight/csharp-flight.md +++ b/content/influxdb3/clustered/reference/client-libraries/flight/csharp-flight.md @@ -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/clustered/reference/client-libraries/v3/csharp/) for integrating InfluxDB 3 with your C# application code. - -[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/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/clustered/reference/client-libraries/v3/csharp/) for integrating InfluxDB 3 with your C# application code. +> +> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +> and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +> Client libraries can query using SQL or InfluxQL. diff --git a/content/influxdb3/clustered/reference/client-libraries/flight/go-flight.md b/content/influxdb3/clustered/reference/client-libraries/flight/go-flight.md index 1daf7a676..22dfdd94c 100644 --- a/content/influxdb3/clustered/reference/client-libraries/flight/go-flight.md +++ b/content/influxdb3/clustered/reference/client-libraries/flight/go-flight.md @@ -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/clustered/reference/client-libraries/v3/go/) for integrating InfluxDB 3 with your Go application code. - -[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/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/clustered/reference/client-libraries/v3/go/) for integrating InfluxDB 3 with your Go application code. +> +> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +> and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/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 diff --git a/content/influxdb3/clustered/reference/client-libraries/flight/java-flightsql.md b/content/influxdb3/clustered/reference/client-libraries/flight/java-flightsql.md index e88b24e82..a064d74e4 100644 --- a/content/influxdb3/clustered/reference/client-libraries/flight/java-flightsql.md +++ b/content/influxdb3/clustered/reference/client-libraries/flight/java-flightsql.md @@ -40,15 +40,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` Go client library](/influxdb3/clustered/reference/client-libraries/v3/java/) for integrating InfluxDB 3 with your Java application code. - -[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/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` Go client library](/influxdb3/clustered/reference/client-libraries/v3/java/) for integrating InfluxDB 3 with your Java application code. +> +> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +> and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +> Client libraries can query using SQL or InfluxQL. diff --git a/content/influxdb3/clustered/reference/client-libraries/flight/python-flight.md b/content/influxdb3/clustered/reference/client-libraries/flight/python-flight.md index dfa346af5..dca1070b1 100644 --- a/content/influxdb3/clustered/reference/client-libraries/flight/python-flight.md +++ b/content/influxdb3/clustered/reference/client-libraries/flight/python-flight.md @@ -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/clustered/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code. - -[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/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/clustered/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code. +> +> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +> and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/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: diff --git a/content/influxdb3/clustered/reference/client-libraries/flight/python-flightsql-dbapi.md b/content/influxdb3/clustered/reference/client-libraries/flight/python-flightsql-dbapi.md index f4b9dabb1..5d2d6d5d2 100644 --- a/content/influxdb3/clustered/reference/client-libraries/flight/python-flightsql-dbapi.md +++ b/content/influxdb3/clustered/reference/client-libraries/flight/python-flightsql-dbapi.md @@ -14,15 +14,14 @@ weight: 201 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/clustered/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code. - -[InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients -and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/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/clustered/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code. +> +> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) wrap Apache Arrow Flight clients +> and provide convenient methods for [writing](/influxdb3/clustered/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/clustered/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}. +> Client libraries can query using SQL or InfluxQL. ## Installation diff --git a/content/influxdb3/clustered/reference/client-libraries/v1/_index.md b/content/influxdb3/clustered/reference/client-libraries/v1/_index.md index dac2f748e..6fc0b996c 100644 --- a/content/influxdb3/clustered/reference/client-libraries/v1/_index.md +++ b/content/influxdb3/clustered/reference/client-libraries/v1/_index.md @@ -14,9 +14,8 @@ influxdb3/clustered/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/clustered/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/clustered/reference/client-libraries/v3/). Functionality varies among client libraries. For specifics about a client library, see the library's GitHub repository. diff --git a/content/influxdb3/clustered/reference/client-libraries/v2/javascript/browser.md b/content/influxdb3/clustered/reference/client-libraries/v2/javascript/browser.md index e180512a2..7e2e99df3 100644 --- a/content/influxdb3/clustered/reference/client-libraries/v2/javascript/browser.md +++ b/content/influxdb3/clustered/reference/client-libraries/v2/javascript/browser.md @@ -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) diff --git a/content/influxdb3/clustered/reference/client-libraries/v3/python.md b/content/influxdb3/clustered/reference/client-libraries/v3/python.md index 5d761dfe7..845067647 100644 --- a/content/influxdb3/clustered/reference/client-libraries/v3/python.md +++ b/content/influxdb3/clustered/reference/client-libraries/v3/python.md @@ -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/clustered/reference/sample-data/#get-started-home-sensor-data). -{{% /note %}} +> [!Note] +> Code samples in this page use the [Get started home sensor sample data](/influxdb3/clustered/reference/sample-data/#get-started-home-sensor-data). - [Installation](#installation) - [Importing the module](#importing-the-module) diff --git a/content/influxdb3/clustered/reference/internals/data-retention.md b/content/influxdb3/clustered/reference/internals/data-retention.md index 1c6630ebb..3d461a35e 100644 --- a/content/influxdb3/clustered/reference/internals/data-retention.md +++ b/content/influxdb3/clustered/reference/internals/data-retention.md @@ -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/clustered/reference/cli/influxctl/database/list/) -to view your databases' retention periods. -{{% /note %}} +> [!Note] +> #### View database retention periods +> +> Use the [`influxctl database list` command](/influxdb3/clustered/reference/cli/influxctl/database/list/) +> to view your databases' retention periods. ## When does data actually get deleted? diff --git a/content/influxdb3/clustered/reference/release-notes/clustered.md b/content/influxdb3/clustered/reference/release-notes/clustered.md index d73f6ee2b..1aaf9cef1 100644 --- a/content/influxdb3/clustered/reference/release-notes/clustered.md +++ b/content/influxdb3/clustered/reference/release-notes/clustered.md @@ -556,9 +556,9 @@ spec: under `observability.serviceMonitor` - The feature flag is now deprecated, and will be removed in a future release. - {{% warn %}} - Using this setting will delete and recreate the existing serviceMonitor resource that was provided by the feature flag. - {{% /warn %}} + > [!Warning] + > Using this setting will delete and recreate the existing serviceMonitor + > resource that was provided by the feature flag. #### Deployment diff --git a/content/influxdb3/clustered/reference/syntax/line-protocol.md b/content/influxdb3/clustered/reference/syntax/line-protocol.md index 09e5ae368..7947d9e93 100644 --- a/content/influxdb3/clustered/reference/syntax/line-protocol.md +++ b/content/influxdb3/clustered/reference/syntax/line-protocol.md @@ -35,9 +35,8 @@ myMeasurement,tag1=value1,tag2=value2 fieldKey="fieldValue" 1556813561098000000 Lines separated by the newline character `\n` represent a single point in InfluxDB. Line protocol is whitespace sensitive. -{{% note %}} -Line protocol does not support the newline character `\n` in tag or field values. -{{% /note %}} +> [!Note] +> Line protocol does not support the newline character `\n` in tag or field values. ## Elements of line protocol @@ -74,13 +73,12 @@ Field keys are subject to [naming restrictions](#naming-restrictions)._ _**Key data type:** [String](#string)_ _**Value data type:** [Float](#float) | [Integer](#integer) | [UInteger](#uinteger) | [String](#string) | [Boolean](#boolean)_ -{{% note %}} -_Always double quote string field values. More on quotes [below](#quotes)._ - -```sh -measurementName fieldKey="field string value" 1556813561098000000 -``` -{{% /note %}} +> [!Note] +> _Always double quote string field values. More on quotes [below](#quotes)._ +> +> ```sh +> measurementName fieldKey="field string value" 1556813561098000000 +> ``` ### Timestamp _**Optional**_ – @@ -90,13 +88,13 @@ If no timestamp is provided, InfluxDB uses the system time (UTC) of its host mac _**Data type:** [Unix timestamp](#unix-timestamp)_ -{{% note %}} -#### Important notes about timestamps -- To ensure a data point includes the time a metric is observed (not received by InfluxDB), - include the timestamp. -- If your timestamps are not in nanoseconds, specify the precision of your timestamps - when [writing the data to InfluxDB](/influxdb/v2/write-data/#timestamp-precision). -{{% /note %}} +> [!Note] +> #### Important notes about timestamps +> +> - To ensure a data point includes the time a metric is observed (not received by InfluxDB), +> include the timestamp. +> - If your timestamps are not in nanoseconds, specify the precision of your timestamps +> when [writing the data to InfluxDB](/influxdb/v2/write-data/#timestamp-precision). ### Whitespace Whitespace in line protocol determines how InfluxDB interprets the data point. @@ -176,10 +174,9 @@ myMeasurement fieldKey=TRUE myMeasurement fieldKey=FALSE ``` -{{% note %}} -Do not quote boolean field values. -Quoted field values are interpreted as strings. -{{% /note %}} +> [!Note] +> Do not quote boolean field values. +> Quoted field values are interpreted as strings. ### Unix timestamp Unix timestamp in a [specified precision](/influxdb/v2/reference/glossary/#unix-timestamp). diff --git a/content/influxdb3/clustered/write-data/_index.md b/content/influxdb3/clustered/write-data/_index.md index aded58b96..034575873 100644 --- a/content/influxdb3/clustered/write-data/_index.md +++ b/content/influxdb3/clustered/write-data/_index.md @@ -18,14 +18,12 @@ influxdb3/clustered/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/clustered/guides/api-compatibility/v1/). -When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb3/clustered/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/clustered/guides/api-compatibility/v1/). +> When creating new write workloads, use the HTTP API [`/api/v2/write` endpoint](/influxdb3/clustered/guides/api-compatibility/v2/). {{< children >}} \ No newline at end of file diff --git a/content/influxdb3/clustered/write-data/best-practices/data-lifecycle.md b/content/influxdb3/clustered/write-data/best-practices/data-lifecycle.md index cfa992379..8ad31b9d3 100644 --- a/content/influxdb3/clustered/write-data/best-practices/data-lifecycle.md +++ b/content/influxdb3/clustered/write-data/best-practices/data-lifecycle.md @@ -48,11 +48,10 @@ Use the following environment variables to tune the garbage collector: These values tune how aggressive the garbage collector can be. A shorter duration value means that files can be removed at a faster pace. -{{% warn %}} -To ensure there is a grace period before files and references are removed, the -minimum garbage collector (GC) object store and Parquet file cutoff time is -three hours (`3h`). -{{% /warn %}} +> [!Warning] +> To ensure there is a grace period before files and references are removed, the +> minimum garbage collector (GC) object store and Parquet file cutoff time is +> three hours (`3h`). We recommend setting these options to a value aligned to your organization's backup and recovery strategy. @@ -161,9 +160,8 @@ This will likely result in higher operational costs as the Catalog store maintai more references to associated Parquet files and the Parquet files persist for longer in the Object store. -{{% note %}} -If possible, we recommend using object versioning. -{{% /note %}} +> [!Note] +> If possible, we recommend using object versioning. The following example sets the garbage collector cutoffs to `100d`: diff --git a/content/influxdb3/clustered/write-data/best-practices/optimize-writes.md b/content/influxdb3/clustered/write-data/best-practices/optimize-writes.md index 04e704086..9e9dff460 100644 --- a/content/influxdb3/clustered/write-data/best-practices/optimize-writes.md +++ b/content/influxdb3/clustered/write-data/best-practices/optimize-writes.md @@ -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/clustered/write-data/use-telegraf/) -- [InfluxDB client libraries](/influxdb3/clustered/reference/client-libraries/) -{{% /note %}} +> [!Note] +> The following tools write to InfluxDB and employ _most_ write optimizations by default: +> +> - [Telegraf](/influxdb3/clustered/write-data/use-telegraf/) +> - [InfluxDB client libraries](/influxdb3/clustered/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 diff --git a/content/influxdb3/clustered/write-data/best-practices/schema-design.md b/content/influxdb3/clustered/write-data/best-practices/schema-design.md index c346b61e6..b2ac12672 100644 --- a/content/influxdb3/clustered/write-data/best-practices/schema-design.md +++ b/content/influxdb3/clustered/write-data/best-practices/schema-design.md @@ -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 %}}. @@ -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. --- diff --git a/content/influxdb3/clustered/write-data/use-telegraf/configure/_index.md b/content/influxdb3/clustered/write-data/use-telegraf/configure/_index.md index 38118e586..2489bfa6b 100644 --- a/content/influxdb3/clustered/write-data/use-telegraf/configure/_index.md +++ b/content/influxdb3/clustered/write-data/use-telegraf/configure/_index.md @@ -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/clustered/write-data/use-telegraf#requirements) -for using Telegraf with {{< product-name >}}._ -{{% /note %}} +> [!Note] +> _View the [requirements](/influxdb3/clustered/write-data/use-telegraf#requirements) +> for using Telegraf with {{< product-name >}}._ @@ -112,12 +111,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 diff --git a/content/shared/influxdb3-query-guides/execute-queries/influxdb-v1-api.md b/content/shared/influxdb3-query-guides/execute-queries/influxdb-v1-api.md index bc04a8fef..ddfa0a523 100644 --- a/content/shared/influxdb3-query-guides/execute-queries/influxdb-v1-api.md +++ b/content/shared/influxdb3-query-guides/execute-queries/influxdb-v1-api.md @@ -5,14 +5,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/version/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/version/reference/influxql/feature-support/). Use the v1 `/query` endpoint and the `GET` request method to query data with InfluxQL: diff --git a/content/shared/influxdb3-query-guides/influxql/aggregate-select.md b/content/shared/influxdb3-query-guides/influxql/aggregate-select.md index 79493e0dd..6e4d72836 100644 --- a/content/shared/influxdb3-query-guides/influxql/aggregate-select.md +++ b/content/shared/influxdb3-query-guides/influxql/aggregate-select.md @@ -12,10 +12,9 @@ An InfluxQL query that aggregates data includes the following clauses: value outside specified thresholds. - `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: diff --git a/content/shared/influxdb3-query-guides/influxql/basic-query.md b/content/shared/influxdb3-query-guides/influxql/basic-query.md index f44441c0d..223f25a0a 100644 --- a/content/shared/influxdb3-query-guides/influxql/basic-query.md +++ b/content/shared/influxdb3-query-guides/influxql/basic-query.md @@ -164,10 +164,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 @@ -222,9 +221,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/version/reference/influxql/#identifiers). When -[aliasing columns in **SQL**](/influxdb3/version/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/version/reference/influxql/#identifiers). When +> [aliasing columns in **SQL**](/influxdb3/version/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. diff --git a/content/shared/influxdb3-query-guides/influxql/explore-schema.md b/content/shared/influxdb3-query-guides/influxql/explore-schema.md index 7685878b4..bd065ce83 100644 --- a/content/shared/influxdb3-query-guides/influxql/explore-schema.md +++ b/content/shared/influxdb3-query-guides/influxql/explore-schema.md @@ -200,20 +200,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" %}} diff --git a/content/shared/influxdb3-query-guides/influxql/parameterized-queries.md b/content/shared/influxdb3-query-guides/influxql/parameterized-queries.md index bc2279218..f8a7a81f3 100644 --- a/content/shared/influxdb3-query-guides/influxql/parameterized-queries.md +++ b/content/shared/influxdb3-query-guides/influxql/parameterized-queries.md @@ -7,12 +7,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. @@ -27,17 +26,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 @@ -127,15 +124,13 @@ 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/version/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/version/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 {{< influxdb3/home-sample-link >}}. +> To run the example queries and return results, +> [write the sample data](/influxdb3/version/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: @@ -185,15 +180,13 @@ AND room = 'Kitchen' ## Execute parameterized InfluxQL queries -{{% note %}} -#### Sample data - -The following examples use the -[Get started home sensor data](/influxdb3/version/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/version/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 {{< influxdb3/home-sample-link >}}. +> To run the example queries and return results, +> [write the sample data](/influxdb3/version/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 diff --git a/content/shared/influxdb3-query-guides/influxql/troubleshoot.md b/content/shared/influxdb3-query-guides/influxql/troubleshoot.md index d7a1b7436..92a72cba7 100644 --- a/content/shared/influxdb3-query-guides/influxql/troubleshoot.md +++ b/content/shared/influxdb3-query-guides/influxql/troubleshoot.md @@ -139,12 +139,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/version/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/version/reference/influxql/#keywords) +> as identifiers. ```sql SELECT duration FROM runs diff --git a/content/shared/influxdb3-query-guides/sql/aggregate-select.md b/content/shared/influxdb3-query-guides/sql/aggregate-select.md index 1db4da3c1..c03652845 100644 --- a/content/shared/influxdb3-query-guides/sql/aggregate-select.md +++ b/content/shared/influxdb3-query-guides/sql/aggregate-select.md @@ -13,10 +13,9 @@ An SQL query that aggregates data includes the following clauses: - `GROUP BY`: Group data that have the same values for specified columns and expressions (for example, an aggregate function result). -{{% note %}} -For simplicity, the verb, **"aggregate,"** in this guide refers to applying -both aggregate and selector functions to a dataset. -{{% /note %}} +> [!Note] +> For simplicity, the verb, **"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: diff --git a/content/shared/influxdb3-query-guides/sql/basic-query.md b/content/shared/influxdb3-query-guides/sql/basic-query.md index be4af1e2d..342e387fe 100644 --- a/content/shared/influxdb3-query-guides/sql/basic-query.md +++ b/content/shared/influxdb3-query-guides/sql/basic-query.md @@ -123,13 +123,12 @@ To query data using a time zone offset, use the [`AT TIME ZONE` operator](/influxdb3/version/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 @@ -150,10 +149,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 diff --git a/content/shared/influxdb3-query-guides/sql/cast-types.md b/content/shared/influxdb3-query-guides/sql/cast-types.md index 5a11f47b0..892ec19c6 100644 --- a/content/shared/influxdb3-query-guides/sql/cast-types.md +++ b/content/shared/influxdb3-query-guides/sql/cast-types.md @@ -284,15 +284,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/version/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/version/reference/sql/functions/time-and-date/> #to_timestamp_nanos) +> function. +> +> {{< code-tabs-wrapper >}} {{% code-tabs %}} [:: shorthand](#) [CAST()](#) @@ -314,7 +314,6 @@ to_timestamp_nanos(1704067200000000000) ``` {{% /code-tab-content %}} {{< /code-tabs-wrapper >}} -{{% /note %}} ### Timestamp functions diff --git a/content/shared/influxdb3-query-guides/sql/parameterized-queries.md b/content/shared/influxdb3-query-guides/sql/parameterized-queries.md index 07efb64a8..2ebdfd4b1 100644 --- a/content/shared/influxdb3-query-guides/sql/parameterized-queries.md +++ b/content/shared/influxdb3-query-guides/sql/parameterized-queries.md @@ -7,12 +7,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. @@ -27,17 +26,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 @@ -127,15 +124,13 @@ 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/version/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/version/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 {{< influxdb3/home-sample-link >}}. +> To run the example queries and return results, +> [write the sample data](/influxdb3/version/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: @@ -185,15 +180,13 @@ AND room = 'Kitchen' ## Execute parameterized SQL queries -{{% note %}} -#### Sample data - -The following examples use the -[Get started home sensor data](/influxdb3/version/reference/sample-data/#get-started-home-sensor-data). -To run the example queries and return results, -[write the sample data](/influxdb3/version/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 {{< influxdb3/home-sample-link >}}. +> To run the example queries and return results, +> [write the sample data](/influxdb3/version/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 diff --git a/content/shared/influxdb3-visualize/grafana.md b/content/shared/influxdb3-visualize/grafana.md index eb21b532c..0cb4321c6 100644 --- a/content/shared/influxdb3-visualize/grafana.md +++ b/content/shared/influxdb3-visualize/grafana.md @@ -131,10 +131,9 @@ use Grafana to build, run, and inspect queries against {{< product-name >}}. {{% tab-content %}} -{{% note %}} -{{% sql/sql-schema-intro %}} -To learn more, see [Query Data](/influxdb3/version/query-data/sql/). -{{% /note %}} +> [!Note] +> {{% sql/sql-schema-intro %}} +> To learn more, see [Query Data](/influxdb3/version/query-data/sql/). 1. Click **Explore**. 2. In the dropdown, select the saved InfluxDB data source to query. diff --git a/content/shared/influxdb3-visualize/tableau.md b/content/shared/influxdb3-visualize/tableau.md index ceff8dc56..7230a87a0 100644 --- a/content/shared/influxdb3-visualize/tableau.md +++ b/content/shared/influxdb3-visualize/tableau.md @@ -55,9 +55,11 @@ the **Flight SQL JDBC driver**. - **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)._ diff --git a/content/shared/v3-core-get-started/_index.md b/content/shared/v3-core-get-started/_index.md index ab3e024ac..7658079dc 100644 --- a/content/shared/v3-core-get-started/_index.md +++ b/content/shared/v3-core-get-started/_index.md @@ -633,11 +633,10 @@ To leverage the LVC, call it using the `last_cache()` function in your query--fo influxdb3 query --database=servers "SELECT * FROM last_cache('cpu', 'cpuCache') WHERE host = 'Bravo;" ``` -{{% note %}} -#### Only works with SQL - -The Last values cache only works with SQL, not InfluxQL; SQL is the default language. -{{% /note %}} +> [!Note] +> #### Only works with SQL +> +> The Last values cache only works with SQL, not InfluxQL; SQL is the default language. #### Deleting a Last values cache diff --git a/content/shared/v3-distributed-admin-custom-partitions/_index.md b/content/shared/v3-distributed-admin-custom-partitions/_index.md index cfd360979..e3f75a40e 100644 --- a/content/shared/v3-distributed-admin-custom-partitions/_index.md +++ b/content/shared/v3-distributed-admin-custom-partitions/_index.md @@ -43,10 +43,9 @@ Using custom partitioning may increase the load on other parts of the [InfluxDB 3 storage engine](/influxdb/version/reference/internals/storage-engine/), but you can scale each part individually to address the added load. -{{% note %}} -_The weight of these disadvantages depends upon the cardinality of - tags and the specificity of time intervals used for partitioning._ -{{% /note %}} +> [!Note] +> _The weight of these disadvantages depends upon the cardinality of +> tags and the specificity of time intervals used for partitioning._ - **Increased load on the [Ingester](/influxdb/version/reference/internals/storage-engine/#ingester)** as it groups data into smaller partitions and files. diff --git a/content/shared/v3-distributed-admin-custom-partitions/best-practices.md b/content/shared/v3-distributed-admin-custom-partitions/best-practices.md index d66afe901..23cec495a 100644 --- a/content/shared/v3-distributed-admin-custom-partitions/best-practices.md +++ b/content/shared/v3-distributed-admin-custom-partitions/best-practices.md @@ -15,16 +15,15 @@ For example, if you often query data related to a specific ID, partitioning by the tag that stores the ID helps the InfluxDB query engine to more quickly identify what partitions contain the relevant data. -{{% note %}} - -#### Use tag buckets for high-cardinality tags - -Partitioning using distinct values of tags with many (10K+) unique values can -actually hurt query performance as partitions are created for each unique tag value. -Instead, use [tag buckets](/influxdb/version/admin/custom-partitions/partition-templates/#tag-bucket-part-templates) -to partition by high-cardinality tags. -This method of partitioning groups tag values into "buckets" and partitions by bucket. -{{% /note %}} +> [!Note] +> +> #### Use tag buckets for high-cardinality tags +> +> Partitioning using distinct values of tags with many (10K+) unique values can +> actually hurt query performance as partitions are created for each unique tag value. +> Instead, use [tag buckets](/influxdb/version/admin/custom-partitions/partition-templates/#tag-bucket-part-templates) +> to partition by high-cardinality tags. +> This method of partitioning groups tag values into "buckets" and partitions by bucket. ## Only partition by tags that _always_ have a value diff --git a/content/shared/v3-distributed-admin-custom-partitions/define-custom-partitions.md b/content/shared/v3-distributed-admin-custom-partitions/define-custom-partitions.md index 1676d2656..c09edf5da 100644 --- a/content/shared/v3-distributed-admin-custom-partitions/define-custom-partitions.md +++ b/content/shared/v3-distributed-admin-custom-partitions/define-custom-partitions.md @@ -14,13 +14,12 @@ table. - [Create a table with a custom partition template](#create-a-table-with-a-custom-partition-template) - [Example partition templates](#example-partition-templates) -{{% warn %}} - -#### Partition templates can only be applied on create - -You can only apply a partition template when creating a database or table. -You can't update a partition template on an existing resource. -{{% /warn %}} +> [!Warning] +> +> #### Partition templates can only be applied on create +> +> You can only apply a partition template when creating a database or table. +> You can't update a partition template on an existing resource. Use the following command flags to identify [partition template parts](/influxdb/version/admin/custom-partitions/partition-templates/#tag-part-templates): @@ -35,21 +34,19 @@ Use the following command flags to identify string that specifies the time format in the partition template and determines the time interval to partition by. -{{% note %}} -A partition template can include up to 7 total tag and tag bucket parts -and only 1 time part. -{{% /note %}} +> [!Note] +> A partition template can include up to 7 total tag and tag bucket parts +> and only 1 time part. +> +> _View [partition template part restrictions](/influxdb/version/admin/custom-partitions/partition-templates/#restrictions)._ -_View [partition template part restrictions](/influxdb/version/admin/custom-partitions/partition-templates/#restrictions)._ - -{{% note %}} -#### Always provide a time format when using custom partitioning - -When defining a custom partition template for your database or table using any -of the `influxctl` `--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 %}} +> [!Important] +> #### Always provide a time format when using custom partitioning +> +> When defining a custom partition template for your database or table using any +> of the `influxctl` `--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. ## Create a database with a custom partition template diff --git a/content/shared/v3-distributed-admin-custom-partitions/partition-templates.md b/content/shared/v3-distributed-admin-custom-partitions/partition-templates.md index 3fa748d40..70c32ec05 100644 --- a/content/shared/v3-distributed-admin-custom-partitions/partition-templates.md +++ b/content/shared/v3-distributed-admin-custom-partitions/partition-templates.md @@ -14,10 +14,9 @@ Three types of template parts exist: to partition data by. The smallest unit of time included in the time part template is the interval used to partition data. -{{% note %}} -A partition template must include 1 [time part](#time-part-templates) -and can include up to 7 total [tag](#tag-part-templates) and [tag bucket](#tag-bucket-part-templates) parts. -{{% /note %}} +> [!Note] +> A partition template must include 1 [time part](#time-part-templates) +> and can include up to 7 total [tag](#tag-part-templates) and [tag bucket](#tag-bucket-part-templates) parts. - [Restrictions](#restrictions) @@ -91,10 +90,9 @@ each partition. **Supported number of tag buckets**: 1-1,000 -{{% note %}} -Tag buckets should be used to partition by high cardinality tags or tags with an -unknown number of distinct values. -{{% /note %}} +> [!Note] +> Tag buckets should be used to partition by high cardinality tags or tags with an +> unknown number of distinct values. A partition template may include a given tag key only once in template parts that operate on tags (tag value and tag bucket)--for example: diff --git a/content/shared/v3-distributed-admin-custom-partitions/view-partitions.md b/content/shared/v3-distributed-admin-custom-partitions/view-partitions.md index d3e4e311c..927aba647 100644 --- a/content/shared/v3-distributed-admin-custom-partitions/view-partitions.md +++ b/content/shared/v3-distributed-admin-custom-partitions/view-partitions.md @@ -6,25 +6,23 @@ are working as intended. - [Query partition information from system tables](#query-partition-information-from-system-tables) - [Partition-related queries](#partition-related-queries) -{{% warn %}} -#### Querying system tables may impact overall cluster performance - -Partition information is stored in InfluxDB 3 system tables. -Querying system tables may impact the overall write and query performance of -your {{< product-name omit=" Clustered" >}} cluster. - - - -#### 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 24, 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). - - - -{{% /warn %}} +> [!Warning] +> #### Querying system tables may impact overall cluster performance +> +> Partition information is stored in InfluxDB 3 system tables. +> Querying system tables may impact the overall write and query performance of +> your {{< product-name omit=" Clustered" >}} cluster. +> +> +> +> #### 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 24, 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). +> +> ## Query partition information from system tables @@ -105,11 +103,10 @@ SELECT * FROM system.tables WHERE table_name = 'TABLE_NAME' | :--------- | :----------------------------------------------------------------------------------------- | | weather | `{"parts":[{"timeFormat":"%Y-%m-%d"},{"bucket":{"tagName":"location","numBuckets":250}}]}` | -{{% note %}} -If a table doesn't include a partition template in the output of this command, -the table uses the default (1 day) partition strategy and doesn't partition -by tags or tag buckets. -{{% /note %}} +> [!Note] +> If a table doesn't include a partition template in the output of this command, +> the table uses the default (1 day) partition strategy and doesn't partition +> by tags or tag buckets. ### View all partitions for a table diff --git a/content/shared/v3-enterprise-get-started/_index.md b/content/shared/v3-enterprise-get-started/_index.md index 8be1bb216..4ec3d5d8d 100644 --- a/content/shared/v3-enterprise-get-started/_index.md +++ b/content/shared/v3-enterprise-get-started/_index.md @@ -617,11 +617,10 @@ To leverage the LVC, call it using the `last_cache()` function in your query--fo influxdb3 query --database=servers "SELECT * FROM last_cache('cpu', 'cpuCache') WHERE host = 'Bravo;" ``` -{{% note %}} -#### Only works with SQL - -The Last values cache only works with SQL, not InfluxQL; SQL is the default language. -{{% /note %}} +> [!Note] +> #### Only works with SQL +> +> The Last values cache only works with SQL, not InfluxQL; SQL is the default language. #### Deleting a Last values cache diff --git a/content/shared/v3-line-protocol.md b/content/shared/v3-line-protocol.md index 63e0c94a2..0f197053d 100644 --- a/content/shared/v3-line-protocol.md +++ b/content/shared/v3-line-protocol.md @@ -22,9 +22,8 @@ myTable,tag1=value1,tag2=value2 fieldKey="fieldValue" 1556813561098000000 Lines separated by the newline character `\n` represent a single point in InfluxDB. Line protocol is whitespace-sensitive. -{{% note %}} -Line protocol does not support the newline character `\n` in tag or field values. -{{% /note %}} +> [!Note] +> Line protocol does not support the newline character `\n` in tag or field values. ## Elements of line protocol @@ -67,13 +66,12 @@ Field keys are subject to [naming restrictions](#naming-restrictions)._ _**Key data type:** [String](#string)_ _**Value data type:** [Float](#float) | [Integer](#integer) | [UInteger](#uinteger) | [String](#string) | [Boolean](#boolean)_ -{{% note %}} -_Always double quote string field values. More on quotes [below](#quotes)._ - -```sh -tableName fieldKey="field string value" 1556813561098000000 -``` -{{% /note %}} +> [!Note] +> _Always double quote string field values. More on quotes [below](#quotes)._ +> +> ```sh +> tableName fieldKey="field string value" 1556813561098000000 +> ``` ### Timestamp @@ -84,14 +82,13 @@ If no timestamp is provided, InfluxDB uses the system time (UTC) of its host mac _**Data type:** [Unix timestamp](#unix-timestamp)_ -{{% note %}} -#### Important notes about timestamps - -- To ensure a data point includes the time a metric is observed (not received by InfluxDB), - include the timestamp. -- If your timestamps are not in nanoseconds, specify the precision of your timestamps - when writing the data to {{< product-name >}}. -{{% /note %}} +> [!Note] +> #### Important notes about timestamps +> +> - To ensure a data point includes the time a metric is observed (not received by InfluxDB), +> include the timestamp. +> - If your timestamps are not in nanoseconds, specify the precision of your timestamps +> when writing the data to {{< product-name >}}. ### Whitespace @@ -182,10 +179,9 @@ myTable fieldKey=TRUE myTable fieldKey=FALSE ``` -{{% note %}} -Do not quote boolean field values. -Quoted field values are interpreted as strings. -{{% /note %}} +> [!Note] +> Do not quote boolean field values. +> Quoted field values are interpreted as strings. ### Unix timestamp