-
Notifications
You must be signed in to change notification settings - Fork 14
docs: Add periodic refresh table jobs documentation (experimental) #816
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
WanYixian
merged 7 commits into
main
from
copilot/update-documentation-refresh-table-jobs
Nov 28, 2025
Merged
Changes from 6 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
0a047f7
Initial plan
Copilot 9d537eb
Add documentation for periodic refresh table jobs (experimental)
Copilot 9b87291
Fix comment alignment in SQL example
Copilot f32da2a
Address review feedback: clarify default behavior, FULL_RELOAD requir…
Copilot a4f8af8
add `last_success_time`
WanYixian adb99e0
language review
WanYixian 8f8c844
add refresh table in command overview
WanYixian File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| --- | ||
| title: "REFRESH TABLE" | ||
| description: "Use the `REFRESH TABLE` command to manually trigger a refresh operation for tables created with the FULL_RELOAD refresh mode." | ||
| --- | ||
|
|
||
| <Note> | ||
| Added in v2.7.0. It is currently in **[technical preview](/changelog/product-lifecycle#product-release-lifecycle)** stage. | ||
| </Note> | ||
|
|
||
| The `REFRESH TABLE` command manually triggers a full reload of data from the external source for tables configured with the `FULL_RELOAD` refresh mode. This is useful when you need to immediately update the table data without waiting for the next scheduled refresh. | ||
|
|
||
| When a table is created with `refresh_mode = 'FULL_RELOAD'`, it can be configured to automatically refresh at a specified interval using the `refresh_interval_sec` parameter. The `REFRESH TABLE` command allows you to trigger an additional refresh on demand. | ||
|
|
||
| ## Syntax | ||
|
|
||
| ```sql | ||
| REFRESH TABLE table_name; | ||
| ``` | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Description | | ||
| |:----------|:------------| | ||
| | `table_name` | The name of the table to refresh. The table must be created with `refresh_mode = 'FULL_RELOAD'`. | | ||
|
|
||
| ## Example | ||
|
|
||
| Create a table with the `FULL_RELOAD` refresh mode: | ||
|
|
||
| ```sql | ||
| CREATE TABLE iceberg_batch_table ( | ||
| id int primary key, | ||
| name varchar | ||
| ) WITH ( | ||
| connector = 'iceberg', | ||
| catalog.type = 'storage', | ||
| table.name = 'my_iceberg_table', | ||
| database.name = 'public', | ||
| refresh_mode = 'FULL_RELOAD', | ||
| refresh_interval_sec = '60' -- Automatically refresh every 60 seconds | ||
| ); | ||
| ``` | ||
|
|
||
| Manually trigger a refresh: | ||
|
|
||
| ```sql | ||
| REFRESH TABLE iceberg_batch_table; | ||
| ``` | ||
|
|
||
| ## Monitor refresh status | ||
|
|
||
| You can monitor the status of refresh operations using the `rw_catalog.rw_refresh_table_state` system catalog: | ||
|
|
||
| ```sql | ||
| SELECT table_id, current_status, last_trigger_time, last_success_time, trigger_interval_secs | ||
| FROM rw_catalog.rw_refresh_table_state; | ||
| ``` | ||
|
|
||
| This query returns information about all refreshable tables, including: | ||
| - `table_id`: The unique identifier of the table | ||
| - `current_status`: The current status of the refresh job (e.g., `IDLE`, `REFRESHING`) | ||
| - `last_trigger_time`: The timestamp of the last refresh operation | ||
| - `last_success_time`: The timestamp when the refresh last completed successfully | ||
| - `trigger_interval_secs`: The configured refresh interval in seconds | ||
|
|
||
| ## Related topics | ||
|
|
||
| - [Ingest data from Iceberg tables](/iceberg/ingest-from-iceberg) | ||
| - [RisingWave catalogs](/sql/system-catalogs/rw-catalog) |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.