This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new 76e33ecc209 Docs sync done from apache/pulsar(#bc1e0cb)
76e33ecc209 is described below
commit 76e33ecc209db0ad0351ce0ec0f0ca692d4e5e0b
Author: Pulsar Site Updater <[email protected]>
AuthorDate: Sat Nov 19 12:01:40 2022 +0000
Docs sync done from apache/pulsar(#bc1e0cb)
---
site2/website-next/docs/admin-api-brokers.md | 57 +++-
site2/website-next/docs/admin-api-clusters.md | 20 +-
site2/website-next/docs/admin-api-functions.md | 139 ++++----
site2/website-next/docs/admin-api-namespaces.md | 154 +++++----
site2/website-next/docs/admin-api-packages.md | 2 +-
site2/website-next/docs/admin-api-permissions.md | 43 ++-
site2/website-next/docs/admin-api-schemas.md | 4 +
site2/website-next/docs/admin-api-tenants.md | 22 +-
site2/website-next/docs/admin-api-topics.md | 380 ++++++++++++---------
site2/website-next/docs/admin-api-transactions.md | 79 ++---
.../docs/getting-started-standalone.md | 2 +-
11 files changed, 505 insertions(+), 397 deletions(-)
diff --git a/site2/website-next/docs/admin-api-brokers.md
b/site2/website-next/docs/admin-api-brokers.md
index dec95a900fc..11253175f11 100644
--- a/site2/website-next/docs/admin-api-brokers.md
+++ b/site2/website-next/docs/admin-api-brokers.md
@@ -51,7 +51,12 @@ Fetch all available active brokers that are serving traffic
with cluster name.
```shell
pulsar-admin brokers list use
-broker1.use.org.com:8080
+```
+
+Example output:
+
+```
+localhost:8080
```
</TabItem>
@@ -83,7 +88,14 @@ Fetch the information of the leader broker, for example, the
service url.
```shell
pulsar-admin brokers leader-broker
-BrokerInfo(serviceUrl=broker1.use.org.com:8080)
+```
+
+Example output:
+
+```json
+{
+ "serviceUrl" : "http://localhost:8080";
+}
```
</TabItem>
@@ -117,15 +129,20 @@ It finds all namespaces which are owned and served by a
given broker.
```shell
pulsar-admin brokers namespaces use \
---url broker1.use.org.com:8080
+ --url localhost:8080
+```
-{
- "my-property/use/my-ns/0x00000000_0xffffffff": {
- "broker_assignment": "shared",
- "is_controlled": false,
- "is_active": true
- }
-}
+Example output:
+
+```
+public/default/0x00000000_0x40000000 [broker_assignment=shared
is_controlled=false is_active=true]
+public/default/0xc0000000_0xffffffff [broker_assignment=shared
is_controlled=false is_active=true]
+public/functions/0x40000000_0x80000000 [broker_assignment=shared
is_controlled=false is_active=true]
+public/functions/0x00000000_0x40000000 [broker_assignment=shared
is_controlled=false is_active=true]
+pulsar/standalone/localhost:8080/0x00000000_0xffffffff
[broker_assignment=shared is_controlled=false is_active=true]
+pulsar/localhost:8080/0x00000000_0xffffffff [broker_assignment=shared
is_controlled=false is_active=true]
+public/functions/0x80000000_0xc0000000 [broker_assignment=shared
is_controlled=false is_active=true]
+public/default/0x80000000_0xc0000000 [broker_assignment=shared
is_controlled=false is_active=true]
```
</TabItem>
@@ -197,7 +214,19 @@ Fetch a list of all potentially updatable configuration
parameters.
```shell
pulsar-admin brokers list-dynamic-config
-brokerShutdownTimeoutMs
+```
+
+Example output:
+
+```
+forceDeleteNamespaceAllowed
+loadBalancerMemoryResourceWeight
+allowAutoTopicCreation
+brokerDeleteInactivePartitionedTopicMetadataEnabled
+managedLedgerInactiveLedgerRolloverTimeSeconds
+loadBalancerNamespaceBundleMaxMsgRate
+resourceUsageTransportPublishIntervalInSecs
+# omit...
```
</TabItem>
@@ -229,7 +258,11 @@ Fetch a list of all parameters that have been dynamically
updated.
```shell
pulsar-admin brokers get-all-dynamic-config
-brokerShutdownTimeoutMs:100
+```
+Example output:
+
+```
+brokerShutdownTimeoutMs 100
```
</TabItem>
diff --git a/site2/website-next/docs/admin-api-clusters.md
b/site2/website-next/docs/admin-api-clusters.md
index 1c73f642bf8..ee1887baa2c 100644
--- a/site2/website-next/docs/admin-api-clusters.md
+++ b/site2/website-next/docs/admin-api-clusters.md
@@ -53,8 +53,8 @@ You can provision a new cluster using the
[`create`](/tools/pulsar-admin/) subco
```shell
pulsar-admin clusters create cluster-1 \
---url http://my-cluster.org.com:8080 \
---broker-url pulsar://my-cluster.org.com:6650
+ --url http://my-cluster.org.com:8080 \
+ --broker-url pulsar://my-cluster.org.com:6650
```
</TabItem>
@@ -128,6 +128,10 @@ Use the [`get`](/tools/pulsar-admin/) subcommand and
specify the name of the clu
```shell
pulsar-admin clusters get cluster-1
+```
+Output:
+
+```json
{
"serviceUrl": "http://my-cluster.org.com:8080/";,
"serviceUrlTls": null,
@@ -168,8 +172,8 @@ Use the [`update`](/tools/pulsar-admin/) subcommand and
specify new configuratio
```shell
pulsar-admin clusters update cluster-1 \
---url http://my-cluster.org.com:4081 \
---broker-url pulsar://my-cluster.org.com:3350
+ --url http://my-cluster.org.com:4081 \
+ --broker-url pulsar://my-cluster.org.com:3350
```
</TabItem>
@@ -242,10 +246,14 @@ Use the [`list`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin clusters list
+```
+
+Output:
+
+```
cluster-1
cluster-2
```
-
</TabItem>
<TabItem value="REST API">
@@ -275,7 +283,7 @@ Peer clusters can be configured for a given cluster in a
Pulsar [instance](refer
Use the [`update-peer-clusters`](/tools/pulsar-admin/) subcommand and specify
the list of peer-cluster names.
-```
+```shell
pulsar-admin update-peer-clusters cluster-1 --peer-clusters cluster-2
```
diff --git a/site2/website-next/docs/admin-api-functions.md
b/site2/website-next/docs/admin-api-functions.md
index 799fa0c54b6..703265cfade 100644
--- a/site2/website-next/docs/admin-api-functions.md
+++ b/site2/website-next/docs/admin-api-functions.md
@@ -56,13 +56,13 @@ Use the [`create`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions create \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions) \
---inputs test-input-topic \
---output persistent://public/default/test-output-topic \
---classname org.apache.pulsar.functions.api.examples.ExclamationFunction \
---jar /examples/api-examples.jar
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions) \
+ --inputs test-input-topic \
+ --output persistent://public/default/test-output-topic \
+ --classname org.apache.pulsar.functions.api.examples.ExclamationFunction \
+ --jar /examples/api-examples.jar
```
</TabItem>
@@ -110,11 +110,11 @@ Use the [`update`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions update \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions) \
---output persistent://public/default/update-output-topic \
-# other options
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions) \
+ --output persistent://public/default/update-output-topic \
+ # other options
```
</TabItem>
@@ -157,10 +157,10 @@ Use the [`start`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions start \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions) \
---instance-id 1
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions) \
+ --instance-id 1
```
</TabItem>
@@ -196,9 +196,9 @@ Use the [`start`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions start \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions) \
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions) \
```
</TabItem>
@@ -234,10 +234,10 @@ Use the [`stop`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions stop \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions) \
---instance-id 1
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions) \
+ --instance-id 1
```
</TabItem>
@@ -273,9 +273,9 @@ Use the [`stop`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions stop \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions) \
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions)
```
</TabItem>
@@ -311,11 +311,10 @@ Use the [`restart`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions restart \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions) \
---instance-id 1
-
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions) \
+ --instance-id 1
```
</TabItem>
@@ -351,9 +350,9 @@ Use the [`restart`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions restart \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions) \
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions)
```
</TabItem>
@@ -389,8 +388,8 @@ Use the [`list`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions list \
---tenant public \
---namespace default
+ --tenant public \
+ --namespace default
```
</TabItem>
@@ -426,9 +425,9 @@ Use the [`delete`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions delete \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions)
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions)
```
</TabItem>
@@ -464,9 +463,9 @@ Use the [`get`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions get \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions)
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions)
```
</TabItem>
@@ -501,10 +500,10 @@ Use the [`status`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions status \
- --tenant public \
- --namespace default \
- --name (the name of Pulsar Functions) \
- --instance-id 1
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions) \
+ --instance-id 1
```
</TabItem>
@@ -540,9 +539,9 @@ Use the [`status`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions status \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions)
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions)
```
</TabItem>
@@ -578,10 +577,10 @@ Use the [`stats`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions stats \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions) \
---instance-id 1
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions) \
+ --instance-id 1
```
</TabItem>
@@ -617,9 +616,9 @@ Use the [`stats`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions stats \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions)
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions)
```
</TabItem>
@@ -655,12 +654,12 @@ Use the [`trigger`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions trigger \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions) \
---topic (the name of input topic) \
---trigger-value \"hello pulsar\"
-# or --trigger-file (the path of trigger file)
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions) \
+ --topic (the name of input topic) \
+ --trigger-value \"hello pulsar\"
+ # or --trigger-file (the path of trigger file)
```
</TabItem>
@@ -696,10 +695,10 @@ Use the [`putstate`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions putstate \
- --tenant public \
- --namespace default \
- --name (the name of Pulsar Functions) \
- --state "{\"key\":\"pulsar\", \"stringValue\":\"hello pulsar\"}"
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions) \
+ --state "{\"key\":\"pulsar\", \"stringValue\":\"hello pulsar\"}"
```
</TabItem>
@@ -737,10 +736,10 @@ Use the [`querystate`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin functions querystate \
---tenant public \
---namespace default \
---name (the name of Pulsar Functions) \
---key (the key of state)
+ --tenant public \
+ --namespace default \
+ --name (the name of Pulsar Functions) \
+ --key (the key of state)
```
</TabItem>
diff --git a/site2/website-next/docs/admin-api-namespaces.md
b/site2/website-next/docs/admin-api-namespaces.md
index 10b24ed115d..e74117256d0 100644
--- a/site2/website-next/docs/admin-api-namespaces.md
+++ b/site2/website-next/docs/admin-api-namespaces.md
@@ -79,6 +79,11 @@ Use the [`policies`](/tools/pulsar-admin/) subcommand and
specify the namespace:
```shell
pulsar-admin namespaces policies test-tenant/test-namespace
+```
+
+Example output:
+
+```json
{
"auth_policies": {
"namespace_auth": {},
@@ -133,8 +138,13 @@ Use the [`list`](/tools/pulsar-admin/) subcommand and
specify the tenant:
```shell
pulsar-admin namespaces list test-tenant
-test-tenant/ns1
-test-tenant/ns2
+```
+
+Example output:
+
+```
+test-tenant/namespace1
+test-tenant/namespace2
```
</TabItem>
@@ -167,7 +177,7 @@ You can delete existing namespaces from a tenant.
Use the [`delete`](/tools/pulsar-admin/) subcommand and specify the namespace:
```shell
-pulsar-admin namespaces delete test-tenant/ns1
+pulsar-admin namespaces delete test-tenant/namespace1
```
</TabItem>
@@ -200,8 +210,7 @@ You can set replication clusters for a namespace to enable
Pulsar to internally
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces set-clusters test-tenant/ns1 \
---clusters cl1
+pulsar-admin namespaces set-clusters test-tenant/namespace1 --clusters cl1
```
</TabItem>
@@ -232,11 +241,13 @@ You can get the list of replication clusters for a given
namespace.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces get-clusters test-tenant/cl1/ns1
+pulsar-admin namespaces get-clusters test-tenant/cluster1/namespace1
```
-```shell
-cl2
+Example output:
+
+```
+cluster2
```
</TabItem>
@@ -277,7 +288,10 @@ Backlog quota restriction can be taken care of by defining
the restriction of ba
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces set-backlog-quota --limit 10G --limitTime 36000
--policy producer_request_hold test-tenant/ns1
+pulsar-admin namespaces set-backlog-quota --limit 10G \
+ --limitTime 36000 \
+ --policy producer_request_hold \
+ test-tenant/namespace1
```
</TabItem>
@@ -308,16 +322,13 @@ You can get a configured backlog quota for a given
namespace.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces get-backlog-quotas test-tenant/ns1
+pulsar-admin namespaces get-backlog-quotas test-tenant/namespace1
```
-```json
-{
- "destination_storage": {
- "limit": 10,
- "policy": "producer_request_hold"
- }
-}
+Example output:
+
+```
+destination_storage BacklogQuotaImpl(limit=10737418240,
limitSize=10737418240, limitTime=36000, policy=producer_request_hold)
```
</TabItem>
@@ -348,7 +359,7 @@ You can remove backlog quota policies for a given namespace.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces remove-backlog-quota test-tenant/ns1
+pulsar-admin namespaces remove-backlog-quota test-tenant/namespace1
```
</TabItem>
@@ -389,7 +400,10 @@ Persistence policies allow users to configure
persistency-level for all topic me
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces set-persistence --bookkeeper-ack-quorum 2
--bookkeeper-ensemble 3 --bookkeeper-write-quorum 2 --ml-mark-delete-max-rate 0
test-tenant/ns1
+pulsar-admin namespaces set-persistence \
+ --bookkeeper-ack-quorum 2 --bookkeeper-ensemble 3 \
+ --bookkeeper-write-quorum 2 --ml-mark-delete-max-rate 0 \
+ test-tenant/namespace1
```
</TabItem>
@@ -420,9 +434,11 @@ You can get the configured persistence policies of a given
namespace.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces get-persistence test-tenant/ns1
+pulsar-admin namespaces get-persistence test-tenant/namespace1
```
+Example output:
+
```json
{
"bookkeeperEnsemble": 3,
@@ -462,7 +478,7 @@ A namespace bundle is a virtual group of topics that belong
to the same namespac
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces unload --bundle 0x00000000_0xffffffff test-tenant/ns1
+pulsar-admin namespaces unload --bundle 0x00000000_0xffffffff
test-tenant/namespace1
```
</TabItem>
@@ -493,7 +509,7 @@ One namespace bundle can contain multiple topics but can be
served by only one b
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces split-bundle --bundle 0x00000000_0xffffffff
test-tenant/ns1
+pulsar-admin namespaces split-bundle --bundle 0x00000000_0xffffffff
test-tenant/namespace1
```
</TabItem>
@@ -526,7 +542,7 @@ You can configure the time to live (in seconds) duration
for messages. In the ex
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces set-message-ttl --messageTTL 100 test-tenant/ns1
+pulsar-admin namespaces set-message-ttl --messageTTL 100 test-tenant/namespace1
```
</TabItem>
@@ -557,8 +573,9 @@ When the message-ttl for a namespace is set, you can use
the command below to ge
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces get-message-ttl test-tenant/ns1
+pulsar-admin namespaces get-message-ttl test-tenant/namespace1
```
+Example output:
```
100
@@ -596,7 +613,7 @@ Remove a message TTL of the configured namespace.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces remove-message-ttl test-tenant/ns1
+pulsar-admin namespaces remove-message-ttl test-tenant/namespace1
```
</TabItem>
@@ -630,7 +647,7 @@ It clears all message backlogs for all the topics that
belong to a specific name
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces clear-backlog --sub my-subscription test-tenant/ns1
+pulsar-admin namespaces clear-backlog --sub my-subscription
test-tenant/namespace1
```
</TabItem>
@@ -661,7 +678,10 @@ It clears all message backlogs for all the topics that
belong to a specific Name
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces clear-backlog --bundle 0x00000000_0xffffffff --sub
my-subscription test-tenant/ns1
+pulsar-admin namespaces clear-backlog \
+ --bundle 0x00000000_0xffffffff \
+ --sub my-subscription \
+ test-tenant/namespace1
```
</TabItem>
@@ -696,7 +716,7 @@ Each namespace contains multiple topics and the retention
size (storage size) of
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces set-retention --size 100 --time 10 test-tenant/ns1
+pulsar-admin namespaces set-retention --size 100M --time 10m
test-tenant/namespace1
```
</TabItem>
@@ -727,7 +747,7 @@ It shows the retention information of a given namespace.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces get-retention test-tenant/ns1
+pulsar-admin namespaces get-retention test-tenant/namespace1
```
```json
@@ -776,10 +796,10 @@ disables the throttling.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces set-dispatch-rate test-tenant/ns1 \
---msg-dispatch-rate 1000 \
---byte-dispatch-rate 1048576 \
---dispatch-rate-period 1
+pulsar-admin namespaces set-dispatch-rate test-tenant/namespace1 \
+ --msg-dispatch-rate 1000 \
+ --byte-dispatch-rate 1048576 \
+ --dispatch-rate-period 1
```
</TabItem>
@@ -810,13 +830,16 @@ It shows the configured message-rate for the namespace
(topics under this namesp
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces get-dispatch-rate test-tenant/ns1
+pulsar-admin namespaces get-dispatch-rate test-tenant/namespace1
```
+Example output:
+
```json
{
- "dispatchThrottlingRatePerTopicInMsg" : 1000,
- "dispatchThrottlingRatePerTopicInByte" : 1048576,
+ "dispatchThrottlingRateInMsg" : 1000,
+ "dispatchThrottlingRateInByte" : 1048576,
+ "relativeToPublishRate" : false,
"ratePeriodInSecond" : 1
}
```
@@ -852,10 +875,10 @@ disables the throttling.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces set-subscription-dispatch-rate test-tenant/ns1 \
---msg-dispatch-rate 1000 \
---byte-dispatch-rate 1048576 \
---dispatch-rate-period 1
+pulsar-admin namespaces set-subscription-dispatch-rate test-tenant/namespace1 \
+ --msg-dispatch-rate 1000 \
+ --byte-dispatch-rate 1048576 \
+ --dispatch-rate-period 1
```
</TabItem>
@@ -886,13 +909,16 @@ It shows the configured message-rate for the namespace
(topics under this namesp
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces get-subscription-dispatch-rate test-tenant/ns1
+pulsar-admin namespaces get-subscription-dispatch-rate test-tenant/namespace1
```
+Example output:
+
```json
{
- "dispatchThrottlingRatePerTopicInMsg" : 1000,
- "dispatchThrottlingRatePerTopicInByte" : 1048576,
+ "dispatchThrottlingRateInMsg" : 1000,
+ "dispatchThrottlingRateInByte" : 1048576,
+ "relativeToPublishRate" : false,
"ratePeriodInSecond" : 1
}
```
@@ -927,10 +953,10 @@ It sets the message dispatch rate for all the replicators
between replication cl
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces set-replicator-dispatch-rate test-tenant/ns1 \
---msg-dispatch-rate 1000 \
---byte-dispatch-rate 1048576 \
---dispatch-rate-period 1
+pulsar-admin namespaces set-replicator-dispatch-rate test-tenant/namespace1 \
+ --msg-dispatch-rate 1000 \
+ --byte-dispatch-rate 1048576 \
+ --dispatch-rate-period 1
```
</TabItem>
@@ -961,7 +987,7 @@ It shows the configured message-rate for the namespace
(topics under this namesp
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces get-replicator-dispatch-rate test-tenant/ns1
+pulsar-admin namespaces get-replicator-dispatch-rate test-tenant/namespace1
```
```json
@@ -1002,7 +1028,7 @@ It shows the configured `deduplicationSnapshotInterval`
for a namespace (Each to
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces get-deduplication-snapshot-interval test-tenant/ns1
+pulsar-admin namespaces get-deduplication-snapshot-interval
test-tenant/namespace1
```
</TabItem>
@@ -1033,7 +1059,7 @@ Set the configured `deduplicationSnapshotInterval` for a
namespace. Each topic u
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces set-deduplication-snapshot-interval test-tenant/ns1
--interval 1000
+pulsar-admin namespaces set-deduplication-snapshot-interval
test-tenant/namespace1 --interval 1000
```
</TabItem>
@@ -1064,7 +1090,7 @@ Remove configured `deduplicationSnapshotInterval` of a
namespace (Each topic und
<TabItem value="pulsar-admin">
```shell
-pulsar-admin namespaces remove-deduplication-snapshot-interval test-tenant/ns1
+pulsar-admin namespaces remove-deduplication-snapshot-interval
test-tenant/namespace1
```
</TabItem>
@@ -1135,9 +1161,11 @@ Entry filter helps with filtering message on server side.
<TabItem value="pulsar-admin">
```
-
-$ pulsar-admin namespaces set-entry-filters --desc "The description of the
entry filter to be used for user help."
---entry-filters-name "The class name for the entry filter."
--entry-filters-dir "The directory for all the entry filter implementations."
test-tenant/ns1
+pulsar-admin namespaces set-entry-filters \
+ --desc "The description of the entry filter to be used for user help." \
+ --entry-filters-name "The class name for the entry filter." \
+ --entry-filters-dir "The directory for all the entry filter
implementations." \
+ test-tenant/namespace1
```
</TabItem>
@@ -1150,9 +1178,7 @@ version=@pulsar:version_number@}
<TabItem value="Java">
```java
-
admin.namespaces().setEntryFilters(namespace, new EntryFilters("desc",
"classes name", "class files localtion"))
-
```
</TabItem>
@@ -1170,10 +1196,8 @@ You can get a configured entry filter for a given
namespace.
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST
API","value":"REST API"},{"label":"Java","value":"Java"}]}>
<TabItem value="pulsar-admin">
-```
-
-$ pulsar-admin namespaces get-entry-filters test-tenant/ns1
-
+```shell
+pulsar-admin namespaces get-entry-filters test-tenant/namespace1
```
</TabItem>
@@ -1186,9 +1210,7 @@ version=@pulsar:version_number@}
<TabItem value="Java">
```java
-
admin.namespaces().getEntryFilters(namespace);
-
```
</TabItem>
@@ -1206,10 +1228,8 @@ You can remove entry filters policies for a given
namespace.
values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST
API","value":"REST API"},{"label":"Java","value":"Java"}]}>
<TabItem value="pulsar-admin">
-```
-
-$ pulsar-admin namespaces remove-entry-filters test-tenant/ns1
-
+```shell
+pulsar-admin namespaces remove-entry-filters test-tenant/namespace1
```
</TabItem>
@@ -1222,9 +1242,7 @@ version=@pulsar:version_number@}
<TabItem value="Java">
```java
-
admin.namespaces().removeEntryFilters(namespace)
-
```
</TabItem>
diff --git a/site2/website-next/docs/admin-api-packages.md
b/site2/website-next/docs/admin-api-packages.md
index 73437f5cdf5..c55ffcf546b 100644
--- a/site2/website-next/docs/admin-api-packages.md
+++ b/site2/website-next/docs/admin-api-packages.md
@@ -22,7 +22,7 @@ import TabItem from '@theme/TabItem';
:::
-Package managers or package-management systems automatically manage packages
in a consistent manner. These tools simplify the installation tasks, upgrade
process, and deletion operations for users. A package is a minimal unit that a
package manager deals with. In Pulsar, packages are organized at the tenant-
and namespace-level to manage Pulsar Functions and Pulsar IO connectors (i.e.,
source and sink).
+Package managers or package-management systems automatically manage packages
in a consistent manner. These tools simplify the installation tasks, upgrade
process, and deletion operations for users. A package is a minimal unit that a
package manager deals with. In Pulsar, packages are organized at the
tenant-level and namespace-level to manage Pulsar Functions and Pulsar IO
connectors (i.e., source and sink).
## What is a package?
diff --git a/site2/website-next/docs/admin-api-permissions.md
b/site2/website-next/docs/admin-api-permissions.md
index b4d95fc2d1d..b25d2f1c8fc 100644
--- a/site2/website-next/docs/admin-api-permissions.md
+++ b/site2/website-next/docs/admin-api-permissions.md
@@ -43,9 +43,9 @@ You can grant permissions to specific roles for lists of
operations such as `pro
Use the [`grant-permission`](/tools/pulsar-admin/) subcommand and specify a
namespace, actions using the `--actions` flag, and a role using the `--role`
flag:
```shell
-pulsar-admin namespaces grant-permission test-tenant/ns1 \
---actions produce,consume \
---role admin10
+pulsar-admin namespaces grant-permission test-tenant/namespace1 \
+ --actions produce,consume \
+ --role admin10
```
Wildcard authorization can be performed when
`authorizationAllowWildcardsMatching` is set to `true` in `broker.conf`.
@@ -53,18 +53,17 @@ Wildcard authorization can be performed when
`authorizationAllowWildcardsMatchin
**Example**
```shell
-pulsar-admin namespaces grant-permission test-tenant/ns1 \
- --actions produce,consume \
- --role 'my.role.*'
-
+pulsar-admin namespaces grant-permission test-tenant/namespace1 \
+ --actions produce,consume \
+ --role 'my.role.*'
```
Then, roles `my.role.1`, `my.role.2`, `my.role.foo`, `my.role.bar`, etc. can
produce and consume.
```shell
-pulsar-admin namespaces grant-permission test-tenant/ns1 \
- --actions produce,consume \
- --role '*.role.my'
+pulsar-admin namespaces grant-permission test-tenant/namespace1 \
+ --actions produce,consume \
+ --role '*.role.my'
```
Then, roles `1.role.my`, `2.role.my`, `foo.role.my`, `bar.role.my`, etc. can
produce and consume.
@@ -78,9 +77,9 @@ A wildcard matching works at **the beginning or end of the
role name only**.
**Example**
```shell
-pulsar-admin namespaces grant-permission test-tenant/ns1 \
- --actions produce,consume \
- --role 'my.*.role'
+pulsar-admin namespaces grant-permission test-tenant/namespace1 \
+ --actions produce,consume \
+ --role 'my.*.role'
```
In this case, only the role `my.*.role` has permissions.
@@ -116,13 +115,13 @@ You can see which permissions have been granted to which
roles in a namespace.
Use the [`permissions`](/tools/pulsar-admin/) subcommand and specify a
namespace:
```shell
-pulsar-admin namespaces permissions test-tenant/ns1
-{
- "admin10": [
- "produce",
- "consume"
- ]
-}
+pulsar-admin namespaces permissions test-tenant/namespace1
+```
+
+Example output:
+
+```
+my.role.* [produce, consume]
```
</TabItem>
@@ -155,8 +154,8 @@ You can revoke permissions from specific roles, which means
that those roles wil
Use the [`revoke-permission`](/tools/pulsar-admin/) subcommand and specify a
namespace and a role using the `--role` flag:
```shell
-pulsar-admin namespaces revoke-permission test-tenant/ns1 \
---role admin10
+pulsar-admin namespaces revoke-permission test-tenant/namespace1 \
+ --role admin10
```
</TabItem>
diff --git a/site2/website-next/docs/admin-api-schemas.md
b/site2/website-next/docs/admin-api-schemas.md
index 15f11f4a91b..609135e1a44 100644
--- a/site2/website-next/docs/admin-api-schemas.md
+++ b/site2/website-next/docs/admin-api-schemas.md
@@ -199,7 +199,11 @@ Use the `get` subcommand.
```bash
pulsar-admin schemas get <topic-name>
+```
+
+Example output:
+```json
{
"version": 0,
"type": "String",
diff --git a/site2/website-next/docs/admin-api-tenants.md
b/site2/website-next/docs/admin-api-tenants.md
index e6a1b09437e..49679662f8e 100644
--- a/site2/website-next/docs/admin-api-tenants.md
+++ b/site2/website-next/docs/admin-api-tenants.md
@@ -43,6 +43,11 @@ Use the [`list`](/tools/pulsar-admin/) subcommand.
```shell
pulsar-admin tenants list
+```
+
+Output:
+
+```
my-tenant-1
my-tenant-2
```
@@ -86,12 +91,14 @@ as a comma-separated list. Here are some examples:
```shell
pulsar-admin tenants create my-tenant \
---admin-roles role1,role2,role3 \
---allowed-clusters cluster1
+ --admin-roles role1,role2,role3 \
+ --allowed-clusters cluster1
+```
+```shell
pulsar-admin tenants create my-tenant \
--r role1
--c cluster1
+ -r role1 \
+ -c cluster1
```
</TabItem>
@@ -125,6 +132,9 @@ Use the [`get`](/tools/pulsar-admin/) subcommand and
specify the name of the ten
```shell
pulsar-admin tenants get my-tenant
+```
+
+```json
{
"adminRoles": [
"admin1",
@@ -200,7 +210,9 @@ You can update a tenant's configuration.
Use the [`update`](/tools/pulsar-admin/) subcommand.
```shell
-pulsar-admin tenants update my-tenant
+pulsar-admin tenants update my-tenant \
+ --admin-roles role1,role2 \
+ --allowed-clusters cluster1,cluster2
```
</TabItem>
diff --git a/site2/website-next/docs/admin-api-topics.md
b/site2/website-next/docs/admin-api-topics.md
index bf23ed7f520..ec80a3b04ea 100644
--- a/site2/website-next/docs/admin-api-topics.md
+++ b/site2/website-next/docs/admin-api-topics.md
@@ -55,8 +55,7 @@ You can get the list of topics under a given namespace in the
following ways.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics list \
-my-tenant/my-namespace
+pulsar-admin topics list my-tenant/my-namespace
```
</TabItem>
@@ -89,8 +88,9 @@ You can grant permissions on a client role to perform
specific actions on a give
```shell
pulsar-admin topics grant-permission \
---actions produce,consume --role application1 \
-persistent://test-tenant/ns1/tp1 \
+ --actions produce,consume \
+ --role application1 \
+ persistent://test-tenant/ns1/tp1
```
</TabItem>
@@ -124,15 +124,13 @@ You can fetch permission in the following ways.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics permissions \
-persistent://test-tenant/ns1/tp1 \
+pulsar-admin topics permissions persistent://test-tenant/ns1/tp1
+```
-{
- "application1": [
- "consume",
- "produce"
- ]
-}
+Example output:
+
+```
+application1 [consume, produce]
```
</TabItem>
@@ -165,15 +163,8 @@ You can revoke permissions granted on a client role in the
following ways.
```shell
pulsar-admin topics revoke-permission \
---role application1 \
-persistent://test-tenant/ns1/tp1 \
-
-{
- "application1": [
- "consume",
- "produce"
- ]
-}
+ --role application1 \
+ persistent://test-tenant/ns1/tp1
```
</TabItem>
@@ -206,8 +197,7 @@ You can delete a topic in the following ways. You cannot
delete a topic if any a
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics delete \
-persistent://test-tenant/ns1/tp1 \
+pulsar-admin topics delete persistent://test-tenant/ns1/tp1
```
</TabItem>
@@ -239,8 +229,7 @@ You can unload a topic in the following ways.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics unload \
-persistent://test-tenant/ns1/tp1 \
+pulsar-admin topics unload persistent://test-tenant/ns1/tp1
```
</TabItem>
@@ -572,8 +561,7 @@ To get the status of a topic, you can use the following
ways.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics stats \
-persistent://test-tenant/ns1/tp1 \
+pulsar-admin topics stats persistent://test-tenant/ns1/tp1
```
</TabItem>
@@ -747,8 +735,7 @@ To get the internal status of a topic, you can use the
following ways.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics stats-internal \
-persistent://test-tenant/ns1/tp1 \
+pulsar-admin topics stats-internal persistent://test-tenant/ns1/tp1
```
</TabItem>
@@ -781,12 +768,21 @@ You can peek a number of messages for a specific
subscription of a given topic i
```shell
pulsar-admin topics peek-messages \
---count 10 --subscription my-subscription \
-persistent://test-tenant/ns1/tp1 \
+ --count 10 --subscription my-subscription \
+ persistent://test-tenant/ns1/tp1
+```
-Message ID: 315674752:0
-Properties: { "X-Pulsar-publish-time" : "2015-07-13 17:40:28.451" }
-msg-payload
+Example output:
+
+```
+Message ID: 77:2
+Publish time: 1668674963028
+Event time: 0
+ +-------------------------------------------------+
+ | 0 1 2 3 4 5 6 7 8 9 a b c d e f |
++--------+-------------------------------------------------+----------------+
+|00000000| 68 65 6c 6c 6f 2d 31 |hello-1 |
++--------+-------------------------------------------------+----------------+
```
</TabItem>
@@ -820,9 +816,8 @@ You can fetch the message with the given ledger ID and
entry ID in the following
<TabItem value="pulsar-admin">
```shell
-./bin/pulsar-admin topics get-message-by-id \
-persistent://public/default/my-topic \
--l 10 -e 0
+pulsar-admin topics get-message-by-id \
+ -l 10 -e 0 persistent://public/default/my-topic
```
</TabItem>
@@ -856,9 +851,8 @@ You can examine a specific message on a topic by position
relative to the earlie
<TabItem value="pulsar-admin">
```shell
-./bin/pulsar-admin topics examine-messages \
-persistent://public/default/my-topic \
--i latest -m 1
+pulsar-admin topics examine-messages \
+ -i latest -m 1 persistent://public/default/my-topic
```
</TabItem>
@@ -890,9 +884,9 @@ You can get message ID published at or just after the given
datetime.
<TabItem value="pulsar-admin">
```shell
-./bin/pulsar-admin topics get-message-id \
-persistent://public/default/my-topic \
--d 2021-06-28T19:01:17Z
+pulsar-admin topics get-message-id \
+ persistent://public/default/my-topic \
+ -d 2021-06-28T19:01:17Z
```
</TabItem>
@@ -927,8 +921,8 @@ You can skip a number of messages for a specific
subscription of a given topic i
```shell
pulsar-admin topics skip \
---count 10 --subscription my-subscription \
-persistent://test-tenant/ns1/tp1 \
+ --count 10 --subscription my-subscription \
+ persistent://test-tenant/ns1/tp1
```
</TabItem>
@@ -962,9 +956,9 @@ You can skip all the old messages for a specific
subscription of a given topic.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics skip-all \
---subscription my-subscription \
-persistent://test-tenant/ns1/tp1 \
+pulsar-admin topics clear-backlog \
+ --subscription my-subscription \
+ persistent://test-tenant/ns1/tp1
```
</TabItem>
@@ -998,8 +992,8 @@ You can reset a subscription cursor position back to the
position which is recor
```shell
pulsar-admin topics reset-cursor \
---subscription my-subscription --time 10 \
-persistent://test-tenant/ns1/tp1 \
+ --subscription my-subscription --time 10 \
+ persistent://test-tenant/ns1/tp1
```
</TabItem>
@@ -1035,9 +1029,12 @@ You can locate the owner broker of the given topic in
the following ways.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics lookup \
-persistent://test-tenant/ns1/tp1 \
+pulsar-admin topics lookup persistent://test-tenant/ns1/tp1
+```
+Example output:
+
+```
"pulsar://broker1.org.com:4480"
```
@@ -1051,7 +1048,7 @@ persistent://test-tenant/ns1/tp1 \
```java
String topic = "persistent://my-tenant/my-namespace/my-topic";
-admin.lookup().lookupDestination(topic);
+admin.lookups().lookupDestination(topic);
```
</TabItem>
@@ -1070,30 +1067,37 @@ You can locate the owner broker of the given
partitioned topic in the following
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics partitioned-lookup \
-persistent://test-tenant/ns1/my-topic \
+pulsar-admin topics partitioned-lookup persistent://test-tenant/ns1/my-topic
+```
+
+Example output:
+```
"persistent://test-tenant/ns1/my-topic-partition-0 pulsar://localhost:6650"
"persistent://test-tenant/ns1/my-topic-partition-1 pulsar://localhost:6650"
"persistent://test-tenant/ns1/my-topic-partition-2 pulsar://localhost:6650"
"persistent://test-tenant/ns1/my-topic-partition-3 pulsar://localhost:6650"
```
-</TabItem>
-<TabItem value="Java">
-
-```java
-String topic = "persistent://my-tenant/my-namespace/my-topic";
-admin.lookup().lookupPartitionedTopic(topic);
-```
-
Lookup the partitioned topics sorted by broker URL
```shell
pulsar-admin topics partitioned-lookup \
-persistent://test-tenant/ns1/my-topic --sort-by-broker \
+ persistent://test-tenant/ns1/my-topic --sort-by-broker
+```
+
+Example output:
-"pulsar://localhost:6650 [persistent://test-tenant/ns1/my-topic-partition-0,
persistent://test-tenant/ns1/my-topic-partition-1,
persistent://test-tenant/ns1/my-topic-partition-2,
persistent://test-tenant/ns1/my-topic-partition-3]"
+```
+pulsar://localhost:6650 [persistent://test-tenant/ns1/my-topic-partition-0,
persistent://test-tenant/ns1/my-topic-partition-1,
persistent://test-tenant/ns1/my-topic-partition-2,
persistent://test-tenant/ns1/my-topic-partition-3]
+```
+
+</TabItem>
+<TabItem value="Java">
+
+```java
+String topic = "persistent://my-tenant/my-namespace/my-topic";
+admin.lookups().lookupPartitionedTopic(topic);
```
</TabItem>
@@ -1112,9 +1116,12 @@ You can get the range of the bundle that the given topic
belongs to in the follo
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics bundle-range \
-persistent://test-tenant/ns1/tp1 \
+pulsar-admin topics bundle-range persistent://test-tenant/ns1/tp1
+```
+Example output:
+
+```
"0x00000000_0xffffffff"
```
@@ -1128,7 +1135,7 @@ persistent://test-tenant/ns1/tp1 \
```java
String topic = "persistent://my-tenant/my-namespace/my-topic";
-admin.lookup().getBundleRange(topic);
+admin.lookups().getBundleRange(topic);
```
</TabItem>
@@ -1147,9 +1154,12 @@ You can check all subscription names for a given topic
in the following ways.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics subscriptions \
-persistent://test-tenant/ns1/tp1 \
+pulsar-admin topics subscriptions persistent://test-tenant/ns1/tp1
+```
+Example output:
+
+```
my-subscription
```
@@ -1185,6 +1195,16 @@ You can get the last committed message ID for a
persistent topic. It is availabl
pulsar-admin topics last-message-id topic-name
```
+Example output:
+
+```json
+{
+ "ledgerId" : 97,
+ "entryId" : 9,
+ "partitionIndex" : -1
+}
+```
+
</TabItem>
<TabItem value="REST API">
@@ -1216,7 +1236,7 @@ You can get the backlog size of a single partition topic
or a non-partitioned to
```shell
pulsar-admin topics get-backlog-size \
-m 1:1 \
- persistent://test-tenant/ns1/tp1-partition-0 \
+ persistent://test-tenant/ns1/tp1-partition-0
```
</TabItem>
@@ -1252,7 +1272,7 @@ To get the topic-level deduplication snapshot interval,
use one of the following
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics get-deduplication-snapshot-interval options
+pulsar-admin topics get-deduplication-snapshot-interval my-topic
```
</TabItem>
@@ -1285,7 +1305,7 @@ To set the topic-level deduplication snapshot interval,
use one of the following
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics set-deduplication-snapshot-interval options
+pulsar-admin topics set-deduplication-snapshot-interval my-topic -i 1000
```
</TabItem>
@@ -1322,7 +1342,7 @@ To remove the topic-level deduplication snapshot
interval, use one of the follow
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics remove-deduplication-snapshot-interval options
+pulsar-admin topics remove-deduplication-snapshot-interval my-topic
```
</TabItem>
@@ -1356,7 +1376,7 @@ To get the topic-level inactive topic policies, use one
of the following methods
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics get-inactive-topic-policies options
+pulsar-admin topics get-inactive-topic-policies my-topic
```
</TabItem>
@@ -1387,7 +1407,7 @@ To set the topic-level inactive topic policies, use one
of the following methods
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics set-inactive-topic-policies options
+pulsar-admin topics set-inactive-topic-policies my-topic
```
</TabItem>
@@ -1418,7 +1438,7 @@ To remove the topic-level inactive topic policies, use
one of the following meth
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics remove-inactive-topic-policies options
+pulsar-admin topics remove-inactive-topic-policies my-topic
```
</TabItem>
@@ -1452,7 +1472,7 @@ To get the topic-level offload policies, use one of the
following methods.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics get-offload-policies options
+pulsar-admin topics get-offload-policies my-topic
```
</TabItem>
@@ -1483,7 +1503,7 @@ To set the topic-level offload policies, use one of the
following methods.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics set-offload-policies options
+pulsar-admin topics set-offload-policies my-topic
```
</TabItem>
@@ -1514,7 +1534,7 @@ To remove the topic-level offload policies, use one of
the following methods.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics remove-offload-policies options
+pulsar-admin topics remove-offload-policies my-topic
```
</TabItem>
@@ -1556,8 +1576,8 @@ You can create non-partitioned topics in the following
ways.
When you create non-partitioned topics with the
[`create`](/tools/pulsar-admin/) command, you need to specify the topic name as
an argument.
```shell
-bin/pulsar-admin topics create \
-persistent://my-tenant/my-namespace/my-topic
+pulsar-admin topics create \
+ persistent://my-tenant/my-namespace/my-topic
```
:::note
@@ -1595,8 +1615,8 @@ You can delete non-partitioned topics in the following
ways.
<TabItem value="pulsar-admin">
```shell
-bin/pulsar-admin topics delete \
-persistent://my-tenant/my-namespace/my-topic
+pulsar-admin topics delete \
+ persistent://my-tenant/my-namespace/my-topic
```
</TabItem>
@@ -1628,6 +1648,11 @@ You can get the list of topics under a given namespace
in the following ways.
```shell
pulsar-admin topics list tenant/namespace
+```
+
+Example output:
+
+```
persistent://tenant/namespace/topic1
persistent://tenant/namespace/topic2
```
@@ -1651,7 +1676,39 @@ admin.topics().getList(namespace);
### Stats
-You can check the current statistics of a given topic. The following is an
example. For the description of each stats, refer to [get stats](#get-stats).
+
+You can check the current statistics of a given topic and its connected
producers and consumers in the following ways.
+
+````mdx-code-block
+<Tabs groupId="api-choice"
+ defaultValue="pulsar-admin"
+ values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST
API","value":"REST API"},{"label":"Java","value":"Java"}]}>
+<TabItem value="pulsar-admin">
+
+```shell
+pulsar-admin topics stats \
+ persistent://test-tenant/namespace/topic \
+ --get-precise-backlog
+```
+
+</TabItem>
+<TabItem value="REST API">
+
+{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/stats|operation/getStats?version=@pulsar:version_number@}
+
+</TabItem>
+<TabItem value="Java">
+
+```java
+admin.topics().getStats(topic, false /* is precise backlog */);
+```
+
+</TabItem>
+
+</Tabs>
+````
+
+The following is an example. For the description of each stats, refer to [get
stats](#get-stats).
```json
{
@@ -1686,45 +1743,18 @@ You can check the current statistics of a given topic.
The following is an examp
}
```
-You can check the current statistics of a given topic and its connected
producers and consumers in the following ways.
-
-````mdx-code-block
-<Tabs groupId="api-choice"
- defaultValue="pulsar-admin"
- values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST
API","value":"REST API"},{"label":"Java","value":"Java"}]}>
-<TabItem value="pulsar-admin">
-
-```shell
-pulsar-admin topics stats \
-persistent://test-tenant/namespace/topic \
---get-precise-backlog
-```
-
-</TabItem>
-<TabItem value="REST API">
-
-{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/stats|operation/getStats?version=@pulsar:version_number@}
-
-</TabItem>
-<TabItem value="Java">
-
-```java
-admin.topics().getStats(topic, false /* is precise backlog */);
-```
-
-</TabItem>
-
-</Tabs>
-````
-
## Manage partitioned topics
You can use Pulsar [admin API](admin-api-overview.md) to create, update,
delete and check the status of partitioned topics.
### Create
-Partitioned topics must be explicitly created. When creating a new partitioned
topic, you need to provide a name and the number of partitions for the topic.
+When creating a new partitioned topic, you need to provide a name and the
number of partitions for the topic.
-By default, 60 seconds after creation, topics are considered inactive and
deleted automatically to avoid generating trash data. To disable this feature,
set `brokerDeleteInactiveTopicsEnabled` to `false`. To change the frequency of
checking inactive topics, set `brokerDeleteInactiveTopicsFrequencySeconds` to a
specific value.
+:::note
+
+By default, if there are no messages 60 seconds after creation, topics are
considered inactive and deleted automatically to avoid generating trash data.
To disable this feature, set `brokerDeleteInactiveTopicsEnabled` to `false`. To
change the frequency of checking inactive topics, set
`brokerDeleteInactiveTopicsFrequencySeconds` to a specific value.
+
+:::
For more information about the two parameters, see
[here](reference-configuration.md#broker).
@@ -1740,9 +1770,9 @@ When you create partitioned topics with the
[`create-partitioned-topic`](/tools/
command, you need to specify the topic name as an argument and the number of
partitions using the `-p` or `--partitions` flag.
```shell
-bin/pulsar-admin topics create-partitioned-topic \
-persistent://my-tenant/my-namespace/my-topic \
---partitions 4
+pulsar-admin topics create-partitioned-topic \
+ persistent://my-tenant/my-namespace/my-topic \
+ --partitions 4
```
:::note
@@ -1783,8 +1813,8 @@ When topic auto-creation is disabled, and you have a
partitioned topic without a
You can create missed partitions with the
[`create-missed-partitions`](/tools/pulsar-admin/) command and specify the
topic name as an argument.
```shell
-bin/pulsar-admin topics create-missed-partitions \
-persistent://my-tenant/my-namespace/my-topic \
+pulsar-admin topics create-missed-partitions \
+ persistent://my-tenant/my-namespace/my-topic
```
</TabItem>
@@ -1823,9 +1853,15 @@ You can check the number of partitions in a partitioned
topic with the [`get-par
```shell
pulsar-admin topics get-partitioned-topic-metadata \
-persistent://my-tenant/my-namespace/my-topic
+ persistent://my-tenant/my-namespace/my-topic
+```
+
+Example output:
+
+```json
{
- "partitions": 4
+ "partitions" : 4,
+ "deleted" : false
}
```
@@ -1863,8 +1899,8 @@ You can update partitioned topics with the
[`update-partitioned-topic`](/tools/p
```shell
pulsar-admin topics update-partitioned-topic \
-persistent://my-tenant/my-namespace/my-topic \
---partitions 8
+ persistent://my-tenant/my-namespace/my-topic \
+ --partitions 8
```
</TabItem>
@@ -1894,8 +1930,8 @@ You can delete partitioned topics with the
[`delete-partitioned-topic`](/tools/p
<TabItem value="pulsar-admin">
```shell
-bin/pulsar-admin topics delete-partitioned-topic \
-persistent://my-tenant/my-namespace/my-topic
+pulsar-admin topics delete-partitioned-topic \
+ persistent://my-tenant/my-namespace/my-topic
```
</TabItem>
@@ -1927,6 +1963,11 @@ You can get the list of partitioned topics under a given
namespace in the follow
```shell
pulsar-admin topics list-partitioned-topics tenant/namespace
+```
+
+Example output:
+
+```
persistent://tenant/namespace/topic1
persistent://tenant/namespace/topic2
```
@@ -1950,7 +1991,39 @@ admin.topics().getPartitionedTopicList(namespace);
### Stats
-You can check the current statistics of a given partitioned topic. The
following is an example. For the description of each stats, refer to [get
stats](#get-stats).
+
+You can check the current statistics of a given partitioned topic and its
connected producers and consumers in the following ways.
+
+````mdx-code-block
+<Tabs groupId="api-choice"
+ defaultValue="pulsar-admin"
+ values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST
API","value":"REST API"},{"label":"Java","value":"Java"}]}>
+<TabItem value="pulsar-admin">
+
+```shell
+pulsar-admin topics partitioned-stats \
+ persistent://test-tenant/namespace/topic \
+ --per-partition
+```
+
+</TabItem>
+<TabItem value="REST API">
+
+{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/partitioned-stats|operation/getPartitionedStats?version=@pulsar:version_number@}
+
+</TabItem>
+<TabItem value="Java">
+
+```java
+admin.topics().getPartitionedStats(topic, true /* per partition */, false /*
is precise backlog */);
+```
+
+</TabItem>
+
+</Tabs>
+````
+
+The following is an example. For the description of each stats, refer to [get
stats](#get-stats).
Note that in the subscription JSON object, `chuckedMessageRate` is deprecated.
Please use `chunkedMessageRate`. Both will be sent in the JSON for now.
@@ -2007,37 +2080,6 @@ Note that in the subscription JSON object,
`chuckedMessageRate` is deprecated. P
}
```
-You can check the current statistics of a given partitioned topic and its
connected producers and consumers in the following ways.
-
-````mdx-code-block
-<Tabs groupId="api-choice"
- defaultValue="pulsar-admin"
- values={[{"label":"pulsar-admin","value":"pulsar-admin"},{"label":"REST
API","value":"REST API"},{"label":"Java","value":"Java"}]}>
-<TabItem value="pulsar-admin">
-
-```shell
-pulsar-admin topics partitioned-stats \
-persistent://test-tenant/namespace/topic \
---per-partition
-```
-
-</TabItem>
-<TabItem value="REST API">
-
-{@inject:
endpoint|GET|/admin/v2/:schema/:tenant/:namespace/:topic/partitioned-stats|operation/getPartitionedStats?version=@pulsar:version_number@}
-
-</TabItem>
-<TabItem value="Java">
-
-```java
-admin.topics().getPartitionedStats(topic, true /* per partition */, false /*
is precise backlog */);
-```
-
-</TabItem>
-
-</Tabs>
-````
-
### Internal stats
You can check the detailed statistics of a topic. The following is an example.
For the description of each stats, refer to [get internal
stats](#get-internal-stats).
@@ -2127,8 +2169,8 @@ You can create a subscription for a topic using one of
the following methods.
```shell
pulsar-admin topics create-subscription \
---subscription my-subscription \
-persistent://test-tenant/ns1/tp1
+ --subscription my-subscription \
+ persistent://test-tenant/ns1/tp1
```
</TabItem>
@@ -2162,8 +2204,12 @@ You can check all subscription names for a given topic
using one of the followin
<TabItem value="pulsar-admin">
```shell
-pulsar-admin topics subscriptions \
-persistent://test-tenant/ns1/tp1 \
+pulsar-admin topics subscriptions persistent://test-tenant/ns1/tp1
+```
+
+Example output:
+
+```
my-subscription
```
@@ -2198,8 +2244,8 @@ When a subscription does not process messages anymore,
you can unsubscribe it us
```shell
pulsar-admin topics unsubscribe \
---subscription my-subscription \
-persistent://test-tenant/ns1/tp1
+ --subscription my-subscription \
+ persistent://test-tenant/ns1/tp1
```
</TabItem>
diff --git a/site2/website-next/docs/admin-api-transactions.md
b/site2/website-next/docs/admin-api-transactions.md
index 0b04527afa2..818409454e3 100644
--- a/site2/website-next/docs/admin-api-transactions.md
+++ b/site2/website-next/docs/admin-api-transactions.md
@@ -35,8 +35,7 @@ In the production environment, there may be some long-lasting
transactions that
<TabItem value="pulsar-admin">
```shell
-pulsar-admin transactions slow-transactions \
--c 1 -t 1s
+pulsar-admin transactions slow-transactions -c 1 -t 1s
```
</TabItem>
@@ -48,9 +47,9 @@ pulsar-admin transactions slow-transactions \
<TabItem value="Java">
```java
-admin.transaction().getSlowTransactionsByCoordinatorId(coordinatorId, timeout,
timeUnit)
+admin.transactions().getSlowTransactionsByCoordinatorId(coordinatorId,
timeout, timeUnit)
//Or get slow transactions from all coordinators
-admin.transaction().getSlowTransactions(timeout, timeUnit)
+admin.transactions().getSlowTransactions(timeout, timeUnit)
```
</TabItem>
@@ -60,7 +59,7 @@ admin.transaction().getSlowTransactions(timeout, timeUnit)
The following is an example of the returned values.
-```shell
+```json
{
"(0,3)": {
"txnId": "(0,3)",
@@ -156,8 +155,7 @@ When the performance of transactions reaches a bottleneck
due to the insufficien
<TabItem value="pulsar-admin">
```shell
-pulsar-admin transactions scale-transactionCoordinators \
--r 17
+pulsar-admin transactions scale-transactionCoordinators -r 17
```
</TabItem>
@@ -169,7 +167,7 @@ pulsar-admin transactions scale-transactionCoordinators \
<TabItem value="Java">
```java
-admin.transaction().scaleTransactionCoordinators(replicas);
+admin.transactions().scaleTransactionCoordinators(replicas);
```
</TabItem>
@@ -198,8 +196,7 @@ Use one of the following ways to get your transaction
metadata.
<TabItem value="pulsar-admin">
```shell
-pulsar-admin transactions transaction-metadata\
--m 1 -l 1
+pulsar-admin transactions transaction-metadata -m 1 -l 1
```
</TabItem>
@@ -221,7 +218,7 @@ admin.transactions().getTransactionMetadata(txnID);
The following is an example of the returned values.
-```shell
+```json
{
"txnId" : "(1,18)",
"status" : "ABORTING",
@@ -257,8 +254,7 @@ Use one of the following ways to get transaction stats in
pending ack:
<TabItem value="pulsar-admin">
```shell
-pulsar-admin transactions transaction-in-pending-ack-stats \
--m 1 -l 1 -t my-topic -s mysubname
+pulsar-admin transactions transaction-in-pending-ack-stats -m 1 -l 1 -t
my-topic -s mysubname
```
</TabItem>
@@ -270,7 +266,7 @@ pulsar-admin transactions transaction-in-pending-ack-stats \
<TabItem value="Java">
```java
-admin.transaction().getTransactionInPendingAckStats(txnID, topic, subname);
+admin.transactions().getTransactionInPendingAckStats(txnID, topic, subname);
```
</TabItem>
@@ -280,7 +276,7 @@ admin.transaction().getTransactionInPendingAckStats(txnID,
topic, subname);
The following is an example of the returned value.
-```shell
+```json
{
"cumulativeAckPosition" : "137:49959"
}
@@ -301,8 +297,7 @@ Use one of the following ways to get transaction stats in
transaction buffer:
<TabItem value="pulsar-admin">
```shell
-pulsar-admin transactions transaction-in-buffer-stats \
--m 1 -l 1 -t my-topic
+pulsar-admin transactions transaction-in-buffer-stats -m 1 -l 1 -t my-topic
```
</TabItem>
@@ -314,7 +309,7 @@ pulsar-admin transactions transaction-in-buffer-stats \
<TabItem value="Java">
```java
-admin.transaction().getTransactionInBufferStatsAsync(txnID, topic);
+admin.transactions().getTransactionInBufferStatsAsync(txnID, topic);
```
</TabItem>
@@ -324,7 +319,7 @@ admin.transaction().getTransactionInBufferStatsAsync(txnID,
topic);
The following is an example of the returned values.
-```shell
+```json
{
"startPosition" : "137:49759",
"aborted" : false
@@ -353,8 +348,7 @@ Use one of the following ways to get transaction
coordinator stats:
<TabItem value="pulsar-admin">
```shell
-pulsar-admin transactions coordinator-stats \
--c 1
+pulsar-admin transactions coordinator-stats -c 1
```
</TabItem>
@@ -366,9 +360,9 @@ pulsar-admin transactions coordinator-stats \
<TabItem value="Java">
```java
-admin.transaction().getCoordinatorStatsById(coordinatorId);
+admin.transactions().getCoordinatorStatsById(coordinatorId);
//Or get all coordinator stats.
-admin.transaction().getCoordinatorStats();
+admin.transactions().getCoordinatorStats();
```
</TabItem>
@@ -378,7 +372,7 @@ admin.transaction().getCoordinatorStats();
The following is an example of the returned values.
-```shell
+```json
{
"state" : "Ready",
"leastSigBits" : 1,
@@ -404,8 +398,7 @@ Use one of the following ways to get coordinator’s internal
stats:
<TabItem value="pulsar-admin">
```shell
-pulsar-admin transactions coordinator-internal-stats \
--c 1 -m
+pulsar-admin transactions coordinator-internal-stats -c 1 -m
```
</TabItem>
@@ -417,7 +410,7 @@ pulsar-admin transactions coordinator-internal-stats \
<TabItem value="Java">
```java
-admin.transaction().getCoordinatorInternalStats(coordinatorId, metadata);
+admin.transactions().getCoordinatorInternalStats(coordinatorId, metadata);
```
</TabItem>
@@ -427,7 +420,7 @@
admin.transaction().getCoordinatorInternalStats(coordinatorId, metadata);
The following is an example of the returned values.
-```shell
+```json
{
"transactionLogStats" : {
"managedLedgerName" : "pulsar/system/persistent/__transaction_log_1",
@@ -496,8 +489,7 @@ Use one of the following ways to get transaction pending
ack stats:
<TabItem value="pulsar-admin">
```shell
-pulsar-admin transactions pending-ack-stats \
--t my-topic -s mysubName -l
+pulsar-admin.transactions()s pending-ack-stats -t my-topic -s mysubName -l
```
</TabItem>
@@ -509,7 +501,7 @@ pulsar-admin transactions pending-ack-stats \
<TabItem value="Java">
```java
-admin.transaction().getPendingAckStats(topic, subName, lowWaterMarks)
+admin.transactions().getPendingAckStats(topic, subName, lowWaterMarks)
```
</TabItem>
@@ -519,7 +511,7 @@ admin.transaction().getPendingAckStats(topic, subName,
lowWaterMarks)
The following is an example of the returned values.
-```shell
+```json
{
"state" : "Ready",
"lowWaterMarks" : {
@@ -547,8 +539,7 @@ Use one of the following ways to get transaction pending
ack internal stats:
<TabItem value="pulsar-admin">
```shell
-pulsar-admin transactions pending-ack-internal-stats \
--t my-topic -s mysubName -m
+pulsar-admin transactions pending-ack-internal-stats -t my-topic -s mysubName
-m
```
</TabItem>
@@ -560,7 +551,7 @@ pulsar-admin transactions pending-ack-internal-stats \
<TabItem value="Java">
```java
-admin.transaction().getPendingAckInternalStats(topic, subName, boolean
metadata);
+admin.transactions().getPendingAckInternalStats(topic, subName, boolean
metadata);
```
</TabItem>
@@ -570,7 +561,7 @@ admin.transaction().getPendingAckInternalStats(topic,
subName, boolean metadata)
The following is an example of the returned values.
-```shell
+```json
{
"pendingAckLogStats" : {
"managedLedgerName" :
"public/default/persistent/my-topic-mysubName__transaction_pending_ack",
@@ -642,8 +633,7 @@ If you want to know whether the position has been
acknowledged, you can use one
<TabItem value="pulsar-admin">
```shell
-pulsar-admin transactions position-stats-in-pending-ack \
--t my-topic -s mysubName -l 15 -e 6
+pulsar-admin transactions position-stats-in-pending-ack -t my-topic -s
mysubName -l 15 -e 6
```
</TabItem>
@@ -656,7 +646,7 @@ pulsar-admin transactions position-stats-in-pending-ack \
<TabItem value="Java">
```java
-admin.transaction().getPositionStatsInPendingAckAsync(topic, subName,
ledgerId, entryId, lowWaterMarks);
+admin.transactions().getPositionStatsInPendingAckAsync(topic, subName,
ledgerId, entryId, lowWaterMarks);
```
</TabItem>
@@ -666,9 +656,9 @@
admin.transaction().getPositionStatsInPendingAckAsync(topic, subName, ledgerId,
The following is an example of the returned values.
-```shell
+```json
{
-"State" : "MarkDelete"
+ "State" : "MarkDelete"
}
```
@@ -697,8 +687,7 @@ Use one of the following ways to get transaction buffer
stats:
<TabItem value="pulsar-admin">
```shell
-pulsar-admin transactions transaction-buffer-stats \
--t my-topic -l
+pulsar-admin transactions transaction-buffer-stats -t my-topic -l
```
</TabItem>
@@ -710,7 +699,7 @@ pulsar-admin transactions transaction-buffer-stats \
<TabItem value="Java">
```java
-admin.transaction().getTransactionBufferStats(topic, lowWaterMarks);
+admin.transactions().getTransactionBufferStats(topic, lowWaterMarks);
```
</TabItem>
@@ -720,7 +709,7 @@ admin.transaction().getTransactionBufferStats(topic,
lowWaterMarks);
The following is an example of the returned values.
-```shell
+```json
{
"state" : "Ready",
"maxReadPosition" : "38:101",
diff --git a/site2/website-next/docs/getting-started-standalone.md
b/site2/website-next/docs/getting-started-standalone.md
index 3f2dc2b4ea9..857a6b752fb 100644
--- a/site2/website-next/docs/getting-started-standalone.md
+++ b/site2/website-next/docs/getting-started-standalone.md
@@ -120,7 +120,7 @@ Leave the consume command from the previous step running.
If you've already clos
Now open a new terminal window and produce more messages. The default message
separator is `,`:
```bash
-bin/pulsar-client produce my-topic --messages "$(seq -s, -f 'Message NO.%g' -t
'\n' 1 10)"
+bin/pulsar-client produce my-topic --messages "$(seq -s, -f 'Message NO.%g' 1
10)"
```
Note how they are displayed almost instantaneously in the consumer terminal.
