Managing Namespaces

Important

This page only shows some frequently used operations.

  • For the latest and complete information about Pulsar admin, including commands, flags, descriptions, and more information, see Pulsar admin doc.

  • For the latest and complete information about REST API, including parameters, responses, samples, and more, see REST API doc.

  • For the latest and complete information about Java admin API, including classes, methods, descriptions, and more, see Java admin API doc.

Pulsar namespaces are logical groupings of topics.

Namespaces can be managed via:

  • The namespaces command of the pulsar-admin tool
  • The /admin/v2/namespaces endpoint of the admin REST API
  • The namespaces method of the PulsarAdmin object in the Java API

Namespaces resources

Create namespaces

You can create new namespaces under a given tenant.

  • pulsar-admin
  • REST API
  • Java

Use the create subcommand and specify the namespace by name:

  2. $ pulsar-admin namespaces create test-tenant/test-namespace
  2. {@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace|operation/createNamespace?version=2.10.0}
  2. admin.namespaces().createNamespace(namespace);

Get policies

You can fetch the current policies associated with a namespace at any time.

  • pulsar-admin
  • REST API
  • Java

Use the policies subcommand and specify the namespace:

  2. $ pulsar-admin namespaces policies test-tenant/test-namespace
  3. {
  4.   "auth_policies": {
  5.     "namespace_auth": {},
  6.     "destination_auth": {}
  7.   },
  8.   "replication_clusters": [],
  9.   "bundles_activated": true,
  10.   "bundles": {
  11.     "boundaries": [
  12.       "0x00000000",
  13.       "0xffffffff"
  14.     ],
  15.     "numBundles": 1
  16.   },
  17.   "backlog_quota_map": {},
  18.   "persistence": null,
  19.   "latency_stats_sample_rate": {},
  20.   "message_ttl_in_seconds": 0,
  21.   "retention_policies": null,
  22.   "deleted": false
  23. }
  2. {@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace|operation/getPolicies?version=2.10.0}
  2. admin.namespaces().getPolicies(namespace);

List namespaces

You can list all namespaces within a given Pulsar tenant.

  • pulsar-admin
  • REST API
  • Java

Use the list subcommand and specify the tenant:

  2. $ pulsar-admin namespaces list test-tenant
  3. test-tenant/ns1
  4. test-tenant/ns2
  2. {@inject: endpoint|GET|/admin/v2/namespaces/:tenant|operation/getTenantNamespaces?version=2.10.0}
  2. admin.namespaces().getNamespaces(tenant);

Delete namespaces

You can delete existing namespaces from a tenant.

  • pulsar-admin
  • REST API
  • Java

Use the delete subcommand and specify the namespace:

  2. $ pulsar-admin namespaces delete test-tenant/ns1
  2. {@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace|operation/deleteNamespace?version=2.10.0}
  2. admin.namespaces().deleteNamespace(namespace);

Configure replication clusters

Set replication cluster

You can set replication clusters for a namespace to enable Pulsar to internally replicate the published messages from one colocation facility to another.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces set-clusters test-tenant/ns1 \
  3.   --clusters cl1
  2. {@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/replication|operation/setNamespaceReplicationClusters?version=2.10.0}
  2. admin.namespaces().setNamespaceReplicationClusters(namespace, clusters);

Get replication cluster

You can get the list of replication clusters for a given namespace.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces get-clusters test-tenant/cl1/ns1
  2. cl2
  2. {@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/replication|operation/getNamespaceReplicationClusters?version=2.10.0}
  2. admin.namespaces().getNamespaceReplicationClusters(namespace)

Configure backlog quota policies

Set backlog quota policies

Backlog quota helps the broker to restrict bandwidth/storage of a namespace once it reaches a certain threshold limit. Admin can set the limit and take corresponding action after the limit is reached.

  1. producer_request_hold: broker holds but not persists produce request payload

  2. producer_exception: broker disconnects with the client by giving an exception

  3. consumer_backlog_eviction: broker starts discarding backlog messages

Backlog quota restriction can be taken care by defining restriction of backlog-quota-type: destination_storage.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces set-backlog-quota --limit 10G --limitTime 36000 --policy producer_request_hold test-tenant/ns1
  2. {@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/backlogQuota|operation/setBacklogQuota?version=2.10.0}
  2. admin.namespaces().setBacklogQuota(namespace, new BacklogQuota(limit, limitTime, policy))

Get backlog quota policies

You can get a configured backlog quota for a given namespace.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces get-backlog-quotas test-tenant/ns1
  2. {
  3.   "destination_storage": {
  4.     "limit": 10,
  5.     "policy": "producer_request_hold"
  6.   }
  7. }
  2. {@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/backlogQuotaMap|operation/getBacklogQuotaMap?version=2.10.0}
  2. admin.namespaces().getBacklogQuotaMap(namespace);

Remove backlog quota policies

You can remove backlog quota policies for a given namespace.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces remove-backlog-quota test-tenant/ns1
  2. {@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/backlogQuota|operation/removeBacklogQuota?version=2.10.0}
  2. admin.namespaces().removeBacklogQuota(namespace, backlogQuotaType)

Configure persistence policies

Set persistence policies

Persistence policies allow users to configure persistency-level for all topic messages under a given namespace.

  • Bookkeeper-ack-quorum: Number of acks (guaranteed copies) to wait for each entry, default: 0

  • Bookkeeper-ensemble: Number of bookies to use for a topic, default: 0

  • Bookkeeper-write-quorum: How many writes to make of each entry, default: 0

  • Ml-mark-delete-max-rate: Throttling rate of mark-delete operation (0 means no throttle), default: 0.0

  • pulsar-admin

  • REST API
  • Java
  2. $ 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
  2. {@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/persistence|operation/setPersistence?version=2.10.0}
  2. admin.namespaces().setPersistence(namespace,new PersistencePolicies(bookkeeperEnsemble, bookkeeperWriteQuorum,bookkeeperAckQuorum,managedLedgerMaxMarkDeleteRate))

Get persistence policies

You can get the configured persistence policies of a given namespace.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces get-persistence test-tenant/ns1
  2. {
  3.   "bookkeeperEnsemble": 3,
  4.   "bookkeeperWriteQuorum": 2,
  5.   "bookkeeperAckQuorum": 2,
  6.   "managedLedgerMaxMarkDeleteRate": 0
  7. }
  2. {@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/persistence|operation/getPersistence?version=2.10.0}
  2. admin.namespaces().getPersistence(namespace)

Configure namespace bundles

Unload namespace bundles

The namespace bundle is a virtual group of topics which belong to the same namespace. If the broker gets overloaded with the number of bundles, this command can help unload a bundle from that broker, so it can be served by some other less-loaded brokers. The namespace bundle ID ranges from 0x00000000 to 0xffffffff.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces unload --bundle 0x00000000_0xffffffff test-tenant/ns1
  2. {@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/{bundle}/unload|operation/unloadNamespaceBundle?version=2.10.0}
  2. admin.namespaces().unloadNamespaceBundle(namespace, bundle)

Split namespace bundles

One namespace bundle can contain multiple topics but can be served by only one broker. If a single bundle is creating an excessive load on a broker, an admin can split the bundle using the command below, permitting one or more of the new bundles to be unloaded, thus balancing the load across the brokers.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces split-bundle --bundle 0x00000000_0xffffffff test-tenant/ns1
  2. {@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/{bundle}/split|operation/splitNamespaceBundle?version=2.10.0}
  2. admin.namespaces().splitNamespaceBundle(namespace, bundle)

Configure message TTL

Set message-ttl

You can configure the time to live (in seconds) duration for messages. In the example below, the message-ttl is set as 100s.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces set-message-ttl --messageTTL 100 test-tenant/ns1
  2. {@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/messageTTL|operation/setNamespaceMessageTTL?version=2.10.0}
  2. admin.namespaces().setNamespaceMessageTTL(namespace, messageTTL)

Get message-ttl

When the message-ttl for a namespace is set, you can use the command below to get the configured value. This example comtinues the example of the command set message-ttl, so the returned value is 100(s).

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces get-message-ttl test-tenant/ns1
  2. 100
  2. {@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/messageTTL|operation/getNamespaceMessageTTL?version=2.10.0}
  2. 100
  2. admin.namespaces().getNamespaceMessageTTL(namespace)
  2. 100

Remove message-ttl

Remove a message TTL of the configured namespace.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces remove-message-ttl test-tenant/ns1
  2. {@inject: endpoint|DELETE|/admin/v2/namespaces/:tenant/:namespace/messageTTL|operation/removeNamespaceMessageTTL?version=2.10.0}
  2. admin.namespaces().removeNamespaceMessageTTL(namespace)

Clear backlog

Clear namespace backlog

It clears all message backlog for all the topics that belong to a specific namespace. You can also clear backlog for a specific subscription as well.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces clear-backlog --sub my-subscription test-tenant/ns1
  2. {@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/clearBacklog|operation/clearNamespaceBacklogForSubscription?version=2.10.0}
  2. admin.namespaces().clearNamespaceBacklogForSubscription(namespace, subscription)

Clear bundle backlog

It clears all message backlog for all the topics that belong to a specific NamespaceBundle. You can also clear backlog for a specific subscription as well.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces clear-backlog  --bundle 0x00000000_0xffffffff  --sub my-subscription test-tenant/ns1
  2. {@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/{bundle}/clearBacklog|operation?version=2.10.0/clearNamespaceBundleBacklogForSubscription}
  2. admin.namespaces().clearNamespaceBundleBacklogForSubscription(namespace, bundle, subscription)

Configure retention

Set retention

Each namespace contains multiple topics and the retention size (storage size) of each topic should not exceed a specific threshold or it should be stored for a certain period. This command helps configure the retention size and time of topics in a given namespace.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces set-retention --size 100 --time 10 test-tenant/ns1
  2. {@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/retention|operation/setRetention?version=2.10.0}
  2. admin.namespaces().setRetention(namespace, new RetentionPolicies(retentionTimeInMin, retentionSizeInMB))

Get retention

It shows retention information of a given namespace.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces get-retention test-tenant/ns1
  2. {
  3.   "retentionTimeInMinutes": 10,
  4.   "retentionSizeInMB": 100
  5. }
  2. {@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/retention|operation/getRetention?version=2.10.0}
  2. admin.namespaces().getRetention(namespace)

Configure dispatch throttling for topics

Set dispatch throttling for topics

It sets message dispatch rate for all the topics under a given namespace. The dispatch rate can be restricted by the number of messages per X seconds (msg-dispatch-rate) or by the number of message-bytes per X second (byte-dispatch-rate). dispatch rate is in second and it can be configured with dispatch-rate-period. Default value of msg-dispatch-rate and byte-dispatch-rate is -1 which disables the throttling.

note
  • If neither clusterDispatchRate nor topicDispatchRate is configured, dispatch throttling is disabled.
  • If topicDispatchRate is not configured, clusterDispatchRate takes effect.

  • If topicDispatchRate is configured, topicDispatchRate takes effect.

  • pulsar-admin

  • REST API
  • Java
  2. $ pulsar-admin namespaces set-dispatch-rate test-tenant/ns1 \
  3.   --msg-dispatch-rate 1000 \
  4.   --byte-dispatch-rate 1048576 \
  5.   --dispatch-rate-period 1
  2. {@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/dispatchRate|operation/setDispatchRate?version=2.10.0}
  2. admin.namespaces().setDispatchRate(namespace, new DispatchRate(1000, 1048576, 1))

Get configured message-rate for topics

It shows configured message-rate for the namespace (topics under this namespace can dispatch this many messages per second)

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces get-dispatch-rate test-tenant/ns1
  2. {
  3.   "dispatchThrottlingRatePerTopicInMsg" : 1000,
  4.   "dispatchThrottlingRatePerTopicInByte" : 1048576,
  5.   "ratePeriodInSecond" : 1
  6. }
  2. {@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/dispatchRate|operation/getDispatchRate?version=2.10.0}
  2. admin.namespaces().getDispatchRate(namespace)

Configure dispatch throttling for subscription

Set dispatch throttling for subscription

It sets message dispatch rate for all the subscription of topics under a given namespace. The dispatch rate can be restricted by the number of messages per X seconds (msg-dispatch-rate) or by the number of message-bytes per X second (byte-dispatch-rate). dispatch rate is in second and it can be configured with dispatch-rate-period. Default value of msg-dispatch-rate and byte-dispatch-rate is -1 which disables the throttling.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces set-subscription-dispatch-rate test-tenant/ns1 \
  3.   --msg-dispatch-rate 1000 \
  4.   --byte-dispatch-rate 1048576 \
  5.   --dispatch-rate-period 1
  2. {@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/subscriptionDispatchRate|operation/setDispatchRate?version=2.10.0}
  2. admin.namespaces().setSubscriptionDispatchRate(namespace, new DispatchRate(1000, 1048576, 1))

Get configured message-rate for subscription

It shows configured message-rate for the namespace (topics under this namespace can dispatch this many messages per second)

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces get-subscription-dispatch-rate test-tenant/ns1
  2. {
  3.   "dispatchThrottlingRatePerTopicInMsg" : 1000,
  4.   "dispatchThrottlingRatePerTopicInByte" : 1048576,
  5.   "ratePeriodInSecond" : 1
  6. }
  2. {@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/subscriptionDispatchRate|operation/getDispatchRate?version=2.10.0}
  2. admin.namespaces().getSubscriptionDispatchRate(namespace)

Configure dispatch throttling for replicator

Set dispatch throttling for replicator

It sets message dispatch rate for all the replicator between replication clusters under a given namespace. The dispatch rate can be restricted by the number of messages per X seconds (msg-dispatch-rate) or by the number of message-bytes per X second (byte-dispatch-rate). dispatch rate is in second and it can be configured with dispatch-rate-period. Default value of msg-dispatch-rate and byte-dispatch-rate is -1 which disables the throttling.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces set-replicator-dispatch-rate test-tenant/ns1 \
  3.   --msg-dispatch-rate 1000 \
  4.   --byte-dispatch-rate 1048576 \
  5.   --dispatch-rate-period 1
  2. {@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/replicatorDispatchRate|operation/setDispatchRate?version=2.10.0}
  2. admin.namespaces().setReplicatorDispatchRate(namespace, new DispatchRate(1000, 1048576, 1))

Get configured message-rate for replicator

It shows configured message-rate for the namespace (topics under this namespace can dispatch this many messages per second)

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces get-replicator-dispatch-rate test-tenant/ns1
  2. {
  3.   "dispatchThrottlingRatePerTopicInMsg" : 1000,
  4.   "dispatchThrottlingRatePerTopicInByte" : 1048576,
  5.   "ratePeriodInSecond" : 1
  6. }
  2. {@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/replicatorDispatchRate|operation/getDispatchRate?version=2.10.0}
  2. admin.namespaces().getReplicatorDispatchRate(namespace)

Configure deduplication snapshot interval

Get deduplication snapshot interval

It shows configured deduplicationSnapshotInterval for a namespace (Each topic under the namespace will take a deduplication snapshot according to this interval)

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces get-deduplication-snapshot-interval test-tenant/ns1
  2. {@inject: endpoint|GET|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval?version=2.10.0}
  2. admin.namespaces().getDeduplicationSnapshotInterval(namespace)

Set deduplication snapshot interval

Set configured deduplicationSnapshotInterval for a namespace. Each topic under the namespace will take a deduplication snapshot according to this interval. brokerDeduplicationEnabled must be set to true for this property to take effect.

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces set-deduplication-snapshot-interval test-tenant/ns1 --interval 1000
  2. {@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval?version=2.10.0}
  2. {
  3.   "interval": 1000
  4. }
  2. admin.namespaces().setDeduplicationSnapshotInterval(namespace, 1000)

Remove deduplication snapshot interval

Remove configured deduplicationSnapshotInterval of a namespace (Each topic under the namespace will take a deduplication snapshot according to this interval)

  • pulsar-admin
  • REST API
  • Java
  2. $ pulsar-admin namespaces remove-deduplication-snapshot-interval test-tenant/ns1
  2. {@inject: endpoint|POST|/admin/v2/namespaces/:tenant/:namespace/deduplicationSnapshotInterval?version=2.10.0}
  2. admin.namespaces().removeDeduplicationSnapshotInterval(namespace)

Namespace isolation

You can use the Pulsar isolation policy to allocate resources (broker and bookie) for a namespace.

Unload namespaces from a broker

You can unload a namespace, or a namespace bundle, from the Pulsar broker that is currently responsible for it.

pulsar-admin

Use the unload subcommand of the namespaces command.

  • pulsar-admin
  • REST
  • Java
  2. $ pulsar-admin namespaces unload my-tenant/my-ns
  2. {@inject: endpoint|PUT|/admin/v2/namespaces/:tenant/:namespace/unload|operation/unloadNamespace?version=2.10.0}
  2. admin.namespaces().unload(namespace)