Merge branch 'master' into 6071-chore-v2-partial-writes
Jason Stirnaman
GitHub
commit
36e65a663e
|
|
@ -40,6 +40,7 @@ tags:
|
|||
See how to [create a management token](/influxdb3/cloud-dedicated/admin/tokens/management/).
|
||||
|
||||
By default, management tokens in InfluxDB 3 are short-lived tokens issued by an OAuth2 identity provider that grant a specific user administrative access to your InfluxDB cluster. However, for automation purposes, you can manually create management tokens that authenticate directly with your InfluxDB cluster and do not require human interaction with your identity provider.
|
||||
<!-- ReDoc-Inject: <security-definitions> -->
|
||||
- name: Database tokens
|
||||
description: Manage database read/write tokens for a cluster
|
||||
- name: Databases
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ tags:
|
|||
#### Related guides
|
||||
|
||||
- [Manage tokens](/influxdb3/core/admin/tokens/)
|
||||
- [Authentication and authorization](/influxdb3/core/reference/authentication/)
|
||||
- [Authentication and authorization](/influxdb3/core/reference/internals/authentication/)
|
||||
x-traitTag: true
|
||||
- name: Cache data
|
||||
description: |
|
||||
|
|
|
|||
|
|
@ -52,7 +52,7 @@ tags:
|
|||
#### Related guides
|
||||
|
||||
- [Manage tokens](/influxdb3/enterprise/admin/tokens/)
|
||||
- [Authentication and authorization](/influxdb3/enterprise/reference/authentication/)
|
||||
- [Authentication and authorization](/influxdb3/enterprise/reference/internals/authentication/)
|
||||
x-traitTag: true
|
||||
- name: Cache data
|
||||
description: |
|
||||
|
|
@ -1936,8 +1936,6 @@ components:
|
|||
scheme: bearer
|
||||
bearerFormat: JWT
|
||||
description: |
|
||||
_During Alpha release, an API token is not required._
|
||||
|
||||
A Bearer token for authentication.
|
||||
|
||||
Provide the scheme and the API token in the `Authorization` header--for example:
|
||||
|
|
|
|||
|
|
@ -3,7 +3,8 @@
|
|||
"baseUrl": ".",
|
||||
"paths": {
|
||||
"*": [
|
||||
"*"
|
||||
"*",
|
||||
"../node_modules/*"
|
||||
]
|
||||
}
|
||||
}
|
||||
|
|
|
|||
|
|
@ -164,13 +164,13 @@ gpg: key 7C3D57159FC2F927: public key "InfluxData Package Signing Key <support@i
|
|||
<!--test:setup
|
||||
```sh
|
||||
curl --silent --location --output-dir ~/Downloads -O \
|
||||
"https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz" \
|
||||
"https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz" \
|
||||
```
|
||||
-->
|
||||
|
||||
```sh
|
||||
curl --silent --location \
|
||||
https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz.asc \
|
||||
https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz.asc \
|
||||
| gpg --verify - ~/Downloads/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz \
|
||||
2>&1 | grep 'InfluxData Package Signing Key <support@influxdata.com>'
|
||||
```
|
||||
|
|
@ -239,12 +239,12 @@ brew install influxdb
|
|||
|
||||
1. In your browser or your terminal, download the InfluxDB package.
|
||||
|
||||
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz" download>InfluxDB v2 (macOS)</a>
|
||||
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz" download>InfluxDB v2 (macOS)</a>
|
||||
|
||||
```sh
|
||||
# Download using cURL
|
||||
curl --location -O \
|
||||
"https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz"
|
||||
"https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_darwin_amd64.tar.gz"
|
||||
```
|
||||
|
||||
2. {{< req text="Recommended:" color="magenta" >}}: Verify the integrity of the download--for example, enter the
|
||||
|
|
@ -443,18 +443,18 @@ _If necessary, adjust the example file paths and utilities for your system._
|
|||
1. In your browser or your terminal, download the InfluxDB binary for your
|
||||
system architecture (AMD64 or ARM).
|
||||
|
||||
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz" download >InfluxDB v2 (amd64)</a>
|
||||
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz" download >InfluxDB v2 (arm)</a>
|
||||
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz" download >InfluxDB v2 (amd64)</a>
|
||||
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz" download >InfluxDB v2 (arm)</a>
|
||||
|
||||
<!--test:actual
|
||||
```sh
|
||||
curl -s --location -O \
|
||||
"https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz"
|
||||
"https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz"
|
||||
```
|
||||
|
||||
```sh
|
||||
curl -s --location -O \
|
||||
"https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz"
|
||||
"https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz"
|
||||
```
|
||||
-->
|
||||
|
||||
|
|
@ -463,7 +463,7 @@ _If necessary, adjust the example file paths and utilities for your system._
|
|||
```sh
|
||||
# Use curl to download the amd64 binary.
|
||||
curl --location -O \
|
||||
https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz
|
||||
https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz
|
||||
```
|
||||
|
||||
<!--pytest.mark.skip-->
|
||||
|
|
@ -471,7 +471,7 @@ _If necessary, adjust the example file paths and utilities for your system._
|
|||
```sh
|
||||
# Use curl to download the arm64 binary.
|
||||
curl --location -O \
|
||||
https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz
|
||||
https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz
|
||||
```
|
||||
|
||||
2. [Choose the InfluxData key-pair for your OS version](#choose-the-influxdata-key-pair-for-your-system).
|
||||
|
|
@ -505,7 +505,7 @@ _If necessary, adjust the example file paths and utilities for your system._
|
|||
| grep 'InfluxData Package Signing Key <support@influxdata.com>' \
|
||||
&&
|
||||
# Download and verify the binary's signature file
|
||||
curl --silent --location "https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz.asc" \
|
||||
curl --silent --location "https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz.asc" \
|
||||
| gpg --verify - influxdb2-{{< latest-patch >}}_linux_amd64.tar.gz \
|
||||
2>&1 | grep 'InfluxData Package Signing Key <support@influxdata.com>'
|
||||
```
|
||||
|
|
@ -519,7 +519,7 @@ _If necessary, adjust the example file paths and utilities for your system._
|
|||
| grep 'InfluxData Package Signing Key <support@influxdata.com>' \
|
||||
&&
|
||||
# Download and verify the binary's signature file
|
||||
curl --silent --location "https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz.asc" \
|
||||
curl --silent --location "https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz.asc" \
|
||||
| gpg --verify - influxdb2-{{< latest-patch >}}_linux_arm64.tar.gz \
|
||||
2>&1 | grep 'InfluxData Package Signing Key <support@influxdata.com>'
|
||||
```
|
||||
|
|
@ -618,7 +618,7 @@ chmod 0750 ~/.influxdbv2
|
|||
>
|
||||
> _You'll install the `influx CLI` in a [later step](#download-install-and-configure-the-influx-cli)._
|
||||
|
||||
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/influxdb2-{{< latest-patch >}}-windows.zip" download >InfluxDB v2 (Windows)</a>
|
||||
<a class="btn download" href="https://download.influxdata.com/influxdb/releases/v{{< latest-patch >}}/influxdb2-{{< latest-patch >}}-windows.zip" download >InfluxDB v2 (Windows)</a>
|
||||
|
||||
Expand the downloaded archive into `C:\Program Files\InfluxData\` and rename the
|
||||
files if desired.
|
||||
|
|
|
|||
|
|
@ -2744,6 +2744,61 @@ storage-validate-keys = true
|
|||
|
||||
---
|
||||
|
||||
### storage-wal-flush-on-shutdown
|
||||
Flush the WAL on shutdown.
|
||||
|
||||
**Default:** `false`
|
||||
|
||||
| influxd flag | Environment variable | Configuration key |
|
||||
| :------------------------------ | :------------------------------------ | :---------------------------- |
|
||||
| `--storage-wal-flush-on-shutdown` | `INFLUXD_STORAGE_WAL_FLUSH_ON_SHUTDOWN` | `storage-wal-flush-on-shutdown` |
|
||||
|
||||
If set, `influxd` flushes or snapshots all WALs prior to completing shutdown--`influxd` performs cache snapshots on shutdown, which
|
||||
results in the WAL files being written to TSM files and then deleted.
|
||||
|
||||
This is useful in upgrade and downgrade scenarios to prevent WAL format
|
||||
compatibility issues.
|
||||
|
||||
###### influxd flag
|
||||
<!--pytest.mark.skip-->
|
||||
|
||||
```sh
|
||||
influxd --storage-wal-flush-on-shutdown
|
||||
```
|
||||
|
||||
###### Environment variable
|
||||
```sh
|
||||
export INFLUXD_STORAGE_WAL_FLUSH_ON_SHUTDOWN=true
|
||||
```
|
||||
|
||||
###### Configuration file
|
||||
{{< code-tabs-wrapper >}}
|
||||
{{% code-tabs %}}
|
||||
[YAML](#)
|
||||
[TOML](#)
|
||||
[JSON](#)
|
||||
{{% /code-tabs %}}
|
||||
{{% code-tab-content %}}
|
||||
```yml
|
||||
storage-wal-flush-on-shutdown: true
|
||||
```
|
||||
{{% /code-tab-content %}}
|
||||
{{% code-tab-content %}}
|
||||
```toml
|
||||
storage-wal-flush-on-shutdown = true
|
||||
```
|
||||
{{% /code-tab-content %}}
|
||||
{{% code-tab-content %}}
|
||||
```json
|
||||
{
|
||||
"storage-wal-flush-on-shutdown": true
|
||||
}
|
||||
```
|
||||
{{% /code-tab-content %}}
|
||||
{{< /code-tabs-wrapper >}}
|
||||
|
||||
---
|
||||
|
||||
### storage-wal-fsync-delay
|
||||
Duration a write will wait before fsyncing.
|
||||
A duration greater than `0` batches multiple fsync calls.
|
||||
|
|
|
|||
|
|
@ -8,6 +8,27 @@ menu:
|
|||
weight: 101
|
||||
---
|
||||
|
||||
## v2.7.12 {date="2025-05-20"}
|
||||
|
||||
### Features
|
||||
|
||||
- Add a `--pid-file` option to write a PID file to the specified location on startup. InfluxDB removes the PID file on shutdown.
|
||||
- Add a `--storage-wal-flush-on-shutdown` option to flush the WAL on database shutdown to ensure all data is written to disk.
|
||||
- Improve response error messages for dropped points, adding details including database, retention policy, and which bound was violated for partial writes.
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
- Fix a locking issue in `TagValueIterator` that could cause reads and writes in buckets to block. [PR #26414](https://github.com/influxdata/influxdb/pull/26414)
|
||||
|
||||
### Maintenance
|
||||
|
||||
- Improved startup logging with an "are we there yet" counter for the number and percentage of shards opened.
|
||||
- Update Go to 1.23.9.
|
||||
- Update Flux to v0.196.1.
|
||||
- Refresh dependencies to address security vulnerabilities and improve stability.
|
||||
|
||||
---
|
||||
|
||||
## v2.7.11 {date="2024-12-02"}
|
||||
|
||||
### Features
|
||||
|
|
@ -606,7 +627,7 @@ to migrate InfluxDB key-value metadata schemas to earlier 2.x versions when nece
|
|||
#### Flux
|
||||
|
||||
- Update to [Flux v0.139.0](/flux/v0/release-notes/#v01390).
|
||||
- Enable writing to remote hosts using the Flux [`to()`](/flux/v0/stdlib/influxdata/influxdb/to/) and [`experimental.to()`](/flux/v0/v0.x/stdlib/experimental/to/) functions.
|
||||
- Enable writing to remote hosts using the Flux [`to()`](/flux/v0/stdlib/influxdata/influxdb/to/) and [`experimental.to()`](/flux/v0/stdlib/experimental/to/) functions.
|
||||
- Flux now supports locations that dynamically modify time offsets based on your specified timezone. You can also specify fixed time offsets relative to UTC.
|
||||
- Perform [bitwise operations](/flux/v0/stdlib/experimental/bitwise/)
|
||||
on integers and unsigned integers.
|
||||
|
|
@ -1118,7 +1139,7 @@ Highlights include:
|
|||
|
||||
- Support for **upgrading to InfluxDB 2.0**:
|
||||
- To upgrade **from InfluxDB 1.x**, see [Upgrade from InfluxDB 1.x to InfluxDB 2.0](/influxdb/v2/upgrade/v1-to-v2).
|
||||
- To upgrade **from InfluxDB 2.0 beta 16 or earlier**, see [Upgrade from InfluxDB 2.0 beta to InfluxDB 2.0](/influxdb/v2/upgrade/v2-beta-to-v2).
|
||||
- To upgrade **from InfluxDB 2.0 beta 16 or earlier**, see [Upgrade from InfluxDB 2.0 beta to InfluxDB 2.0](/influxdb/v2/install/upgrade/v2-beta-to-v2/).
|
||||
- **Flux**, our powerful new functional data scripting language designed for querying, analyzing, and acting on data. This release includes [Flux v0.94.0](/flux/v0/release-notes/#v0940). If you're new to Flux, [check out how to get started with Flux](/influxdb/v2/query-data/get-started/). Next, delve deeper into the [Flux standard library](/flux/v0/stdlib//) reference docs and see how to [query with Flux](/influxdb/v2/query-data/flux/).
|
||||
- Support for [InfluxDB 1.x API compatibility](/influxdb/v2/reference/api/influxdb-1x/).
|
||||
- **Templates** and **stacks**. Discover how to [use community templates](/influxdb/v2/tools/influxdb-templates/use/) and how to [manage templates with stacks](/influxdb/v2/tools/influxdb-templates/stacks/).
|
||||
|
|
@ -1241,14 +1262,14 @@ If you're new to InfluxDB 2.0, we recommend checking out [how to get started](/i
|
|||
{{% warn %}}
|
||||
#### Manual upgrade required
|
||||
|
||||
To simplify the migration for existing users of InfluxDB 1.x, this release includes significant breaking changes that require a manual upgrade from all alpha and beta versions. For more information, see [Upgrade to InfluxDB OSS 2.0rc](/influxdb/v2/upgrade/v2-beta-to-v2/),
|
||||
To simplify the migration for existing users of InfluxDB 1.x, this release includes significant breaking changes that require a manual upgrade from all alpha and beta versions. For more information, see [Upgrade to InfluxDB OSS 2.0rc](/influxdb/v2/install/upgrade/v2-beta-to-v2/),
|
||||
{{% /warn %}}
|
||||
|
||||
### Breaking changes
|
||||
|
||||
#### Manual upgrade
|
||||
|
||||
- To continue using data from InfluxDB 2.0 beta 16 or earlier, you must move all existing data out of the `~/.influxdbv2` (or equivalent) path, including `influxd.bolt`. All existing dashboards, tasks, integrations, alerts, users, and tokens must be recreated. For information on how to migrate your data, see [Upgrade to InfluxDB OSS 2.0rc](/influxdb/v2/upgrade/v2-beta-to-v2/).
|
||||
- To continue using data from InfluxDB 2.0 beta 16 or earlier, you must move all existing data out of the `~/.influxdbv2` (or equivalent) path, including `influxd.bolt`. All existing dashboards, tasks, integrations, alerts, users, and tokens must be recreated. For information on how to migrate your data, see [Upgrade to InfluxDB OSS 2.0rc](/influxdb/v2/install/upgrade/v2-beta-to-v2/).
|
||||
|
||||
#### Port update to 8086
|
||||
|
||||
|
|
@ -2045,7 +2066,7 @@ _**This will remove all data from your InfluxDB v2.0 instance including time ser
|
|||
|
||||
###### Linux and macOS
|
||||
```sh
|
||||
rm ~/.influxdbv2/influxd.bolt
|
||||
rm -f ~/.influxdbv2/influxd.bolt
|
||||
```
|
||||
|
||||
Once completed, `v2.0.0-alpha.6` can be started.
|
||||
|
|
@ -2079,7 +2100,7 @@ run the following command.
|
|||
|
||||
###### Linux and macOS
|
||||
```sh
|
||||
rm -r ~/.influxdbv2/engine
|
||||
rm -rf ~/.influxdbv2/engine
|
||||
```
|
||||
|
||||
Once completed, InfluxDB v2.0.0-alpha.5 can be started.
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ related:
|
|||
- /influxdb3/core/reference/cli/influxdb3/query/
|
||||
- /influxdb3/core/reference/sql/
|
||||
- /influxdb3/core/reference/influxql/
|
||||
# - /influxdb3/core/get-started/query/#execute-an-sql-query, Get started querying data
|
||||
# - /influxdb3/core/query-data/execute-queries/, Get started querying data
|
||||
list_code_example: |
|
||||
```sh
|
||||
influxdb3 query \
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ related:
|
|||
- /influxdb3/enterprise/reference/cli/influxdb3/query/
|
||||
- /influxdb3/enterprise/reference/sql/
|
||||
- /influxdb3/enterprise/reference/influxql/
|
||||
# - /influxdb3/enterprise/get-started/query/#execute-an-sql-query, Get started querying data
|
||||
# - /influxdb3/enterprise/query-data/execute-queries/, Get started querying data
|
||||
list_code_example: |
|
||||
```sh
|
||||
influxdb3 query \
|
||||
|
|
|
|||
|
|
@ -8,5 +8,5 @@ For more information, see the [C# client example on GitHub](https://github.com/a
|
|||
> We recommend using the [`influxdb3-csharp` C# client library](/influxdb3/version/reference/client-libraries/v3/csharp/) for integrating InfluxDB 3 with your C# application code.
|
||||
>
|
||||
> [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
|
||||
> and provide convenient methods for [writing](/influxdb3/version/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/version/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
|
||||
> and provide convenient methods for [writing](/influxdb3/version/write-data/api-client-libraries/), [querying](/influxdb3/version/query-data/execute-queries/), and processing data stored in {{% product-name %}}.
|
||||
> Client libraries can query using SQL or InfluxQL.
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
> We recommend using the [`influxdb3-go` Go client library](/influxdb3/version/reference/client-libraries/v3/go/) for integrating InfluxDB 3 with your Go application code.
|
||||
>
|
||||
> [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
|
||||
> and provide convenient methods for [writing](/influxdb3/version/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/version/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
|
||||
> and provide convenient methods for [writing](/influxdb3/version/write-data/api-client-libraries/), [querying](/influxdb3/version/query-data/execute-queries/), and processing data stored in {{% product-name %}}.
|
||||
> Client libraries can query using SQL or InfluxQL.
|
||||
|
||||
## Flight SQL client
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
> We recommend using the [`influxdb3-java` Java client library](/influxdb3/version/reference/client-libraries/v3/java/) for integrating InfluxDB 3 with your Java application code.
|
||||
>
|
||||
> [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
|
||||
> and provide convenient methods for [writing](/influxdb3/version/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/version/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
|
||||
> and provide convenient methods for [writing](/influxdb3/version/write-data/api-client-libraries/), [querying](/influxdb3/version/query-data/execute-queries/), and processing data stored in {{% product-name %}}.
|
||||
> Client libraries can query using SQL or InfluxQL.
|
||||
|
||||
<!-- TOC -->
|
||||
|
|
|
|||
|
|
@ -6,21 +6,20 @@
|
|||
> We recommend using the [`influxdb3-python` Python client library](/influxdb3/version/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code.
|
||||
>
|
||||
> [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
|
||||
> and provide convenient methods for [writing](/influxdb3/version/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/version/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
|
||||
> and provide convenient methods for [writing](/influxdb3/version/write-data/api-client-libraries/), [querying](/influxdb3/version/query-data/execute-queries/), and processing data stored in {{% product-name %}}.
|
||||
> Client libraries can query using SQL or InfluxQL.
|
||||
|
||||
The following examples show how to use the `pyarrow.flight` and `pandas` Python modules to query and format data stored in an {{% product-name %}} database:
|
||||
|
||||
{{% code-tabs-wrapper %}}
|
||||
{{< code-tabs-wrapper >}}
|
||||
{{% code-tabs %}}
|
||||
[SQL](#sql-python)
|
||||
[InfluxQL](#influxql-python)
|
||||
{{% /code-tabs %}}
|
||||
|
||||
{{% code-tab-content %}}
|
||||
<!-- BEGIN SQL -->
|
||||
{{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}}
|
||||
```py
|
||||
```python
|
||||
# Using pyarrow>=12.0.0 FlightClient
|
||||
from pyarrow.flight import FlightClient, Ticket, FlightCallOptions
|
||||
import json
|
||||
|
|
@ -62,7 +61,7 @@ print(data_frame.to_markdown())
|
|||
{{% code-tab-content %}}
|
||||
<!-- BEGIN INFLUXQL -->
|
||||
{{% code-placeholders "DATABASE_NAME|DATABASE_TOKEN" %}}
|
||||
```py
|
||||
```python
|
||||
# Using pyarrow>=12.0.0 FlightClient
|
||||
from pyarrow.flight import FlightClient, Ticket, FlightCallOptions
|
||||
import json
|
||||
|
|
@ -97,6 +96,7 @@ print(data_frame.to_markdown())
|
|||
{{% /code-placeholders %}}
|
||||
<!-- END INFLUXQL -->
|
||||
{{% /code-tab-content %}}
|
||||
{{< /code-tabs-wrapper >}}
|
||||
|
||||
Replace the following:
|
||||
|
||||
|
|
@ -104,5 +104,3 @@ Replace the following:
|
|||
- {{% code-placeholder-key %}}`DATABASE_TOKEN`{{% /code-placeholder-key %}}:
|
||||
a [database token](/influxdb3/version/admin/tokens/database/)
|
||||
with sufficient permissions to the specified database
|
||||
|
||||
{{% /code-tabs-wrapper %}}
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ The [Python `flightsql-dbapi` Flight SQL DBAPI library](https://github.com/influ
|
|||
> We recommend using the [`influxdb3-python` Python client library](/influxdb3/version/reference/client-libraries/v3/python/) for integrating InfluxDB 3 with your Python application code.
|
||||
>
|
||||
> [InfluxDB 3 client libraries](/influxdb3/version/reference/client-libraries/v3/) wrap Apache Arrow Flight clients
|
||||
> and provide convenient methods for [writing](/influxdb3/version/get-started/write/#write-line-protocol-to-influxdb), [querying](/influxdb3/version/get-started/query/#execute-an-sql-query), and processing data stored in {{% product-name %}}.
|
||||
> and provide convenient methods for [writing](/influxdb3/version/write-data/api-client-libraries/), [querying](/influxdb3/version/query-data/execute-queries/), and processing data stored in {{% product-name %}}.
|
||||
> Client libraries can query using SQL or InfluxQL.
|
||||
|
||||
## Installation
|
||||
|
|
@ -32,7 +32,7 @@ from flightsql import FlightSQLClient
|
|||
```
|
||||
|
||||
- `flightsql.FlightSQLClient` class: an interface for [initializing
|
||||
a client](#initialization) and interacting with a Flight SQL server.
|
||||
a client](#initialize-a-client) and interacting with a Flight SQL server.
|
||||
|
||||
## API reference
|
||||
|
||||
|
|
@ -41,11 +41,11 @@ a client](#initialization) and interacting with a Flight SQL server.
|
|||
- [Initialize a client](#initialize-a-client)
|
||||
- [Instance methods](#instance-methods)
|
||||
- [FlightSQLClient.execute](#flightsqlclientexecute)
|
||||
- [Syntax {#execute-query-syntax}](#syntax-execute-query-syntax)
|
||||
- [Example {#execute-query-example}](#example-execute-query-example)
|
||||
- [Syntax](#execute-query-syntax)
|
||||
- [Example](#execute-query-example)
|
||||
- [FlightSQLClient.do_get](#flightsqlclientdo_get)
|
||||
- [Syntax {#retrieve-data-syntax}](#syntax-retrieve-data-syntax)
|
||||
- [Example {#retrieve-data-example}](#example-retrieve-data-example)
|
||||
- [Syntax](#retrieve-data-syntax)
|
||||
- [Example](#retrieve-data-example)
|
||||
|
||||
## Class FlightSQLClient
|
||||
|
||||
|
|
|
|||
|
|
@ -10,6 +10,7 @@ processing engine.
|
|||
influxdb3 create trigger [OPTIONS] \
|
||||
--database <DATABASE_NAME> \
|
||||
--token <AUTH_TOKEN> \
|
||||
--plugin-filename <PLUGIN_FILENAME> \
|
||||
--trigger-spec <TRIGGER_SPECIFICATION> \
|
||||
<TRIGGER_NAME>
|
||||
```
|
||||
|
|
@ -21,16 +22,21 @@ influxdb3 create trigger [OPTIONS] \
|
|||
## Options
|
||||
|
||||
| Option | | Description |
|
||||
| :----- | :--------------- | :--------------------------------------------------------------------------------------- |
|
||||
| :----- | :------------------ | :------------------------------------------------------------------------------------------------------- |
|
||||
| `-H` | `--host` | Host URL of the running {{< product-name >}} server (default is `http://127.0.0.1:8181`) |
|
||||
| `-d` | `--database` | _({{< req >}})_ Name of the database to operate on |
|
||||
| | `--token` | _({{< req >}})_ Authentication token |
|
||||
| | `--plugin-filename` | _({{< req >}})_ Name of the file, stored in the server's `plugin-dir`, that contains the Python plugin code to run |
|
||||
| | `--trigger-spec` | Trigger specification--for example `table:<TABLE_NAME>` or `all_tables` |
|
||||
| | `--disabled` | Create the trigger in disabled state |
|
||||
| | `--tls-ca` | Path to a custom TLS certificate authority (for testing or self-signed certificates) |
|
||||
| `-h` | `--help` | Print help information |
|
||||
| | `--help-all` | Print detailed help information |
|
||||
|
||||
If you want to use a plugin from the [Plugin Library](https://github.com/influxdata/influxdb3_plugins) repo, use the url path with `gh:` specified as the prefix.
|
||||
For example, to use the [System Metrics](https://github.com/influxdata/influxdb3_plugins/blob/main/examples/schedule/system_metrics/system_metrics.py) plugin, the plugin filename is `gh:examples/schedule/system_metrics/system_metrics.py`.
|
||||
|
||||
|
||||
### Option environment variables
|
||||
|
||||
You can use the following environment variables to set command options:
|
||||
|
|
@ -47,8 +53,8 @@ The following examples show how to use the `influxdb3 create trigger` command to
|
|||
|
||||
|
||||
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: Database name
|
||||
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}:
|
||||
Authentication token
|
||||
- {{% code-placeholder-key %}}`AUTH_TOKEN`{{% /code-placeholder-key %}}: Authentication token
|
||||
- {{% code-placeholder-key %}}`PLUGIN_FILENAME`{{% /code-placeholder-key %}}: Python plugin filename
|
||||
- {{% code-placeholder-key %}}`TRIGGER_NAME`{{% /code-placeholder-key %}}:
|
||||
Name of the trigger to create
|
||||
- {{% code-placeholder-key %}}`TABLE_NAME`{{% /code-placeholder-key %}}:
|
||||
|
|
@ -66,6 +72,7 @@ Create a trigger that processes data from a specific table.
|
|||
influxdb3 create trigger \
|
||||
--database DATABASE_NAME \
|
||||
--token AUTH_TOKEN \
|
||||
--plugin-filename PLUGIN_FILENAME \
|
||||
--trigger-spec table:TABLE_NAME \
|
||||
TRIGGER_NAME
|
||||
```
|
||||
|
|
@ -80,6 +87,7 @@ Create a trigger that applies to all tables in the specified database.
|
|||
influxdb3 create trigger \
|
||||
--database DATABASE_NAME \
|
||||
--token AUTH_TOKEN \
|
||||
--plugin-filename <PLUGIN_FILENAME> \
|
||||
--trigger-spec all_tables \
|
||||
TRIGGER_NAME
|
||||
```
|
||||
|
|
@ -97,6 +105,7 @@ influxdb3 create trigger \
|
|||
--disabled \
|
||||
--database DATABASE_NAME \
|
||||
--token AUTH_TOKEN \
|
||||
--plugin-filename <PLUGIN_FILENAME> \
|
||||
--trigger-spec table:TABLE_NAME \
|
||||
TRIGGER_NAME
|
||||
```
|
||||
|
|
|
|||
|
|
@ -41,7 +41,7 @@ Write requests return the following status codes:
|
|||
| :-------------------------------| :--------------------------------------------------------------- | :------------- |
|
||||
| `204 "Success"` | | If InfluxDB ingested the data |
|
||||
| `400 "Bad request"` | error details about rejected points, up to 100 points: `line` contains the first rejected line, `message` describes rejections | If some or all request data isn't allowed (for example, if it is malformed or falls outside of the bucket's retention period)--the response body indicates whether a partial write has occurred or if all data has been rejected |
|
||||
| `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb3/version/admin/tokens/) doesn't have [permission](/influxdb3/version/reference/cli/influxctl/token/create/#examples) to write to the database. See [examples using credentials](/influxdb3/version/get-started/write/#write-line-protocol-to-influxdb) in write requests. |
|
||||
| `401 "Unauthorized"` | | If the `Authorization` header is missing or malformed or if the [token](/influxdb3/version/admin/tokens/) doesn't have [permission](/influxdb3/version/reference/cli/influxctl/token/create/#examples) to write to the database. See [examples using credentials](/influxdb3/version/write-data/api-client-libraries/) in write requests. |
|
||||
| `404 "Not found"` | requested **resource type** (for example, "organization" or "database"), and **resource name** | If a requested resource (for example, organization or database) wasn't found |
|
||||
| `500 "Internal server error"` | | Default status for an error |
|
||||
| `503` "Service unavailable" | | If the server is temporarily unavailable to accept writes. The `Retry-After` header describes when to try the write again.
|
||||
|
|
|
|||
|
|
@ -161,6 +161,9 @@
|
|||
- flag: "--storage-validate-keys"
|
||||
added: 2.0
|
||||
|
||||
- flag: "--storage-wal-flush-on-shutdown"
|
||||
added: 2.7
|
||||
|
||||
- flag: "--storage-wal-fsync-delay"
|
||||
added: 2.0
|
||||
|
||||
|
|
|
|||
|
|
@ -85,7 +85,7 @@ influxdb:
|
|||
- v1
|
||||
latest: v2.7
|
||||
latest_patches:
|
||||
v2: 2.7.11
|
||||
v2: 2.7.12
|
||||
v1: 1.11.8
|
||||
latest_cli:
|
||||
v2: 2.7.5
|
||||
|
|
|
|||
Loading…
Reference in New Issue