Skip to content

Commit fb7e5f0

Browse files
ShanlanLikwannoelemile-00WanYixian
authored
2082 document featfrontend change streaming rate limit=0 to pause stream instead of disable rate limit (#2111)
* update * Update view-configure-runtime-parameters.md * Update docs/manage/view-configure-runtime-parameters.md Co-authored-by: Noel Kwan <47273164+kwannoel@users.noreply.github.com> * Update docs/troubleshoot/troubleshoot-oom.md Co-authored-by: emile-00 <106993396+emile-00@users.noreply.github.com> * Update view-configure-runtime-parameters.md * Update view-configure-runtime-parameters.md * Update docs/manage/view-configure-runtime-parameters.md Co-authored-by: WanYixian <150207222+WanYixian@users.noreply.github.com> --------- Co-authored-by: Noel Kwan <47273164+kwannoel@users.noreply.github.com> Co-authored-by: emile-00 <106993396+emile-00@users.noreply.github.com> Co-authored-by: WanYixian <150207222+WanYixian@users.noreply.github.com>
1 parent d98f854 commit fb7e5f0

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

docs/manage/view-configure-runtime-parameters.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ Below is the detailed information about the parameters you may see after using t
7272
| lock_timeout | 0 | See [here](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-LOCK-TIMEOUT) for details. Unused in RisingWave, support for compatibility. |
7373
| row_security | `true`/`false` | See [here](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-ROW-SECURITY) for details. Unused in RisingWave, support for compatibility. |
7474
| standard_conforming_strings | on | See [here](https://www.postgresql.org/docs/current/runtime-config-client.html#GUC-STANDARD-CONFORMING-STRINGS) for details. |
75-
| streaming_rate_limit | 0 | Set the maximum number of records per second per source, for each parallelism. The source here refers to an upstream source or snapshot read in the backfilling process. |
75+
| streaming_rate_limit | `default`/ A positive integer / `0` | Set the maximum number of records per second per source, for each parallelism. The source here refers to an upstream source or snapshot read in the backfilling process.<br/><br/> `SET STREAMING_RATE_LIMIT TO 0` will pause the snapshot read stream for backfill and pause the source read for sources (Previously, this disabled the rate limit within the session). `SET STREAMING_RATE_LIMIT TO DEFAULT` will disable the rate limit within the session, but it will not change the rate limits of existing DDLs. |
7676
| rw_streaming_over_window_cache_policy | full | Cache policy for partition cache in streaming over window. Can be "full", "recent", "recent_first_n" or "recent_last_n". |
7777
| background_ddl | `true`/`false` | Run DDL statements in background. |
7878
| server_encoding | UTF8 | Show the server-side character set encoding. At present, this parameter can be shown but not set, because the encoding is determined at database creation time. |
@@ -104,4 +104,4 @@ You can also use the [`ALTER SYSTEM SET`](/sql/commands/sql-alter-system.md) com
104104

105105
```sql title="Syntax"
106106
ALTER SYSTEM SET session_param_name TO session_param_value;
107-
```
107+
```

docs/troubleshoot/troubleshoot-oom.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ If OOM happens during the creation of a new materialized view, it might be cause
3131
CREATE MATERIALIZED VIEW mv WITH ( streaming_rate_limit = 200 ) AS ...
3232
```
3333

34-
The parameter `streaming_rate_limit` means the maximum number of records per second for each parallelism on each source, where the default parallelism for streaming jobs is the total number of CPU cores across the cluster. For example, assuming a materialized view has 4 parallelisms and 2 sources joining together, each source's throughput will be throttled to `4 * streaming_rate_limit` records/s.
34+
The parameter [`streaming_rate_limit`](/manage/view-configure-runtime-parameters.md#how-to-view-runtime-parameters) refers to the maximum number of records per second for each parallelism on each source, where the default parallelism for streaming jobs is the total number of CPU cores across the cluster. For example, assuming a materialized view has four parallelisms and two sources joining together, each source's throughput will be throttled to `4 * streaming_rate_limit` records/s.
3535

3636
Alternatively, you may use `risectl` to alter the streaming rate limit of an existent materialized view, where the `<id>` can be found either from the RisingWave Dashboard or `rw_catalog` schema.
3737

0 commit comments

Comments
 (0)