Skip to content

Commit

Permalink
[Docs] Add putstate, set-replicator-dispatch-rate and get-replicator-…
Browse files Browse the repository at this point in the history
…dispatch-rate cli docs for pulsar admin (#5338)

Signed-off-by: xiaolong.ran <ranxiaolong716@gmail.com>

### Motivation

In [pulsar-admin](https://pulsar.apache.org/docs/en/pulsar-admin), we have not listed the document information related to the `putstate`, `set-replicator-dispatch-rate` and `get-replicator-dispatch-rate`command.

### Modifications

*Describe the modifications you've done.*

Add `putstate` command for **pulsar-admin functions**.
Add `set-replicator-dispatch-rate` command for **pulsar-admin namespaces**.
Add `get-replicator-dispatch-rate` command for **pulsar-admin namespaces**.
  • Loading branch information
wolfstudy authored and sijie committed Oct 10, 2019
1 parent 1611470 commit 0d0af45
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions site2/docs/reference-pulsar-admin.md
Expand Up @@ -391,6 +391,7 @@ Subcommands
* `stats`
* `list`
* `querystate`
* `putstate`
* `trigger`


Expand Down Expand Up @@ -696,6 +697,23 @@ Options
|`--tenant`|The function's tenant||
|`-w`, `--watch`|Watch for changes in the value associated with a key for a Pulsar Function|false|

### `putstate`
Put a key/value pair to the state associated with a Pulsar Function

Usage
```bash
$ pulsar-admin functions putstate options
```

Options

|Flag|Description|Default|
|---|---|---|
|`--fqfn`|The Fully Qualified Function Name (FQFN) for the Pulsar Function||
|`--name`|The name of a Pulsar Function||
|`--namespace`|The namespace of a Pulsar Function||
|`--tenant`|The tenant of a Pulsar Function||
|`-s`, `--state`|The FunctionState that needs to be put||

### `trigger`
Triggers the specified Pulsar Function with a supplied value
Expand Down Expand Up @@ -757,6 +775,8 @@ Subcommands
* `split-bundle`
* `set-dispatch-rate`
* `get-dispatch-rate`
* `set-replicator-dispatch-rate`
* `get-replicator-dispatch-rate`
* `set-subscribe-rate`
* `get-subscribe-rate`
* `set-subscription-dispatch-rate`
Expand Down Expand Up @@ -1130,6 +1150,29 @@ Usage
$ pulsar-admin namespaces get-dispatch-rate tenant/namespace
```

### set-replicator-dispatch-rate
Set replicator message-dispatch-rate for all topics of the namespace

Usage
```bash
$ pulsar-admin namespaces set-replicator-dispatch-rate tenant/namespace options
```

Options
|Flag|Description|Default|
|----|---|---|
|`-bd`, `--byte-dispatch-rate`|The byte dispatch rate (default -1 will be overwrite if not passed)|-1|
|`-dt`, `--dispatch-rate-period`|The dispatch rate period in second type (default 1 second will be overwrite if not passed)|1|
|`-md`, `--msg-dispatch-rate`|The message dispatch rate (default -1 will be overwrite if not passed)|-1|

### get-replicator-dispatch-rate
Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)

Usage
```bash
$ pulsar-admin namespaces get-replicator-dispatch-rate tenant/namespace
```

### `set-subscribe-rate`
Set subscribe-rate per consumer for all topics of the namespace

Expand Down

0 comments on commit 0d0af45

Please sign in to comment.