diff --git a/site2/docs/admin-api-topics.md b/site2/docs/admin-api-topics.md index 414d46a641e3a..0da38319e4f1f 100644 --- a/site2/docs/admin-api-topics.md +++ b/site2/docs/admin-api-topics.md @@ -943,6 +943,30 @@ admin.topics().getLastMessage(topic); +### Get backlog size + +You can get the backlog size of a single partition topic or a non-partitioned topic with a given message ID (in bytes). + + + +```shell +$ pulsar-admin topics get-backlog-size \ + -m 1:1 \ + persistent://test-tenant/ns1/tp1-partition-0 \ +``` + + +{@inject: endpoint|PUT|/admin/v2/:schema/:tenant/:namespace/:topic/backlogSize|operation/getBacklogSizeByMessageId?version=[[pulsar:version_number]]} + + +```java +String topic = "persistent://my-tenant/my-namespace/my-topic"; +MessageId messageId = MessageId.earliest; +admin.topics().getBacklogSizeByMessageId(topic, messageId); +``` + + + ## Manage non-partitioned topics You can use Pulsar [admin API](admin-api-overview.md) to create, delete and check status of non-partitioned topics. @@ -1210,11 +1234,11 @@ admin.topics().delete(topic); ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. ```shell -$ pulsar-admin topics list tenant/namespace +$ pulsar-admin topics list-partitioned-topics tenant/namespace persistent://tenant/namespace/topic1 persistent://tenant/namespace/topic2 ``` @@ -1224,7 +1248,7 @@ persistent://tenant/namespace/topic2 ```java -admin.topics().getList(namespace); +admin.topics().getPartitionedTopicList(namespace); ``` @@ -1368,29 +1392,6 @@ admin.topics().getInternalStats(topic); -### Get backlog size - -You can get backlog size of a single topic partition or a nonpartitioned topic given a message ID (in bytes). - - - -```shell -$ pulsar-admin topics get-backlog-size \ - -m 1:1 \ - persistent://test-tenant/ns1/tp1-partition-0 \ -``` - - -{@inject: endpoint|PUT|/admin/v2/:schema/:tenant/:namespace/:topic/backlogSize|operation/getBacklogSizeByMessageId?version=[[pulsar:version_number]]} - - -```java -String topic = "persistent://my-tenant/my-namespace/my-topic"; -MessageId messageId = MessageId.earliest; -admin.topics().getBacklogSizeByMessageId(topic, messageId); -``` - - ## Publish to partitioned topics diff --git a/site2/website-next/docs/admin-api-topics.md b/site2/website-next/docs/admin-api-topics.md index 4f5fbb509a1b3..9568e4d575505 100644 --- a/site2/website-next/docs/admin-api-topics.md +++ b/site2/website-next/docs/admin-api-topics.md @@ -1173,6 +1173,43 @@ admin.topics().getLastMessage(topic); +### Get backlog size + +You can get the backlog size of a single partition topic or a non-partitioned topic with a given message ID (in bytes). + + + + +```shell + +$ pulsar-admin topics get-backlog-size \ + -m 1:1 \ + persistent://test-tenant/ns1/tp1-partition-0 \ + +``` + + + + +{@inject: endpoint|PUT|/admin/v2/:schema/:tenant/:namespace/:topic/backlogSize|operation/getBacklogSizeByMessageId?version=@pulsar:version_number@} + + + + +```java + +String topic = "persistent://my-tenant/my-namespace/my-topic"; +MessageId messageId = MessageId.earliest; +admin.topics().getBacklogSizeByMessageId(topic, messageId); + +``` + + + + + ## Manage non-partitioned topics You can use Pulsar [admin API](admin-api-overview) to create, delete and check status of non-partitioned topics. @@ -1568,7 +1605,7 @@ admin.topics().delete(topic); ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. @@ -1576,7 +1613,7 @@ You can get the list of topics under a given namespace in the following ways. ```shell -$ pulsar-admin topics list tenant/namespace +$ pulsar-admin list-partitioned-topics list tenant/namespace persistent://tenant/namespace/topic1 persistent://tenant/namespace/topic2 @@ -1592,7 +1629,7 @@ persistent://tenant/namespace/topic2 ```java -admin.topics().getList(namespace); +admin.topics().getPartitionedTopicList(namespace); ``` @@ -1769,42 +1806,6 @@ admin.topics().getInternalStats(topic); -### Get backlog size - -You can get backlog size of a single topic partition or a nonpartitioned topic given a message ID (in bytes). - - - - -```shell - -$ pulsar-admin topics get-backlog-size \ - -m 1:1 \ - persistent://test-tenant/ns1/tp1-partition-0 \ - -``` - - - - -{@inject: endpoint|PUT|/admin/v2/:schema/:tenant/:namespace/:topic/backlogSize|operation/getBacklogSizeByMessageId?version=@pulsar:version_number@} - - - - -```java - -String topic = "persistent://my-tenant/my-namespace/my-topic"; -MessageId messageId = MessageId.earliest; -admin.topics().getBacklogSizeByMessageId(topic, messageId); - -``` - - - - ## Publish to partitioned topics diff --git a/site2/website-next/versioned_docs/version-2.7.0/admin-api-topics.md b/site2/website-next/versioned_docs/version-2.7.0/admin-api-topics.md index a1202569646db..6eef9fe581ca1 100644 --- a/site2/website-next/versioned_docs/version-2.7.0/admin-api-topics.md +++ b/site2/website-next/versioned_docs/version-2.7.0/admin-api-topics.md @@ -1698,7 +1698,7 @@ admin.topics().delete(topic); ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. @@ -1318,7 +1318,7 @@ You can get the list of topics under a given namespace in the following ways. ```shell -$ pulsar-admin topics list tenant/namespace +$ pulsar-admin topics list-partitioned-topics tenant/namespace persistent://tenant/namespace/topic1 persistent://tenant/namespace/topic2 @@ -1334,7 +1334,7 @@ persistent://tenant/namespace/topic2 ```java -admin.topics().getList(namespace); +admin.topics().getPartitionedTopicList(namespace); ``` diff --git a/site2/website-next/versioned_docs/version-2.7.2/admin-api-topics.md b/site2/website-next/versioned_docs/version-2.7.2/admin-api-topics.md index b65504e640da2..99af109980df4 100644 --- a/site2/website-next/versioned_docs/version-2.7.2/admin-api-topics.md +++ b/site2/website-next/versioned_docs/version-2.7.2/admin-api-topics.md @@ -1310,7 +1310,7 @@ admin.topics().delete(topic); ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. @@ -1318,7 +1318,7 @@ You can get the list of topics under a given namespace in the following ways. ```shell -$ pulsar-admin topics list tenant/namespace +$ pulsar-admin topics list-partitioned-topics tenant/namespace persistent://tenant/namespace/topic1 persistent://tenant/namespace/topic2 @@ -1334,7 +1334,7 @@ persistent://tenant/namespace/topic2 ```java -admin.topics().getList(namespace); +admin.topics().getPartitionedTopicList(namespace); ``` diff --git a/site2/website-next/versioned_docs/version-2.7.3/admin-api-topics.md b/site2/website-next/versioned_docs/version-2.7.3/admin-api-topics.md index b65504e640da2..99af109980df4 100644 --- a/site2/website-next/versioned_docs/version-2.7.3/admin-api-topics.md +++ b/site2/website-next/versioned_docs/version-2.7.3/admin-api-topics.md @@ -1310,7 +1310,7 @@ admin.topics().delete(topic); ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. @@ -1318,7 +1318,7 @@ You can get the list of topics under a given namespace in the following ways. ```shell -$ pulsar-admin topics list tenant/namespace +$ pulsar-admin topics list-partitioned-topics tenant/namespace persistent://tenant/namespace/topic1 persistent://tenant/namespace/topic2 @@ -1334,7 +1334,7 @@ persistent://tenant/namespace/topic2 ```java -admin.topics().getList(namespace); +admin.topics().getPartitionedTopicList(namespace); ``` diff --git a/site2/website-next/versioned_docs/version-2.8.0/admin-api-topics.md b/site2/website-next/versioned_docs/version-2.8.0/admin-api-topics.md index 469e54a1d0616..b945ca036cc08 100644 --- a/site2/website-next/versioned_docs/version-2.8.0/admin-api-topics.md +++ b/site2/website-next/versioned_docs/version-2.8.0/admin-api-topics.md @@ -1340,7 +1340,7 @@ admin.topics().delete(topic); ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. @@ -1348,7 +1348,7 @@ You can get the list of topics under a given namespace in the following ways. ```shell -$ pulsar-admin topics list tenant/namespace +$ pulsar-admin topics list-partitioned-topics tenant/namespace persistent://tenant/namespace/topic1 persistent://tenant/namespace/topic2 @@ -1364,7 +1364,7 @@ persistent://tenant/namespace/topic2 ```java -admin.topics().getList(namespace); +admin.topics().getPartitionedTopicList(namespace); ``` diff --git a/site2/website/versioned_docs/version-2.7.0/admin-api-topics.md b/site2/website/versioned_docs/version-2.7.0/admin-api-topics.md index a9c7b7da07b7e..6d3f719d7c375 100644 --- a/site2/website/versioned_docs/version-2.7.0/admin-api-topics.md +++ b/site2/website/versioned_docs/version-2.7.0/admin-api-topics.md @@ -943,11 +943,11 @@ admin.topics().delete(topic); ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. ```shell -$ pulsar-admin topics list tenant/namespace +$ pulsar-admin topics list-partitioned-topics tenant/namespace persistent://tenant/namespace/topic1 persistent://tenant/namespace/topic2 ``` @@ -957,7 +957,7 @@ persistent://tenant/namespace/topic2 ```java -admin.topics().getList(namespace); +admin.topics().getPartitionedTopicList(namespace); ``` diff --git a/site2/website/versioned_docs/version-2.7.1/admin-api-topics.md b/site2/website/versioned_docs/version-2.7.1/admin-api-topics.md index fcb50229cb200..18ce3f47f8282 100644 --- a/site2/website/versioned_docs/version-2.7.1/admin-api-topics.md +++ b/site2/website/versioned_docs/version-2.7.1/admin-api-topics.md @@ -943,11 +943,11 @@ admin.topics().delete(topic); ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. ```shell -$ pulsar-admin topics list tenant/namespace +$ pulsar-admin topics list-partitioned-topics tenant/namespace persistent://tenant/namespace/topic1 persistent://tenant/namespace/topic2 ``` @@ -957,7 +957,7 @@ persistent://tenant/namespace/topic2 ```java -admin.topics().getList(namespace); +admin.topics().getPartitionedTopicList(namespace); ``` diff --git a/site2/website/versioned_docs/version-2.7.2/admin-api-topics.md b/site2/website/versioned_docs/version-2.7.2/admin-api-topics.md index 1e1429461644c..02a5a3aa9cec7 100644 --- a/site2/website/versioned_docs/version-2.7.2/admin-api-topics.md +++ b/site2/website/versioned_docs/version-2.7.2/admin-api-topics.md @@ -943,11 +943,11 @@ admin.topics().delete(topic); ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. ```shell -$ pulsar-admin topics list tenant/namespace +$ pulsar-admin topics list-partitioned-topics tenant/namespace persistent://tenant/namespace/topic1 persistent://tenant/namespace/topic2 ``` @@ -957,7 +957,7 @@ persistent://tenant/namespace/topic2 ```java -admin.topics().getList(namespace); +admin.topics().getPartitionedTopicList(namespace); ``` diff --git a/site2/website/versioned_docs/version-2.7.3/admin-api-topics.md b/site2/website/versioned_docs/version-2.7.3/admin-api-topics.md index 6270adff41cb8..aca6c6b3e353e 100644 --- a/site2/website/versioned_docs/version-2.7.3/admin-api-topics.md +++ b/site2/website/versioned_docs/version-2.7.3/admin-api-topics.md @@ -943,11 +943,11 @@ admin.topics().delete(topic); ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. ```shell -$ pulsar-admin topics list tenant/namespace +$ pulsar-admin topics list-partitioned-topics tenant/namespace persistent://tenant/namespace/topic1 persistent://tenant/namespace/topic2 ``` @@ -957,7 +957,7 @@ persistent://tenant/namespace/topic2 ```java -admin.topics().getList(namespace); +admin.topics().getPartitionedTopicList(namespace); ``` diff --git a/site2/website/versioned_docs/version-2.8.0/admin-api-topics.md b/site2/website/versioned_docs/version-2.8.0/admin-api-topics.md index 38c32552abbae..2c2ed95d99ec8 100644 --- a/site2/website/versioned_docs/version-2.8.0/admin-api-topics.md +++ b/site2/website/versioned_docs/version-2.8.0/admin-api-topics.md @@ -973,11 +973,11 @@ admin.topics().delete(topic); ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. ```shell -$ pulsar-admin topics list tenant/namespace +$ pulsar-admin topics list-partitioned-topics tenant/namespace persistent://tenant/namespace/topic1 persistent://tenant/namespace/topic2 ``` @@ -987,7 +987,7 @@ persistent://tenant/namespace/topic2 ```java -admin.topics().getList(namespace); +admin.topics().getPartitionedTopicList(namespace); ``` diff --git a/site2/website/versioned_docs/version-2.8.1/admin-api-topics.md b/site2/website/versioned_docs/version-2.8.1/admin-api-topics.md index fccadb1a97e1c..9dfd1d4f207ab 100644 --- a/site2/website/versioned_docs/version-2.8.1/admin-api-topics.md +++ b/site2/website/versioned_docs/version-2.8.1/admin-api-topics.md @@ -973,11 +973,11 @@ admin.topics().delete(topic); ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. ```shell -$ pulsar-admin topics list tenant/namespace +$ pulsar-admin topics list-partitioned-topics tenant/namespace persistent://tenant/namespace/topic1 persistent://tenant/namespace/topic2 ``` @@ -987,7 +987,7 @@ persistent://tenant/namespace/topic2 ```java -admin.topics().getList(namespace); +admin.topics().getPartitionedTopicList(namespace); ``` diff --git a/site2/website/versioned_docs/version-2.8.2/admin-api-topics.md b/site2/website/versioned_docs/version-2.8.2/admin-api-topics.md index c24c35241bec7..b7576c1cf4fb6 100644 --- a/site2/website/versioned_docs/version-2.8.2/admin-api-topics.md +++ b/site2/website/versioned_docs/version-2.8.2/admin-api-topics.md @@ -983,11 +983,11 @@ admin.topics().delete(topic); ### List -You can get the list of topics under a given namespace in the following ways. +You can get the list of partitioned topics under a given namespace in the following ways. ```shell -$ pulsar-admin topics list tenant/namespace +$ pulsar-admin topics list-partitioned-topics tenant/namespace persistent://tenant/namespace/topic1 persistent://tenant/namespace/topic2 ``` @@ -997,7 +997,7 @@ persistent://tenant/namespace/topic2 ```java -admin.topics().getList(namespace); +admin.topics().getPartitionedTopicList(namespace); ```