Skip to content

Commit 0c85740

Browse files
committed
Update docs to reflect no-retain-float-format argument change
1 parent 3a46b3a commit 0c85740

File tree

1 file changed

+3
-19
lines changed

1 file changed

+3
-19
lines changed

docs/src/user-docs/core-clp-s.md

Lines changed: 3 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,8 @@ Usage:
2424
where `size` is the total size of the dictionaries and encoded messages in an archive.
2525
* This option acts as a soft limit on memory usage for compression, decompression, and search.
2626
* This option significantly affects compression ratio.
27-
* `--retain-float-format` specifies that floating-point numbers should be stored with extra
28-
metadata to preserve their textual representation after decompression. This feature is currently
29-
not supported when ingesting KV-IR.
27+
* `--no-retain-float-format` specifies that clp-s should not store extra information to
28+
losslessly decompress floats.
3029
* `--structurize-arrays` specifies that arrays should be fully parsed and array entries should be
3130
encoded into dedicated columns.
3231
* `--auth <s3|none>` specifies the authentication method that should be used for network requests
@@ -77,21 +76,6 @@ AWS_ACCESS_KEY_ID='...' AWS_SECRET_ACCESS_KEY='...' \
7776
/mnt/logs/log1.json
7877
```
7978

80-
:::{tip}
81-
Use the `--retain-float-format` flag during compression. Internally, switch to using a different
82-
encoding approach for floating point numbers that always retains their original formats. For
83-
example, values like `1.000e+00` or `0.000000012300` will be decompressed unchanged.
84-
:::
85-
86-
**Enable retaining float numbers' formats:**
87-
88-
```shell
89-
./clp-s c \
90-
--retain-float-format \
91-
/mnt/data/archives1 \
92-
/mnt/logs/log1.json
93-
```
94-
9579
## Decompression
9680

9781
Usage:
@@ -170,7 +154,7 @@ compressed data:**
170154
* The order of log events is not preserved.
171155
* The input directory structure is not preserved and during decompression all files are written to
172156
the same file.
173-
* When using the `--retain-float-format` flag:
157+
* For floating-point numbers:
174158
* KV-IR inputs currently don't support preserving the original printed float formats.
175159
* Comparisons against floating point numbers at query time treat each stored number as if it were
176160
the nearest representable double-precision value, which can potentially lose precision.

0 commit comments

Comments
 (0)