Skip to content

docs: DOC-1107: Improve blink table docs#7651

Open
margaretkennedy wants to merge 3 commits intodeephaven:mainfrom
margaretkennedy:doc-1107
Open

docs: DOC-1107: Improve blink table docs#7651
margaretkennedy wants to merge 3 commits intodeephaven:mainfrom
margaretkennedy:doc-1107

Conversation

@margaretkennedy
Copy link
Contributor

No description provided.

@margaretkennedy margaretkennedy added documentation Improvements or additions to documentation NoDocumentationNeeded NoReleaseNotesNeeded No release notes are needed. labels Feb 4, 2026
@github-actions
Copy link
Contributor

github-actions bot commented Feb 4, 2026

Deploying docs previews for cf44867 (available for 14 days)

Python
Groovy

@margaretkennedy margaretkennedy enabled auto-merge (squash) February 4, 2026 21:14
Copy link
Contributor

@elijahpetty elijahpetty left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs gifs for examples, otherwise LGTM


To get around these restrictions, you can use [`removeBlink`](../table-operations/create/remove-blink.md) to opt out of special semantics. Then, you can use [`partitionBy`](../table-operations/group-and-aggregate/partitionBy.md) to get a result with constituents that will blink in and out of existence.

```groovy order=null
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add gif displaying results

The following example demonstrates the difference in aggregation behavior. With the blink attribute, `sumBy` accumulates over all rows ever seen. After `removeBlink`, `sumBy` only sums rows in the current cycle.

```groovy order=tNoBlink,tBlink
```groovy ticking-table order=tBlinkSum,tNoBlinkSum
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Needs gif.


In this example:

- `tBlinkSum` continuously grows as it aggregates over all historical data.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `tBlinkSum` continuously grows as it aggregates over all historical data.
- `tBlinkSum` grows continuously as it aggregates over all historical data.


To get around these restrictions, you can use [`remove_blink`](../table-operations/create/remove-blink.md) to opt out of special semantics. Then, you can use [`partition_by`](../table-operations/group-and-aggregate/partitionBy.md) to get a result with constituents that will blink in and out of existence.

```python order=null
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gif

The following example demonstrates the difference in aggregation behavior. With the blink attribute, `sum_by` accumulates over all rows ever seen. After `remove_blink`, `sum_by` only sums rows in the current cycle.

```python order=t_no_blink,t_blink
```python ticking-table order=t_blink_sum,t_no_blink_sum
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

gif


In this example:

- `t_blink_sum` continuously grows as it aggregates over all historical data.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- `t_blink_sum` continuously grows as it aggregates over all historical data.
- `t_blink_sum` grows continuously as it aggregates over all historical data.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation NoDocumentationNeeded NoReleaseNotesNeeded No release notes are needed.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants