Skip to content

Commit 0a277ea

Browse files
authored
hotfix(influxdb3): remove precision bug notes (#6560)
1 parent 6e61554 commit 0a277ea

File tree

2 files changed

+39
-44
lines changed

2 files changed

+39
-44
lines changed
Lines changed: 39 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,36 @@
1-
21
Use tools like the {{% show-in "cloud-dedicated,clustered" %}}`influxctl`{{% /show-in %}}{{% show-in "cloud-serverless" %}}`influx`{{% /show-in %}}{{% show-in "core,enterprise" %}}`influxdb3`{{% /show-in %}}
3-
CLI, Telegraf, and InfluxDB client libraries
2+
CLI, Telegraf, and InfluxDB client libraries
43
to write time series data to {{< product-name >}}.
54
[line protocol](#line-protocol)
65
is the text-based format used to write data to InfluxDB.
76

8-
> [!Tip]
7+
> \[!Tip]
98
> Tools are available to convert other formats (for example—[CSV](/influxdb3/version/write-data/use-telegraf/csv/)) to line protocol.
109
1110
{{% show-in "core,enterprise" %}}
11+
1212
- [Choose the write endpoint for your workload](#choose-the-write-endpoint-for-your-workload)
1313
- [Timestamp precision across write APIs](#timestamp-precision-across-write-apis)
14-
{{% /show-in %}}
14+
{{% /show-in %}}
1515
- [Line protocol](#line-protocol)
1616
- [Line protocol elements](#line-protocol-elements)
1717
- [Write data to InfluxDB](#write-data-to-influxdb)
1818
{{< children type="anchored-list" >}}
1919

2020
{{% show-in "core,enterprise" %}}
2121

22-
> [!Tip]
22+
> \[!Tip]
23+
>
2324
> #### Choose the write endpoint for your workload
24-
>
25+
>
2526
> When creating new write workloads, use the
2627
> [InfluxDB HTTP API `/api/v3/write_lp` endpoint](/influxdb3/version/write-data/http-api/v3-write-lp/)
2728
> and [client libraries](/influxdb3/version/write-data/client-libraries/).
2829
>
29-
> When bringing existing _v1_ write workloads, use the {{% product-name %}}
30+
> When bringing existing *v1* write workloads, use the {{% product-name %}}
3031
> HTTP API [`/write` endpoint](/influxdb3/core/api/v3/#operation/PostV1Write).
3132
>
32-
> When bringing existing _v2_ write workloads, use the {{% product-name %}}
33+
> When bringing existing *v2* write workloads, use the {{% product-name %}}
3334
> HTTP API [`/api/v2/write` endpoint](/influxdb3/version/api/v3/#operation/PostV2Write).
3435
>
3536
> **For Telegraf**, use the InfluxDB v1.x [`outputs.influxdb`](/telegraf/v1/output-plugins/influxdb/) or v2.x [`outputs.influxdb_v2`](/telegraf/v1/output-plugins/influxdb_v2/) output plugins.
@@ -40,19 +41,16 @@ is the text-based format used to write data to InfluxDB.
4041
{{% product-name %}} provides multiple write endpoints for compatibility with different InfluxDB versions.
4142
The following table compares timestamp precision support across v1, v2, and v3 write APIs:
4243

43-
| Precision | v1 (`/write`) | v2 (`/api/v2/write`) | v3 (`/api/v3/write_lp`) |
44-
|-----------|---------------|----------------------|-------------------------|
45-
| **Auto detection** | ❌ No | ❌ No |`auto` (default) |
46-
| **Seconds** |`s` |`s` |`second` |
47-
| **Milliseconds** |`ms` |`ms` |`millisecond` |
48-
| **Microseconds** |`u` or `µ` |`us` |`microsecond` |
49-
| **Nanoseconds** |`ns` |`ns` |`nanosecond` |
50-
| **Minutes** |`m` | ❌ No | ❌ No |
51-
| **Hours** |`h` | ❌ No | ❌ No |
52-
| **Default** | Nanosecond | Nanosecond | **Auto** (guessed) |
53-
54-
> [!Note]
55-
> A bug currently prevents abbreviated precision values (`ns`, `n`, `us`, `u`, `ms`, `s`) from working with the `/api/v3/write_lp` endpoint. Use the full names (`nanosecond`, `microsecond`, `millisecond`, `second`) instead. Abbreviated values will be supported in a future release.
44+
| Precision | v1 (`/write`) | v2 (`/api/v2/write`) | v3 (`/api/v3/write_lp`) |
45+
| ------------------ | ------------- | -------------------- | ----------------------- |
46+
| **Auto detection** | ❌ No | ❌ No |`auto` (default) |
47+
| **Seconds** |`s` |`s` |`second` |
48+
| **Milliseconds** |`ms` |`ms` |`millisecond` |
49+
| **Microseconds** |`u` or `µ` |`us` |`microsecond` |
50+
| **Nanoseconds** |`ns` |`ns` |`nanosecond` |
51+
| **Minutes** |`m` | ❌ No | ❌ No |
52+
| **Hours** |`h` | ❌ No | ❌ No |
53+
| **Default** | Nanosecond | Nanosecond | **Auto** (guessed) |
5654

5755
- All write endpoints accept timestamps in line protocol format.
5856
- {{% product-name %}} multiplies timestamps by the appropriate precision value to convert them to nanoseconds for internal storage.
@@ -61,15 +59,16 @@ The following table compares timestamp precision support across v1, v2, and v3 w
6159
{{% /show-in %}}
6260

6361
{{% hide-in "core,enterprise" %}}
64-
> [!Note]
65-
>
62+
63+
> \[!Note]
64+
>
6665
> #### Choose the write endpoint for your workload
67-
>
66+
>
6867
> When bringing existing v1 write workloads, use the {{% product-name %}}
6968
> HTTP API [`/write` endpoint](/influxdb3/version/guides/api-compatibility/v1/).
7069
> When creating new write workloads, use the HTTP API
7170
> [`/api/v2/write` endpoint](/influxdb3/version/guides/api-compatibility/v2/).
72-
{{% /hide-in %}}
71+
> {{% /hide-in %}}
7372
7473
## Line protocol
7574

@@ -89,11 +88,11 @@ Each line of line protocol contains the following elements:
8988
- {{< req "\*" >}} **table**: A string that identifies the
9089
table to store the data in.
9190
- **tag set**: Comma-delimited list of key value pairs, each representing a tag.
92-
Tag keys and values are unquoted strings. _Spaces, commas, and equal characters
93-
must be escaped._
91+
Tag keys and values are unquoted strings. *Spaces, commas, and equal characters
92+
must be escaped.*
9493
- {{< req "\*" >}} **field set**: Comma-delimited list of key value pairs, each
9594
representing a field.
96-
Field keys are unquoted strings. _Spaces and commas must be escaped._
95+
Field keys are unquoted strings. *Spaces and commas must be escaped.*
9796
Field values can be [strings](/influxdb3/version/reference/line-protocol/#string)
9897
(quoted),
9998
[floats](/influxdb3/version/reference/line-protocol/#float),
@@ -102,30 +101,29 @@ Each line of line protocol contains the following elements:
102101
or [booleans](/influxdb3/version/reference/line-protocol/#boolean).
103102
- **timestamp**: [Unix timestamp](/influxdb3/version/reference/line-protocol/#unix-timestamp)
104103
associated with the data. InfluxDB supports up to nanosecond precision.
105-
_If the precision of the timestamp is not in nanoseconds, you must specify the
106-
precision when writing the data to InfluxDB._
104+
*If the precision of the timestamp is not in nanoseconds, you must specify the
105+
precision when writing the data to InfluxDB.*
107106

108107
#### Line protocol element parsing
109108

110-
- **table**: Everything before the _first unescaped comma before the first
111-
whitespace_.
112-
- **tag set**: Key-value pairs between the _first unescaped comma_ and the _first
113-
unescaped whitespace_.
114-
- **field set**: Key-value pairs between the _first and second unescaped whitespaces_.
115-
- **timestamp**: Integer value after the _second unescaped whitespace_.
109+
- **table**: Everything before the *first unescaped comma before the first
110+
whitespace*.
111+
- **tag set**: Key-value pairs between the *first unescaped comma* and the *first
112+
unescaped whitespace*.
113+
- **field set**: Key-value pairs between the *first and second unescaped whitespaces*.
114+
- **timestamp**: Integer value after the *second unescaped whitespace*.
116115
- Lines are separated by the newline character (`\n`).
117116
Line protocol is whitespace sensitive.
118117

119-
---
118+
***
120119

121120
{{< influxdb/line-protocol version="v3" >}}
122121

123-
---
122+
***
124123

125-
_For schema design recommendations, see
126-
[InfluxDB schema design](/influxdb3/version/write-data/best-practices/schema-design/)._
124+
*For schema design recommendations, see
125+
[InfluxDB schema design](/influxdb3/version/write-data/best-practices/schema-design/).*
127126

128127
## Write data to InfluxDB
129128

130129
{{< children >}}
131-

content/shared/influxdb3-write-guides/http-api/v3-write-lp.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,6 @@ syntax as previous versions of InfluxDB, and supports the following:
2121
- `millisecond` (milliseconds)
2222
- `second` (seconds)
2323

24-
> \[!Note]
25-
> A bug currently prevents abbreviated precision values (`ns`, `n`, `us`, `u`, `ms`, `s`) from working with the `/api/v3/write_lp` endpoint. Use the full names (`nanosecond`, `microsecond`, `millisecond`, `second`) instead. Abbreviated values will be supported in a future release.
26-
2724
### Auto precision detection
2825

2926
When you use `precision=auto` (or omit the parameter), {{% product-name %}} automatically detects the timestamp precision based on the magnitude of the timestamp value:

0 commit comments

Comments
 (0)