|
10 | 10 | class StreamingDataFrame()
|
11 | 11 | ```
|
12 | 12 |
|
13 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L84) |
| 13 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L85) |
14 | 14 |
|
15 | 15 | `StreamingDataFrame` is the main object you will use for ETL work.
|
16 | 16 |
|
@@ -73,7 +73,7 @@ sdf = sdf.to_topic(topic_obj)
|
73 | 73 | def stream_id() -> str
|
74 | 74 | ```
|
75 | 75 |
|
76 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L169) |
| 76 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L170) |
77 | 77 |
|
78 | 78 | An identifier of the data stream this StreamingDataFrame
|
79 | 79 | manipulates in the application.
|
@@ -107,7 +107,7 @@ def apply(func: Union[
|
107 | 107 | metadata: bool = False) -> "StreamingDataFrame"
|
108 | 108 | ```
|
109 | 109 |
|
110 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L228) |
| 110 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L229) |
111 | 111 |
|
112 | 112 | Apply a function to transform the value and return a new value.
|
113 | 113 |
|
@@ -165,7 +165,7 @@ def update(func: Union[
|
165 | 165 | metadata: bool = False) -> "StreamingDataFrame"
|
166 | 166 | ```
|
167 | 167 |
|
168 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L336) |
| 168 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L337) |
169 | 169 |
|
170 | 170 | Apply a function to mutate value in-place or to perform a side effect
|
171 | 171 |
|
@@ -233,7 +233,7 @@ def filter(func: Union[
|
233 | 233 | metadata: bool = False) -> "StreamingDataFrame"
|
234 | 234 | ```
|
235 | 235 |
|
236 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L443) |
| 236 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L444) |
237 | 237 |
|
238 | 238 | Filter value using provided function.
|
239 | 239 |
|
@@ -287,7 +287,7 @@ def group_by(
|
287 | 287 | ) -> "StreamingDataFrame"
|
288 | 288 | ```
|
289 | 289 |
|
290 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L532) |
| 290 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L533) |
291 | 291 |
|
292 | 292 | "Groups" messages by re-keying them via the provided group_by operation
|
293 | 293 |
|
@@ -352,7 +352,7 @@ a clone with this operation added (assign to keep its effect).
|
352 | 352 | def contains(keys: Union[str, list[str]]) -> StreamingSeries
|
353 | 353 | ```
|
354 | 354 |
|
355 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L642) |
| 355 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L643) |
356 | 356 |
|
357 | 357 | Check if keys are present in the Row value.
|
358 | 358 |
|
@@ -394,7 +394,7 @@ def to_topic(
|
394 | 394 | key: Optional[Callable[[Any], Any]] = None) -> "StreamingDataFrame"
|
395 | 395 | ```
|
396 | 396 |
|
397 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L673) |
| 397 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L674) |
398 | 398 |
|
399 | 399 | Produce current value to a topic. You can optionally specify a new key.
|
400 | 400 |
|
@@ -448,7 +448,7 @@ def set_timestamp(
|
448 | 448 | func: Callable[[Any, Any, int, Any], int]) -> "StreamingDataFrame"
|
449 | 449 | ```
|
450 | 450 |
|
451 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L718) |
| 451 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L719) |
452 | 452 |
|
453 | 453 | Set a new timestamp based on the current message value and its metadata.
|
454 | 454 |
|
@@ -501,7 +501,7 @@ def set_headers(
|
501 | 501 | ) -> "StreamingDataFrame"
|
502 | 502 | ```
|
503 | 503 |
|
504 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L761) |
| 504 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L762) |
505 | 505 |
|
506 | 506 | Set new message headers based on the current message value and metadata.
|
507 | 507 |
|
@@ -550,7 +550,7 @@ a new StreamingDataFrame instance
|
550 | 550 | def print(pretty: bool = True, metadata: bool = False) -> "StreamingDataFrame"
|
551 | 551 | ```
|
552 | 552 |
|
553 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L812) |
| 553 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L813) |
554 | 554 |
|
555 | 555 | Print out the current message value (and optionally, the message metadata) to
|
556 | 556 |
|
@@ -613,7 +613,7 @@ def print_table(
|
613 | 613 | int]] = None) -> "StreamingDataFrame"
|
614 | 614 | ```
|
615 | 615 |
|
616 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L858) |
| 616 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L859) |
617 | 617 |
|
618 | 618 | Print a table with the most recent records.
|
619 | 619 |
|
@@ -706,7 +706,7 @@ sdf.print_table(size=5, title="Live Records", slowdown=1)
|
706 | 706 | def compose(sink: Optional[VoidExecutor] = None) -> dict[str, VoidExecutor]
|
707 | 707 | ```
|
708 | 708 |
|
709 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L974) |
| 709 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L975) |
710 | 710 |
|
711 | 711 | Compose all functions of this StreamingDataFrame into one big closure.
|
712 | 712 |
|
@@ -760,7 +760,7 @@ def test(value: Any,
|
760 | 760 | topic: Optional[Topic] = None) -> List[Any]
|
761 | 761 | ```
|
762 | 762 |
|
763 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1008) |
| 763 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1009) |
764 | 764 |
|
765 | 765 | A shorthand to test `StreamingDataFrame` with provided value
|
766 | 766 |
|
@@ -800,7 +800,7 @@ def tumbling_window(
|
800 | 800 | ) -> TumblingTimeWindowDefinition
|
801 | 801 | ```
|
802 | 802 |
|
803 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1047) |
| 803 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1048) |
804 | 804 |
|
805 | 805 | Create a time-based tumbling window transformation on this StreamingDataFrame.
|
806 | 806 |
|
@@ -892,7 +892,7 @@ def tumbling_count_window(
|
892 | 892 | name: Optional[str] = None) -> TumblingCountWindowDefinition
|
893 | 893 | ```
|
894 | 894 |
|
895 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1136) |
| 895 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1137) |
896 | 896 |
|
897 | 897 | Create a count-based tumbling window transformation on this StreamingDataFrame.
|
898 | 898 |
|
@@ -965,7 +965,7 @@ def hopping_window(
|
965 | 965 | ) -> HoppingTimeWindowDefinition
|
966 | 966 | ```
|
967 | 967 |
|
968 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1186) |
| 968 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1187) |
969 | 969 |
|
970 | 970 | Create a time-based hopping window transformation on this StreamingDataFrame.
|
971 | 971 |
|
@@ -1068,7 +1068,7 @@ def hopping_count_window(
|
1068 | 1068 | name: Optional[str] = None) -> HoppingCountWindowDefinition
|
1069 | 1069 | ```
|
1070 | 1070 |
|
1071 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1289) |
| 1071 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1290) |
1072 | 1072 |
|
1073 | 1073 | Create a count-based hopping window transformation on this StreamingDataFrame.
|
1074 | 1074 |
|
@@ -1146,7 +1146,7 @@ def sliding_window(
|
1146 | 1146 | ) -> SlidingTimeWindowDefinition
|
1147 | 1147 | ```
|
1148 | 1148 |
|
1149 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1346) |
| 1149 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1347) |
1150 | 1150 |
|
1151 | 1151 | Create a time-based sliding window transformation on this StreamingDataFrame.
|
1152 | 1152 |
|
@@ -1244,7 +1244,7 @@ def sliding_count_window(
|
1244 | 1244 | name: Optional[str] = None) -> SlidingCountWindowDefinition
|
1245 | 1245 | ```
|
1246 | 1246 |
|
1247 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1441) |
| 1247 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1442) |
1248 | 1248 |
|
1249 | 1249 | Create a count-based sliding window transformation on this StreamingDataFrame.
|
1250 | 1250 |
|
@@ -1314,7 +1314,7 @@ sdf = (
|
1314 | 1314 | def fill(*columns: str, **mapping: Any) -> "StreamingDataFrame"
|
1315 | 1315 | ```
|
1316 | 1316 |
|
1317 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1494) |
| 1317 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1495) |
1318 | 1318 |
|
1319 | 1319 | Fill missing values in the message value with a constant value.
|
1320 | 1320 |
|
@@ -1371,7 +1371,7 @@ def drop(columns: Union[str, List[str]],
|
1371 | 1371 | errors: Literal["ignore", "raise"] = "raise") -> "StreamingDataFrame"
|
1372 | 1372 | ```
|
1373 | 1373 |
|
1374 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1546) |
| 1374 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1547) |
1375 | 1375 |
|
1376 | 1376 | Drop column(s) from the message value (value must support `del`, like a dict).
|
1377 | 1377 |
|
@@ -1415,7 +1415,7 @@ a new StreamingDataFrame instance
|
1415 | 1415 | def sink(sink: BaseSink)
|
1416 | 1416 | ```
|
1417 | 1417 |
|
1418 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1590) |
| 1418 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1591) |
1419 | 1419 |
|
1420 | 1420 | Sink the processed data to the specified destination.
|
1421 | 1421 |
|
@@ -1443,7 +1443,7 @@ operations, but branches can still be generated from its originating SDF.
|
1443 | 1443 | def concat(other: "StreamingDataFrame") -> "StreamingDataFrame"
|
1444 | 1444 | ```
|
1445 | 1445 |
|
1446 |
| -[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1628) |
| 1446 | +[[VIEW SOURCE]](https://github.com/quixio/quix-streams/blob/main/quixstreams/dataframe/dataframe.py#L1629) |
1447 | 1447 |
|
1448 | 1448 | Concatenate two StreamingDataFrames together and return a new one.
|
1449 | 1449 |
|
|
0 commit comments