Skip to content

Commit 308a5d5

Browse files
authored
Merge branch 'master' into garylfowler-patch-4
2 parents 05e7408 + 7de4b11 commit 308a5d5

File tree

47 files changed

+6707
-2786
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

47 files changed

+6707
-2786
lines changed

.ci/vale/styles/config/vocabularies/InfluxDataDocs/accept.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ LogicalPlan
3131
[Mm]onitor
3232
MBs?
3333
PBs?
34-
Parquet
34+
Parquet|\b\w*-*parquet-\w*\b|\b--\w*parquet\w*\b|`[^`]*parquet[^`]*`
3535
Redoc
3636
SQLAlchemy
3737
SQLAlchemy

.husky/_/pre-commit

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,6 @@ call_lefthook()
3333
then
3434
"$dir/node_modules/lefthook/bin/index.js" "$@"
3535

36-
elif go tool lefthook -h >/dev/null 2>&1
37-
then
38-
go tool lefthook "$@"
3936
elif bundle exec lefthook -h >/dev/null 2>&1
4037
then
4138
bundle exec lefthook "$@"
@@ -45,21 +42,12 @@ call_lefthook()
4542
elif pnpm lefthook -h >/dev/null 2>&1
4643
then
4744
pnpm lefthook "$@"
48-
elif swift package lefthook >/dev/null 2>&1
45+
elif swift package plugin lefthook >/dev/null 2>&1
4946
then
50-
swift package --build-path .build/lefthook --disable-sandbox lefthook "$@"
47+
swift package --disable-sandbox plugin lefthook "$@"
5148
elif command -v mint >/dev/null 2>&1
5249
then
5350
mint run csjones/lefthook-plugin "$@"
54-
elif uv run lefthook -h >/dev/null 2>&1
55-
then
56-
uv run lefthook "$@"
57-
elif mise exec -- lefthook -h >/dev/null 2>&1
58-
then
59-
mise exec -- lefthook "$@"
60-
elif devbox run lefthook -h >/dev/null 2>&1
61-
then
62-
devbox run lefthook "$@"
6351
else
6452
echo "Can't find lefthook in PATH"
6553
fi

.husky/_/pre-push

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,6 @@ call_lefthook()
3333
then
3434
"$dir/node_modules/lefthook/bin/index.js" "$@"
3535

36-
elif go tool lefthook -h >/dev/null 2>&1
37-
then
38-
go tool lefthook "$@"
3936
elif bundle exec lefthook -h >/dev/null 2>&1
4037
then
4138
bundle exec lefthook "$@"
@@ -45,21 +42,12 @@ call_lefthook()
4542
elif pnpm lefthook -h >/dev/null 2>&1
4643
then
4744
pnpm lefthook "$@"
48-
elif swift package lefthook >/dev/null 2>&1
45+
elif swift package plugin lefthook >/dev/null 2>&1
4946
then
50-
swift package --build-path .build/lefthook --disable-sandbox lefthook "$@"
47+
swift package --disable-sandbox plugin lefthook "$@"
5148
elif command -v mint >/dev/null 2>&1
5249
then
5350
mint run csjones/lefthook-plugin "$@"
54-
elif uv run lefthook -h >/dev/null 2>&1
55-
then
56-
uv run lefthook "$@"
57-
elif mise exec -- lefthook -h >/dev/null 2>&1
58-
then
59-
mise exec -- lefthook "$@"
60-
elif devbox run lefthook -h >/dev/null 2>&1
61-
then
62-
devbox run lefthook "$@"
6351
else
6452
echo "Can't find lefthook in PATH"
6553
fi

.husky/_/prepare-commit-msg

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,6 @@ call_lefthook()
3333
then
3434
"$dir/node_modules/lefthook/bin/index.js" "$@"
3535

36-
elif go tool lefthook -h >/dev/null 2>&1
37-
then
38-
go tool lefthook "$@"
3936
elif bundle exec lefthook -h >/dev/null 2>&1
4037
then
4138
bundle exec lefthook "$@"
@@ -45,21 +42,12 @@ call_lefthook()
4542
elif pnpm lefthook -h >/dev/null 2>&1
4643
then
4744
pnpm lefthook "$@"
48-
elif swift package lefthook >/dev/null 2>&1
45+
elif swift package plugin lefthook >/dev/null 2>&1
4946
then
50-
swift package --build-path .build/lefthook --disable-sandbox lefthook "$@"
47+
swift package --disable-sandbox plugin lefthook "$@"
5148
elif command -v mint >/dev/null 2>&1
5249
then
5350
mint run csjones/lefthook-plugin "$@"
54-
elif uv run lefthook -h >/dev/null 2>&1
55-
then
56-
uv run lefthook "$@"
57-
elif mise exec -- lefthook -h >/dev/null 2>&1
58-
then
59-
mise exec -- lefthook "$@"
60-
elif devbox run lefthook -h >/dev/null 2>&1
61-
then
62-
devbox run lefthook "$@"
6351
else
6452
echo "Can't find lefthook in PATH"
6553
fi
Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
title: Rename a table
3+
description: >
4+
Use the [`influxctl table rename` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/table/rename/)
5+
to rename a table in your {{< product-name omit=" Cluster" >}} cluster.
6+
menu:
7+
influxdb3_cloud_dedicated:
8+
parent: Manage tables
9+
weight: 202
10+
list_code_example: |
11+
##### CLI
12+
```sh
13+
influxctl table rename <DATABASE_NAME> <CURRENT_TABLE_NAME> <NEW_TABLE_NAME>
14+
```
15+
related:
16+
- /influxdb3/cloud-dedicated/reference/cli/influxctl/table/rename/
17+
---
18+
19+
Use the [`influxctl table rename` command](/influxdb3/cloud-dedicated/reference/cli/influxctl/table/rename/)
20+
to rename a table in your {{< product-name omit=" Clustered" >}} cluster.
21+
22+
> [!Note]
23+
> After renaming a table, write and query requests using the old table name
24+
> are routed to the same table.
25+
26+
## Rename a database using the influxctl CLI
27+
28+
<!-- pytest.mark.skip -->
29+
30+
```bash { placeholders="DATABASE_NAME|CURRENT_TABLE_NAME|NEW_TABLE_NAME" }
31+
influxctl table rename DATABASE_NAME CURRENT_TABLE_NAME NEW_TABLE_NAME
32+
```
33+
34+
Replace the following:
35+
36+
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}: Name of the database the table is in
37+
- {{% code-placeholder-key %}}`CURRENT_TABLE_NAME`{{% /code-placeholder-key %}}: Name of the table to change
38+
- {{% code-placeholder-key %}}`NEW_TABLE_NAME`{{% /code-placeholder-key %}}: New name for the table
39+
40+
> [!Note]
41+
> #### Renamed table retains its ID
42+
>
43+
> The table ID remains the same after renaming. When you list tables,
44+
> you'll see the new name associated with the original table ID.

content/influxdb3/cloud-dedicated/query-data/execute-queries/client-libraries/python.md

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ related:
2626
- /influxdb3/cloud-dedicated/reference/influxql/
2727
- /influxdb3/cloud-dedicated/reference/sql/
2828
- /influxdb3/cloud-dedicated/query-data/execute-queries/troubleshoot/
29+
- /influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-timeout-best-practices/
2930

3031
list_code_example: |
3132
```py
@@ -240,7 +241,8 @@ from influxdb_client_3 import InfluxDBClient3
240241
client = InfluxDBClient3(
241242
host='{{< influxdb/host >}}',
242243
token='DATABASE_TOKEN',
243-
database='DATABASE_NAME'
244+
database='DATABASE_NAME',
245+
timeout=60 # Set default timeout to 60 seconds
244246
)
245247
```
246248
{{% /code-placeholders %}}
@@ -275,6 +277,7 @@ client = InfluxDBClient3(
275277
host="{{< influxdb/host >}}",
276278
token='DATABASE_TOKEN',
277279
database='DATABASE_NAME',
280+
timeout=60, # Set default timeout to 60 seconds
278281
flight_client_options=flight_client_options(
279282
tls_root_certs=cert))
280283
...
@@ -332,7 +335,8 @@ client = InfluxDBClient3(
332335
# Execute the query and return an Arrow table
333336
table = client.query(
334337
query="SELECT * FROM home",
335-
language="sql"
338+
language="sql",
339+
timeout=30 # Override default timeout for simple queries (30 seconds)
336340
)
337341
338342
print("\n#### View Schema information\n")
@@ -377,7 +381,8 @@ client = InfluxDBClient3(
377381
# Execute the query and return an Arrow table
378382
table = client.query(
379383
query="SELECT * FROM home",
380-
language="influxql"
384+
language="influxql",
385+
timeout=30 # Override default timeout for simple queries (30 seconds)
381386
)
382387
383388
print("\n#### View Schema information\n")

content/influxdb3/cloud-dedicated/query-data/execute-queries/influxctl-cli.md

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ influxdb3/cloud-dedicated/tags: [query, sql, influxql, influxctl, CLI]
1313
related:
1414
- /influxdb3/cloud-dedicated/reference/cli/influxctl/query/
1515
- /influxdb3/cloud-dedicated/get-started/query/#execute-an-sql-query, Get started querying data
16+
- /influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-timeout-best-practices/, Query timeout best practices
1617
- /influxdb3/cloud-dedicated/reference/sql/
1718
- /influxdb3/cloud-dedicated/reference/influxql/
1819
list_code_example: |
@@ -142,6 +143,34 @@ Replace the following:
142143
- {{% code-placeholder-key %}}`DATABASE_NAME`{{% /code-placeholder-key %}}:
143144
Name of the database to query
144145

146+
## Query timeouts
147+
148+
The [`influxctl --timeout` global flag](/influxdb3/cloud-dedicated/reference/cli/influxctl/) sets the maximum duration for API calls, including query requests.
149+
If a query takes longer than the specified timeout, the operation will be canceled.
150+
151+
### Timeout examples
152+
153+
Use different timeout values based on your query type:
154+
155+
{{% code-placeholders "DATABASE_(TOKEN|NAME)" %}}
156+
```sh
157+
# Shorter timeout for testing dashboard queries (10 seconds)
158+
influxctl query \
159+
--timeout 10s \
160+
--token DATABASE_TOKEN \
161+
--database DATABASE_NAME \
162+
"SELECT AVG(temperature) FROM sensors WHERE time >= now() - INTERVAL '1 day'"
163+
164+
# Longer timeout for analytical queries (5 minutes)
165+
influxctl query \
166+
--timeout 5m \
167+
--token DATABASE_TOKEN \
168+
--database DATABASE_NAME \
169+
"SELECT room, AVG(temperature) FROM sensors WHERE time >= now() - INTERVAL '30 days' GROUP BY room"
170+
```
171+
{{% /code-placeholders %}}
172+
173+
For guidance on selecting appropriate timeout values, see [Query timeout best practices](/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-timeout-best-practices/).
145174

146175
## Output format
147176

@@ -243,7 +272,7 @@ influxctl query \
243272
{{% /influxdb/custom-timestamps %}}
244273

245274
{{< expand-wrapper >}}
246-
{{% expand "View example results with unix nanosecond timestamps" %}}
275+
{{% expand "View example results with Unix nanosecond timestamps" %}}
247276
{{% influxdb/custom-timestamps %}}
248277
```
249278
+-------+--------+---------+------+---------------------+
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Query timeout best practices
3+
description: Learn how to set appropriate query timeouts to balance performance and resource protection.
4+
menu:
5+
influxdb3_cloud_dedicated:
6+
name: Query timeout best practices
7+
parent: Troubleshoot and optimize queries
8+
weight: 205
9+
related:
10+
- /influxdb3/cloud-dedicated/reference/client-libraries/v3/
11+
- /influxdb3/cloud-dedicated/query-data/execute-queries/influxctl-cli/
12+
source: shared/influxdb3-query-guides/query-timeout-best-practices.md
13+
---
14+
15+
<!--
16+
//SOURCE - content/shared/influxdb3-query-guides/query-timeout-best-practices.md
17+
>

content/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/troubleshoot.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ related:
1212
- /influxdb3/cloud-dedicated/query-data/sql/
1313
- /influxdb3/cloud-dedicated/query-data/influxql/
1414
- /influxdb3/cloud-dedicated/reference/client-libraries/v3/
15+
- /influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-timeout-best-practices/
1516
aliases:
1617
- /influxdb3/cloud-dedicated/query-data/execute-queries/troubleshoot/
1718
- /influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/trace/
@@ -30,7 +31,9 @@ If a query doesn't return any data, it might be due to the following:
3031

3132
- Your data falls outside the time range (or other conditions) in the query--for example, the InfluxQL `SHOW TAG VALUES` command uses a default time range of 1 day.
3233
- The query (InfluxDB server) timed out.
33-
- The query client timed out.
34+
- The query client timed out.
35+
See [Query timeout best practices](/influxdb3/cloud-dedicated/query-data/troubleshoot-and-optimize/query-timeout-best-practices/)
36+
for guidance on setting appropriate timeouts.
3437
- The query return type is not supported by the client library.
3538
For example, array or list types may not be supported.
3639
In this case, use `array_to_string()` to convert the array value to a string--for example:
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
---
2+
title: influxctl table rename
3+
description: >
4+
The `influxctl table rename` command renames a table in an
5+
{{% product-name omit=" Clustered" %}} cluster.
6+
menu:
7+
influxdb3_cloud_dedicated:
8+
parent: influxctl table
9+
weight: 301
10+
metadata: [influxctl 2.10.3+]
11+
source: /shared/influxctl/table/rename.md
12+
---
13+
14+
<!-- //SOURCE content/shared/influxctl/table/rename.md -->

0 commit comments

Comments
 (0)