Skip to content

Commit c6f0fdd

Browse files
committed
Merge branch 'master' into sql-window-functions
2 parents 5fc7e99 + be9273e commit c6f0fdd

File tree

6 files changed

+1621
-624
lines changed

6 files changed

+1621
-624
lines changed

content/influxdb3/clustered/admin/backup-restore.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -129,8 +129,8 @@ spec:
129129
containers:
130130
iox:
131131
env:
132-
INFLUXDB_IOX_CREATE_CATALOG_BACKUP_DATA_SNAPSHOT_FILES: true
133-
INFLUXDB_IOX_DELETE_USING_CATALOG_BACKUP_DATA_SNAPSHOT_FILES: true
132+
INFLUXDB_IOX_CREATE_CATALOG_BACKUP_DATA_SNAPSHOT_FILES: 'true'
133+
INFLUXDB_IOX_DELETE_USING_CATALOG_BACKUP_DATA_SNAPSHOT_FILES: 'true'
134134
INFLUXDB_IOX_KEEP_HOURLY_CATALOG_BACKUP_FILE_LISTS: '30d'
135135
INFLUXDB_IOX_KEEP_DAILY_CATALOG_BACKUP_FILE_LISTS: '90d'
136136
INFLUXDB_IOX_GC_OBJECTSTORE_CUTOFF: '14d'
@@ -140,20 +140,20 @@ spec:
140140
141141
#### INFLUXDB_IOX_CREATE_CATALOG_BACKUP_DATA_SNAPSHOT_FILES
142142
143-
Enable hourly Catalog snapshotting. The default is `false`. Set to `true`:
143+
Enable hourly Catalog snapshotting. The default is `'false'`. Set to `'true'`:
144144
145145
```yaml
146-
INFLUXDB_IOX_CREATE_CATALOG_BACKUP_DATA_SNAPSHOT_FILES: true
146+
INFLUXDB_IOX_CREATE_CATALOG_BACKUP_DATA_SNAPSHOT_FILES: 'true'
147147
```
148148
149149
#### INFLUXDB_IOX_DELETE_USING_CATALOG_BACKUP_DATA_SNAPSHOT_FILES
150150
151151
Enable a snapshot check when deleting files to ensure the Garbage Collector does
152152
not remove Parquet files from the object store that are associated with existing
153-
snapshots. The default is `false`. Set to `true`:
153+
snapshots. The default is `'false'`. Set to `'true'`:
154154
155155
```yaml
156-
INFLUXDB_IOX_DELETE_USING_CATALOG_BACKUP_DATA_SNAPSHOT_FILES: true
156+
INFLUXDB_IOX_DELETE_USING_CATALOG_BACKUP_DATA_SNAPSHOT_FILES: 'true'
157157
```
158158
159159
> [!Caution]

content/shared/influxdb3-sample-data/sample-data.md

Lines changed: 96 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -40,12 +40,13 @@ to
4040

4141
#### Write the home sensor data to InfluxDB
4242

43-
Use the `influxdb3` CLI, InfluxDB v2 API, or InfluxDB v1 API to write the
43+
Use the `influxdb3` CLI, InfluxDB v3 API, InfluxDB v2 API, or InfluxDB v1 API to write the
4444
home sensor sample data to {{< product-name >}}.
4545

4646
{{< code-tabs-wrapper >}}
4747
{{% code-tabs %}}
4848
[influxdb3](#)
49+
[v3 API](#)
4950
[v2 API](#)
5051
[v1 API](#)
5152
{{% /code-tabs %}}
@@ -90,6 +91,43 @@ home,room=Kitchen temp=22.7,hum=36.5,co=26i 1641067200'
9091
{{% /code-tab-content %}}
9192
{{% code-tab-content %}}
9293

94+
{{% influxdb/custom-timestamps %}}
95+
{{% code-placeholders "AUTH_TOKEN|DATABASE_NAME" %}}
96+
```sh
97+
curl -v "http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto&accept_partial=true" \
98+
--data-raw "home,room=Living\ Room temp=21.1,hum=35.9,co=0i 1735545600
99+
home,room=Kitchen temp=21.0,hum=35.9,co=0i 1735545600
100+
home,room=Living\ Room temp=21.4,hum=35.9,co=0i 1735549200
101+
home,room=Kitchen temp=23.0,hum=36.2,co=0i 1735549200
102+
home,room=Living\ Room temp=21.8,hum=36.0,co=0i 1735552800
103+
home,room=Kitchen temp=22.7,hum=36.1,co=0i 1735552800
104+
home,room=Living\ Room temp=22.2,hum=36.0,co=0i 1735556400
105+
home,room=Kitchen temp=22.4,hum=36.0,co=0i 1735556400
106+
home,room=Living\ Room temp=22.2,hum=35.9,co=0i 1735560000
107+
home,room=Kitchen temp=22.5,hum=36.0,co=0i 1735560000
108+
home,room=Living\ Room temp=22.4,hum=36.0,co=0i 1735563600
109+
home,room=Kitchen temp=22.8,hum=36.5,co=1i 1735563600
110+
home,room=Living\ Room temp=22.3,hum=36.1,co=0i 1735567200
111+
home,room=Kitchen temp=22.8,hum=36.3,co=1i 1735567200
112+
home,room=Living\ Room temp=22.3,hum=36.1,co=1i 1735570800
113+
home,room=Kitchen temp=22.7,hum=36.2,co=3i 1735570800
114+
home,room=Living\ Room temp=22.4,hum=36.0,co=4i 1735574400
115+
home,room=Kitchen temp=22.4,hum=36.0,co=7i 1735574400
116+
home,room=Living\ Room temp=22.6,hum=35.9,co=5i 1735578000
117+
home,room=Kitchen temp=22.7,hum=36.0,co=9i 1735578000
118+
home,room=Living\ Room temp=22.8,hum=36.2,co=9i 1735581600
119+
home,room=Kitchen temp=23.3,hum=36.9,co=18i 1735581600
120+
home,room=Living\ Room temp=22.5,hum=36.3,co=14i 1735585200
121+
home,room=Kitchen temp=23.1,hum=36.6,co=22i 1735585200
122+
home,room=Living\ Room temp=22.2,hum=36.4,co=17i 1735588800
123+
home,room=Kitchen temp=22.7,hum=36.5,co=26i 1735588800"
124+
```
125+
{{% /code-placeholders %}}
126+
{{% /influxdb/custom-timestamps %}}
127+
128+
{{% /code-tab-content %}}
129+
{{% code-tab-content %}}
130+
93131
{{% influxdb/custom-timestamps %}}
94132
{{% code-placeholders "AUTH_TOKEN|DATABASE_NAME" %}}
95133
```sh
@@ -227,12 +265,13 @@ to
227265

228266
#### Write the home sensor actions data to InfluxDB
229267

230-
Use the `influxdb3` CLI, InfluxDB v2 API, or InfluxDB v1 API to write the
268+
Use the `influxdb3` CLI, InfluxDB v3 API, InfluxDB v2 API, or InfluxDB v1 API to write the
231269
home sensor actions sample data to {{< product-name >}}.
232270

233271
{{< code-tabs-wrapper >}}
234272
{{% code-tabs %}}
235273
[influxdb3](#)
274+
[v3 API](#)
236275
[v2 API](#)
237276
[v1 API](#)
238277
{{% /code-tabs %}}
@@ -259,6 +298,25 @@ home_actions,room=Living\ Room,action=alert,level=warn description="Carbon monox
259298
{{% /code-tab-content %}}
260299
{{% code-tab-content %}}
261300

301+
{{% influxdb/custom-timestamps %}}
302+
{{% code-placeholders "AUTH_TOKEN|DATABASE_NAME" %}}
303+
```sh
304+
curl -v "http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto&accept_partial=true" \
305+
--data-raw "home_actions,room=Kitchen,action=cool,level=ok description=\"Temperature at or above 23°C (23°C). Cooling to 22°C.\" 1739437200
306+
home_actions,room=Kitchen,action=cool,level=ok description=\"Temperature at or above 23°C (23.3°C). Cooling to 22°C.\" 1739469600
307+
home_actions,room=Kitchen,action=cool,level=ok description=\"Temperature at or above 23°C (23.1°C). Cooling to 22°C.\" 1739473200
308+
home_actions,room=Kitchen,action=alert,level=warn description=\"Carbon monoxide level above normal: 18 ppm.\" 1739469600
309+
home_actions,room=Kitchen,action=alert,level=warn description=\"Carbon monoxide level above normal: 22 ppm.\" 1739473200
310+
home_actions,room=Kitchen,action=alert,level=warn description=\"Carbon monoxide level above normal: 26 ppm.\" 1739476800
311+
home_actions,room=Living Room,action=alert,level=warn description=\"Carbon monoxide level above normal: 14 ppm.\" 1739473200
312+
home_actions,room=Living Room,action=alert,level=warn description=\"Carbon monoxide level above normal: 17 ppm.\" 1739476800"
313+
```
314+
{{% /code-placeholders %}}
315+
{{% /influxdb/custom-timestamps %}}
316+
317+
{{% /code-tab-content %}}
318+
{{% code-tab-content %}}
319+
262320
{{% influxdb/custom-timestamps %}}
263321
{{% code-placeholders "AUTH_TOKEN|DATABASE_NAME" %}}
264322
```sh
@@ -354,12 +412,13 @@ series use cases that involve seasonality.
354412

355413
#### Write the NOAA Bay Area weather data to InfluxDB
356414

357-
Use the `influxdb3` CLI, InfluxDB v2 API, or InfluxDB v1 API to write the
415+
Use the `influxdb3` CLI, InfluxDB v3 API, InfluxDB v2 API, or InfluxDB v1 API to write the
358416
NOAA Bay Area weather sample data to {{< product-name >}}.
359417

360418
{{< code-tabs-wrapper >}}
361419
{{% code-tabs %}}
362420
[influxdb3](#)
421+
[v3 API](#)
363422
[v2 API](#)
364423
[v1 API](#)
365424
{{% /code-tabs %}}
@@ -374,6 +433,16 @@ influxdb3 write \
374433
```
375434
{{% /code-placeholders %}}
376435

436+
{{% /code-tabs %}}
437+
{{% code-tab-content %}}
438+
439+
{{% code-placeholders "AUTH_TOKEN|DATABASE_NAME" %}}
440+
```sh
441+
curl -v "http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto&accept_partial=false" \
442+
--data-binary "$(curl --request GET https://docs.influxdata.com/downloads/bay-area-weather.lp)"
443+
```
444+
{{% /code-placeholders %}}
445+
377446
{{% /code-tab-content %}}
378447
{{% code-tab-content %}}
379448

@@ -454,12 +523,13 @@ The Bitcoin price sample dataset provides Bitcoin prices from
454523

455524
#### Write the Bitcoin price sample data to InfluxDB
456525

457-
Use the `influxdb3` CLI, InfluxDB v2 API, or InfluxDB v1 API to write the
526+
Use the `influxdb3` CLI, InfluxDB v3 API, InfluxDB v2 API, or InfluxDB v1 API to write the
458527
Bitcoin price sample data to {{< product-name >}}.
459528

460529
{{< code-tabs-wrapper >}}
461530
{{% code-tabs %}}
462531
[influxdb3](#)
532+
[v3 API](#)
463533
[v2 API](#)
464534
[v1 API](#)
465535
{{% /code-tabs %}}
@@ -474,6 +544,16 @@ influxdb3 write \
474544
```
475545
{{% /code-placeholders %}}
476546

547+
{{% /code-tabs %}}
548+
{{% code-tab-content %}}
549+
550+
{{% code-placeholders "AUTH_TOKEN|DATABASE_NAME" %}}
551+
```sh
552+
curl -v "http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto&accept_partial=false" \
553+
--data-binary "$(curl --request GET https://docs.influxdata.com/downloads/bitcoin.lp)"
554+
```
555+
{{% /code-placeholders %}}
556+
477557
{{% /code-tab-content %}}
478558
{{% code-tab-content %}}
479559

@@ -528,12 +608,13 @@ transformation functions.
528608

529609
#### Write the random number sample data to InfluxDB
530610

531-
Use the `influxdb3` CLI, InfluxDB v2 API, or InfluxDB v1 API to write the
611+
Use the `influxdb3` CLI, InfluxDB v3 API, InfluxDB v2 API, or InfluxDB v1 API to write the
532612
random number sample data to {{< product-name >}}.
533613

534614
{{< code-tabs-wrapper >}}
535615
{{% code-tabs %}}
536616
[influxdb3](#)
617+
[v3 API](#)
537618
[v2 API](#)
538619
[v1 API](#)
539620
{{% /code-tabs %}}
@@ -551,6 +632,16 @@ influxdb3 write \
551632
{{% /code-tab-content %}}
552633
{{% code-tab-content %}}
553634

635+
{{% code-placeholders "AUTH_TOKEN|DATABASE_NAME" %}}
636+
```sh
637+
curl -v "http://localhost:8181/api/v3/write_lp?db=sensors&precision=auto&accept_partial=false" \
638+
--data-binary "$(curl --request GET https://docs.influxdata.com/downloads/bitcoin.lp)"
639+
```
640+
{{% /code-placeholders %}}
641+
642+
{{% /code-tab-content %}}
643+
{{% code-tab-content %}}
644+
554645
{{% code-placeholders "AUTH_TOKEN|DATABASE_NAME" %}}
555646
```sh
556647
curl --request POST \

content/shared/v3-core-get-started/_index.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -570,11 +570,6 @@ influxdb3 create distinct_cache -h
570570
571571
### Python plugins and the Processing engine
572572
573-
> [!Important]
574-
> #### Processing engine only works with Docker
575-
>
576-
> The Processing engine is currently supported only in Docker x86 environments. Non-Docker support is coming soon. The engine, API, and developer experience are actively evolving and may change. Join our [Discord](https://discord.gg/9zaNCW2PRT) for updates and feedback.
577-
578573
The InfluxDB 3 Processing engine is an embedded Python VM for running code inside the database to process and transform data.
579574
580575
To use the Processing engine, you create [plugins](#plugin) and [triggers](#trigger).
@@ -609,11 +604,6 @@ InfluxDB 3 provides the following types of triggers:
609604
610605
### Test, create, and trigger plugin code
611606
612-
> [!Important]
613-
> #### Processing engine only works with Docker
614-
>
615-
> The Processing engine is currently supported only in Docker x86 environments. Non-Docker support is coming soon. The engine, API, and developer experience are actively evolving and may change. Join our [Discord](https://discord.gg/9zaNCW2PRT) for updates and feedback.
616-
617607
##### Example: Python plugin for WAL flush
618608
619609
```python
@@ -699,10 +689,9 @@ Test your InfluxDB 3 plugin safely without affecting written data. During a plug
699689
To test a plugin, do the following:
700690
701691
1. Create a _plugin directory_--for example, `/path/to/.influxdb/plugins`
702-
2. Make the plugin directory available to the Docker container (for example, using a bind mount)
703-
3. Run the Docker command to [start the server](#start-influxdb) and include the `--plugin-dir` option with your plugin directory path.
704-
4. Save the [preceding example code](#example-python-plugin) to a plugin file inside of the plugin directory. If you haven't yet written data to the table in the example, comment out the lines where it queries.
705-
5. To run the test, enter the following command with the following options:
692+
2. [Start the InfluxDB server](#start-influxdb) and include the `--plugin-dir` option with your plugin directory path.
693+
3. Save the [preceding example code](#example-python-plugin) to a plugin file inside of the plugin directory. If you haven't yet written data to the table in the example, comment out the lines where it queries.
694+
4. To run the test, enter the following command with the following options:
706695
707696
- `--lp` or `--file`: The line protocol to test
708697
- Optional: `--input-arguments`: A comma-delimited list of `<KEY>=<VALUE>` arguments for your plugin code

content/shared/v3-core-plugins/_index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,3 @@
1-
> [!Important]
2-
> #### Processing engine only works with Docker
3-
>
4-
> The Processing engine is currently supported only in Docker x86 environments. Non-Docker support is coming soon. The engine, API, and developer experience are actively evolving and may change. Join our [Discord](https://discord.gg/9zaNCW2PRT) for updates and feedback.
51

62
Use the {{% product-name %}} Processing engine to run code and perform tasks
73
for different database events.
@@ -35,6 +31,7 @@ The Processing engine provides four types of plugins and triggers--each type cor
3531
- **On Request**: Bound to the HTTP API `/api/v3/engine/<CUSTOM_PATH>` endpoint and triggered by a GET or POST request to the endpoint.
3632

3733
## Activate the Processing engine
34+
3835
To enable the Processing engine, start the {{% product-name %}} server with the `--plugin-dir` option and a path to your plugins directory (it doesn't need to exist yet)--for example:
3936

4037
```bash
@@ -351,6 +348,7 @@ def process_scheduled_call(influxdb3_local, time, args=None):
351348
```
352349

353350
### Schedule Trigger Configuration
351+
354352
Schedule plugins are set with a `trigger-spec` of `schedule:<cron_expression>` or `every:<duration>`. The `args` parameter can be used to pass configuration to the plugin. For example, if we wanted to use the system-metrics example from the Github repo and have it collect every 10 seconds we could use the following trigger definition:
355353

356354
```shell
@@ -361,6 +359,7 @@ influxdb3 create trigger \
361359
```
362360

363361
## On Request Plugin
362+
364363
On Request plugins are triggered by a request to a specific endpoint under `/api/v3/engine`. The plugin will receive the local API, query parameters `Dict[str, str]`, request headers `Dict[str, str]`, request body (as bytes), and any arguments passed in the trigger definition. Here's an example of a simple On Request plugin:
365364

366365
```python
@@ -387,6 +386,7 @@ def process_request(influxdb3_local, query_parameters, request_headers, request_
387386
```
388387

389388
### On Request Trigger Configuration
389+
390390
On Request plugins are set with a `trigger-spec` of `request:<endpoint>`. The `args` parameter can be used to pass configuration to the plugin. For example, if we wanted the above plugin to run on the endpoint `/api/v3/engine/my_plugin`, we would use `request:my_plugin` as the `trigger-spec`.
391391

392392
Trigger specs must be unique across all configured plugins, regardless of which database they are tied to, given the path is the same. Here's an example to create a request trigger tied to the "hello-world' path using a plugin in the plugin-dir:

content/shared/v3-enterprise-get-started/_index.md

Lines changed: 3 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -560,11 +560,6 @@ influxdb3 create distinct_cache -h
560560
561561
### Python plugins and the Processing engine
562562
563-
> [!Important]
564-
> #### Processing engine only works with Docker
565-
>
566-
> The Processing engine is currently supported only in Docker x86 environments. Non-Docker support is coming soon. The engine, API, and developer experience are actively evolving and may change. Join our [Discord](https://discord.gg/9zaNCW2PRT) for updates and feedback.
567-
568563
The InfluxDB 3 Processing engine is an embedded Python VM for running code inside the database to process and transform data.
569564
570565
To use the Processing engine, you create [plugins](#plugin) and [triggers](#trigger).
@@ -599,11 +594,6 @@ InfluxDB 3 provides the following types of triggers:
599594
600595
### Test, create, and trigger plugin code
601596
602-
> [!Important]
603-
> #### Processing engine only works with Docker
604-
>
605-
> The Processing engine is currently supported only in Docker x86 environments. Non-Docker support is coming soon. The engine, API, and developer experience are actively evolving and may change. Join our [Discord](https://discord.gg/9zaNCW2PRT) for updates and feedback.
606-
607597
##### Example: Python plugin for WAL flush
608598
609599
```python
@@ -689,10 +679,9 @@ Test your InfluxDB 3 plugin safely without affecting written data. During a plug
689679
To test a plugin, do the following:
690680
691681
1. Create a _plugin directory_--for example, `/path/to/.influxdb/plugins`
692-
2. Make the plugin directory available to the Docker container (for example, using a bind mount)
693-
3. Run the Docker command to [start the server](#start-influxdb) and include the `--plugin-dir` option with your plugin directory path.
694-
4. Save the [preceding example code](#example-python-plugin) to a plugin file inside of the plugin directory. If you haven't yet written data to the table in the example, comment out the lines where it queries.
695-
5. To run the test, enter the following command with the following options:
682+
2. [Start the InfluxDB server](#start-influxdb) and include the `--plugin-dir` option with your plugin directory path.
683+
3. Save the [preceding example code](#example-python-plugin) to a plugin file inside of the plugin directory. If you haven't yet written data to the table in the example, comment out the lines where it queries.
684+
4. To run the test, enter the following command with the following options:
696685
697686
- `--lp` or `--file`: The line protocol to test
698687
- Optional: `--input-arguments`: A comma-delimited list of `<KEY>=<VALUE>` arguments for your plugin code

0 commit comments

Comments
 (0)