Skip to content

Commit f75c481

Browse files
committed
Sync rabbitmq-streams man page with broker repository
1 parent e575173 commit f75c481

File tree

1 file changed

+71
-31
lines changed

1 file changed

+71
-31
lines changed

docs/man/rabbitmq-streams.8.md

Lines changed: 71 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,16 @@
115115
### Stream plugin {#Stream_plugin}
116116
<dl class="Bl-tag">
117117
<dt >
118+
#### <code class="Cm">activate_stream_consumer</code> <code class="Fl">--stream</code> <var class="Ar">stream</var> <code class="Fl">--reference</code> <var class="Ar">reference</var> [<code class="Fl">--vhost</code> <var class="Ar">vhost</var>] {#activate_stream_consumer}
119+
</dt>
120+
<dd>
121+
<p class="Pp">Trigger a rebalancing to activate a consumer in a single active consumer group.</p>
122+
<p class="Pp">Example:</p>
123+
<div class="Bd Bd-indent lang-bash">
124+
<code class="Li">rabbitmq-streams activate_stream_consumer --stream stream --reference app-1</code>
125+
</div>
126+
</dd>
127+
<dt >
118128
#### <code class="Cm">list_stream_connections</code> [<var class="Ar">connectioninfoitem ...</var>] {#list_stream_connections}
119129
</dt>
120130
<dd>
@@ -348,14 +358,12 @@ The default is <code class="Cm">balanced</code>
348358
#### <code class="Cm">delete_super_stream</code> <var class="Ar">super-stream</var> [<code class="Fl">--vhost</code> <var class="Ar">vhost</var>] {#delete_super_stream}
349359
</dt>
350360
<dd>
361+
<p class="Pp">Delete a super stream.</p>
351362
<dl class="Bl-tag">
352363
<dt><var class="Ar">super-stream</var></dt>
353364
<dd>The name of the super stream to delete.</dd>
354365
<dt><var class="Ar">vhost</var></dt>
355-
<dd>
356-
The virtual host of the super stream.
357-
<p class="Pp">Delete a super stream.</p>
358-
</dd>
366+
<dd>The virtual host of the super stream.</dd>
359367
</dl>
360368
<p class="Pp"></p>
361369
</dd>
@@ -388,40 +396,72 @@ The default is <code class="Cm">balanced</code>
388396
</dt>
389397
<dd>
390398
<p class="Pp">Lists consumers of a stream consumer group in a vhost.</p>
391-
</dd>
392-
<dt><var class="Ar">stream</var></dt>
393-
<dd>The stream the consumers are attached to.</dd>
394-
<dt><var class="Ar">reference</var></dt>
395-
<dd>The group reference (name).</dd>
396-
<dt><var class="Ar">vhost</var></dt>
397-
<dd>The virtual host of the stream.</dd>
398-
</dl>
399-
<p class="Pp">The <var class="Ar">consumerinfoitem</var> parameter is used to indicate which consumer information items to include in the results. The column order in the results will match the order of the parameters. <var class="Ar">consumerinfoitem</var> can take any value from the list that follows:</p>
400-
<dl class="Bl-tag">
401-
<dt><var class="Ar">connection_name</var></dt>
402-
<dd>Readable name of the consumer connection.</dd>
403-
<dt><var class="Ar">state</var></dt>
404-
<dd>
405-
Consumer state; one of:
406-
<ul class="Bl-bullet Bl-compact">
407-
<li>
399+
<dl class="Bl-tag">
400+
<dt><var class="Ar">stream</var></dt>
401+
<dd>The stream the consumers are attached to.</dd>
402+
<dt><var class="Ar">reference</var></dt>
403+
<dd>The group reference (name).</dd>
404+
<dt><var class="Ar">vhost</var></dt>
405+
<dd>The virtual host of the stream.</dd>
406+
</dl>
407+
<p class="Pp">The <var class="Ar">consumerinfoitem</var> parameter is used to indicate which consumer information items to include in the results. The column order in the results will match the order of the parameters. <var class="Ar">consumerinfoitem</var> can take any value from the list that follows:</p>
408+
<dl class="Bl-tag">
409+
<dt><var class="Ar">connection_name</var></dt>
410+
<dd>Readable name of the consumer connection.</dd>
411+
<dt><var class="Ar">state</var></dt>
412+
<dd>
413+
Consumer state; one of:
414+
<ul class="Bl-bullet Bl-compact">
415+
<li>
408416
active
409417
</li>
410-
<li>
418+
<li>
411419
inactive
412420
</li>
413-
</ul>
421+
</ul>
414422

423+
</dd>
424+
<dt><var class="Ar">subscription_id</var></dt>
425+
<dd>The connection-scoped ID of the consumer.</dd>
426+
</dl>
427+
<p class="Pp">If no <var class="Ar">consumerinfoitem</var> are specified then subscription_id, connection_name, and state are displayed.</p>
428+
<p class="Pp">For example, this command displays the connection name and state for each consumer attached to the stream-1 stream and belonging to the stream-1 group:</p>
429+
<p class="Pp"></p>
430+
<div class="Bd Bd-indent lang-bash">
431+
<code class="Li">rabbitmq-streams list_stream_group_consumers --stream stream-1 --reference stream-1 connection_name state</code>
432+
</div>
433+
<p class="Pp"></p>
434+
</dd>
435+
<dt >
436+
#### <code class="Cm">list_stream_tracking</code> <var class="Ar">stream</var> [<code class="Fl">--all</code> | <code class="Fl">--offset</code> | <code class="Fl">--writer</code>] [<code class="Fl">--vhost</code> <var class="Ar">vhost</var>] {#list_stream_tracking}
437+
</dt>
438+
<dd>
439+
<p class="Pp">Lists tracking information for a stream.</p>
440+
<dl class="Bl-tag">
441+
<dt><var class="Ar">stream</var></dt>
442+
<dd>The name of the stream.</dd>
443+
</dl>
444+
<p class="Pp">Tracking information can be filtered by their type using one of the following mutually exclusive options:</p>
445+
<dl class="Bl-tag">
446+
<dt >
447+
#### <code class="Fl">--all</code> {#all}
448+
</dt>
449+
<dd>List offset tracking and writer deduplication information.</dd>
450+
<dt >
451+
#### <code class="Fl">--offset</code> {#offset}
452+
</dt>
453+
<dd>List only offset tracking information.</dd>
454+
<dt >
455+
#### <code class="Fl">--writer</code> {#writer}
456+
</dt>
457+
<dd>List only writer deduplication tracking information.</dd>
458+
</dl>
459+
<p class="Pp">Example:</p>
460+
<div class="Bd Bd-indent lang-bash">
461+
<code class="Li">rabbitmq-streams list_stream_tracking stream-1 --offset</code>
462+
</div>
415463
</dd>
416-
<dt><var class="Ar">subscription_id</var></dt>
417-
<dd>The connection-scoped ID of the consumer.</dd>
418464
</dl>
419-
<p class="Pp">If no <var class="Ar">consumerinfoitem</var> are specified then subscription_id, connection_name, and state are displayed.</p>
420-
<p class="Pp">For example, this command displays the connection name and state for each consumer attached to the stream-1 stream and belonging to the stream-1 group:</p>
421-
<p class="Pp"></p>
422-
<div class="Bd Bd-indent lang-bash">
423-
<code class="Li">rabbitmq-streams list_stream_group_consumers --stream stream-1 --reference stream-1 connection_name state</code>
424-
</div>
425465
</section>
426466
</section>
427467
<section class="Sh">

0 commit comments

Comments
 (0)