既存の具体化されたビューに関連付けられている DocString 値を変更して説明します。
アクセス許可
このコマンドを実行するには、少なくとも Materialized View Admin アクセス許可が必要です。
構文
.alter
materialized-view
MaterializedViewName docstring
DocString
構文規則について詳しく知る。
パラメーター
件名 | タイプ | Required | 説明 |
---|---|---|---|
MaterializedViewName | string |
✔️ | マテリアライズドビューの名。 |
DocString | string |
✔️ | 具体化されたビューに添付して説明できるフリー テキスト。 この文字列は、エンティティ名の横にあるさまざまな UI 設定で表示されます。 |
返品
[Output Schema]\(出力スキーマ\):
名前 | 種類 | 説明 |
---|---|---|
Name | string |
マテリアライズドビューの名。 |
SourceTable | string |
ビューが定義されているソース テーブルの名前。 |
クエリ | string |
具体化されたビューのクエリ定義。 |
MaterializedTo | datetime |
ソース テーブルのマテリアライズド ingestion_time() タイムスタンプの最大値。 詳細については、マテリアライズドビューのしくみ を参照してください。 |
LastRun | datetime |
前回具体化が実行された時刻。 |
LastRunResult | string |
最後の実行の結果。 正常に実行された場合は Completed を返します。それ以外の場合は Failed を返します。 |
IsHealthy | bool |
true ビューが正常と見なされる場合、false それ以外の場合。 ビューは、直近の 1 時間まで正常にマテリアライズされた場合に正常と見なされます (MaterializedTo が ago(1h) より大きい)。 |
IsEnabled | bool |
true ビューが有効になっている場合 (「具体化されたビューを無効化または有効化」を参照)。 |
フォルダー | string |
具体化されたビューが作成されるフォルダー。 |
DocString | string |
具体化されたビューに割り当てられた説明。 |
AutoUpdateSchema | bool |
ビューの自動更新が有効になっているかどうか。 |
EffectiveDateTime | datetime |
ビューの有効な日時。作成時に決定されます ( .create materialized-view 参照)。 |
ルックバック | timespan |
重複が予想される期間を制限する期間。 |
例
具体化されたビューの docstring を設定する
次のコマンドは、docstring プロパティを使用してマテリアライズドの説明を設定します。
.alter materialized-view MyView docstring "docs here..."
出力
Name | SourceTable | クエリ | MaterializedTo | LastRun | LastRunResult | IsHealthy | IsEnabled | フォルダー | DocString | AutoUpdateSchema | EffectiveDateTime | ルックバック |
---|---|---|---|---|---|---|---|---|---|---|---|---|
MyView | MyTable | MyTable |column1 によるtake_any(*) の集計 | 2023-02-26T16:40:03.3345704Z | 2023-02-26T16:44:15.9033667Z | 完了済み | true | true | "docs here..." | true | 2023-02-23T14:01:42.5172342Z |