Skip to content

Commit 4d9a98c

Browse files
authored
Document PERMANENT flag for pause/resume MV (#578)
1 parent 4e520e0 commit 4d9a98c

2 files changed

Lines changed: 10 additions & 4 deletions

File tree

docs/sql-system-pause.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,16 @@
33
## SYSTEM PAUSE MATERIALIZED VIEW
44

55
```sql
6-
SYSTEM PAUSE MATERIALIZED VIEW mv
6+
SYSTEM PAUSE MATERIALIZED VIEW <mv> [PERMANENT]
77
```
8-
Materialized views are long-running queries. In some cases, you may want to pause the query so that no more data is sent to the downstream. You can unpause the materialized view later. Please avoid restarting the server when the materialized view is paused.
8+
9+
Materialized views are long-running queries. In some cases, you may want to pause the query so that no more data is sent to the downstream. You can resume the materialized view later. Note: Without the PERMANENT flag, paused views will automatically resume after a service restart.
10+
11+
`PERMANENT` (Optional) - Keeps the paused state after a service restart; without it, the view resumes automatically on restart.
912

1013
## SYSTEM PAUSE TASK
1114

1215
```sql
1316
SYSTEM PAUSE TASK task;
1417
```
18+

docs/sql-system-resume.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,12 @@
33
## SYSTEM RESUME MATERIALIZED VIEW
44

55
```sql
6-
SYSTEM RESUME MATERIALIZED VIEW mv
6+
SYSTEM RESUME MATERIALIZED VIEW <mv> [PERMANENT]
77
```
88

9-
Materialized views are long-running queries. In some cases, you may want to pause the query so that no more data is sent to the downstream. Then resume the materialized view later. Please avoid restarting the server when the materialized view is paused.
9+
Materialized views are long-running queries. In some cases, you may want to pause the query so that no more data is sent to the downstream, then resume the materialized view later. Please avoid restarting the server when the materialized view is paused.
10+
11+
`PERMANENT` (Optional) - Resumes the view persistently so it remains running after a service restart; without it, the resume is temporary and any previous permanent pause state will be restored on restart.
1012

1113
This command is only available in Timeplus Enterprise v2.7.0 or above. In earlier versions, you can use `SYSTEM UNPAUSE MATERIALIZED VIEW` to resume the materialized view.
1214

0 commit comments

Comments
 (0)