Skip to content

Commit 51c3bf2

Browse files
Update documentation (#798)
Co-authored-by: daniil-quix <[email protected]>
1 parent f77c9be commit 51c3bf2

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

docs/api-reference/quixstreams.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -2938,7 +2938,7 @@ It should return the final aggregation result.
29382938
class Collector(ABC, Generic[I])
29392939
```
29402940

2941-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/windows/aggregations.py#L169)
2941+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/windows/aggregations.py#L174)
29422942

29432943
Base class for window collections.
29442944

@@ -2958,7 +2958,7 @@ To reduce incoming items as they come in use an `Aggregator`.
29582958
def column() -> Column
29592959
```
29602960

2961-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/windows/aggregations.py#L182)
2961+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/windows/aggregations.py#L187)
29622962

29632963
The column to collect.
29642964

@@ -2973,7 +2973,7 @@ Use `ROOT` to collect the whole message.
29732973
def result(items: Iterable[I]) -> Any
29742974
```
29752975

2976-
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/windows/aggregations.py#L191)
2976+
[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/windows/aggregations.py#L196)
29772977

29782978
This method is triggered when a window is closed.
29792979
It should return the final collection result.
@@ -3826,6 +3826,7 @@ def __init__(token: str,
38263826
time_precision: TimePrecision = "ms",
38273827
allow_missing_fields: bool = False,
38283828
include_metadata_tags: bool = False,
3829+
convert_ints_to_floats: bool = False,
38293830
batch_size: int = 1000,
38303831
enable_gzip: bool = True,
38313832
request_timeout_ms: int = 10_000,
@@ -3890,6 +3891,8 @@ Default - `False`
38903891
- `include_metadata_tags`: if True, includes record's key, topic,
38913892
and partition as tags.
38923893
Default - `False`.
3894+
- `convert_ints_to_floats`: if True, converts all integer values to floats.
3895+
Default - `False`.
38933896
- `batch_size`: how many records to write to InfluxDB in one request.
38943897
Note that it only affects the size of one write request, and not the number
38953898
of records flushed on each checkpoint.

docs/api-reference/sinks.md

+3
Original file line numberDiff line numberDiff line change
@@ -342,6 +342,7 @@ def __init__(token: str,
342342
time_precision: TimePrecision = "ms",
343343
allow_missing_fields: bool = False,
344344
include_metadata_tags: bool = False,
345+
convert_ints_to_floats: bool = False,
345346
batch_size: int = 1000,
346347
enable_gzip: bool = True,
347348
request_timeout_ms: int = 10_000,
@@ -408,6 +409,8 @@ Default - `False`
408409
- `include_metadata_tags`: if True, includes record's key, topic,
409410
and partition as tags.
410411
Default - `False`.
412+
- `convert_ints_to_floats`: if True, converts all integer values to floats.
413+
Default - `False`.
411414
- `batch_size`: how many records to write to InfluxDB in one request.
412415
Note that it only affects the size of one write request, and not the number
413416
of records flushed on each checkpoint.

0 commit comments

Comments
 (0)