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

Merge branch 'master' into docs/v3/processing-engine

pull/5940/head
Jameelah Mercer 2025-04-10 20:01:53 -07:00 committed by GitHub
parent 58bed0eb2a 1e9179c050
commit 63d3946dbf
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
197 changed files with 6942 additions and 1973 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
.vscode/settings.json vendored
View File

@ -1,12 +1,12 @@
{
"commentAnchors.tags.anchors":
{ "SOURCE": {
"scope": "file",
"behavior": "link",
"iconColor": "#FF0000",
"highlightColor": "#FF0000",
"style": "bold"
}},
"commentAnchors.tags.anchors":
{ "SOURCE": {
"scope": "file",
"behavior": "link",
"iconColor": "#FF0000",
"highlightColor": "#FF0000",
"style": "bold"
}},
"commentAnchors.workspace.matchFiles": "**/*.{md,ini,json,yaml,yml}",
"commentAnchors.workspace.enabled": true,
"yaml.schemas": {
@ -15,10 +15,17 @@
"vale.valeCLI.config": "${workspaceFolder}/.vale.ini",
"vale.valeCLI.minAlertLevel": "warning",
"github.copilot.chat.codeGeneration.useInstructionFiles": true,
"github.copilot.chat.codeGeneration.instructionFiles": [
"github.copilot.chat.codeGeneration.instructions": [
{
"path": "${workspaceFolder}/.github/copilot-instructions.md",
"enabled": true
"file": "${workspaceFolder}/.github/copilot-instructions.md",
}
],
"github.copilot.chat.pullRequestDescriptionGeneration.instructions": [
{
"file": "${workspaceFolder}/.github/copilot-instructions.md",
}
],
"cSpell.words": [
"influxctl"
]
}

2
api-docs/influxdb3/core/v3/ref.yml
View File

@ -43,7 +43,7 @@ security:
tags:
- name: Authentication
description: |
During the initial Alpha phase, InfluxDB 3 Core does not require authentication.
During the Beta phase, InfluxDB 3 Core does not require authentication.
x-traitTag: true
- name: Compatibility endpoints
description: |

2
api-docs/influxdb3/enterprise/v3/ref.yml
View File

@ -43,7 +43,7 @@ security:
tags:
- name: Authentication
description: |
During the initial Alpha phase, InfluxDB 3 Enterprise does not require authentication.
During the Beta phase, InfluxDB 3 Enterprise does not require authentication.
x-traitTag: true
- name: Compatibility endpoints
description: |

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

@ -29,17 +29,21 @@ 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.
or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/)
to delete a database from your {{< product-name omit=" Clustered" >}} cluster.
> [!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.
>
> #### Wait before writing to a new database with the same name
>
> After deleting a database from your {{% product-name omit=" Clustered" %}}
> cluster, you can reuse the name to create a new database, but **wait two to
> three minutes** after deleting the previous database before writing to the new
> database to allow write caches to clear.
{{< tabs-wrapper >}}
{{% tabs %}}
@ -50,13 +54,15 @@ or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to crea
<!------------------------------- BEGIN INFLUXCTL ----------------------------->
1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster.
1. If you haven't already,
[download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles)
for your cluster.
2. In your terminal, run the `influxctl database delete` command and provide the following:
2. In your terminal, run the `influxctl database delete` command and provide the following:
- Name of the database to delete
- The name of the database to delete
3. Confirm that you want to delete the database.
3. Confirm that you want to delete the database.
{{% code-placeholders "DATABASE_NAME" %}}
@ -73,23 +79,26 @@ influxctl database delete DATABASE_NAME
_This example uses [cURL](https://curl.se/) to send a Management HTTP API request, but you can use any HTTP client._
1. If you haven't already, follow the instructions to [install cURL](https://everything.curl.dev/install/index.html) for your system.
2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint:
1. If you haven't already, follow the instructions to [install cURL](https://everything.curl.dev/install/index.html) for your system.
2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint:
{{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases/DATABASE_NAME" method="delete" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/DeleteClusterDatabase" %}}
{{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/databases/DATABASE_NAME" method="delete" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/DeleteClusterDatabase" %}}
In the URL, provide the following:
In the URL, provide the following:
- `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_.
- `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_.
- `DATABASE_NAME`: The name of the [database](/influxdb3/cloud-dedicated/admin/databases/) that you want to delete _(see how to [list databases](/influxdb3/cloud-dedicated/admin/databases/list/))_.
- `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster)
that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_.
- `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster)
that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_.
- `DATABASE_NAME`: The name of the [database](/influxdb3/cloud-dedicated/admin/databases/)
that you want to delete _(see how to [list databases](/influxdb3/cloud-dedicated/admin/databases/list/))_.
Provide the following request headers:
Provide the following request headers:
- `Accept: application/json` to ensure the response body is JSON content
- `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_.
- `Accept: application/json` to ensure the response body is JSON content
- `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_.
Specify the `DELETE` request method.
Specify the `DELETE` request method.
The following example shows how to use the Management API to delete a database:

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

@ -16,6 +16,7 @@ list_code_example: |
--read-database DATABASE1_NAME \
--read-database DATABASE2_NAME \
--write-database DATABASE2_NAME \
--expires-at 2030-01-01T00:00:00Z \
"Read-only on DATABASE1_NAME, Read/write on DATABASE2_NAME"
```
@ -37,7 +38,9 @@ list_code_example: |
"action": "read",
"resource": "DATABASE_NAME"
}
]
],
"expirationType": "datetime",
"expiresAt": "2030-01-01T00:00:00Z"
}'
```
aliases:
@ -60,6 +63,7 @@ or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/) to crea
{{% tab-content %}}
<!------------------------------- BEGIN INFLUXCTL ----------------------------->
Use the [`influxctl token create` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/)
to create a token that grants access to databases in your {{% product-name omit=" Clustered" %}} cluster.
@ -74,22 +78,31 @@ to create a token that grants access to databases in your {{% product-name omit=
permissions to all databases. Enclose wildcards in single or double
quotes--for example: `'*'` or `"*"`.
- _Optional_: the `--expires-at` flag with an RFC3339 date string that defines the
token expiration date and time--for example, `{{< datetime/current-date offset=1 >}}`.
If an expiration isn't set, the token does not expire until revoked.
- Token description
{{% code-placeholders "DATABASE_NAME|TOKEN_DESCRIPTION" %}}
{{% code-placeholders "DATABASE_NAME|TOKEN_DESCRIPTION|RFC3339_TIMESTAMP" %}}
```sh
influxctl token create \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
"Read/write token for DATABASE_NAME"
--expires-at RFC3339_TIMESTAMP \
"Read/write token for DATABASE_NAME"
```
{{% /code-placeholders %}}
Replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/)
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
your {{% product-name %}} [database](/influxdb3/cloud-dedicated/admin/databases/)
- {{% code-placeholder-key %}}`RFC3339_TIMESTAMP`{{% /code-placeholder-key %}}:
the token expiration date and time in
[RFC3339 format](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp).
The output is the token ID and the token string.
**This is the only time the token string is available in plain text.**
@ -100,28 +113,34 @@ The output is the token ID and the token string.
<!------------------------------- BEGIN cURL ---------------------------------->
_This example uses [cURL](https://curl.se/) to send a Management HTTP API request, but you can use any HTTP client._
1. If you haven't already, follow the instructions to [install cURL](https://everything.curl.dev/install/index.html) for your system.
2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint:
1. If you haven't already, follow the instructions to [install cURL](https://everything.curl.dev/install/index.html) for your system.
2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint:
{{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens" method="post" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/CreateDatabaseToken" %}}
{{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens" method="post" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/CreateDatabaseToken" %}}
In the URL, provide the following credentials:
In the URL, provide the following credentials:
- `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_.
- `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_.
- `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_.
- `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_.
Provide the following request headers:
Provide the following request headers:
- `Accept: application/json` to ensure the response body is JSON content
- `Content-Type: application/json` to indicate the request body is JSON content
- `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_.
- `Accept: application/json` to ensure the response body is JSON content
- `Content-Type: application/json` to indicate the request body is JSON content
- `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_.
In the request body, provide the following parameters:
In the request body, provide the following parameters:
- `permissions`: an array of token [permissions](/influxdb3/cloud-dedicated/api/management/#operation/CreateDatabaseToken) (read or write) objects:
- `"action"`: Specify `read` or `write` permission to the database.
- `"resource"`: Specify the database name.
- `description`: Provide a description of the token.
- `expirationType`: Specify `datetime` or `noExpiration` token expiration type.
- `expiresAt`: Specify the token expiration date and time in
[RFC3339 format](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp).
> [!Note]
> `expiresAt` is only required when `expirationType` is `datetime`.
The following example shows how to use the Management API to create a database token:
@ -144,7 +163,9 @@ curl \
"action": "read",
"resource": "DATABASE_NAME"
}
]
],
"expirationType": "datetime",
"expiresAt": "2030-01-01T00:00:00Z"
}'
```
@ -195,6 +216,7 @@ The Management API outputs JSON format in the response body.
- [Create a token with read-only access to a database](#create-a-token-with-read-only-access-to-a-database)
- [Create a token with read-only access to multiple databases](#create-a-token-with-read-only-access-to-multiple-databases)
- [Create a token with mixed permissions to multiple databases](#create-a-token-with-mixed-permissions-to-multiple-databases)
- [Create a token that expires in seven days](#create-a-token-that-expires-in-seven-days)
In the examples below, replace the following:
@ -241,7 +263,8 @@ curl \
"action": "read",
"resource": "DATABASE_NAME"
}
]
],
"expirationType": "noExpiration"
}'
```
@ -435,3 +458,124 @@ curl \
{{% /code-placeholders %}}
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
### Create a token that expires in seven days
{{< tabs-wrapper >}}
{{% tabs "small" %}}
[Linux](#)
[macOS](#)
{{% /tabs %}}
{{% tab-content %}}
{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[influxctl](#)
[Management API](#)
{{% /code-tabs %}}
{{% code-tab-content %}}
{{% code-placeholders "DATABASE_NAME" %}}
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
--expires-at $(date -d "+7 days" +"%Y-%m-%dT%H:%M:%S%z") \
"Read/write token for DATABASE_NAME with 7d expiration"
```
{{% /code-placeholders %}}
{{% /code-tab-content %}}
{{% code-tab-content %}}
{{% code-placeholders "DATABASE_NAME" %}}
```sh
curl \
--location "https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens" \
--header "Accept: application/json" \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer MANAGEMENT_TOKEN" \
--data "{
\"description\": \"Read/write token for DATABASE_NAME\",
\"permissions\": [
{
\"action\": \"write\",
\"resource\": \"DATABASE_NAME\"
},
{
\"action\": \"read\",
\"resource\": \"DATABASE_NAME\"
}
],
\"expirationType\": \"datetime\",
\"expiresAt:\" \"$(date -d "+7 days" +"%Y-%m-%dT%H:%M:%S%z")\"
}"
```
{{% /code-placeholders %}}
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
{{% /tab-content %}}
{{% tab-content %}}
{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[influxctl](#)
[Management API](#)
{{% /code-tabs %}}
{{% code-tab-content %}}
{{% code-placeholders "DATABASE_NAME" %}}
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
--expires-at $(gdate -d "+7 days" +"%Y-%m-%dT%H:%M:%S%z") \
"Read/write token for DATABASE_NAME with 7d expiration"
```
{{% /code-placeholders %}}
{{% /code-tab-content %}}
{{% code-tab-content %}}
{{% code-placeholders "DATABASE_NAME" %}}
```sh
curl \
--location "https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens" \
--header "Accept: application/json" \
--header 'Content-Type: application/json' \
--header "Authorization: Bearer MANAGEMENT_TOKEN" \
--data "{
\"description\": \"Read/write token for DATABASE_NAME\",
\"permissions\": [
{
\"action\": \"write\",
\"resource\": \"DATABASE_NAME\"
},
{
\"action\": \"read\",
\"resource\": \"DATABASE_NAME\"
}
],
\"expirationType\": \"datetime\",
\"expiresAt:\" \"$(gdate -d "+7 days" +"%Y-%m-%dT%H:%M:%S%z")\"
}"
```
{{% /code-placeholders %}}
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
{{% /tab-content %}}
{{< /tabs-wrapper >}}

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

@ -1,131 +0,0 @@
---
title: Delete a database token
description: >
Use the [`influxctl token delete` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/delete/)
or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/)
to delete a database token from your InfluxDB Cloud Dedicated cluster and revoke all
permissions associated with the token.
Provide the ID of the database token you want to delete.
menu:
influxdb3_cloud_dedicated:
parent: Database tokens
weight: 203
list_code_example: |
##### CLI
```sh
influxctl token delete <TOKEN_ID>
```
##### API
```sh
curl \
--location "https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens/TOKEN_ID" \
--request DELETE \
--header "Accept: application/json" \
--header "Authorization: Bearer $MANAGEMENT_TOKEN" \
```
aliases:
- /influxdb3/cloud-dedicated/admin/tokens/delete/
related:
- /influxdb3/cloud-dedicated/reference/cli/influxctl/token/delete/
- /influxdb3/cloud-dedicated/reference/api/
---
Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/)
or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/)
to delete a database token from your {{< product-name omit=" Clustered" >}} cluster.
{{< tabs-wrapper >}}
{{% tabs %}}
[influxctl](#)
[Management API](#)
{{% /tabs %}}
{{% tab-content %}}
<!------------------------------- BEGIN INFLUXCTL ----------------------------->
Use the [`influxctl token delete` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/delete/)
to delete a database token from your {{% product-name omit="Clustered" %}} cluster and revoke
all permissions associated with the token.
1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then [configure an `influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles) for your cluster.
2. To list token IDs, run the [`influxctl token list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/list) in your terminal.
```sh
influxctl token list
```
Copy the **token ID** of the token you want to delete.
3. Run the `influxctl token delete` command and provide the following:
- Token ID to delete
4. Confirm that you want to delete the token.
{{% code-placeholders "TOKEN_ID" %}}
```sh
influxctl token delete TOKEN_ID
```
{{% /code-placeholders %}}
<!-------------------------------- END INFLUXCTL ------------------------------>
{{% /tab-content %}}
{{% tab-content %}}
<!------------------------------- BEGIN cURL ---------------------------------->
_This example uses [cURL](https://curl.se/) to send a Management HTTP API request, but you can use any HTTP client._
1. If you haven't already, follow the instructions to [install cURL](https://everything.curl.dev/install/index.html) for your system.
2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint:
{{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens/TOKEN_ID" method="delete" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/DeleteDatabaseToken" %}}
In the URL, provide the following:
- `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_.
- `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_.
- `TOKEN_ID`: The ID of the database [token](/influxdb3/cloud-dedicated/admin/tokens/database) that you want to delete _(see how to [list token details](/influxdb3/cloud-dedicated/admin/tokens/database/list/#detailed-output-in-json))_.
Provide the following request headers:
- `Accept: application/json` to ensure the response body is JSON content
- `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_.
Specify the `DELETE` request method.
The following example shows how to use the Management API to delete a database token and revoke all
permissions associated with the token:
{{% code-placeholders "TOKEN_ID|ACCOUNT_ID|CLUSTER_ID|MANAGEMENT_TOKEN" %}}
```sh
curl \
--location "https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens/TOKEN_ID" \
--request DELETE \
--header "Accept: application/json" \
--header "Authorization: Bearer $MANAGEMENT_TOKEN" \
```
{{% /code-placeholders %}}
Replace the following:
- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for
- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}: the ID of the {{% product-name %}} [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster) to create the database token for
- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}: a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for your {{% product-name %}} cluster
- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}: the ID of the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) to delete
<!------------------------------- END cURL ------------------------------------>
{{% /tab-content %}}
{{< /tabs-wrapper >}}
> [!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.

156
content/influxdb3/cloud-dedicated/admin/tokens/database/revoke.md Normal file
View File

@ -0,0 +1,156 @@
---
title: Revoke a database token
description: >
Use the [`influxctl token revoke` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/revoke/)
or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/)
to revoke a database token associated with your {{% product-name omit-" Clustered" %}}
cluster and remove all permissions associated with the token.
Provide the ID of the database token you want to revoke.
menu:
influxdb3_cloud_dedicated:
parent: Database tokens
weight: 203
list_code_example: |
##### CLI
```sh
influxctl token revoke <TOKEN_ID>
```
##### API
```sh
curl \
--location "https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens/TOKEN_ID" \
--request DELETE \
--header "Accept: application/json" \
--header "Authorization: Bearer $MANAGEMENT_TOKEN" \
```
aliases:
- /influxdb3/cloud-dedicated/admin/tokens/delete/
- /influxdb3/cloud-dedicated/admin/tokens/database/delete/
related:
- /influxdb3/cloud-dedicated/reference/cli/influxctl/token/revoke/
- /influxdb3/cloud-dedicated/reference/api/
---
Use the [`influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/)
or the [Management HTTP API](/influxdb3/cloud-dedicated/api/management/)
to revoke a database token associated with your
{{< product-name omit=" Clustered" >}} cluster.
{{< tabs-wrapper >}}
{{% tabs %}}
[influxctl](#)
[Management API](#)
{{% /tabs %}}
{{% tab-content %}}
<!------------------------------- BEGIN INFLUXCTL ----------------------------->
Use the [`influxctl token revoke` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/revoke/)
to revoke a database token and remove all permissions associated with the token.
1. If you haven't already,
[download and install the `influxctl` CLI](/influxdb3/cloud-dedicated/reference/cli/influxctl/#download-and-install-influxctl), and then
[configure an `influxctl` connection profile](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles)
for your cluster.
2. To list token IDs, run the
[`influxctl token list` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/list)
in your terminal.
```sh
influxctl token list
```
Copy the **token ID** of the token you want to revoke.
3. Run the `influxctl token revoke` command and provide the following:
- Token ID to revoke
4. Confirm that you want to revoke the token.
{{% code-placeholders "TOKEN_ID" %}}
```sh
influxctl token revoke TOKEN_ID
```
{{% /code-placeholders %}}
<!-------------------------------- END INFLUXCTL ------------------------------>
{{% /tab-content %}}
{{% tab-content %}}
<!------------------------------- BEGIN cURL ---------------------------------->
_This example uses [cURL](https://curl.se/) to send a Management HTTP API request,
but you can use any HTTP client._
1. If you haven't already, follow the instructions to
[install cURL](https://everything.curl.dev/install/index.html) for your system.
2. In your terminal, use cURL to send a request to the following {{% product-name %}} endpoint:
{{% api-endpoint endpoint="https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens/TOKEN_ID" method="delete" api-ref="/influxdb3/cloud-dedicated/api/management/#operation/DeleteDatabaseToken" %}}
In the URL, provide the following:
- `ACCOUNT_ID`: The ID of the [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster)
that the cluster belongs to _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_.
- `CLUSTER_ID`: The ID of the [cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster)
that you want to manage _(see how to [list cluster details](/influxdb3/cloud-dedicated/admin/clusters/list/#detailed-output-in-json))_.
- `TOKEN_ID`: The ID of the database [token](/influxdb3/cloud-dedicated/admin/tokens/database)
that you want to revoke _(see how to [list token details](/influxdb3/cloud-dedicated/admin/tokens/database/list/#detailed-output-in-json))_.
Provide the following request headers:
- `Accept: application/json` to ensure the response body is JSON content
- `Authorization: Bearer` and a [Management API token](/influxdb3/cloud-dedicated/admin/tokens/management/)
for your cluster _(see how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for Management API requests)_.
Specify the `DELETE` request method.
The following example shows how to use the Management API to revoke a database
token and remove all permissions associated with the token:
{{% code-placeholders "TOKEN_ID|ACCOUNT_ID|CLUSTER_ID|MANAGEMENT_TOKEN" %}}
```sh
curl \
--location "https://console.influxdata.com/api/v0/accounts/ACCOUNT_ID/clusters/CLUSTER_ID/tokens/TOKEN_ID" \
--request DELETE \
--header "Accept: application/json" \
--header "Authorization: Bearer $MANAGEMENT_TOKEN" \
```
{{% /code-placeholders %}}
Replace the following:
- {{% code-placeholder-key %}}`ACCOUNT_ID`{{% /code-placeholder-key %}}:
the ID of the {{% product-name %}} [account](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster)
associated with the token you want to revoke
- {{% code-placeholder-key %}}`CLUSTER_ID`{{% /code-placeholder-key %}}:
the ID of the {{% product-name omit=" Clustered" %}}
[cluster](/influxdb3/cloud-dedicated/get-started/setup/#request-an-influxdb-cloud-dedicated-cluster)
associated with the token you want to revoke
- {{% code-placeholder-key %}}`MANAGEMENT TOKEN`{{% /code-placeholder-key %}}:
a [management token](/influxdb3/cloud-dedicated/admin/tokens/management/) for
your {{% product-name omit=" Clustered" %}} cluster
- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}: the ID of
the [database token](/influxdb3/cloud-dedicated/admin/tokens/database/) to revoke
<!------------------------------- END cURL ------------------------------------>
{{% /tab-content %}}
{{< /tabs-wrapper >}}
> [!Warning]
> #### Revoking a token is immediate and cannot be undone
>
> Revoking a database token is a destructive action that takes place immediately
> and cannot be undone.
>
> #### Rotate revoked tokens
>
> After revoking a database token, any clients using the revoked token need to
> be updated with a new database token to continue to interact with your
> {{% product-name omit=" Clustered" %}} cluster.

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

@ -69,17 +69,12 @@ Be sure to follow [partitioning best practices](/influxdb3/cloud-dedicated/admin
> Otherwise, InfluxDB omits time from the partition template and won't compact partitions.
> [!Warning]
> #### Cannot reuse deleted database names
>
> You cannot reuse the name of a deleted database when creating a new database.
> If you try to reuse the name, the API response status code
> is `400` and the `message` field contains the following:
>
> ```text
> 'iox_proxy.app.CreateDatabase failed to create database: \
> rpc error: code = AlreadyExists desc = A namespace with the
> name `<DATABASE_NAME>` already exists'
> ```
> #### Wait before writing to a new database with the same name as a deleted database
>
> After deleting a database from your {{% product-name omit=" Clustered" %}}
> cluster, you can reuse the name to create a new database, but **wait two to
> three minutes** after deleting the previous database before writing to the new
> database to allow write caches to clear.
## Usage

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

@ -9,8 +9,8 @@ menu:
weight: 301
---
The `influxctl database delete` command deletes a database from an InfluxDB
Cloud Dedicated cluster.
The `influxctl database delete` command deletes a database from an
{{< product-name omit=" Clustered" >}} cluster.
## Usage
@ -25,11 +25,13 @@ influxctl database delete [command options] [--force] <DATABASE_NAME> [<DATABASE
> #### 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.
>
> #### Wait before writing to a new database with the same name
>
> After deleting a database from your {{% product-name omit=" Clustered" %}}
> cluster, you can reuse the name to create a new database, but **wait two to
> three minutes** after deleting the previous database before writing to the new
> database to allow write caches to clear.
## Arguments

8
content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/_index.md
View File

@ -20,14 +20,14 @@ influxctl token [subcommand] [flags]
## Subcommands
| Subcommand | Description |
| :------------------------------------------------------------------------ | :---------------------------- |
| Subcommand | Description |
| :------------------------------------------------------------------------- | :---------------------------- |
| [create](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/) | Create a database token |
| [delete](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/delete/) | Delete a database token |
| [revoke](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/revoke/) | Revoke a database token |
| [get](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/get/) | Get information about a token |
| [list](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/list/) | List database tokens |
| [update](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/update/) | Update a database token |
| help, h | Output command help |
| help, h | Output command help |
## Flags

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

@ -10,25 +10,33 @@ weight: 301
---
The `influxctl token create` command creates a database token with specified
permissions to resources in an InfluxDB Cloud Dedicated cluster and outputs
the token string.
permissions to resources in an {{< product-name omit=" Clustered">}} cluster and
outputs the token string.
The `--read-database` and `--write-database` flags support the `*` wildcard
which grants read or write permissions to all databases. Enclose wildcards in
single or double quotes--for example: `'*'` or `"*"`.
The `--expires-at` flag specifies the date and time a token should expire.
Provide an [RFC3339 timestamp](/influxdb3/cloud-dedicated/reference/glossary/#rfc3339-timestamp).
> [!Important]
> If you don't specify a token expiration, the token never expires.
The `--format` flag lets you print the output in other formats.
The `json` format is available for programmatic parsing by other tooling.
Default: `table`.
## Notable behaviors
- InfluxDB might take some time--from a few seconds to a few minutes--to activate and synchronize new tokens.
If a new database token doesn't immediately work (you receive a `401 Unauthorized` error) for querying or writing, wait and then try again.
- InfluxDB might take some time--from a few seconds to a few minutes--to
activate and synchronize new tokens. 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.
@ -36,10 +44,13 @@ If a new database token doesn't immediately work (you receive a `401 Unauthorize
## Usage
```sh
<!-- pytest.mark.skip -->
```bash
influxctl token create \
[--read-database=<DATABASE_NAME>] \
[--write-database=<DATABASE_NAME>] \
[--expires-at=<RFC3339_DATE>] \
<TOKEN_DESCRIPTION>
```
@ -53,6 +64,7 @@ influxctl token create \
| Flag | | Description |
| :--- | :----------------- | :--------------------------------------------------- |
| | `--expires-at` | Token expiration date and time in RFC3339 format |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| | `--read-database` | Grant read permissions to a database _(Repeatable)_ |
| | `--write-database` | Grant write permissions to a database _(Repeatable)_ |
@ -62,13 +74,6 @@ 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.
## Examples
- [Create a token with read and write access to a database](#create-a-token-with-read-and-write-access-to-a-database)
@ -76,6 +81,7 @@ _Also see [`influxctl` global flags](/influxdb3/cloud-dedicated/reference/cli/in
- [Create a token with read-only access to a database](#create-a-token-with-read-only-access-to-a-database)
- [Create a token with read-only access to multiple databases](#create-a-token-with-read-only-access-to-multiple-databases)
- [Create a token with mixed permissions to multiple databases](#create-a-token-with-mixed-permissions-on-multiple-databases)
- [Create a token that expires in seven days](#create-a-token-that-expires-in-seven-days)
In the examples below, replace the following:
@ -86,7 +92,10 @@ In the examples below, replace the following:
### Create a token with read and write access to a database
{{% code-placeholders "DATABASE_NAME" %}}
```sh
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
@ -96,7 +105,9 @@ influxctl token create \
### Create a token with read and write access to all databases
```sh
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database "*" \
--write-database "*" \
@ -106,7 +117,10 @@ influxctl token create \
### Create a token with read-only access to a database
{{% code-placeholders "DATABASE_NAME" %}}
```sh
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
"Read-only token for DATABASE_NAME"
@ -116,7 +130,10 @@ influxctl token create \
### Create a token with read-only access to multiple databases
{{% code-placeholders "DATABASE_NAME|DATABASE2_NAME" %}}
```sh
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--read-database DATABASE2_NAME \
@ -127,7 +144,10 @@ influxctl token create \
### Create a token with mixed permissions to multiple databases
{{% code-placeholders "DATABASE_NAME|DATABASE2_NAME" %}}
```sh
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--read-database DATABASE2_NAME \
@ -135,3 +155,42 @@ influxctl token create \
"Read-only on DATABASE_NAME, read/write on DATABASE2_NAME"
```
{{% /code-placeholders %}}
### Create a token that expires in seven days
{{% code-placeholders "DATABASE_NAME" %}}
{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Linux](#)
[macOS](#)
{{% /code-tabs %}}
{{% code-tab-content %}}
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
--expires-at $(date -d "+7 days" +"%Y-%m-%dT%H:%M:%S%z") \
"Read/write token for DATABASE_NAME with 7d expiration"
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
--expires-at $(gdate -d "+7 days" +"%Y-%m-%dT%H:%M:%S%z") \
"Read/write token for DATABASE_NAME with 7d expiration"
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
{{% /code-placeholders %}}

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

@ -1,73 +0,0 @@
---
title: influxctl token delete
description: >
The `influxctl token delete` command deletes a database token from an InfluxDB
Cloud Dedicated cluster and revokes all permissions associated with the token.
menu:
influxdb3_cloud_dedicated:
parent: influxctl token
weight: 301
---
The `influxctl token delete` command deletes a database token from an InfluxDB
Cloud Dedicated cluster and revokes all permissions associated with the token.
## Usage
```sh
influxctl token delete <TOKEN_ID> [<TOKEN_ID_N>...]
```
> [!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
| Argument | Description |
| :----------- | :-------------------------- |
| **TOKEN_ID** | Database token ID to delete |
## Flags
| Flag | | Description |
| :--- | :-------- | :---------------------------------------------------------- |
| | `--force` | Do not prompt for confirmation to delete (default is false) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb3/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
- [Delete a database token](#delete-a-database-token)
- [Delete multiple database tokens](#delete-multiple-database-tokens)
In the examples below, replace the following:
- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}: token ID to delete
### Delete a database token
{{% code-placeholders "TOKEN_ID" %}}
```sh
influxctl token delete TOKEN_ID
```
{{% /code-placeholders %}}
### Delete multiple database tokens
{{% code-placeholders "TOKEN_ID_\d{1}" %}}
```sh
influxctl token delete TOKEN_ID_1 TOKEN_ID_2
```
{{% /code-placeholders %}}

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

@ -2,7 +2,7 @@
title: influxctl token get
description: >
The `influxctl token get` command returns information about a database token
in an InfluxDB Cloud Dedicated cluster.
in an {{% product-name omit=" Clustered" %}} cluster.
menu:
influxdb3_cloud_dedicated:
parent: influxctl token
@ -10,7 +10,7 @@ weight: 301
---
The `influxctl token get` command returns information about a database token
in an InfluxDB Cloud Dedicated cluster.
in an {{% product-name omit=" Clustered" %}} cluster.
The `--format` flag lets you print the output in other formats.
The `json` format is available for programmatic parsing by other tooling.
@ -24,10 +24,11 @@ influxctl token get [command options] <TOKEN_ID>
## Flags
| Flag | | Description |
| :--- | :--------- | :-------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
| Flag | | Description |
| :--- | :------------------ | :-------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| | `--include-revoked` | Allow returning a revoked token |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb3/cloud-dedicated/reference/cli/influxctl/#global-flags)._
@ -43,4 +44,4 @@ influxctl token get TOKEN_ID
Replace the following:
- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}: token ID to delete
- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}: token ID to get

19
content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/list.md
View File

@ -1,16 +1,16 @@
---
title: influxctl token list
description: >
The `influxctl token list` command lists all database tokens in an InfluxDB
Cloud Dedicated cluster.
The `influxctl token list` command lists all database tokens in an
{{% product-name omit=" Clustered" %}} cluster.
menu:
influxdb3_cloud_dedicated:
parent: influxctl token
weight: 301
---
The `influxctl token list` command lists all database tokens in an InfluxDB Cloud
Dedicated cluster.
The `influxctl token list` command lists all database tokens in an
{{% product-name omit=" Clustered" %}} cluster.
The `--format` flag lets you print the output in other formats.
The `json` format is available for programmatic parsing by other tooling.
@ -24,11 +24,12 @@ influxctl token list [--format=table|json]
## Flags
| Flag | | Description |
| :--- | :--------- | :------------------------------------------------------------------------------------------------------------ |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| | `--sort` | Sort output by a specific column (`created` _(default)_, `id`, `description`, `prefix`, `expires`, `revoked`) |
| `-h` | `--help` | Output command help |
| Flag | | Description |
| :--- | :------------------ | :-------------------------------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| | `--sort` | Sort output by a specific column ( `id` _(default)_ or `description`) |
| | `--include-revoked` | Include revoked tokens in the list |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb3/cloud-dedicated/reference/cli/influxctl/#global-flags)._

82
content/influxdb3/cloud-dedicated/reference/cli/influxctl/token/revoke.md Normal file
View File

@ -0,0 +1,82 @@
---
title: influxctl token revoke
description: >
The `influxctl token revoke` command revokes a database token associated with
an {{% product-name omit=" Clustered" %}} cluster and removes all permissions
associated with the token.
menu:
influxdb3_cloud_dedicated:
parent: influxctl token
weight: 301
aliases:
- /influxdb3/cloud-dedicated/reference/cli/influxctl/token/delete/
---
The `influxctl token revoke` command revokes a database token associated with
an {{% product-name omit=" Clustered" %}} cluster and removes all permissions
associated with the token.
## Usage
```sh
influxctl token revoke <TOKEN_ID> [<TOKEN_ID_N>...]
```
> [!Warning]
> #### Revoking a token is immediate and cannot be undone
>
> Revoking a database token is a destructive action that takes place immediately
> and cannot be undone.
>
> #### Rotate revoked tokens
>
> After revoking a database token, any clients using the revoked token need to
> be updated with a new database token to continue to interact with your
> {{% product-name omit=" Clustered" %}} cluster.
##### Aliases
`delete`
## Arguments
| Argument | Description |
| :----------- | :-------------------------- |
| **TOKEN_ID** | Database token ID to revoke |
## Flags
| Flag | | Description |
| :--- | :-------- | :---------------------------------------------------------- |
| | `--force` | Do not prompt for confirmation to revoke (default is false) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb3/cloud-dedicated/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
- [Revoke a database token](#revoke-a-database-token)
- [Revoke multiple database tokens](#revoke-multiple-database-tokens)
In the examples below, replace the following:
- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}:
token ID to revoke
### Revoke a database token
{{% code-placeholders "TOKEN_ID" %}}
```sh
influxctl token revoke TOKEN_ID
```
{{% /code-placeholders %}}
### Revoke multiple database tokens
{{% code-placeholders "TOKEN_ID_\d{1}" %}}
```sh
influxctl token revoke TOKEN_ID_1 TOKEN_ID_2
```
{{% /code-placeholders %}}

3
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/_index.md
View File

@ -17,8 +17,7 @@ prepend: |
> client libraries and the `influx` CLI, **can't** query an
> {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/)
> and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/)
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/reference/client-libraries/v3/)
> are available that integrate with your code to write and query data stored
> in {{% product-name %}}.
>

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/arduino.md
View File

@ -16,7 +16,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/csharp.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/dart.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/go.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/java.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/_index.md
View File

@ -19,7 +19,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

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

@ -22,7 +22,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/_index.md
View File

@ -19,7 +19,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/install.md
View File

@ -16,7 +16,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/javascript/nodejs/write.md
View File

@ -19,7 +19,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/kotlin.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/php.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/python.md
View File

@ -20,7 +20,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/r.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/ruby.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/scala.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-dedicated/reference/client-libraries/v2/swift.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-dedicated/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-dedicated/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-dedicated/write-data/) and [**querying**](/influxdb3/cloud-dedicated/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-dedicated/get-started/#tools-to-use) to interact with {{% product-name %}}.

641
content/influxdb3/cloud-dedicated/reference/release-notes/influxctl.md
View File

@ -9,643 +9,8 @@ menu:
name: influxctl
parent: Release notes
weight: 202
source: /shared/influxctl/release-notes.md
---
## v2.9.9 {date="2025-01-24"}
### Features
- Sort [`influxctl token list`](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/list/)
and [`influxctl management list`](/influxdb3/cloud-dedicated/reference/cli/influxctl/management/list/) output.
### Bug fixes
- Remove `UpdateAccount` and `UpdateCluster`.
- Remove "incorrect version" warning for gRPC unimplemented error code.
- Correctly parse multi-line queries from stdin.
### Dependency updates
- Update `github.com/fatih/color` from 1.17.0 to 1.18.0.
- Update `github.com/go-git/go-git/v5` from 5.12.0 to 5.13.1.
- Update `github.com/jedib0t/go-pretty/v6` from 6.6.0 to 6.6.5.
- Update `github.com/stretchr/testify` from 1.9.0 to 1.10.0.
- Update `golang.org/x/crypto` from 0.27.0 to 0.31.0.
- Update `golang.org/x/mod` from 0.21.0 to 0.22.0.
- Update `golang.org/x/oauth2` from 0.23.0 to 0.25.0.
- Update `google.golang.org/grpc` from 1.67.1 to 1.69.4.
- Update `google.golang.org/protobuf` from 1.35.1 to 1.36.3.
- Update Go to v1.23.5.
---
## v2.9.8 {date="2024-10-15"}
### Bug Fixes
- Continue revoking tokens on error.
- Reject unsupported input to `--template-timeformat`.
- Remove unused `client_secret` option from
[connection configuration profiles](/influxdb3/cloud-dedicated/reference/cli/influxctl/#configure-connection-profiles).
### Dependency Updates
- Update Go to v1.23.2.
- Update `github.com/jedib0t/go-pretty/v6` from 6.5.9 to 6.6.0.
- Update `github.com/urfave/cli/v2` from 2.27.4 to 2.27.5.
- Update `google.golang.org/grpc` from 1.66.0 to 1.67.1.
- Update `google.golang.org/protobuf` from 1.34.2 to 1.35.1.
---
## v2.9.7 {date="2024-09-11"}
### Features
- Add [global `--timeout` flag](/influxdb3/cloud-dedicated/reference/cli/influxctl/#global-flags).
- Improve timezone support.
### Bug Fixes
- Use passthrough resolver for gRPC.
### Dependency Updates
- Update Go to 1.23.1.
- Update `github.com/pelletier/go-toml/v2` from 2.2.2 to 2.2.3.
- Update `golang.org/x/mod` from 0.20.0 to 0.21.0.
- Update `golang.org/x/oauth2` from 0.22.0 to 0.23.0.
- Update `google.golang.org/grpc` from 1.65.0 to 1.66.0.
---
## v2.9.6 {date="2024-08-15"}
### Bug Fixes
- Update query to wait for EOF on stdin instead of the first newline.
---
## v2.9.5 {date="2024-08-13"}
### Bug Fixes
- Introduce auth login and logout commands.
### Dependency Updates
- Update `github.com/urfave/cli/v2` from 2.27.2 to 2.27.4
- Update `golang.org/x/mod` from 0.19.0 to 0.20.0
- Update `golang.org/x/oauth2` from 0.21.0 to 0.22.0
---
## v2.9.4 {date="2024-07-25"}
### Bug Fixes
- Resolve crash when parsing error message and authentication was null.
### Dependency Updates
- Update `golang.org/x/mod` from 0.18.0 to 0.19.0
- Update `google.golang.org/grpc` from 1.64.0 to 1.65.0
---
## v2.9.3 {date="2024-06-26"}
### Bug Fixes
- Update query subcommand to safely handle null timestamp in response.
---
## v2.9.2 {date="2024-06-17"}
### Bug Fixes
- Ensure query subcommand returns any error while looping through results.
### Dependency Updates
- Update `google.golang.org/protobuf` from 1.34.1 to 1.34.2.
---
## v2.9.1 {date="2024-06-06"}
### Dependency Updates
- Update Go from 1.22.2 to 1.22.4
- Update `github.com/apache/arrow/go/v16` from 16.0.0 to 16.1.0
- Update `github.com/fatih/color` from 1.16.0 to 1.17.0
- Update `golang.org/x/mod` from 0.17.0 to 0.18.0
- Update `golang.org/x/oauth2` from 0.20.0 to 0.21.0
- Update `google.golang.org/grpc` from 1.63.2 to 1.64.0
- Update `google.golang.org/protobuf` from 1.34.0 to 1.34.1
- Update build dependencies.
---
## v2.9.0 {date="2024-05-06"}
### Features
- Restore default `rfc3339nano` timestamps in table output for `influxctl query`
and add the option for `unixnano` timestamps.
### Bug Fixes
- Update unimplemented error message with additional information.
### Dependency Updates
- Update `github.com/apache/arrow/go/v16` from 16.0.0-20240401180149-68241d8a86e9 to 16.0.0.
- Update `github.com/jedib0t/go-pretty/v6` from 6.5.8 to 6.5.9.
- Update `github.com/pelletier/go-toml/v2` from 2.2.0 to 2.2.1.
- Update `github.com/pelletier/go-toml/v2` from 2.2.1 to 2.2.2.
- Update `github.com/urfave/cli/v2` from 2.27.1 to 2.27.2.
- Update `golang.org/x/net` from 0.22.0 to 0.23.0.
- Update `golang.org/x/oauth2` from 0.19.0 to 0.20.0.
- Update `google.golang.org/protobuf` from 1.33.0 to 1.34.0.
- Update build dependencies.
---
## v2.8.0 {date="2024-04-11"}
### Features
- Introduce the ability to query with InfluxQL.
- Add insecure configuration option to TLS configuration.
- Allow users to query system tables.
- Utilize the database proxy service.
### Dependency Updates
- Update Go to v1.22.2.
- Update `github.com/go-git/go-git/v5` from 5.11.0 to 5.12.0.
- Update `github.com/jedib0t/go-pretty/v6` from 6.5.6 to 6.5.8.
- Update `golang.org/x/mod` from 0.16.0 to 0.17.0.
- Update `golang.org/x/oauth2` from 0.18.0 to 0.19.0.
- Update `google.golang.org/grpc` from 1.62.1 to 1.63.2.
---
## v2.7.1 {date="2024-03-27"}
### Bug Fixes
- Correctly parse template tag bucket strings.
---
## v2.7.0 {date="2024-03-26"}
This minor release adds the `--template-tag-bucket` partition template option to
the already existing `--template-time-format` and `--template-tag` options used
to define custom partition templates for databases and tables.
This also fixes a nil pointer issue when listing management tokens.
### Features
- Introduce the bucket template method for grouping tag values into buckets and
partitioning by each tag bucket.
### Bug Fixes
- Ensure strings are not nil pointers.
### Dependency Updates
- Update `github.com/jedib0t/go-pretty/v6` from 6.5.5 to 6.5.6.
- Update `github.com/pelletier/go-toml/v2` from 2.1.1 to 2.2.0.
- Update granite proto.
---
## v2.6.0 {date="2024-03-18"}
`influxctl` 2.6.0 introduces the ability to create, list, and revoke
management tokens and allow you to authenticate directly with your
InfluxDB cluster instead of an OAuth2 provider.
### New Features
- Add management token subcommands to create, list, and revoke management
tokens.
- Introduce management token configuration option to authenticate using
management tokens created with `influxctl`.
### Dependency Updates
- Update Go to v1.22.1
- Update `github.com/golang-jwt/jwt/v5` from v5.2.0 to v5.2.1.
- Update `google.golang.org/protobuf` from v1.32.0 to v1.33.0.
- Update `golang.org/x/oauth2` from v0.17.0 to v0.18.0.
- Update `google.golang.org/grpc` from v1.62.0 to v1.62.1.
- Update `github.com/jedib0t/go-pretty/v6` from v6.5.4 to v6.5.5.
---
## v2.5.0 {date="2024-03-04"}
`influxctl` 2.5.0 introduces the ability to set
[partition templates](/influxdb3/cloud-dedicated/admin/custom-partitions/) during
database or table creation. It introduces the
[`table` subcommand](/influxdb3/cloud-dedicated/reference/cli/influxctl/table/)
that lets users manually create tables. Additionally, `influxctl` now removes a
previously cached token if the response from InfluxDB is unauthorized. This
helps InfluxDB Clustered users who deploy new clusters using unexpired tokens
associated with another InfluxDB cluster.
### New Features
- Add partition templates to database and table creation.
- Remove token if unauthorized.
### Bug Fixes
- Update Arrow to allow non-TLS connections.
- Do not attempt to load cached tokens when an admin token file is provided.
- Print retention period up to days rather than very large hours.
- Fix indentation of help output.
### Dependency Updates
- Update `github.com/golangci/golangcilint` from v1.56.1 to v1.56.2.
- Update `golang.org/x/mod` from v0.15.0 to v0.16.0.
- Update `github.com/pkg/browser` from v0.0.0-20210911075715-681adbf594b8 to
v0.0.0-20240102092130-5ac0b6a4141c.
- Update `github.com/stretchr/testify` from 1.8.4 to 1.9.0.
- Update `go.uber.org/zap` from 1.26.0 to 1.27.0.
- Update `google.golang.org/grpc` from 1.61.0 to 1.61.1.
- Update `google.golang.org/grpc` from 1.61.1 to 1.62.0.
---
## v2.4.4 {date="2024-02-16"}
### Bug fixes
- Introduced trace HTTP debug CLI option.
- Added custom gRPC error message handling to gRPC experience.
### Dependency updates
- Update to go1.22.0.
- Update `github.com/apache/arrow/go/v14` v14.0.2 to v15.0.0.
- Update `github.com/google/uuid` from 1.5.0 to 1.6.0.
- Update `github.com/jedib0t/go-pretty/v6` from 6.5.3 to 6.5.4.
- Update `golang.org/x/mod from` 0.14.0 to 0.15.0.
- Update `golang.org/x/oauth2` from 0.16.0 to 0.17.0.
- Update `google.golang.org/grpc` from 1.60.1 to 1.61.0.
---
## v2.4.3 {date="2024-01-17"}
### Bug fixes
- Show empty value for database limits when not set, rather than zero.
- Use user configured port for write.
- Correct typos in query and write error messages.
### Dependency updates
- Update to go1.21.6.
- Update `github.com/apache/arrow/go/v14` from 14.0.1 to 14.0.2.
- Update `github.com/cloudflare/circl` from 1.3.6 to 1.3.7.
- Update `github.com/jedib0t/go-pretty/v6` from 6.4.9 to 6.5.3.
- Update `github.com/urfave/cli/v2` from 2.26.0 to 2.27.1.
- Update `golang.org/x/crypto` from 0.16.0 to 0.17.0.
- Update `golang.org/x/oauth2` from 0.15.0 to 0.16.0.
- Update `google.golang.org/grpc` from 1.60.0 to 1.60.1.
- Update `google.golang.org/protobuf` from 1.31.0 to 1.32.0.
---
## v2.4.2 {date="2023-12-18"}
### Bug fixes
- Correctly set the version and build info for the version command.
---
## v2.4.1 {date="2023-12-14"}
### Bug fixes
- Update `influxctl query` examples with SQL instead of InfluxQL.
- Update example connection profile configuration with query and write options.
- Use database and token CLI options if set.
---
## v2.4.0 {date="2023-12-13"}
This release includes the following notable changes:
- InfluxDB Cloud Dedicated users now have the same `influxctl` login experience
as InfluxDB Clustered users. The Auth0 server uses device authorization by
displaying a code to validate when logging in. The browser still opens,
if possible, and pre-populates the code. The only difference is the need to
verify the code on one additional page. This was done to align the user
experience between both InfluxDB Cloud Dedicated and InfluxDB Clustered and
to allow Cloud Dedicated users without a local UI or browser to continue to
use `influxctl`.
- Introduce the `influxctl write` and `influxctl query` commands.
`influxctl query` queries an InfluxDB 3 instance using SQL.
`influxctl write` writes line protocol to a InfluxDB 3 instance.
### Features
- Introduce `influxctl query` command.
- Introduce `influxctl write` command.
- Use device auth for InfluxDB Cloud Dedicated.
### Bug fixes
- Avoid nil pointer for database information.
- Login and early return for TokenFile in InfluxDB Clustered.
### Dependency updates
- Update `github.com/go-git/go-git/v5` from 5.10.0 to 5.10.1.
- Update `github.com/go-git/go-git/v5` from 5.10.1 to 5.11.0.
- Update `github.com/golang-jwt/jwt/v5` from 5.1.0 to 5.2.0.
- Update `github.com/urfave/cli/v2` from 2.25.7 to 2.26.0.
- Update `golang.org/x/oauth2` from 0.14.0 to 0.15.0.
---
## v2.3.1 {date="2023-11-15"}
### Bug fixes
- Include error message description in device authorization polling errors.
- Do not save tokens when loading from file.
- Update header comments in the example `config.toml`.
### Dependency updates
- Update `github.com/golang-jwt/jwt/v5` from 5.0.0 to 5.1.0.
- Update `golang.org/x/oauth2` from 0.13.0 to 0.14.0.
---
## v2.3.0 {date="2023-11-06"}
_Features updated in this release are meant for internal InfluxData use and do
not affect any public APIs._
### Dependency updates
- Update `github.com/go-git/go-git/v5` from 5.9.0 to 5.10.0.
- Update `github.com/google/uuid` from 1.3.1 to 1.4.0.
- Update `github.com/jedib0t/go-pretty/v6` from 6.4.8 to 6.4.9.
- Update `golang.org/x/mod` from 0.13.0 to 0.14.0.
---
## v2.2.0 {date="2023-10-27"}
### Features
- Allow token authentication for InfluxDB Clustered.
---
## v2.1.0 {date="2023-10-26"}
### Features
- Add `--format` flag to [`influxctl token create`](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/)
to specify the command output format.
### Bug fixes
- Use correct account and cluster names when specified in command flags.
- Make `influxctl database list` return an empty array instead of _null_ when
there are no databases to list.
### Dependency updates
- Update to Go 1.21.3.
- Update `github.com/jedib0t/go-pretty/v6` from 6.4.7 to 6.4.8.
- Update `go.uber.org/zap` from 1.25.0 to 1.26.0.
- Update `golang.org/x/mod` from 0.12.0 to 0.13.0.
- Update `golang.org/x/net` from 0.15.0 to 0.17.0.
- Update `golang.org/x/oauth2` from 0.12.0 to 0.13.0.
- Update `google.golang.org/grpc` from 1.58.0 to 1.59.0.
### Miscellaneous
- Automate Homebrew tap releases for `influxctl`.
---
## v2.0.4 {date="2023-09-14"}
### Bug fixes
- Validate Microsoft Entra ID (formerly Azure Active Directory) token and device URLs.
- Only validate Microsoft Entra ID configuration when getting a token.
### Dependency updates
- Update to Go 1.21.
---
## v2.0.3 {date="2023-09-12"}
### Bug fixes
- Add pagination support to [`influxctl token list`](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/list/)
and [`influxctl user list`](/influxdb3/cloud-dedicated/reference/cli/influxctl/user/list/).
- Send all logging output to stderr.
- Return error for commands that are not supported by InfluxDB Clustered.
### Dependency updates
- Update `github.com/google/uuid` from 1.3.0 to 1.3.1.
- Update `github.com/jedib0t/go-pretty/v6` from 6.4.6 to 6.4.7.
- Update `github.com/pelletier/go-toml/v2` from 2.0.9 to 2.1.0.
- Update `golang.org/x/oauth2` from 0.11.0 to 0.12.0.
- Update `google.golang.org/grpc` from 1.57.0 to 1.58.0.
---
## v2.0.2 {date="2023-08-23"}
### Bug fixes
- Add cluster get args, clarify error message.
- [`influxctl database update`](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/update/)
should only accept retention policy updates as a flag.
- Update [`influxctl token create`](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/create/)
and [`influxctl token update`](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/update/)
help information with examples that use multiple permission flags.
- Update [`influxctl cluster get`](/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/get/)
help text.
- Switch email param ordering.
### Dependency updates
- Update `golang.org/x/mod` from 0.8.0 to 0.12.0.
### Miscellaneous
- Clean up log formatting.
- Remove extra debug output of account ID.
---
## v2.0.1 {date="2023-08-15"}
### Bug fixes
- Return an error when using unrecognized TOML configuration options.
---
## v2.0.0 {date="2023-08-09"}
`influxctl` 2.0.0 introduces support for both InfluxDB Cloud Dedicated and
InfluxDB Clustered. To simplify configuration profile management, all connection
configurations now managed in a single configuration file. If using `influxctl`
1.x, migrate your 1.x configuration profiles to the 2.0 format:
### Migrate from influxctl 1.x to 2.0
`influxctl` 2.0+ supports multiple InfluxDB 3 products.
To simplify connection configuration management, all configurations are now managed
in a single file rather than separate files for each connection configuration.
To migrate `influxctl` 1.x configuration files to the 2.x format, use the
following guidelines:
1. Create a 2.0+ configuration file (`config.toml`) at the default location
for your operating system.
_See [Create a configuration file](/influxdb3/cloud-dedicated/reference/cli/influxctl/#create-a-configuration-file)_.
2. Copy the `account_id` and `cluster_id` credentials from your `influxctl` 1.x
configuration file and add them to a `[[profile]]` TOML table along with the
following fields:
- **name**: Profile name
- **product**: InfluxDB product (`dedicated`)
For example, the following 1.x configuration file:
```toml
account_id = "dff3ee52-b494-47c1-9e2c-ab59d90d94eb"
cluster_id = "5827cdeb-b868-4446-b40e-e08de116fddf"
```
would become:
```toml
[[profile]]
name = "default"
product = "dedicated"
account_id = "dff3ee52-b494-47c1-9e2c-ab59d90d94eb"
cluster_id = "5827cdeb-b868-4446-b40e-e08de116fddf"
```
### Features
- Add support for both InfluxDB Cloud Dedicated and InfluxDB Clustered.
- Provide public distributions through <https://www.influxdata.com/downloads/>
and the <https://repos.influxdata.com/> repository.
- The `influxctl` configuration file is now a single file that you can
optionally pass in via the CLI.
- Add additional options to [`influxctl database`](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/)
and [`influxctl token`](/influxdb3/cloud-dedicated/reference/cli/influxctl/token/)
subcommands.
- Introduce [`influxctl cluster`](/influxdb3/cloud-dedicated/reference/cli/influxctl/cluster/)
subcommands.
- Remove the `influxctl init` subcommand to avoid additional complexity of an
InfluxDB Cloud Dedicated configuration.
- Set maximum tables and columns when creating a database.
- Support passing a connection configuration file path as a CLI option.
- Delete multiple tokens or database in one command.
- Disable of TLS verification for self-signed certificates.
- Update a database and token values.
- Update account & cluster ID for configurations for InfluxDB Clustered.
- Add account and authz gRPC method support.
- Add account and authz protofiles.
- Add oauth2 authentication.
- Specify custom TLS certificates.
- Store configuration settings for multiple InfluxDB products in a single
configuration file.
### Bug Fixes
- Return error when too many arguments are provided to a command.
- Set token directory permissions to only the current user.
- Unmarshal `expires_in` for device OAuth2 token.
- Update authentication host for InfluxDB Cloud Dedicated.
- Verify account and cluster IDs.
### Miscellaneous
- Update configuration examples with InfluxDB Clustered configurations.
- Properly close gRPC connections.
- Update error message for missing connection profiles.
### Dependency Updates
- Update `github.com/pelletier/go-toml/v2` from 2.0.7 to 2.0.9.
- Update `github.com/stretchr/testify` from 1.8.2 to 1.8.4.
- Update `github.com/urfave/cli/v2` from 2.25.3 to 2.25.7.
- Update `go.uber.org/zap` from 1.24.0 to 1.25.0.
- Update `golang.org/x/oauth2` from 0.9.0 to 0.11.0.
- Update `google.golang.org/grpc` from 1.55.0 to 1.57.0.
- Update `google.golang.org/protobuf` from 1.30.0 to 1.31.0.
---
## v1.1.0 {date="2023-05-19"}
### Features
- Add the [`influxctl database update`](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/update/)
subcommand to update retention periods.
- Add the [`influxctl token update`](/influxdb3/cloud-dedicated/reference/cli/influxctl/database/update/)
subcommand to update token descriptions.
- Using the `influxctl init` command:
- Confirm before overwriting an existing profile.
- Remove the existing token if overwriting a profile.
- On error, use stderr and return non-zero return code.
- Increase command timeouts to 60 seconds.
- Support setting the Auth0 and gRPC destinations using environment variables
for staging and development environment use.
### Bug fixes
- Call `Makefile` instead of `goreleaser`.
- Remove token on init.
### Dependency updates
- Update `github.com/urfave/cli/v2` from 2.25.1 to 2.25.3.
- Update `golang.org/x/oauth2` from 0.7.0 to 0.8.0.
- Update `google.golang.org/grpc` from 1.54.0 to 1.55.0.
---
## v1.0.0 {date="2023-04-26"}
### Features
- Output confirmation messages on delete.
- Use production Authentication service URLs.
### Miscellaneous
- Display `0s` retention policies as infinite.
<!-- The content of this page is located at
// SOURCE content/shared/influxctl/release-notes.md -->

4
content/influxdb3/cloud-dedicated/write-data/line-protocol/influxctl-cli.md
View File

@ -26,7 +26,7 @@ to write line protocol data to {{< product-name >}}.
## Construct line protocol
With a [basic understanding of line protocol](/influxdb3/cloud-dedicated/write-data/line-protocol/),
you can now construct line protocol and write data to InfluxDB.
you can construct data in line protocol format and write it to InfluxDB.
Consider a use case where you collect data from sensors in your home.
Each sensor collects temperature, humidity, and carbon monoxide readings.
To collect this data, use the following schema:
@ -40,7 +40,7 @@ To collect this data, use the following schema:
- `co`: carbon monoxide in parts per million (integer)
- **timestamp**: Unix timestamp in _second_ precision
The following line protocol represent the schema described above:
The following line protocol represents the schema described above:
```text
home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/_index.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/arduino.md
View File

@ -16,7 +16,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/csharp.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/dart.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/go.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/java.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/javascript/_index.md
View File

@ -19,7 +19,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/javascript/browser.md
View File

@ -22,7 +22,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/javascript/nodejs/_index.md
View File

@ -20,7 +20,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/javascript/nodejs/install.md
View File

@ -16,7 +16,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/javascript/nodejs/write.md
View File

@ -19,7 +19,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/kotlin.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/php.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/python.md
View File

@ -20,7 +20,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/r.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/ruby.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/scala.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/cloud-serverless/reference/client-libraries/v2/swift.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/cloud-serverless/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/cloud-serverless/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/cloud-serverless/write-data/) and [**querying**](/influxdb3/cloud-serverless/query-data/) data.
> [**Compare tools you can use**](/influxdb3/cloud-serverless/get-started/#tools-to-use) to interact with {{% product-name %}}.

63
content/influxdb3/clustered/admin/tokens/database/create.md
View File

@ -14,6 +14,7 @@ list_code_example: |
--read-database DATABASE1_NAME \
--read-database DATABASE2_NAME \
--write-database DATABASE2_NAME \
--expires-at 2030-01-01T00:00:00Z \
"Read-only on DATABASE1_NAME, Read/write on DATABASE2_NAME"
```
aliases:
@ -28,38 +29,50 @@ to create a token that grants access to databases in your {{% product-name omit=
1. If you haven't already, [download and install the `influxctl` CLI](/influxdb3/clustered/reference/cli/influxctl/#download-and-install-influxctl).
2. In your terminal, run the `influxctl token create` command and provide the following:
- Token permissions (read and write)
- `--read-database`: Grants read permissions to the specified database. Repeatable.
- `--write-database`: Grants write permissions to the specified database. Repeatable.
Both of these flags support the `*` wildcard which grants read or write
permissions to all databases. Enclose wildcards in single or double
quotes--for example: `'*'` or `"*"`.
- Token expiration date and time in [RFC3339 format](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp).
_If you do not provide an expiration, the token does not expire._
- Token description
{{% code-placeholders "DATABASE_NAME|TOKEN_DESCRIPTION" %}}
{{% code-placeholders "DATABASE_NAME|TOKEN_DESCRIPTION|RFC3339_TIMESTAMP" %}}
```sh
influxctl token create \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
"Read/write token for DATABASE_NAME"
--expires-at RFC3339_TIMESTAMP \
"Read/write token for DATABASE_NAME"
```
{{% /code-placeholders %}}
Replace the following:
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/)
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
your {{% product-name %}} [database](/influxdb3/clustered/admin/databases/)
- {{% code-placeholder-key %}}`RFC3339_TIMESTAMP`{{% /code-placeholder-key %}}:
the token expiration date and time in
[RFC3339 format](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp).
The output is the token ID and the token string.
**This is the only time the token string is available in plain text.**
## Notable behaviors
- InfluxDB might take some time--from a few seconds to a few minutes--to activate and synchronize new tokens.
If a new database token doesn't immediately work (you receive a `401 Unauthorized` error) for querying or writing, wait and then try again.
- InfluxDB might take some time--from a few seconds to a few minutes--to
activate and synchronize new tokens.
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]
@ -86,6 +99,7 @@ with your command to format the output as JSON.
- [Create a token with read-only access to a database](#create-a-token-with-read-only-access-to-a-database)
- [Create a token with read-only access to multiple databases](#create-a-token-with-read-only-access-to-multiple-databases)
- [Create a token with mixed permissions to multiple databases](#create-a-token-with-mixed-permissions-to-multiple-databases)
- [Create a token that expires in seven days](#create-a-token-that-expires-in-seven-days)
In the examples below, replace the following:
@ -152,3 +166,42 @@ influxctl token create \
```
{{% /code-placeholders %}}
### Create a token that expires in seven days
{{% code-placeholders "DATABASE_NAME" %}}
{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Linux](#)
[macOS](#)
{{% /code-tabs %}}
{{% code-tab-content %}}
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
--expires-at $(date -d "+7 days" +"%Y-%m-%dT%H:%M:%S%z") \
"Read/write token for DATABASE_NAME with 7d expiration"
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
--expires-at $(gdate -d "+7 days" +"%Y-%m-%dT%H:%M:%S%z") \
"Read/write token for DATABASE_NAME with 7d expiration"
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
{{% /code-placeholders %}}

8
content/influxdb3/clustered/reference/cli/influxctl/token/_index.md
View File

@ -20,14 +20,14 @@ influxctl token [subcommand] [flags]
## Subcommands
| Subcommand | Description |
| :------------------------------------------------------------------------ | :---------------------------- |
| Subcommand | Description |
| :------------------------------------------------------------------- | :---------------------------- |
| [create](/influxdb3/clustered/reference/cli/influxctl/token/create/) | Create a database token |
| [delete](/influxdb3/clustered/reference/cli/influxctl/token/delete/) | Delete a database token |
| [revoke](/influxdb3/clustered/reference/cli/influxctl/token/revoke/) | Revoke a database token |
| [get](/influxdb3/clustered/reference/cli/influxctl/token/get/) | Get information about a token |
| [list](/influxdb3/clustered/reference/cli/influxctl/token/list/) | List database tokens |
| [update](/influxdb3/clustered/reference/cli/influxctl/token/update/) | Update a database token |
| help, h | Output command help |
| help, h | Output command help |
## Flags

82
content/influxdb3/clustered/reference/cli/influxctl/token/create.md
View File

@ -17,14 +17,22 @@ The `--read-database` and `--write-database` flags support the `*` wildcard
which grants read or write permissions to all databases. Enclose wildcards in
single or double quotes--for example: `'*'` or `"*"`.
The `--expires-at` flag specifies the date and time a token should expire.
Provide an [RFC3339 timestamp](/influxdb3/clustered/reference/glossary/#rfc3339-timestamp).
> [!Important]
> If you don't specify a token expiration, the token never expires.
The `--format` flag lets you print the output in other formats.
The `json` format is available for programmatic parsing by other tooling.
Default: `table`.
## Notable behaviors
- InfluxDB might take some time--from a few seconds to a few minutes--to activate and synchronize new tokens.
If a new database token doesn't immediately work (you receive a `401 Unauthorized` error) for querying or writing, wait and then try again.
- InfluxDB might take some time--from a few seconds to a few minutes--to
activate and synchronize new tokens. 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]
@ -36,10 +44,13 @@ If a new database token doesn't immediately work (you receive a `401 Unauthorize
## Usage
```sh
<!-- pytest.mark.skip -->
```bash
influxctl token create \
[--read-database=<DATABASE_NAME>] \
[--write-database=<DATABASE_NAME>] \
[--expires-at=<RFC3339_DATE>] \
<TOKEN_DESCRIPTION>
```
@ -53,6 +64,7 @@ influxctl token create \
| Flag | | Description |
| :--- | :----------------- | :--------------------------------------------------- |
| | `--expires-at` | Token expiration date and time in RFC3339 format |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| | `--read-database` | Grant read permissions to a database _(Repeatable)_ |
| | `--write-database` | Grant write permissions to a database _(Repeatable)_ |
@ -69,6 +81,7 @@ _Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxct
- [Create a token with read-only access to a database](#create-a-token-with-read-only-access-to-a-database)
- [Create a token with read-only access to multiple databases](#create-a-token-with-read-only-access-to-multiple-databases)
- [Create a token with mixed permissions to multiple databases](#create-a-token-with-mixed-permissions-on-multiple-databases)
- [Create a token that expires in seven days](#create-a-token-that-expires-in-seven-days)
In the examples below, replace the following:
@ -79,7 +92,10 @@ In the examples below, replace the following:
### Create a token with read and write access to a database
{{% code-placeholders "DATABASE_NAME" %}}
```sh
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
@ -89,7 +105,9 @@ influxctl token create \
### Create a token with read and write access to all databases
```sh
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database "*" \
--write-database "*" \
@ -99,7 +117,10 @@ influxctl token create \
### Create a token with read-only access to a database
{{% code-placeholders "DATABASE_NAME" %}}
```sh
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
"Read-only token for DATABASE_NAME"
@ -109,7 +130,10 @@ influxctl token create \
### Create a token with read-only access to multiple databases
{{% code-placeholders "DATABASE_NAME|DATABASE2_NAME" %}}
```sh
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--read-database DATABASE2_NAME \
@ -120,7 +144,10 @@ influxctl token create \
### Create a token with mixed permissions to multiple databases
{{% code-placeholders "DATABASE_NAME|DATABASE2_NAME" %}}
```sh
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--read-database DATABASE2_NAME \
@ -128,3 +155,42 @@ influxctl token create \
"Read-only on DATABASE_NAME, read/write on DATABASE2_NAME"
```
{{% /code-placeholders %}}
### Create a token that expires in seven days
{{% code-placeholders "DATABASE_NAME" %}}
{{< code-tabs-wrapper >}}
{{% code-tabs %}}
[Linux](#)
[macOS](#)
{{% /code-tabs %}}
{{% code-tab-content %}}
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
--expires-at $(date -d "+7 days" +"%Y-%m-%dT%H:%M:%S%z") \
"Read/write token for DATABASE_NAME with 7d expiration"
```
{{% /code-tab-content %}}
{{% code-tab-content %}}
<!-- pytest.mark.skip -->
```bash
influxctl token create \
--read-database DATABASE_NAME \
--write-database DATABASE_NAME \
--expires-at $(gdate -d "+7 days" +"%Y-%m-%dT%H:%M:%S%z") \
"Read/write token for DATABASE_NAME with 7d expiration"
```
{{% /code-tab-content %}}
{{< /code-tabs-wrapper >}}
{{% /code-placeholders %}}

72
content/influxdb3/clustered/reference/cli/influxctl/token/delete.md
View File

@ -1,72 +0,0 @@
---
title: influxctl token delete
description: >
The `influxctl token delete` command deletes a database token from an InfluxDB
cluster and revokes all permissions associated with the token.
menu:
influxdb3_clustered:
parent: influxctl token
weight: 301
---
The `influxctl token delete` command deletes a database token from an InfluxDB
cluster and revokes all permissions associated with the token.
## Usage
```sh
influxctl token delete <TOKEN_ID> [<TOKEN_ID_N>...]
```
> [!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
| Argument | Description |
| :----------- | :-------------------------- |
| **TOKEN_ID** | Database token ID to delete |
## Flags
| Flag | | Description |
| :--- | :-------- | :---------------------------------------------------------- |
| | `--force` | Do not prompt for confirmation to delete (default is false) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
- [Delete a database token](#delete-a-database-token)
- [Delete multiple database tokens](#delete-multiple-database-tokens)
In the examples below, replace the following:
- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}: token ID to delete
### Delete a database token
{{% code-placeholders "TOKEN_ID" %}}
```sh
influxctl token delete TOKEN_ID
```
{{% /code-placeholders %}}
### Delete multiple database tokens
{{% code-placeholders "TOKEN_ID_\d{1}" %}}
```sh
influxctl token delete TOKEN_ID_1 TOKEN_ID_2
```
{{% /code-placeholders %}}

15
content/influxdb3/clustered/reference/cli/influxctl/token/get.md
View File

@ -2,7 +2,7 @@
title: influxctl token get
description: >
The `influxctl token get` command returns information about a database token
in an InfluxDB cluster.
in an {{% product-name omit=" Clustered" %}} cluster.
menu:
influxdb3_clustered:
parent: influxctl token
@ -10,7 +10,7 @@ weight: 301
---
The `influxctl token get` command returns information about a database token
in an InfluxDB cluster.
in an {{% product-name omit=" Clustered" %}} cluster.
The `--format` flag lets you print the output in other formats.
The `json` format is available for programmatic parsing by other tooling.
@ -24,10 +24,11 @@ influxctl token get [command options] <TOKEN_ID>
## Flags
| Flag | | Description |
| :--- | :--------- | :-------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| `-h` | `--help` | Output command help |
| Flag | | Description |
| :--- | :------------------ | :-------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| | `--include-revoked` | Allow returning a revoked token |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._
@ -43,4 +44,4 @@ influxctl token get TOKEN_ID
Replace the following:
- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}: token ID to delete
- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}: token ID to get

18
content/influxdb3/clustered/reference/cli/influxctl/token/list.md
View File

@ -1,15 +1,16 @@
---
title: influxctl token list
description: >
The `influxctl token list` command lists all database tokens in an InfluxDB cluster.
The `influxctl token list` command lists all database tokens in an
{{% product-name omit=" Clustered" %}} cluster.
menu:
influxdb3_clustered:
parent: influxctl token
weight: 301
---
The `influxctl token list` command lists all database tokens in an InfluxDB Cloud
Dedicated cluster.
The `influxctl token list` command lists all database tokens in an
{{% product-name omit=" Clustered" %}} cluster.
The `--format` flag lets you print the output in other formats.
The `json` format is available for programmatic parsing by other tooling.
@ -23,11 +24,12 @@ influxctl token list [--format=table|json]
## Flags
| Flag | | Description |
| :--- | :--------- | :------------------------------------------------------------------------------------------------------------ |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| | `--sort` | Sort output by a specific column (`created` _(default)_, `id`, `description`, `prefix`, `expires`, `revoked`) |
| `-h` | `--help` | Output command help |
| Flag | | Description |
| :--- | :------------------ | :-------------------------------------------------------------------- |
| | `--format` | Output format (`table` _(default)_ or `json`) |
| | `--sort` | Sort output by a specific column ( `id` _(default)_ or `description`) |
| | `--include-revoked` | Include revoked tokens in the list |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._

82
content/influxdb3/clustered/reference/cli/influxctl/token/revoke.md Normal file
View File

@ -0,0 +1,82 @@
---
title: influxctl token revoke
description: >
The `influxctl token revoke` command revokes a database token associated with
an {{% product-name omit=" Clustered" %}} cluster and removes all permissions
associated with the token.
menu:
influxdb3_clustered:
parent: influxctl token
weight: 301
aliases:
- /influxdb3/clustered/reference/cli/influxctl/token/delete/
---
The `influxctl token revoke` command revokes a database token associated with
an {{% product-name omit=" Clustered" %}} cluster and removes all permissions
associated with the token.
## Usage
```sh
influxctl token revoke <TOKEN_ID> [<TOKEN_ID_N>...]
```
> [!Warning]
> #### Revoking a token is immediate and cannot be undone
>
> Revoking a database token is a destructive action that takes place immediately
> and cannot be undone.
>
> #### Rotate revoked tokens
>
> After revoking a database token, any clients using the revoked token need to
> be updated with a new database token to continue to interact with your
> {{% product-name omit=" Clustered" %}} cluster.
##### Aliases
`delete`
## Arguments
| Argument | Description |
| :----------- | :-------------------------- |
| **TOKEN_ID** | Database token ID to revoke |
## Flags
| Flag | | Description |
| :--- | :-------- | :---------------------------------------------------------- |
| | `--force` | Do not prompt for confirmation to revoke (default is false) |
| `-h` | `--help` | Output command help |
{{% caption %}}
_Also see [`influxctl` global flags](/influxdb3/clustered/reference/cli/influxctl/#global-flags)._
{{% /caption %}}
## Examples
- [Revoke a database token](#revoke-a-database-token)
- [Revoke multiple database tokens](#revoke-multiple-database-tokens)
In the examples below, replace the following:
- {{% code-placeholder-key %}}`TOKEN_ID`{{% /code-placeholder-key %}}:
token ID to revoke
### Revoke a database token
{{% code-placeholders "TOKEN_ID" %}}
```sh
influxctl token revoke TOKEN_ID
```
{{% /code-placeholders %}}
### Revoke multiple database tokens
{{% code-placeholders "TOKEN_ID_\d{1}" %}}
```sh
influxctl token revoke TOKEN_ID_1 TOKEN_ID_2
```
{{% /code-placeholders %}}

2
content/influxdb3/clustered/reference/client-libraries/v2/_index.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/arduino.md
View File

@ -16,7 +16,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/csharp.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/dart.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/go.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/java.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/javascript/_index.md
View File

@ -19,7 +19,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/javascript/browser.md
View File

@ -22,7 +22,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/_index.md
View File

@ -19,7 +19,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/install.md
View File

@ -16,7 +16,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/javascript/nodejs/write.md
View File

@ -19,7 +19,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/kotlin.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/php.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/python.md
View File

@ -20,7 +20,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/r.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/ruby.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/scala.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

2
content/influxdb3/clustered/reference/client-libraries/v2/swift.md
View File

@ -15,7 +15,7 @@ prepend: |
>
> The `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, **can't** query an {{% product-name omit=" Clustered" %}} cluster.
>
> [InfluxDB 3 client libraries](/influxdb3/clustered/reference/client-libraries/v3/) and [Flight SQL clients](/influxdb3/clustered/reference/client-libraries/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/clustered/write-data/) and [**querying**](/influxdb3/clustered/query-data/) data.
> [**Compare tools you can use**](/influxdb3/clustered/get-started/#tools-to-use) to interact with {{% product-name %}}.

650
content/influxdb3/clustered/reference/release-notes/influxctl.md
View File

@ -9,652 +9,8 @@ menu:
name: influxctl
parent: Release notes
weight: 202
canonical: /influxdb3/cloud-dedicated/reference/release-notes/influxctl/
source: /shared/influxctl/release-notes.md
---
## v2.9.9 {date="2025-01-24"}
### Features
- Sort [`influxctl token list`](/influxdb3/clustered/reference/cli/influxctl/token/list/)
and [`influxctl management list`](/influxdb3/clustered/reference/cli/influxctl/management/list/) output.
### Bug fixes
- Remove `UpdateAccount` and `UpdateCluster`.
- Remove "incorrect version" warning for gRPC unimplemented error code.
- Correctly parse multi-line queries from stdin.
### Dependency updates
- Update `github.com/fatih/color` from 1.17.0 to 1.18.0.
- Update `github.com/go-git/go-git/v5` from 5.12.0 to 5.13.1.
- Update `github.com/jedib0t/go-pretty/v6` from 6.6.0 to 6.6.5.
- Update `github.com/stretchr/testify` from 1.9.0 to 1.10.0.
- Update `golang.org/x/crypto` from 0.27.0 to 0.31.0.
- Update `golang.org/x/mod` from 0.21.0 to 0.22.0.
- Update `golang.org/x/oauth2` from 0.23.0 to 0.25.0.
- Update `google.golang.org/grpc` from 1.67.1 to 1.69.4.
- Update `google.golang.org/protobuf` from 1.35.1 to 1.36.3.
- Update Go to v1.23.5.
---
## v2.9.8 {date="2024-10-15"}
### Bug Fixes
- Continue revoking tokens on error.
- Reject unsupported input to `--template-timeformat`.
- Remove unused `client_secret` option from
[connection configuration profiles](/influxdb3/clustered/reference/cli/influxctl/#configure-connection-profiles).
### Dependency Updates
- Update Go to v1.23.2.
- Update `github.com/jedib0t/go-pretty/v6` from 6.5.9 to 6.6.0.
- Update `github.com/urfave/cli/v2` from 2.27.4 to 2.27.5.
- Update `google.golang.org/grpc` from 1.66.0 to 1.67.1.
- Update `google.golang.org/protobuf` from 1.34.2 to 1.35.1.
---
## v2.9.7 {date="2024-09-11"}
### Features
- Add [global `--timeout` flag](/influxdb3/clustered/reference/cli/influxctl/#global-flags).
- Improve timezone support.
### Bug Fixes
- Use passthrough resolver for gRPC.
### Dependency Updates
- Update Go to 1.23.1.
- Update `github.com/pelletier/go-toml/v2` from 2.2.2 to 2.2.3.
- Update `golang.org/x/mod` from 0.20.0 to 0.21.0.
- Update `golang.org/x/oauth2` from 0.22.0 to 0.23.0.
- Update `google.golang.org/grpc` from 1.65.0 to 1.66.0.
---
## v2.9.6 {date="2024-08-15"}
### Bug Fixes
- Update query to wait for EOF on stdin instead of the first newline.
---
## v2.9.5 {date="2024-08-13"}
### Bug Fixes
- Introduce auth login and logout commands.
- Attempt to refresh OAuth tokens when refresh token is present.
### Dependency Updates
- Update `github.com/urfave/cli/v2` from 2.27.2 to 2.27.4
- Update `golang.org/x/mod` from 0.19.0 to 0.20.0
- Update `golang.org/x/oauth2` from 0.21.0 to 0.22.0
---
## v2.9.4 {date="2024-07-25"}
### Bug Fixes
- Resolve crash when parsing error message and authentication was null.
### Dependency Updates
- Update `golang.org/x/mod` from 0.18.0 to 0.19.0
- Update `google.golang.org/grpc` from 1.64.0 to 1.65.0
---
## v2.9.3 {date="2024-06-26"}
### Bug Fixes
- Update query subcommand to safely handle null timestamp in response.
---
## v2.9.2 {date="2024-06-17"}
### Bug Fixes
- Ensure query subcommand returns any error while looping through results.
### Dependency Updates
- Update `google.golang.org/protobuf` from 1.34.1 to 1.34.2.
---
## v2.9.1 {date="2024-06-06"}
### Dependency Updates
- Update Go from 1.22.2 to 1.22.4
- Update `github.com/apache/arrow/go/v16` from 16.0.0 to 16.1.0
- Update `github.com/fatih/color` from 1.16.0 to 1.17.0
- Update `golang.org/x/mod` from 0.17.0 to 0.18.0
- Update `golang.org/x/oauth2` from 0.20.0 to 0.21.0
- Update `google.golang.org/grpc` from 1.63.2 to 1.64.0
- Update `google.golang.org/protobuf` from 1.34.0 to 1.34.1
- Update build dependencies.
---
## v2.9.0 {date="2024-05-06"}
### Features
- Restore default `rfc3339nano` timestamps in table output for `influxctl query`
and add the option for `unixnano` timestamps.
### Bug Fixes
- Update unimplemented error message with additional information.
### Dependency Updates
- Update `github.com/apache/arrow/go/v16` from 16.0.0-20240401180149-68241d8a86e9 to 16.0.0.
- Update `github.com/jedib0t/go-pretty/v6` from 6.5.8 to 6.5.9.
- Update `github.com/pelletier/go-toml/v2` from 2.2.0 to 2.2.1.
- Update `github.com/pelletier/go-toml/v2` from 2.2.1 to 2.2.2.
- Update `github.com/urfave/cli/v2` from 2.27.1 to 2.27.2.
- Update `golang.org/x/net` from 0.22.0 to 0.23.0.
- Update `golang.org/x/oauth2` from 0.19.0 to 0.20.0.
- Update `google.golang.org/protobuf` from 1.33.0 to 1.34.0.
- Update build dependencies.
---
## v2.8.0 {date="2024-04-11"}
`influxctl` 2.8.0 requires InfluxDB Clustered version 20240326-922145 or newer.
A change was made to how database commands were handled internally in InfluxDB
Clustered that required this change. If using an older version of InfluxDB
Clustered, you will observe an unimplemented gRPC error when using functionality
that depends on the updated command handling. If upgrading is not possible, you
can continue to use a version prior to 2.8.0 until you are able to update.
### Features
- Introduce the ability to query with InfluxQL.
- Add insecure configuration option to TLS configuration.
- Allow users to query system tables.
- Utilize the database proxy service.
### Dependency Updates
- Update Go to v1.22.2.
- Update `github.com/go-git/go-git/v5` from 5.11.0 to 5.12.0.
- Update `github.com/jedib0t/go-pretty/v6` from 6.5.6 to 6.5.8.
- Update `golang.org/x/mod` from 0.16.0 to 0.17.0.
- Update `golang.org/x/oauth2` from 0.18.0 to 0.19.0.
- Update `google.golang.org/grpc` from 1.62.1 to 1.63.2.
---
## v2.7.1 {date="2024-03-27"}
### Bug Fixes
- Correctly parse template tag bucket strings.
---
## v2.7.0 {date="2024-03-26"}
This minor release adds the `--template-tag-bucket` partition template option to
the already existing `--template-time-format` and `--template-tag` options used
to define custom partition templates for databases and tables.
This also fixes a nil pointer issue when listing management tokens.
### Features
- Introduce the bucket template method for grouping tag values into buckets and
partitioning by each tag bucket.
### Bug Fixes
- Ensure strings are not nil pointers.
### Dependency Updates
- Update `github.com/jedib0t/go-pretty/v6` from 6.5.5 to 6.5.6.
- Update `github.com/pelletier/go-toml/v2` from 2.1.1 to 2.2.0.
- Update granite proto.
---
## v2.6.0 {date="2024-03-18"}
`influxctl` 2.6.0 introduces the ability to create, list, and revoke
management tokens and allow you to authenticate directly with your
InfluxDB cluster instead of an OAuth2 provider.
### New Features
- Add management token subcommands to create, list, and revoke management
tokens.
- Introduce management token configuration option to authenticate using
management tokens created with `influxctl`.
### Dependency Updates
- Update Go to v1.22.1
- Update `github.com/golang-jwt/jwt/v5` from v5.2.0 to v5.2.1.
- Update `google.golang.org/protobuf` from v1.32.0 to v1.33.0.
- Update `golang.org/x/oauth2` from v0.17.0 to v0.18.0.
- Update `google.golang.org/grpc` from v1.62.0 to v1.62.1.
- Update `github.com/jedib0t/go-pretty/v6` from v6.5.4 to v6.5.5.
---
## v2.5.0 {date="2024-03-04"}
`influxctl` 2.5.0 introduces the ability to set
[partition templates](/influxdb3/clustered/admin/custom-partitions/) during
database or table creation. It introduces the
[`table` subcommand](/influxdb3/clustered/reference/cli/influxctl/table/)
that lets users manually create tables. Additionally, `influxctl` now removes a
previously cached token if the response from InfluxDB is unauthorized. This
helps InfluxDB Clustered users who deploy new clusters using unexpired tokens
associated with another InfluxDB cluster.
### New Features
- Add partition templates to database and table creation.
- Remove token if unauthorized.
### Bug Fixes
- Update Arrow to allow non-TLS connections.
- Do not attempt to load cached tokens when an admin token file is provided.
- Print retention period up to days rather than very large hours.
- Fix indentation of help output.
### Dependency Updates
- Update `github.com/golangci/golangcilint` from v1.56.1 to v1.56.2.
- Update `golang.org/x/mod` from v0.15.0 to v0.16.0.
- Update `github.com/pkg/browser` from v0.0.0-20210911075715-681adbf594b8 to
v0.0.0-20240102092130-5ac0b6a4141c.
- Update `github.com/stretchr/testify` from 1.8.4 to 1.9.0.
- Update `go.uber.org/zap` from 1.26.0 to 1.27.0.
- Update `google.golang.org/grpc` from 1.61.0 to 1.61.1.
- Update `google.golang.org/grpc` from 1.61.1 to 1.62.0.
---
## v2.4.4 {date="2024-02-16"}
### Bug fixes
- Introduced trace HTTP debug CLI option.
- Added custom gRPC error message handling to gRPC experience.
### Dependency updates
- Update to go1.22.0.
- Update `github.com/apache/arrow/go/v14` v14.0.2 to v15.0.0.
- Update `github.com/google/uuid` from 1.5.0 to 1.6.0.
- Update `github.com/jedib0t/go-pretty/v6` from 6.5.3 to 6.5.4.
- Update `golang.org/x/mod from` 0.14.0 to 0.15.0.
- Update `golang.org/x/oauth2` from 0.16.0 to 0.17.0.
- Update `google.golang.org/grpc` from 1.60.1 to 1.61.0.
---
## v2.4.3 {date="2024-01-17"}
### Bug fixes
- Show empty value for database limits when not set, rather than zero.
- Use user configured port for write.
- Correct typos in query and write error messages.
### Dependency updates
- Update to go1.21.6.
- Update `github.com/apache/arrow/go/v14` from 14.0.1 to 14.0.2.
- Update `github.com/cloudflare/circl` from 1.3.6 to 1.3.7.
- Update `github.com/jedib0t/go-pretty/v6` from 6.4.9 to 6.5.3.
- Update `github.com/urfave/cli/v2` from 2.26.0 to 2.27.1.
- Update `golang.org/x/crypto` from 0.16.0 to 0.17.0.
- Update `golang.org/x/oauth2` from 0.15.0 to 0.16.0.
- Update `google.golang.org/grpc` from 1.60.0 to 1.60.1.
- Update `google.golang.org/protobuf` from 1.31.0 to 1.32.0.
---
## v2.4.2 {date="2023-12-18"}
### Bug fixes
- Correctly set the version and build info for the version command.
---
## v2.4.1 {date="2023-12-14"}
### Bug fixes
- Update `influxctl query` examples with SQL instead of InfluxQL.
- Update example connection profile configuration with query and write options.
- Use database and token CLI options if set.
---
## v2.4.0 {date="2023-12-13"}
This release includes the following notable changes:
- InfluxDB Cloud Dedicated users now have the same `influxctl` login experience
as InfluxDB Clustered users. The Auth0 server uses device authorization by
displaying a code to validate when logging in. The browser still opens,
if possible, and pre-populates the code. The only difference is the need to
verify the code on one additional page. This was done to align the user
experience between both InfluxDB Cloud Dedicated and InfluxDB Clustered and
to allow Cloud Dedicated users without a local UI or browser to continue to
use `influxctl`.
- Introduce the `influxctl write` and `influxctl query` commands.
`influxctl query` queries an InfluxDB 3 instance using SQL.
`influxctl write` writes line protocol to a InfluxDB 3 instance.
### Features
- Introduce `influxctl query` command.
- Introduce `influxctl write` command.
- Use device auth for InfluxDB Cloud Dedicated.
### Bug fixes
- Avoid nil pointer for database information.
- Login and early return for TokenFile in InfluxDB Clustered.
### Dependency updates
- Update `github.com/go-git/go-git/v5` from 5.10.0 to 5.10.1.
- Update `github.com/go-git/go-git/v5` from 5.10.1 to 5.11.0.
- Update `github.com/golang-jwt/jwt/v5` from 5.1.0 to 5.2.0.
- Update `github.com/urfave/cli/v2` from 2.25.7 to 2.26.0.
- Update `golang.org/x/oauth2` from 0.14.0 to 0.15.0.
---
## v2.3.1 {date="2023-11-15"}
### Bug fixes
- Include error message description in device authorization polling errors.
- Do not save tokens when loading from file.
- Update header comments in the example `config.toml`.
### Dependency updates
- Update `github.com/golang-jwt/jwt/v5` from 5.0.0 to 5.1.0.
- Update `golang.org/x/oauth2` from 0.13.0 to 0.14.0.
---
## v2.3.0 {date="2023-11-06"}
_Features updated in this release are meant for internal InfluxData use and do
not affect any public APIs._
### Dependency updates
- Update `github.com/go-git/go-git/v5` from 5.9.0 to 5.10.0.
- Update `github.com/google/uuid` from 1.3.1 to 1.4.0.
- Update `github.com/jedib0t/go-pretty/v6` from 6.4.8 to 6.4.9.
- Update `golang.org/x/mod` from 0.13.0 to 0.14.0.
---
## v2.2.0 {date="2023-10-27"}
### Features
- Allow token authentication for InfluxDB Clustered.
---
## v2.1.0 {date="2023-10-26"}
### Features
- Add `--format` flag to [`influxctl token create`](/influxdb3/clustered/reference/cli/influxctl/token/create/)
to specify the command output format.
### Bug fixes
- Use correct account and cluster names when specified in command flags.
- Make `influxctl database list` return an empty array instead of _null_ when
there are no databases to list.
### Dependency updates
- Update to Go 1.21.3.
- Update `github.com/jedib0t/go-pretty/v6` from 6.4.7 to 6.4.8.
- Update `go.uber.org/zap` from 1.25.0 to 1.26.0.
- Update `golang.org/x/mod` from 0.12.0 to 0.13.0.
- Update `golang.org/x/net` from 0.15.0 to 0.17.0.
- Update `golang.org/x/oauth2` from 0.12.0 to 0.13.0.
- Update `google.golang.org/grpc` from 1.58.0 to 1.59.0.
### Miscellaneous
- Automate Homebrew tap releases for `influxctl`.
---
## v2.0.4 {date="2023-09-14"}
### Bug fixes
- Validate Microsoft Entra ID (formerly Azure Active Directory) token and device URLs.
- Only validate Microsoft Entra ID configuration when getting a token.
### Dependency updates
- Update to Go 1.21.
---
## v2.0.3 {date="2023-09-12"}
### Bug fixes
- Add pagination support to [`influxctl token list`](/influxdb3/clustered/reference/cli/influxctl/token/list/)
and [`influxctl user list`](/influxdb3/clustered/reference/cli/influxctl/user/list/).
- Send all logging output to stderr.
- Return error for commands that are not supported by InfluxDB Clustered.
### Dependency updates
- Update `github.com/google/uuid` from 1.3.0 to 1.3.1.
- Update `github.com/jedib0t/go-pretty/v6` from 6.4.6 to 6.4.7.
- Update `github.com/pelletier/go-toml/v2` from 2.0.9 to 2.1.0.
- Update `golang.org/x/oauth2` from 0.11.0 to 0.12.0.
- Update `google.golang.org/grpc` from 1.57.0 to 1.58.0.
---
## v2.0.2 {date="2023-08-23"}
### Bug fixes
- Add cluster get args, clarify error message.
- [`influxctl database update`](/influxdb3/clustered/reference/cli/influxctl/database/update/)
should only accept retention policy updates as a flag.
- Update [`influxctl token create`](/influxdb3/clustered/reference/cli/influxctl/token/create/)
and [`influxctl token update`](/influxdb3/clustered/reference/cli/influxctl/token/update/)
help information with examples that use multiple permission flags.
- Update [`influxctl cluster get`](/influxdb3/clustered/reference/cli/influxctl/cluster/get/)
help text.
- Switch email param ordering.
### Dependency updates
- Update `golang.org/x/mod` from 0.8.0 to 0.12.0.
### Miscellaneous
- Clean up log formatting.
- Remove extra debug output of account ID.
---
## v2.0.1 {date="2023-08-15"}
### Bug fixes
- Return an error when using unrecognized TOML configuration options.
---
## v2.0.0 {date="2023-08-09"}
`influxctl` 2.0.0 introduces support for both InfluxDB Cloud Dedicated and
InfluxDB Clustered. To simplify configuration profile management, all connection
configurations now managed in a single configuration file. If using `influxctl`
1.x, migrate your 1.x configuration profiles to the 2.0 format:
### Migrate from influxctl 1.x to 2.0
`influxctl` 2.0+ supports multiple InfluxDB 3 products.
To simplify connection configuration management, all configurations are now managed
in a single file rather than separate files for each connection configuration.
To migrate `influxctl` 1.x configuration files to the 2.x format, use the
following guidelines:
1. Create a 2.0+ configuration file (`config.toml`) at the default location
for your operating system.
_See [Create a configuration file](/influxdb3/clustered/reference/cli/influxctl/#create-a-configuration-file)_.
2. Copy the `account_id` and `cluster_id` credentials from your `influxctl` 1.x
configuration file and add them to a `[[profile]]` TOML table along with the
following fields:
- **name**: Profile name
- **product**: InfluxDB product (`dedicated`)
For example, the following 1.x configuration file:
```toml
account_id = "dff3ee52-b494-47c1-9e2c-ab59d90d94eb"
cluster_id = "5827cdeb-b868-4446-b40e-e08de116fddf"
```
would become:
```toml
[[profile]]
name = "default"
product = "dedicated"
account_id = "dff3ee52-b494-47c1-9e2c-ab59d90d94eb"
cluster_id = "5827cdeb-b868-4446-b40e-e08de116fddf"
```
### Features
- Add support for both InfluxDB Cloud Dedicated and InfluxDB Clustered.
- Provide public distributions through <https://www.influxdata.com/downloads/>
and the <https://repos.influxdata.com/> repository.
- The `influxctl` configuration file is now a single file that you can
optionally pass in via the CLI.
- Add additional options to [`influxctl database`](/influxdb3/clustered/reference/cli/influxctl/database/)
and [`influxctl token`](/influxdb3/clustered/reference/cli/influxctl/token/)
subcommands.
- Introduce [`influxctl cluster`](/influxdb3/clustered/reference/cli/influxctl/cluster/)
subcommands.
- Remove the `influxctl init` subcommand to avoid additional complexity of an
InfluxDB Cloud Dedicated configuration.
- Set maximum tables and columns when creating a database.
- Support passing a connection configuration file path as a CLI option.
- Delete multiple tokens or database in one command.
- Disable of TLS verification for self-signed certificates.
- Update a database and token values.
- Update account & cluster ID for configurations for InfluxDB Clustered.
- Add account and authz gRPC method support.
- Add account and authz protofiles.
- Add oauth2 authentication.
- Specify custom TLS certificates.
- Store configuration settings for multiple InfluxDB products in a single
configuration file.
### Bug Fixes
- Return error when too many arguments are provided to a command.
- Set token directory permissions to only the current user.
- Unmarshal `expires_in` for device OAuth2 token.
- Update authentication host for InfluxDB Cloud Dedicated.
- Verify account and cluster IDs.
### Miscellaneous
- Update configuration examples with InfluxDB Clustered configurations.
- Properly close gRPC connections.
- Update error message for missing connection profiles.
### Dependency Updates
- Update `github.com/pelletier/go-toml/v2` from 2.0.7 to 2.0.9.
- Update `github.com/stretchr/testify` from 1.8.2 to 1.8.4.
- Update `github.com/urfave/cli/v2` from 2.25.3 to 2.25.7.
- Update `go.uber.org/zap` from 1.24.0 to 1.25.0.
- Update `golang.org/x/oauth2` from 0.9.0 to 0.11.0.
- Update `google.golang.org/grpc` from 1.55.0 to 1.57.0.
- Update `google.golang.org/protobuf` from 1.30.0 to 1.31.0.
---
## v1.1.0 {date="2023-05-19"}
### Features
- Add the [`influxctl database update`](/influxdb3/clustered/reference/cli/influxctl/database/update/)
subcommand to update retention periods.
- Add the [`influxctl token update`](/influxdb3/clustered/reference/cli/influxctl/database/update/)
subcommand to update token descriptions.
- Using the `influxctl init` command:
- Confirm before overwriting an existing profile.
- Remove the existing token if overwriting a profile.
- On error, use stderr and return non-zero return code.
- Increase command timeouts to 60 seconds.
- Support setting the Auth0 and gRPC destinations using environment variables
for staging and development environment use.
### Bug fixes
- Call `Makefile` instead of `goreleaser`.
- Remove token on init.
### Dependency updates
- Update `github.com/urfave/cli/v2` from 2.25.1 to 2.25.3.
- Update `golang.org/x/oauth2` from 0.7.0 to 0.8.0.
- Update `google.golang.org/grpc` from 1.54.0 to 1.55.0.
---
## v1.0.0 {date="2023-04-26"}
### Features
- Output confirmation messages on delete.
- Use production Authentication service URLs.
### Miscellaneous
- Display `0s` retention policies as infinite.
<!-- The content of this page is located at
// SOURCE content/shared/influxctl/release-notes.md -->

4
content/influxdb3/clustered/write-data/line-protocol/influxctl-cli.md
View File

@ -26,7 +26,7 @@ to write line protocol data to {{< product-name >}}.
## Construct line protocol
With a [basic understanding of line protocol](/influxdb3/clustered/write-data/line-protocol/),
you can now construct line protocol and write data to InfluxDB.
you can construct data in line protocol format and write it to InfluxDB.
Consider a use case where you collect data from sensors in your home.
Each sensor collects temperature, humidity, and carbon monoxide readings.
To collect this data, use the following schema:
@ -40,7 +40,7 @@ To collect this data, use the following schema:
- `co`: carbon monoxide in parts per million (integer)
- **timestamp**: Unix timestamp in _second_ precision
The following line protocol represent the schema described above:
The following line protocol represents the schema described above:
```text
home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1641024000

10
content/influxdb3/core/get-started/_index.md
View File

@ -11,7 +11,17 @@ menu:
weight: 3
related:
- /influxdb3/core/admin/query-system-data/
- /influxdb3/core/write-data/
- /influxdb3/core/query-data/
source: /shared/v3-core-get-started/_index.md
prepend: |
> [!Note]
> InfluxDB 3 Core is purpose-built for real-time data monitoring and recent data.
> InfluxDB 3 Enterprise builds on top of Core with support for historical data
> querying, high availability, read replicas, and more.
> Enterprise will soon unlock
> enhanced security, row-level deletions, an administration UI, and more.
> Learn more about [InfluxDB 3 Enterprise](/influxdb3/enterprise/).
---
<!--

22
content/influxdb3/core/reference/client-libraries/_index.md Normal file
View File

@ -0,0 +1,22 @@
---
title: InfluxDB API client libraries
description: >
InfluxDB client libraries are language-specific tools that integrate with InfluxDB APIs.
View the list of available client libraries.
list_title: API client libraries
weight: 105
aliases:
- /influxdb3/core/reference/api/client-libraries/
- /influxdb3/core/tools/client-libraries/
- /influxdb3/core/api-guide/client-libraries/
menu:
influxdb3_core:
name: Client libraries
parent: Reference
influxdb3/core/tags: [client libraries, API, developer tools]
source: /shared/influxdb-client-libraries-reference/_index.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/_index.md
-->

21
content/influxdb3/core/reference/client-libraries/flight/_index.md Normal file
View File

@ -0,0 +1,21 @@
---
title: Apache Arrow Flight RPC clients
description: >
Flight clients are language-specific drivers that can interact with Flight servers using the Arrow in-memory format and the Flight RPC framework.
View the list of available clients.
weight: 30
menu:
influxdb3_core:
name: Arrow Flight clients
parent: Client libraries
influxdb3/core/tags: [client libraries, Flight RPC, Flight SQL]
aliases:
- /influxdb3/core/reference/client-libraries/flight-sql/
- /influxdb3/core/reference/client-libraries/flight-sql/go-flightsql/
- /influxdb3/core/reference/client-libraries/flight-sql/python-flightsql-dbapi/
source: /shared/influxdb-client-libraries-reference/flight/_index.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/flight/_index.md
-->

18
content/influxdb3/core/reference/client-libraries/flight/csharp-flight.md Normal file
View File

@ -0,0 +1,18 @@
---
title: C# .NET Flight client
description: The C# .NET Flight client integrates with C# .NET scripts and applications to query data stored in InfluxDB.
menu:
influxdb3_core:
name: C# .NET
parent: Arrow Flight clients
identifier: csharp-flight-client
influxdb3/core/tags: [C#, gRPC, SQL, Flight SQL, client libraries]
aliases:
- /influxdb3/core/reference/client-libraries/flight-sql/csharp-flightsql/
weight: 201
source: /shared/influxdb-client-libraries-reference/flight/csharp-flight.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/flight/csharp-flight.md
-->

20
content/influxdb3/core/reference/client-libraries/flight/go-flight.md Normal file
View File

@ -0,0 +1,20 @@
---
title: Go Flight client
description: The Go Flight client integrates with Go scripts and applications to query data stored in InfluxDB.
menu:
influxdb3_core:
name: Go
parent: Arrow Flight clients
identifier: go-flight-client
influxdb3/core/tags: [Flight client, Go, gRPC, SQL, Flight SQL, client libraries]
related:
- /influxdb3/core/reference/client-libraries/v3/go/
aliases:
- /influxdb3/core/reference/client-libraries/flight-sql/go-flightsql/
weight: 201
source: /shared/influxdb-client-libraries-reference/flight/go-flight.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/flight/go-flight.md
-->

45
content/influxdb3/core/reference/client-libraries/flight/java-flightsql.md Normal file
View File

@ -0,0 +1,45 @@
---
title: Java Flight SQL package
description: The Java Flight SQL client integrates with Java applications to query and retrieve data from Flight database servers using RPC and SQL.
menu:
influxdb3_core:
name: Java Flight SQL
parent: Arrow Flight clients
identifier: java-flightsql-client
influxdb3/core/tags: [Flight client, Java, gRPC, SQL, Flight SQL]
weight: 201
related:
- /influxdb3/core/reference/client-libraries/v3/java/
aliases:
- /influxdb3/core/reference/client-libraries/flight-sql/java-flightsql/
list_code_example: |
```java
public class Query {
public static void main(String[] args) {
String query = "SELECT * FROM home";
Location location = Location.forGrpcTls(HOST, 443);
CredentialCallOption auth = new CredentialCallOption(new BearerCredentialWriter(TOKEN));
BufferAllocator allocator = new RootAllocator(Long.MAX_VALUE);
FlightClientMiddleware.Factory f = info -> new FlightClientMiddleware() {
@Override
public void onBeforeSendingHeaders(CallHeaders outgoingHeaders) {
outgoingHeaders.insert(DATABASE_FIELD, DATABASE_NAME);
}
};
FlightClient client = FlightClient.builder(allocator, location)
.intercept(f)
.build();
FlightSqlClient sqlClient = new FlightSqlClient(client);
FlightInfo flightInfo = sqlClient.execute(query, auth);
}
}
```
source: /shared/influxdb-client-libraries-reference/flight/java-flightsql.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/flight/java-flightsql.md
-->

53
content/influxdb3/core/reference/client-libraries/flight/python-flight.md Normal file
View File

@ -0,0 +1,53 @@
---
title: Python Flight client
description: The Python Flight client integrates with Python scripts and applications to query data stored in InfluxDB.
menu:
influxdb3_core:
name: Python
parent: Arrow Flight clients
identifier: python-flight-client
influxdb3/core/tags: [Flight client, Python, gRPC, SQL, Flight SQL, client libraries]
aliases:
- /influxdb3/core/reference/client-libraries/flight-sql/python-flightsql/
weight: 201
list_code_example: |
```py
from pyarrow.flight import FlightClient, Ticket, FlightCallOptions
import json
import pandas
import tabulate
# Downsampling query groups data into 2-hour bins
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
1,
room
ORDER BY room, 1"""
flight_ticket = Ticket(json.dumps({
"namespace_name": "DATABASE_NAME",
"sql_query": sql,
"query_type": "sql"
}))
token = (b"authorization", bytes(f"Bearer DATABASE_TOKEN".encode('utf-8')))
options = FlightCallOptions(headers=[token])
client = FlightClient(f"grpc+tls://{{< influxdb/host >}}:443")
reader = client.do_get(flight_ticket, options)
arrow_table = reader.read_all()
```
source: /shared/influxdb-client-libraries-reference/flight/python-flight.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/flight/python-flight.md
-->

18
content/influxdb3/core/reference/client-libraries/flight/python-flightsql-dbapi.md Normal file
View File

@ -0,0 +1,18 @@
---
title: Python Flight SQL DBAPI client
description: The Python `flightsql-dbapi` library uses SQL and the Flight SQL protocol to query data stored in an InfluxDB Core database.
menu:
influxdb3_core:
name: Python Flight SQL
parent: Arrow Flight clients
identifier: python-flightsql-client
influxdb3/core/tags: [Flight client, Python, SQL, Flight SQL]
weight: 201
aliases:
- /influxdb3/core/reference/client-libraries/flight-sql/python-flightsql/
source: /shared/influxdb-client-libraries-reference/flight/python-flightsql-dbapi.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/flight/python-flightsql-dbapi.md
-->

17
content/influxdb3/core/reference/client-libraries/v1/_index.md Normal file
View File

@ -0,0 +1,17 @@
---
title: InfluxDB v1 client libraries
description: >
InfluxDB v1 client libraries use the InfluxDB 1.7 API and should be fully compatible with InfluxDB 1.5+.
View the list of available client libraries.
menu:
influxdb3_core:
weight: 201
name: v1 client libraries
parent: Client libraries
influxdb3/core/tags: [client libraries, API, developer tools]
source: /shared/influxdb-client-libraries-reference/v1/_index.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/v1/_index.md
-->

33
content/influxdb3/core/reference/client-libraries/v2/_index.md Normal file
View File

@ -0,0 +1,33 @@
---
title: InfluxDB v2 API client libraries
description: >
InfluxDB v2 client libraries use InfluxDB `/api/v2` endpoints and work with [InfluxDB 2.x API compatibility endpoints](/influxdb/v1/tools/api/#influxdb-2x-api-compatibility-endpoints).
View the list of available client libraries.
weight: 101
menu:
influxdb3_core:
name: v2 client libraries
parent: Client libraries
influxdb3/core/tags: [client libraries, API, developer tools]
prepend: |
> [!WARNING]
> #### Use InfluxDB 3 clients to query
>
> InfluxDB 3 supports [compatibility endpoints for _writing data_](/influxdb3/{{% product-key %}}/write-data/compatibility-apis/) using InfluxDB v2 and v1 tools. However, the `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, _can't query_
> stored in {{% product-name %}}.
>
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/reference/client-libraries/v3/)
> are available that integrate with your code to write and query data stored
> in {{% product-name %}}.
>
> InfluxDB 3 supports many different tools for [**writing**](/influxdb3/core/write-data/)
> and [**querying**](/influxdb3/core/query-data/) data.
> [**Compare tools you can use**](/influxdb3/core/get-started/#tools-to-use)
> to interact with {{% product-name %}}.
>
source: /shared/influxdb-client-libraries-reference/v2/_index.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/v2/_index.md
-->

27
content/influxdb3/core/reference/client-libraries/v2/arduino.md Normal file
View File

@ -0,0 +1,27 @@
---
title: Arduino client library
seotitle: Use the InfluxDB Arduino client library
list_title: Arduino
description: Use the InfluxDB Arduino client library to interact with InfluxDB.
external_url: https://github.com/tobiasschuerg/InfluxDB-Client-for-Arduino
list_note: _– contributed by [tobiasschuerg](https://github.com/tobiasschuerg)_
menu:
influxdb3_core:
name: Arduino
parent: v2 client libraries
weight: 201
prepend: |
> [!WARNING]
> #### Use InfluxDB 3 clients to query
>
> InfluxDB 3 supports [compatibility endpoints for _writing data_](/influxdb3/{{% product-key %}}/write-data/compatibility-apis/) using InfluxDB v2 and v1 tools. However, the `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, _can't query_ data stored in {{% product-name %}}.
>
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/reference/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> [**Compare tools you can use**](/influxdb3/core/get-started/#tools-to-use) to interact with {{% product-name %}}.
source: /shared/influxdb-client-libraries-reference/v2/arduino.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/v2/arduino.md
-->

26
content/influxdb3/core/reference/client-libraries/v2/csharp.md Normal file
View File

@ -0,0 +1,26 @@
---
title: C# client library
list_title: C#
seotitle: Use the InfluxDB C# client library
description: Use the InfluxDB C# client library to interact with InfluxDB.
external_url: https://github.com/influxdata/influxdb-client-csharp
menu:
influxdb3_core:
name: C#
parent: v2 client libraries
weight: 201
prepend: |
> [!WARNING]
> #### Use InfluxDB 3 clients to query
>
> InfluxDB 3 supports [compatibility endpoints for _writing data_](/influxdb3/{{% product-key %}}/write-data/compatibility-apis/) using InfluxDB v2 and v1 tools. However, the `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, _can't query_ data stored in {{% product-name %}}.
>
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/reference/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> [**Compare tools you can use**](/influxdb3/core/get-started/#tools-to-use) to interact with {{% product-name %}}.
source: /shared/influxdb-client-libraries-reference/v2/csharp.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/v2/csharp.md
-->

26
content/influxdb3/core/reference/client-libraries/v2/dart.md Normal file
View File

@ -0,0 +1,26 @@
---
title: Dart client library
list_title: Dart
seotitle: Use the InfluxDB Dart client library
description: Use the InfluxDB Dart client library to interact with InfluxDB.
external_url: https://github.com/influxdata/influxdb-client-dart
menu:
influxdb3_core:
name: Dart
parent: v2 client libraries
weight: 201
prepend: |
> [!WARNING]
> #### Use InfluxDB 3 clients to query
>
> InfluxDB 3 supports [compatibility endpoints for _writing data_](/influxdb3/{{% product-key %}}/write-data/compatibility-apis/) using InfluxDB v2 and v1 tools. However, the `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, _can't query_ data stored in {{% product-name %}}.
>
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/reference/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> [**Compare tools you can use**](/influxdb3/core/get-started/#tools-to-use) to interact with {{% product-name %}}.
source: /shared/influxdb-client-libraries-reference/v2/dart.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/v2/dart.md
-->

26
content/influxdb3/core/reference/client-libraries/v2/go.md Normal file
View File

@ -0,0 +1,26 @@
---
title: InfluxDB v2 Go client library
list_title: Go
description: >
The InfluxDB v2 Go client library integrates with Go applications to write data to an InfluxDB Core database.
menu:
influxdb3_core:
name: Go
parent: v2 client libraries
influxdb3/core/tags: [client libraries, Go]
weight: 201
prepend: |
> [!WARNING]
> #### Use InfluxDB 3 clients to query
>
> InfluxDB 3 supports [compatibility endpoints for _writing data_](/influxdb3/{{% product-key %}}/write-data/compatibility-apis/) using InfluxDB v2 and v1 tools. However, the `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, _can't query_ data stored in {{% product-name %}}.
>
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/reference/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> [**Compare tools you can use**](/influxdb3/core/get-started/#tools-to-use) to interact with {{% product-name %}}.
source: /shared/influxdb-client-libraries-reference/v2/go.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/v2/go.md
-->

26
content/influxdb3/core/reference/client-libraries/v2/java.md Normal file
View File

@ -0,0 +1,26 @@
---
title: Java client library
seotitle: Use the InfluxDB Java client library
list_title: Java
description: Use the Java client library to interact with InfluxDB.
external_url: https://github.com/influxdata/influxdb-client-java
menu:
influxdb3_core:
name: Java
parent: v2 client libraries
weight: 201
prepend: |
> [!WARNING]
> #### Use InfluxDB 3 clients to query
>
> InfluxDB 3 supports [compatibility endpoints for _writing data_](/influxdb3/{{% product-key %}}/write-data/compatibility-apis/) using InfluxDB v2 and v1 tools. However, the `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, _can't query_ data stored in {{% product-name %}}.
>
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/reference/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> [**Compare tools you can use**](/influxdb3/core/get-started/#tools-to-use) to interact with {{% product-name %}}.
source: /shared/influxdb-client-libraries-reference/v2/java.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/v2/java.md
-->

30
content/influxdb3/core/reference/client-libraries/v2/javascript/_index.md Normal file
View File

@ -0,0 +1,30 @@
---
title: JavaScript client library for the InfluxDB v2 API
seotitle: InfluxDB v2 JavaScript client library for the InfluxDB v2 API
list_title: JavaScript
description: >
The [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js)
for Node.js and browsers integrates with the InfluxDB v2 API to write data to an InfluxDB Core cluster.
menu:
influxdb3_core:
name: JavaScript
parent: v2 client libraries
influxdb3/core/tags: [client libraries, JavaScript, NodeJS]
weight: 201
aliases:
- /influxdb3/core/reference/api/client-libraries/js/
prepend: |
> [!WARNING]
> #### Use InfluxDB 3 clients to query
>
> InfluxDB 3 supports [compatibility endpoints for _writing data_](/influxdb3/{{% product-key %}}/write-data/compatibility-apis/) using InfluxDB v2 and v1 tools. However, the `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, _can't query_ data stored in {{% product-name %}}.
>
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/reference/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> [**Compare tools you can use**](/influxdb3/core/get-started/#tools-to-use) to interact with {{% product-name %}}.
source: /shared/influxdb-client-libraries-reference/v2/javascript/_index.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/v2/javascript/_index.md
-->

33
content/influxdb3/core/reference/client-libraries/v2/javascript/browser.md Normal file
View File

@ -0,0 +1,33 @@
---
title: InfluxDB v2 JavaScript client library for web browsers
list_title: JavaScript for browsers
description: >
Use the InfluxDB v2 JavaScript client library in browsers and front-end clients to write data to an InfluxDB Core database.
menu:
influxdb3_core:
name: Browsers and web clients
identifier: client_js_browsers
parent: JavaScript
influxdb3/core/tags: [client libraries, JavaScript]
weight: 201
aliases:
- /influxdb3/core/api-guide/client-libraries/browserjs/write
- /influxdb3/core/api-guide/client-libraries/browserjs/query
related:
- /influxdb3/core/reference/client-libraries/v2/javascript/nodejs/write/
- /influxdb3/core/api-guide/client-libraries/nodejs/query/
prepend: |
> [!Warning]
> #### Use InfluxDB 3 clients to query
>
> InfluxDB 3 supports [compatibility endpoints for _writing data_](/influxdb3/{{% product-key %}}/write-data/compatibility-apis/) using InfluxDB v2 and v1 tools. However, the `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, _can't query_ data stored in {{% product-name %}}.
>
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/reference/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> [**Compare tools you can use**](/influxdb3/core/get-started/#tools-to-use) to interact with {{% product-name %}}.
source: /shared/influxdb-client-libraries-reference/v2/javascript/browser.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/v2/javascript/browser.md
-->

30
content/influxdb3/core/reference/client-libraries/v2/javascript/nodejs/_index.md Normal file
View File

@ -0,0 +1,30 @@
---
title: Node.js JavaScript client library
seotitle: InfluxDB v2 JavaScript client library for Node.js
list_title: Node.js
description: >
The [InfluxDB v2 JavaScript client library](https://github.com/influxdata/influxdb-client-js)
for Node.js integrates with the InfluxDB v2 API to write data to an InfluxDB Core database.
menu:
influxdb3_core:
name: Node.js
parent: JavaScript
influxdb3/core/tags: [client libraries, JavaScript, NodeJS]
weight: 201
aliases:
- /influxdb3/core/reference/api/client-libraries/nodejs/
prepend: |
> [!WARNING]
> #### Use InfluxDB 3 clients to query
>
> InfluxDB 3 supports [compatibility endpoints for _writing data_](/influxdb3/{{% product-key %}}/write-data/compatibility-apis/) using InfluxDB v2 and v1 tools. However, the `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, _can't query_ data stored in {{% product-name %}}.
>
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/reference/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> [**Compare tools you can use**](/influxdb3/core/get-started/#tools-to-use) to interact with {{% product-name %}}.
source: /shared/influxdb-client-libraries-reference/v2/javascript/nodejs/_index.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/v2/javascript/nodejs/_index.md
-->

27
content/influxdb3/core/reference/client-libraries/v2/javascript/nodejs/install.md Normal file
View File

@ -0,0 +1,27 @@
---
title: Install the InfluxDB v2 JavaScript client library
description: >
Install the Node.js JavaScript client library to write data to an InfluxDB Core database.
menu:
influxdb3_core:
name: Install
parent: Node.js
influxdb3/core/tags: [client libraries, JavaScript]
weight: 100
aliases:
- /influxdb3/core/reference/api/client-libraries/nodejs/install
prepend: |
> [!WARNING]
> #### Use InfluxDB 3 clients to query
>
> InfluxDB 3 supports [compatibility endpoints for _writing data_](/influxdb3/{{% product-key %}}/write-data/compatibility-apis/) using InfluxDB v2 and v1 tools. However, the `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, _can't query_ data stored in {{% product-name %}}.
>
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/reference/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> [**Compare tools you can use**](/influxdb3/core/get-started/#tools-to-use) to interact with {{% product-name %}}.
source: /shared/influxdb-client-libraries-reference/v2/javascript/nodejs/install.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/v2/javascript/nodejs/install.md
-->

30
content/influxdb3/core/reference/client-libraries/v2/javascript/nodejs/write.md Normal file
View File

@ -0,0 +1,30 @@
---
title: Write data with the InfluxDB v2 JavaScript client library
list_title: Write data
description: >
The InfluxDB v2 JavaScript client library integrates with Node.js applications to write data to the InfluxDB v2 API.
menu:
influxdb3_core:
name: Write
parent: Node.js
influxdb3/core/tags: [client libraries, JavaScript]
weight: 101
aliases:
- /influxdb3/core/reference/api/client-libraries/nodejs/write
related:
- /influxdb3/core/write-data/troubleshoot/
prepend: |
> [!WARNING]
> #### Use InfluxDB 3 clients to query
>
> InfluxDB 3 supports [compatibility endpoints for _writing data_](/influxdb3/{{% product-key %}}/write-data/compatibility-apis/) using InfluxDB v2 and v1 tools. However, the `/api/v2/query` API endpoint and associated tooling, such as InfluxDB v2 client libraries and the `influx` CLI, _can't query_ data stored in {{% product-name %}}.
>
> [InfluxDB 3 client libraries](/influxdb3/{{% product-key %}}/reference/client-libraries/v3/) are available that integrate with your code to write and query data stored in {{% product-name %}}.
>
> [**Compare tools you can use**](/influxdb3/core/get-started/#tools-to-use) to interact with {{% product-name %}}.
source: /shared/influxdb-client-libraries-reference/v2/javascript/nodejs/write.md
---
<!-- The content for this page is at
// SOURCE content/shared/influxdb-client-libraries-reference/v2/javascript/nodejs/write.md
-->

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