|
10 | 10 | class StreamingDataFrame()
|
11 | 11 | ```
|
12 | 12 |
|
13 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L76) |
| 13 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L80) |
14 | 14 |
|
15 | 15 | `StreamingDataFrame` is the main object you will use for ETL work.
|
16 | 16 |
|
@@ -83,7 +83,7 @@ def apply(func: Union[
|
83 | 83 | metadata: bool = False) -> Self
|
84 | 84 | ```
|
85 | 85 |
|
86 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L191) |
| 86 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L195) |
87 | 87 |
|
88 | 88 | Apply a function to transform the value and return a new value.
|
89 | 89 |
|
@@ -141,7 +141,7 @@ def update(func: Union[
|
141 | 141 | metadata: bool = False) -> Self
|
142 | 142 | ```
|
143 | 143 |
|
144 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L298) |
| 144 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L302) |
145 | 145 |
|
146 | 146 | Apply a function to mutate value in-place or to perform a side effect
|
147 | 147 |
|
@@ -209,7 +209,7 @@ def filter(func: Union[
|
209 | 209 | metadata: bool = False) -> Self
|
210 | 210 | ```
|
211 | 211 |
|
212 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L404) |
| 212 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L408) |
213 | 213 |
|
214 | 214 | Filter value using provided function.
|
215 | 215 |
|
@@ -261,7 +261,7 @@ def group_by(key: Union[str, Callable[[Any], Any]],
|
261 | 261 | key_serializer: Optional[SerializerType] = "json") -> Self
|
262 | 262 | ```
|
263 | 263 |
|
264 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L492) |
| 264 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L496) |
265 | 265 |
|
266 | 266 | "Groups" messages by re-keying them via the provided group_by operation
|
267 | 267 |
|
@@ -325,7 +325,7 @@ a clone with this operation added (assign to keep its effect).
|
325 | 325 | def contains(key: str) -> StreamingSeries
|
326 | 326 | ```
|
327 | 327 |
|
328 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L570) |
| 328 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L574) |
329 | 329 |
|
330 | 330 | Check if the key is present in the Row value.
|
331 | 331 |
|
@@ -364,7 +364,7 @@ or False otherwise.
|
364 | 364 | def to_topic(topic: Topic, key: Optional[Callable[[Any], Any]] = None) -> Self
|
365 | 365 | ```
|
366 | 366 |
|
367 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L595) |
| 367 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L599) |
368 | 368 |
|
369 | 369 | Produce current value to a topic. You can optionally specify a new key.
|
370 | 370 |
|
@@ -417,7 +417,7 @@ the updated StreamingDataFrame instance (reassignment NOT required).
|
417 | 417 | def set_timestamp(func: Callable[[Any, Any, int, Any], int]) -> Self
|
418 | 418 | ```
|
419 | 419 |
|
420 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L640) |
| 420 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L644) |
421 | 421 |
|
422 | 422 | Set a new timestamp based on the current message value and its metadata.
|
423 | 423 |
|
@@ -469,7 +469,7 @@ def set_headers(
|
469 | 469 | ]) -> Self
|
470 | 470 | ```
|
471 | 471 |
|
472 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L681) |
| 472 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L685) |
473 | 473 |
|
474 | 474 | Set new message headers based on the current message value and metadata.
|
475 | 475 |
|
@@ -518,7 +518,7 @@ a new StreamingDataFrame instance
|
518 | 518 | def print(pretty: bool = True, metadata: bool = False) -> Self
|
519 | 519 | ```
|
520 | 520 |
|
521 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L732) |
| 521 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L736) |
522 | 522 |
|
523 | 523 | Print out the current message value (and optionally, the message metadata) to
|
524 | 524 |
|
@@ -579,7 +579,7 @@ def print_table(size: int = 5,
|
579 | 579 | column_widths: Optional[dict[str, int]] = None) -> Self
|
580 | 580 | ```
|
581 | 581 |
|
582 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L776) |
| 582 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L780) |
583 | 583 |
|
584 | 584 | Print a table with the most recent records.
|
585 | 585 |
|
@@ -672,7 +672,7 @@ sdf.print_table(size=5, title="Live Records", slowdown=1)
|
672 | 672 | def compose(sink: Optional[VoidExecutor] = None) -> dict[str, VoidExecutor]
|
673 | 673 | ```
|
674 | 674 |
|
675 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L890) |
| 675 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L896) |
676 | 676 |
|
677 | 677 | Compose all functions of this StreamingDataFrame into one big closure.
|
678 | 678 |
|
@@ -726,7 +726,7 @@ def test(value: Any,
|
726 | 726 | topic: Optional[Topic] = None) -> List[Any]
|
727 | 727 | ```
|
728 | 728 |
|
729 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L924) |
| 729 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L930) |
730 | 730 |
|
731 | 731 | A shorthand to test `StreamingDataFrame` with provided value
|
732 | 732 |
|
@@ -766,7 +766,7 @@ def tumbling_window(
|
766 | 766 | ) -> TumblingTimeWindowDefinition
|
767 | 767 | ```
|
768 | 768 |
|
769 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L961) |
| 769 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L967) |
770 | 770 |
|
771 | 771 | Create a time-based tumbling window transformation on this StreamingDataFrame.
|
772 | 772 |
|
@@ -856,7 +856,7 @@ def tumbling_count_window(
|
856 | 856 | name: Optional[str] = None) -> TumblingCountWindowDefinition
|
857 | 857 | ```
|
858 | 858 |
|
859 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1048) |
| 859 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1054) |
860 | 860 |
|
861 | 861 | Create a count-based tumbling window transformation on this StreamingDataFrame.
|
862 | 862 |
|
@@ -923,7 +923,7 @@ def hopping_window(
|
923 | 923 | ) -> HoppingTimeWindowDefinition
|
924 | 924 | ```
|
925 | 925 |
|
926 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1092) |
| 926 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1098) |
927 | 927 |
|
928 | 928 | Create a time-based hopping window transformation on this StreamingDataFrame.
|
929 | 929 |
|
@@ -1023,7 +1023,7 @@ def hopping_count_window(
|
1023 | 1023 | name: Optional[str] = None) -> HoppingCountWindowDefinition
|
1024 | 1024 | ```
|
1025 | 1025 |
|
1026 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1192) |
| 1026 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1198) |
1027 | 1027 |
|
1028 | 1028 | Create a count-based hopping window transformation on this StreamingDataFrame.
|
1029 | 1029 |
|
@@ -1095,7 +1095,7 @@ def sliding_window(
|
1095 | 1095 | ) -> SlidingTimeWindowDefinition
|
1096 | 1096 | ```
|
1097 | 1097 |
|
1098 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1243) |
| 1098 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1249) |
1099 | 1099 |
|
1100 | 1100 | Create a time-based sliding window transformation on this StreamingDataFrame.
|
1101 | 1101 |
|
@@ -1190,7 +1190,7 @@ def sliding_count_window(
|
1190 | 1190 | name: Optional[str] = None) -> SlidingCountWindowDefinition
|
1191 | 1191 | ```
|
1192 | 1192 |
|
1193 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1335) |
| 1193 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1341) |
1194 | 1194 |
|
1195 | 1195 | Create a count-based sliding window transformation on this StreamingDataFrame.
|
1196 | 1196 |
|
@@ -1255,7 +1255,7 @@ def drop(columns: Union[str, List[str]],
|
1255 | 1255 | errors: Literal["ignore", "raise"] = "raise") -> Self
|
1256 | 1256 | ```
|
1257 | 1257 |
|
1258 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1382) |
| 1258 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1388) |
1259 | 1259 |
|
1260 | 1260 | Drop column(s) from the message value (value must support `del`, like a dict).
|
1261 | 1261 |
|
@@ -1299,7 +1299,7 @@ a new StreamingDataFrame instance
|
1299 | 1299 | def sink(sink: BaseSink)
|
1300 | 1300 | ```
|
1301 | 1301 |
|
1302 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1426) |
| 1302 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1432) |
1303 | 1303 |
|
1304 | 1304 | Sink the processed data to the specified destination.
|
1305 | 1305 |
|
|
0 commit comments