docs: clarify local MV version pinning

This commit is contained in:
Jack Ye
2026-10-02 11:47:41 -05:00
parent d4f5c718ad
commit f2f35c0413
4 changed files with 11 additions and 7 deletions
+3 -2
View File
@@ -65,8 +65,9 @@ refresh(options?): Promise<RefreshMaterializedViewResult>
Recompute the view from its source.
Every refresh rebuilds the complete view. `sourceVersion` refreshes to
that source version instead of the latest.
Every refresh rebuilds the complete view. For local views, `sourceVersion`
refreshes to that source version instead of the latest; remote SQL refreshes
do not support source-version pinning.
#### Parameters
+3 -2
View File
@@ -187,8 +187,9 @@ export class MaterializedView {
/**
* Recompute the view from its source.
*
* Every refresh rebuilds the complete view. `sourceVersion` refreshes to
* that source version instead of the latest.
* Every refresh rebuilds the complete view. For local views,
* `sourceVersion` refreshes to that source version instead of the latest;
* remote SQL refreshes do not support source-version pinning.
*/
async refresh(options?: {
sourceVersion?: number;
+3 -2
View File
@@ -183,8 +183,9 @@ class AsyncMaterializedView:
) -> "RefreshMaterializedViewResult":
"""Recompute the view from its source.
Every refresh rebuilds the complete view. ``source_version`` refreshes
to that source version instead of the latest.
Every refresh rebuilds the complete view. For local views,
``source_version`` refreshes to that source version instead of the
latest; remote SQL refreshes do not support source-version pinning.
"""
return await self._table._inner.refresh_materialized_view(
source_version=source_version
+2 -1
View File
@@ -1713,7 +1713,8 @@ pub struct RefreshMaterializedViewBuilder {
}
impl RefreshMaterializedViewBuilder {
/// Refresh to this source table version instead of the latest.
/// Refresh a local view to this source table version instead of the latest.
/// Remote SQL refreshes do not support source-version pinning.
pub fn source_version(mut self, version: u64) -> Self {
self.source_version = Some(version);
self