$broker-stats
Operations to collect broker statistics
$ pulsar-admin broker-stats subcommand
monitoring-metricsmbeanstopicsallocator-statsload-reportdump metrics for Monitoring
Command:
$ pulsar-admin broker-stats monitoring-metrics options
Options:
| Flag | Description | Default |
|---|---|---|
-i, --indent |
Indent JSON output | false |
dump mbean stats
Command:
$ pulsar-admin broker-stats mbeans options
Options:
| Flag | Description | Default |
|---|---|---|
-i, --indent |
Indent JSON output | false |
dump topics stats
Command:
$ pulsar-admin broker-stats topics options
Options:
| Flag | Description | Default |
|---|---|---|
-i, --indent |
Indent JSON output | false |
dump allocator stats
Command:
$ pulsar-admin broker-stats allocator-stats options
dump broker load-report
Command:
$ pulsar-admin broker-stats load-report options
$brokers
Operations about brokers
$ pulsar-admin brokers subcommand
listleader-brokernamespacesupdate-dynamic-configdelete-dynamic-configlist-dynamic-configget-all-dynamic-configget-internal-configget-runtime-confighealthcheckbacklog-quota-checkversionshutdownList active brokers of the cluster
Command:
$ pulsar-admin brokers list options
Get the information of the leader broker
Command:
$ pulsar-admin brokers leader-broker options
List namespaces owned by the broker
Command:
$ pulsar-admin brokers namespaces options
Options:
| Flag | Description | Default |
|---|---|---|
-u, --url |
broker-url | null |
Update dynamic-serviceConfiguration of broker
Command:
$ pulsar-admin brokers update-dynamic-config options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-c, --config |
service-configuration name | null | |
-v, --value |
service-configuration value | null |
Delete dynamic-serviceConfiguration of broker
Command:
$ pulsar-admin brokers delete-dynamic-config options
Options:
| Flag | Description | Default |
|---|---|---|
-c, --config |
service-configuration name | null |
Get list of updatable configuration name
Command:
$ pulsar-admin brokers list-dynamic-config options
Get all overridden dynamic-configuration values
Command:
$ pulsar-admin brokers get-all-dynamic-config options
Get internal configuration information
Command:
$ pulsar-admin brokers get-internal-config options
Get runtime configuration values
Command:
$ pulsar-admin brokers get-runtime-config options
Run a health check against the broker
Command:
$ pulsar-admin brokers healthcheck options
Options:
| Flag | Description | Default |
|---|---|---|
-tv, --topic-version |
topic version V1 is default | null |
Manually trigger backlogQuotaCheck
Command:
$ pulsar-admin brokers backlog-quota-check options
Get the version of the currently connected broker
Command:
$ pulsar-admin brokers version options
Shutdown broker gracefully.
Command:
$ pulsar-admin brokers shutdown options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--max-concurrent-unload-per-sec, -m |
Max concurrent unload per second, if the value absent(value=0) means no concurrent limitation | 0 | |
--forced-terminate-topic, -f |
Force terminate all topics on Broker | false |
$bookies
Operations about bookies rack placement
$ pulsar-admin bookies subcommand
racks-placementlist-bookiesget-bookie-rackdelete-bookie-rackset-bookie-rackGets the rack placement information for all the bookies in the cluster
Command:
$ pulsar-admin bookies racks-placement options
List bookies
Command:
$ pulsar-admin bookies list-bookies options
Gets the rack placement information for a specific bookie in the cluster
Command:
$ pulsar-admin bookies get-bookie-rack options
Options:
| Flag | Description | Default |
|---|---|---|
-b, --bookie |
Bookie address (format: address:port) |
null |
Remove rack placement information for a specific bookie in the cluster
Command:
$ pulsar-admin bookies delete-bookie-rack options
Options:
| Flag | Description | Default |
|---|---|---|
-b, --bookie |
Bookie address (format: address:port) |
null |
Updates the rack placement information for a specific bookie in the cluster (note. bookie address format:address:port)
Command:
$ pulsar-admin bookies set-bookie-rack options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-b, --bookie |
Bookie address (format: address:port) |
null | |
-g, --group |
Bookie group name | default | |
-r, --rack |
Bookie rack name. If you set a bookie rack name to slash (/) or an empty string (""): when using Pulsar earlier than 2.7.5, 2.8.3, and 2.9.2, an exception is thrown; if you use Pulsar 2.7.5, 2.8.3, 2.9.2 or later versions, it falls back to /default-rack or /default-region/default-rack.When RackawareEnsemblePlacementPolicy is enabled, the rack name is not allowed to contain slash (/) except for the beginning and end of the rack name string. For example, rack name like /rack0 is okay, but /rack/0 is not allowed. When RegionawareEnsemblePlacementPolicy is enabled, the rack name can only contain one slash (/) except for the beginning and end of the rack name string. For example, rack name like /region0/rack0 is okay, but /region0rack0 and /region0/rack/0 are not allowed. |
null | |
-hn, --hostname |
Bookie host name | null |
$clusters
Operations about clusters
$ pulsar-admin clusters subcommand
getcreateupdatedeletelistupdate-peer-clustersget-peer-clustersget-failure-domaincreate-failure-domainupdate-failure-domaindelete-failure-domainlist-failure-domainsGet the configuration data for the specified cluster
Command:
$ pulsar-admin clusters get options
Provisions a new cluster. This operation requires Pulsar super-user privileges
Command:
$ pulsar-admin clusters create options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--listener-name |
listenerName when client would like to connect to cluster | null | |
--proxy-url |
Proxy-service url when client would like to connect to broker via proxy. | null | |
--tls-trust-store-type |
TLS TrustStore type configuration for internal client eg: JKS | null | |
--tls-enable |
Enable tls connection | null | |
--auth-parameters |
authentication parameters | null | |
--proxy-protocol |
protocol to decide type of proxy routing eg: SNI | null | |
--tls-allow-insecure |
Allow insecure tls connection | null | |
--url |
service-url | null | |
--broker-url |
broker-service-url | null | |
--auth-plugin |
authentication plugin | null | |
--tls-trust-certs-filepath |
path for the trusted TLS certificate file | null | |
--cluster-config-file |
The path to a YAML config file specifying the cluster's configuration | null | |
--tls-enable-keystore |
Whether use KeyStore type to authenticate | null | |
--tls-trust-store-pwd |
TLS TrustStore password for internal client | null | |
--tls-trust-store |
TLS TrustStore path for internal client | null | |
--broker-url-secure |
broker-service-url for secure connection | null | |
--url-secure |
service-url for secure connection | null |
Update the configuration for a cluster
Command:
$ pulsar-admin clusters update options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--listener-name |
listenerName when client would like to connect to cluster | null | |
--proxy-url |
Proxy-service url when client would like to connect to broker via proxy. | null | |
--tls-trust-store-type |
TLS TrustStore type configuration for internal client eg: JKS | null | |
--tls-enable |
Enable tls connection | null | |
--auth-parameters |
authentication parameters | null | |
--proxy-protocol |
protocol to decide type of proxy routing eg: SNI | null | |
--tls-allow-insecure |
Allow insecure tls connection | null | |
--url |
service-url | null | |
--broker-url |
broker-service-url | null | |
--auth-plugin |
authentication plugin | null | |
--tls-trust-certs-filepath |
path for the trusted TLS certificate file | null | |
--cluster-config-file |
The path to a YAML config file specifying the cluster's configuration | null | |
--tls-enable-keystore |
Whether use KeyStore type to authenticate | null | |
--tls-trust-store-pwd |
TLS TrustStore password for internal client | null | |
--tls-trust-store |
TLS TrustStore path for internal client | null | |
--broker-url-secure |
broker-service-url for secure connection | null | |
--url-secure |
service-url for secure connection | null |
Deletes an existing cluster
Command:
$ pulsar-admin clusters delete options
Options:
| Flag | Description | Default |
|---|---|---|
-a, --all |
Delete all data (tenants) of the cluster | false |
List the existing clusters
Command:
$ pulsar-admin clusters list options
Update peer cluster names
Command:
$ pulsar-admin clusters update-peer-clusters options
Options:
| Flag | Description | Default |
|---|---|---|
--peer-clusters |
Comma separated peer-cluster names [Pass empty string "" to delete list] | null |
Get list of peer-clusters
Command:
$ pulsar-admin clusters get-peer-clusters options
Get the configuration brokers of a failure-domain
Command:
$ pulsar-admin clusters get-failure-domain options
Options:
| Flag | Description | Default |
|---|---|---|
--domain-name |
domain-name | null |
Create a new failure-domain for a cluster. updates it if already created.
Command:
$ pulsar-admin clusters create-failure-domain options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--domain-name |
domain-name | null | |
--broker-list |
Comma separated broker list | null |
Update failure-domain for a cluster. Creates a new one if not exist.
Command:
$ pulsar-admin clusters update-failure-domain options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--domain-name |
domain-name | null | |
--broker-list |
Comma separated broker list | null |
Deletes an existing failure-domain
Command:
$ pulsar-admin clusters delete-failure-domain options
Options:
| Flag | Description | Default |
|---|---|---|
--domain-name |
domain-name | null |
List the existing failure-domains for a cluster
Command:
$ pulsar-admin clusters list-failure-domains options
$functions-worker
Operations to collect function-worker statistics
$ pulsar-admin functions-worker subcommand
function-statsmonitoring-metricsget-clusterget-cluster-leaderget-function-assignmentsrebalanceDump all functions stats running on this broker
Command:
$ pulsar-admin functions-worker function-stats options
Dump metrics for Monitoring
Command:
$ pulsar-admin functions-worker monitoring-metrics options
Get all workers belonging to this cluster
Command:
$ pulsar-admin functions-worker get-cluster options
Get the leader of the worker cluster
Command:
$ pulsar-admin functions-worker get-cluster-leader options
Get the assignments of the functions across the worker cluster
Command:
$ pulsar-admin functions-worker get-function-assignments options
Triggers a rebalance of functions to workers
Command:
$ pulsar-admin functions-worker rebalance options
$functions
Interface for managing Pulsar Functions (lightweight, Lambda-style compute processes that work with Pulsar)
$ pulsar-admin functions subcommand
localruncreatedeleteupdategetrestartstopstartstatusstatslistquerystateputstatetriggeruploaddownloadRun a Pulsar Function locally, rather than deploy to a Pulsar cluster)
Command:
$ pulsar-admin functions localrun options
Options:
| Flag | Description | Default | Support |
|---|---|---|---|
--custom-schema-outputs |
The map of input topics to Schema properties (as a JSON string) | null | Java |
--window-length-duration-ms |
The time duration of the window in milliseconds | null | Java |
--batch-builder |
BatcherBuilder provides two types of batch construction methods, DEFAULT and KEY_BASED. The default value is: DEFAULT | null | |
--custom-schema-inputs |
The map of input topics to Schema properties (as a JSON string) | null | Java, Python |
--window-length-count |
The number of messages per window | null | Java |
--forward-source-message-property |
Forwarding input message's properties to output topic when processing (use false to disable it) | true | Java |
--metrics-port-start |
The starting port range for metrics server | null | Java, Python, Go |
--secrets |
The map of secretName to an object that encapsulates how the secret is fetched by the underlying secrets provider | null | Java, Python |
--ram |
The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime) | null | Java(Process & K8s),Python(K8s),Go(K8s) |
--function-config-file |
The path to a YAML config file that specifies the configuration of a Pulsar Function | null | Java, Python, Go |
--subs-name |
Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer | null | Java, Python, Go |
--use-tls |
Use tls connection | false | Java, Python |
--dead-letter-topic |
The topic where messages that are not processed successfully are sent to | null | Java |
-i, --inputs |
The input topic or topics (multiple topics can be specified as a comma-separated list) of a Pulsar Function | null | Java, Python, Go |
--auto-ack |
Whether or not the framework acknowledges messages automatically | null | Java, Python, Go |
--subs-position |
Pulsar source subscription position if user wants to consume messages from the specified location | null | Java |
--user-config |
User-defined config key/values | null | Java, Python, Go |
--secrets-provider-classname |
Whats the classname for secrets provider | null | Java, Python |
--py |
Path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package. | null | Python |
--broker-service-url |
The URL for Pulsar broker | null | Java, Python, Go |
--go |
Path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package. | null | Go |
--parallelism |
The parallelism factor of a Pulsar Function (i.e. the number of function instances to run) | null | Java |
--tenant |
The tenant of a Pulsar Function | null | Java, Python, Go |
--producer-config |
The custom producer configuration (as a JSON string) | null | Java |
--tls-trust-cert-path |
tls trust cert file path | null | Java, Python |
--log-topic |
The topic to which the logs of a Pulsar Function are produced | null | Java, Python, Go |
--processing-guarantees |
The processing guarantees (aka delivery semantics) applied to the function | null | Java, Python, Go |
--input-specs |
The map of inputs to custom configuration (as a JSON string) | null | Java, Python, Go |
-o, --output |
The output topic of a Pulsar Function (If none is specified, no output is written) | null | Java, Python, Go |
--jar |
Path to the JAR file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package. | null | Java |
--web-service-url |
The URL for Pulsar web service | null | Java, Python |
--retain-ordering |
Function consumes and processes messages in order | null | Java |
--state-storage-service-url |
The URL for the state storage service (the default is Apache BookKeeper) | null | Java, Python |
-st, --schema-type |
The builtin schema type or custom schema class name to be used for messages output by the function | Java | |
--client-auth-plugin |
Client authentication plugin using which function-process can connect to broker | null | Java, Python |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | Java, Python |
--retain-key-ordering |
Function consumes and processes messages in key order | null | Java |
--sliding-interval-count |
The number of messages after which the window slides | null | Java |
--custom-runtime-options |
A string that encodes options to customize the runtime, see docs for configured runtime for details | null | Java |
--custom-serde-inputs |
The map of input topics to SerDe class names (as a JSON string) | null | Java, Python |
--timeout-ms |
The message timeout in milliseconds | null | Java, Python |
--max-message-retries |
How many times should we try to process a message before giving up | null | Java |
-t, --function-type |
The built-in Pulsar Function type | null | |
--runtime |
either THREAD or PROCESS. Only applies for Java functions | null | Java |
--cpu |
The cpu in cores that need to be allocated per function instance(applicable only to docker runtime) | null | Java(Process & K8s),Python(K8s),Go(K8s) |
--topics-pattern |
The topic pattern to consume from a list of topics under a namespace that matches the pattern. [--input] and [--topics-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java functions only) | null | Java, Python |
--tls-allow-insecure |
Allow insecure tls connection | false | Java, Python |
--secrets-provider-config |
Config that needs to be passed to secrets provider | null | Java, Python |
--hostname-verification-enabled |
Enable hostname verification | false | Java, Python |
--instance-id-offset |
Start the instanceIds from this offset | 0 | Java, Python |
--name |
The name of a Pulsar Function | null | Java, Python, Go |
--classname |
The class name of a Pulsar Function | null | Java, Python |
--client-auth-params |
Client authentication param | null | Java, Python |
--disk |
The disk in bytes that need to be allocated per function instance(applicable only to docker runtime) | null | Java(Process & K8s),Python(K8s),Go(K8s) |
--output-serde-classname |
The SerDe class to be used for messages output by the function | null | Java, Python |
--sliding-interval-duration-ms |
The time duration after which the window slides | null | Java |
--namespace |
The namespace of a Pulsar Function | null | Java, Python, Go |
Create a Pulsar Function in cluster mode (deploy it on a Pulsar cluster)
Command:
$ pulsar-admin functions create options
Options:
| Flag | Description | Default | Support |
|---|---|---|---|
--custom-schema-outputs |
The map of input topics to Schema properties (as a JSON string) | null | Java |
--window-length-duration-ms |
The time duration of the window in milliseconds | null | Java |
--batch-builder |
BatcherBuilder provides two types of batch construction methods, DEFAULT and KEY_BASED. The default value is: DEFAULT | null | |
--custom-schema-inputs |
The map of input topics to Schema properties (as a JSON string) | null | Java, Python |
--window-length-count |
The number of messages per window | null | Java |
--forward-source-message-property |
Forwarding input message's properties to output topic when processing (use false to disable it) | true | Java |
--secrets |
The map of secretName to an object that encapsulates how the secret is fetched by the underlying secrets provider | null | Java, Python |
--ram |
The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime) | null | Java(Process & K8s),Python(K8s),Go(K8s) |
--function-config-file |
The path to a YAML config file that specifies the configuration of a Pulsar Function | null | Java, Python, Go |
--subs-name |
Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer | null | Java, Python, Go |
--dead-letter-topic |
The topic where messages that are not processed successfully are sent to | null | Java |
-i, --inputs |
The input topic or topics (multiple topics can be specified as a comma-separated list) of a Pulsar Function | null | Java, Python, Go |
--auto-ack |
Whether or not the framework acknowledges messages automatically | null | Java, Python, Go |
--subs-position |
Pulsar source subscription position if user wants to consume messages from the specified location | null | Java |
--user-config |
User-defined config key/values | null | Java, Python, Go |
--py |
Path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package. | null | Python |
--go |
Path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package. | null | Go |
--parallelism |
The parallelism factor of a Pulsar Function (i.e. the number of function instances to run) | null | Java |
--tenant |
The tenant of a Pulsar Function | null | Java, Python, Go |
--producer-config |
The custom producer configuration (as a JSON string) | null | Java |
--log-topic |
The topic to which the logs of a Pulsar Function are produced | null | Java, Python, Go |
--processing-guarantees |
The processing guarantees (aka delivery semantics) applied to the function | null | Java, Python, Go |
--input-specs |
The map of inputs to custom configuration (as a JSON string) | null | Java, Python, Go |
-o, --output |
The output topic of a Pulsar Function (If none is specified, no output is written) | null | Java, Python, Go |
--jar |
Path to the JAR file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package. | null | Java |
--retain-ordering |
Function consumes and processes messages in order | null | Java |
-st, --schema-type |
The builtin schema type or custom schema class name to be used for messages output by the function | Java | |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | Java, Python |
--retain-key-ordering |
Function consumes and processes messages in key order | null | Java |
--sliding-interval-count |
The number of messages after which the window slides | null | Java |
--custom-runtime-options |
A string that encodes options to customize the runtime, see docs for configured runtime for details | null | Java |
--custom-serde-inputs |
The map of input topics to SerDe class names (as a JSON string) | null | Java, Python |
--timeout-ms |
The message timeout in milliseconds | null | Java, Python |
--max-message-retries |
How many times should we try to process a message before giving up | null | Java |
-t, --function-type |
The built-in Pulsar Function type | null | |
--cpu |
The cpu in cores that need to be allocated per function instance(applicable only to docker runtime) | null | Java(Process & K8s),Python(K8s),Go(K8s) |
--topics-pattern |
The topic pattern to consume from a list of topics under a namespace that matches the pattern. [--input] and [--topics-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java functions only) | null | Java, Python |
--name |
The name of a Pulsar Function | null | Java, Python, Go |
--classname |
The class name of a Pulsar Function | null | Java, Python |
--disk |
The disk in bytes that need to be allocated per function instance(applicable only to docker runtime) | null | Java(Process & K8s),Python(K8s),Go(K8s) |
--output-serde-classname |
The SerDe class to be used for messages output by the function | null | Java, Python |
--sliding-interval-duration-ms |
The time duration after which the window slides | null | Java |
--namespace |
The namespace of a Pulsar Function | null | Java, Python, Go |
Delete a Pulsar Function that is running on a Pulsar cluster
Command:
$ pulsar-admin functions delete options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The name of a Pulsar Function | null | |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | |
--namespace |
The namespace of a Pulsar Function | null | |
--tenant |
The tenant of a Pulsar Function | null |
Update a Pulsar Function that has been deployed to a Pulsar cluster
Command:
$ pulsar-admin functions update options
Options:
| Flag | Description | Default | Support |
|---|---|---|---|
--custom-schema-outputs |
The map of input topics to Schema properties (as a JSON string) | null | Java |
--window-length-duration-ms |
The time duration of the window in milliseconds | null | Java |
--batch-builder |
BatcherBuilder provides two types of batch construction methods, DEFAULT and KEY_BASED. The default value is: DEFAULT | null | |
--custom-schema-inputs |
The map of input topics to Schema properties (as a JSON string) | null | Java, Python |
--window-length-count |
The number of messages per window | null | Java |
--forward-source-message-property |
Forwarding input message's properties to output topic when processing (use false to disable it) | true | Java |
--secrets |
The map of secretName to an object that encapsulates how the secret is fetched by the underlying secrets provider | null | Java, Python |
--ram |
The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime) | null | Java(Process & K8s),Python(K8s),Go(K8s) |
--function-config-file |
The path to a YAML config file that specifies the configuration of a Pulsar Function | null | Java, Python, Go |
--subs-name |
Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer | null | Java, Python, Go |
--dead-letter-topic |
The topic where messages that are not processed successfully are sent to | null | Java |
-i, --inputs |
The input topic or topics (multiple topics can be specified as a comma-separated list) of a Pulsar Function | null | Java, Python, Go |
--auto-ack |
Whether or not the framework acknowledges messages automatically | null | Java, Python, Go |
--subs-position |
Pulsar source subscription position if user wants to consume messages from the specified location | null | Java |
--user-config |
User-defined config key/values | null | Java, Python, Go |
--update-auth-data |
Whether or not to update the auth data | false | Java, Python |
--py |
Path to the main Python file/Python Wheel file for the function (if the function is written in Python). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package. | null | Python |
--go |
Path to the main Go executable binary for the function (if the function is written in Go). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package. | null | Go |
--parallelism |
The parallelism factor of a Pulsar Function (i.e. the number of function instances to run) | null | Java |
--tenant |
The tenant of a Pulsar Function | null | Java, Python, Go |
--producer-config |
The custom producer configuration (as a JSON string) | null | Java |
--log-topic |
The topic to which the logs of a Pulsar Function are produced | null | Java, Python, Go |
--processing-guarantees |
The processing guarantees (aka delivery semantics) applied to the function | null | Java, Python, Go |
--input-specs |
The map of inputs to custom configuration (as a JSON string) | null | Java, Python, Go |
-o, --output |
The output topic of a Pulsar Function (If none is specified, no output is written) | null | Java, Python, Go |
--jar |
Path to the JAR file for the function (if the function is written in Java). It also supports URL path [http/https/file (file protocol assumes that file already exists on worker host)/function (package URL from packages management service)] from which worker can download the package. | null | Java |
--retain-ordering |
Function consumes and processes messages in order | null | Java |
-st, --schema-type |
The builtin schema type or custom schema class name to be used for messages output by the function | Java | |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | Java, Python |
--retain-key-ordering |
Function consumes and processes messages in key order | null | Java |
--sliding-interval-count |
The number of messages after which the window slides | null | Java |
--custom-runtime-options |
A string that encodes options to customize the runtime, see docs for configured runtime for details | null | Java |
--custom-serde-inputs |
The map of input topics to SerDe class names (as a JSON string) | null | Java, Python |
--timeout-ms |
The message timeout in milliseconds | null | Java, Python |
--max-message-retries |
How many times should we try to process a message before giving up | null | Java |
-t, --function-type |
The built-in Pulsar Function type | null | |
--cpu |
The cpu in cores that need to be allocated per function instance(applicable only to docker runtime) | null | Java(Process & K8s),Python(K8s),Go(K8s) |
--topics-pattern |
The topic pattern to consume from a list of topics under a namespace that matches the pattern. [--input] and [--topics-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java functions only) | null | Java, Python |
--name |
The name of a Pulsar Function | null | Java, Python, Go |
--classname |
The class name of a Pulsar Function | null | Java, Python |
--disk |
The disk in bytes that need to be allocated per function instance(applicable only to docker runtime) | null | Java(Process & K8s),Python(K8s),Go(K8s) |
--output-serde-classname |
The SerDe class to be used for messages output by the function | null | Java, Python |
--sliding-interval-duration-ms |
The time duration after which the window slides | null | Java |
--namespace |
The namespace of a Pulsar Function | null | Java, Python, Go |
Fetch information about a Pulsar Function
Command:
$ pulsar-admin functions get options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The name of a Pulsar Function | null | |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | |
--namespace |
The namespace of a Pulsar Function | null | |
--tenant |
The tenant of a Pulsar Function | null |
Restart function instance
Command:
$ pulsar-admin functions restart options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The name of a Pulsar Function | null | |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | |
--namespace |
The namespace of a Pulsar Function | null | |
--tenant |
The tenant of a Pulsar Function | null | |
--instance-id |
The function instanceId (restart all instances if instance-id is not provided) | null |
Stops function instance
Command:
$ pulsar-admin functions stop options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The name of a Pulsar Function | null | |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | |
--namespace |
The namespace of a Pulsar Function | null | |
--instance-id |
The function instanceId (stop all instances if instance-id is not provided) | null | |
--tenant |
The tenant of a Pulsar Function | null |
Starts a stopped function instance
Command:
$ pulsar-admin functions start options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The name of a Pulsar Function | null | |
--instance-id |
The function instanceId (start all instances if instance-id is not provided) | null | |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | |
--namespace |
The namespace of a Pulsar Function | null | |
--tenant |
The tenant of a Pulsar Function | null |
Check the current status of a Pulsar Function
Command:
$ pulsar-admin functions status options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The name of a Pulsar Function | null | |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | |
--namespace |
The namespace of a Pulsar Function | null | |
--tenant |
The tenant of a Pulsar Function | null | |
--instance-id |
The function instanceId (Get-status of all instances if instance-id is not provided) | null |
Get the current stats of a Pulsar Function
Command:
$ pulsar-admin functions stats options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The name of a Pulsar Function | null | |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | |
--instance-id |
The function instanceId (Get-stats of all instances if instance-id is not provided) | null | |
--namespace |
The namespace of a Pulsar Function | null | |
--tenant |
The tenant of a Pulsar Function | null |
List all Pulsar Functions running under a specific tenant and namespace
Command:
$ pulsar-admin functions list options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--namespace |
The namespace of a Pulsar Function | null | |
--tenant |
The tenant of a Pulsar Function | null |
Fetch the current state associated with a Pulsar Function
Command:
$ pulsar-admin functions querystate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The name of a Pulsar Function | null | |
-k, --key |
Key name of State | null | |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | |
--namespace |
The namespace of a Pulsar Function | null | |
-w, --watch |
Watch for changes in the value associated with a key for a Pulsar Function | false | |
--tenant |
The tenant of a Pulsar Function | null |
Put the state associated with a Pulsar Function
Command:
$ pulsar-admin functions putstate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The name of a Pulsar Function | null | |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | |
--namespace |
The namespace of a Pulsar Function | null | |
--tenant |
The tenant of a Pulsar Function | null | |
-s, --state |
The FunctionState that needs to be put | null |
Trigger the specified Pulsar Function with a supplied value
Command:
$ pulsar-admin functions trigger options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The name of a Pulsar Function | null | |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | |
--namespace |
The namespace of a Pulsar Function | null | |
--trigger-value |
The value with which you want to trigger the function | null | |
--trigger-file |
The path to the file that contains the data with which you want to trigger the function | null | |
--topic |
The specific topic name that the function consumes from that you want to inject the data to | null | |
--tenant |
The tenant of a Pulsar Function | null |
Upload File Data to Pulsar
Command:
$ pulsar-admin functions upload options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--source-file |
The file whose contents need to be uploaded | null | |
--path |
Path or functionPkgUrl where the contents need to be stored | null |
Download File Data from Pulsar
Command:
$ pulsar-admin functions download options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The name of a Pulsar Function | null | |
--fqfn |
The Fully Qualified Function Name (FQFN) for the function | null | |
--namespace |
The namespace of a Pulsar Function | null | |
--destination-file |
The file to store downloaded content | null | |
--tenant |
The tenant of a Pulsar Function | null |
$namespaces
Operations about namespaces
$ pulsar-admin namespaces subcommand
listlist-clustertopicsbundlesdestinationspoliciescreatedeletepermissionsgrant-permissionrevoke-permissionsubscription-permissiongrant-subscription-permissionrevoke-subscription-permissionset-clustersget-clustersset-subscription-types-enabledget-subscription-types-enabledremove-subscription-types-enabledget-backlog-quotasset-backlog-quotaremove-backlog-quotaget-persistenceset-persistenceremove-persistenceget-message-ttlset-message-ttlremove-message-ttlget-max-subscriptions-per-topicset-max-subscriptions-per-topicremove-max-subscriptions-per-topicget-subscription-expiration-timeset-subscription-expiration-timeremove-subscription-expiration-timeget-anti-affinity-groupset-anti-affinity-groupget-anti-affinity-namespacesdelete-anti-affinity-groupset-deduplicationget-deduplicationremove-deduplicationset-auto-topic-creationget-auto-topic-creationremove-auto-topic-creationset-auto-subscription-creationget-auto-subscription-creationremove-auto-subscription-creationget-retentionset-retentionremove-retentionset-bookie-affinity-groupget-bookie-affinity-groupdelete-bookie-affinity-groupunloadsplit-bundleget-topic-positionsset-dispatch-rateremove-dispatch-rateget-dispatch-rateset-subscribe-rateget-subscribe-rateremove-subscribe-rateset-subscription-dispatch-rateget-subscription-dispatch-rateremove-subscription-dispatch-rateset-publish-rateget-publish-rateremove-publish-rateset-replicator-dispatch-rateget-replicator-dispatch-rateremove-replicator-dispatch-rateclear-backlogunsubscribeset-encryption-requiredget-encryption-requiredset-subscription-auth-modeget-subscription-auth-modeset-delayed-deliveryget-delayed-deliveryremove-delayed-deliveryget-inactive-topic-policiesset-inactive-topic-policiesremove-inactive-topic-policiesget-max-producers-per-topicset-max-producers-per-topicremove-max-producers-per-topicget-max-consumers-per-topicset-max-consumers-per-topicremove-max-consumers-per-topicget-max-consumers-per-subscriptionset-max-consumers-per-subscriptionremove-max-consumers-per-subscriptionget-max-unacked-messages-per-subscriptionset-max-unacked-messages-per-subscriptionremove-max-unacked-messages-per-subscriptionget-max-unacked-messages-per-consumerset-max-unacked-messages-per-consumerremove-max-unacked-messages-per-consumerget-compaction-thresholdset-compaction-thresholdremove-compaction-thresholdget-offload-thresholdset-offload-thresholdget-offload-deletion-lagset-offload-deletion-lagclear-offload-deletion-lagget-schema-autoupdate-strategyset-schema-autoupdate-strategyget-schema-compatibility-strategyset-schema-compatibility-strategyget-is-allow-auto-update-schemaset-is-allow-auto-update-schemaget-schema-validation-enforceset-schema-validation-enforceset-offload-policiesremove-offload-policiesget-offload-policiesset-deduplication-snapshot-intervalget-deduplication-snapshot-intervalremove-deduplication-snapshot-intervalset-max-topics-per-namespaceget-max-topics-per-namespaceremove-max-topics-per-namespaceset-propertyget-propertyremove-propertyset-propertiesget-propertiesclear-propertiesget-resource-groupset-resource-groupremove-resource-groupGet the namespaces for a tenant
Command:
$ pulsar-admin namespaces list options
Get the namespaces for a tenant in a cluster
Command:
$ pulsar-admin namespaces list-cluster options
Get the list of topics for a namespace
Command:
$ pulsar-admin namespaces topics options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-m, --mode |
Allowed topic domain mode (persistent, non_persistent, all). | null | |
-ist, --include-system-topic |
Include system topic | false |
Get the list of bundles for a namespace
Command:
$ pulsar-admin namespaces bundles options
Get the list of destinations for a namespace
Command:
$ pulsar-admin namespaces destinations options
Get the configuration policies of a namespace
Command:
$ pulsar-admin namespaces policies options
Creates a new namespace
Command:
$ pulsar-admin namespaces create options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--clusters, -c |
List of clusters this namespace will be assigned | null | |
--bundles, -b |
number of bundles to activate | 0 |
Deletes a namespace.
Command:
$ pulsar-admin namespaces delete options
Options:
| Flag | Description | Default |
|---|---|---|
-f, --force |
Delete namespace forcefully by force deleting all topics under it | false |
Get the permissions on a namespace
Command:
$ pulsar-admin namespaces permissions options
Grant permissions on a namespace
Command:
$ pulsar-admin namespaces grant-permission options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--actions |
Actions to be granted (produce,consume,sources,sinks,functions,packages) | null | |
--role |
Client role to which grant permissions | null |
Revoke permissions on a namespace
Command:
$ pulsar-admin namespaces revoke-permission options
Options:
| Flag | Description | Default |
|---|---|---|
--role |
Client role to which revoke permissions | null |
Get permissions to access subscription admin-api
Command:
$ pulsar-admin namespaces subscription-permission options
Grant permissions to access subscription admin-api
Command:
$ pulsar-admin namespaces grant-subscription-permission options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-rs, --roles |
Client roles to which grant permissions (comma separated roles) | null | |
-s, --subscription |
Subscription name for which permission will be granted to roles | null |
Revoke permissions to access subscription admin-api
Command:
$ pulsar-admin namespaces revoke-subscription-permission options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-s, --subscription |
Subscription name for which permission will be revoked to roles | null | |
-r, --role |
Client role to which revoke permissions | null |
Set replication clusters for a namespace
Command:
$ pulsar-admin namespaces set-clusters options
Options:
| Flag | Description | Default |
|---|---|---|
--clusters, -c |
Replication Cluster Ids list (comma separated values) | null |
Get replication clusters for a namespace
Command:
$ pulsar-admin namespaces get-clusters options
Set subscription types enabled for a namespace
Command:
$ pulsar-admin namespaces set-subscription-types-enabled options
Options:
| Flag | Description | Default |
|---|---|---|
--types, -t |
Subscription types enabled list (comma separated values). Possible values: (Exclusive, Shared, Failover, Key_Shared). | null |
Get subscription types enabled for a namespace
Command:
$ pulsar-admin namespaces get-subscription-types-enabled options
Remove subscription types enabled for a namespace
Command:
$ pulsar-admin namespaces remove-subscription-types-enabled options
Get the backlog quota policies for a namespace
Command:
$ pulsar-admin namespaces get-backlog-quotas options
Set a backlog quota policy for a namespace
Command:
$ pulsar-admin namespaces set-backlog-quota options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-lt, --limitTime |
Time limit in second (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w), non-positive number for disabling time limit. | null | |
-l, --limit |
Size limit (eg: 10M, 16G) | null | |
-t, --type |
Backlog quota type to set. Valid options are: destination_storage and message_age. destination_storage limits backlog by size (in bytes). message_age limits backlog by time, that is, message timestamp (broker or publish timestamp). You can set size or time to control the backlog, or combine them together to control the backlog. | destination_storage | |
-p, --policy |
Retention policy to enforce when the limit is reached. Valid options are: [producer_request_hold, producer_exception, consumer_backlog_eviction] | null |
Remove a backlog quota policy from a namespace
Command:
$ pulsar-admin namespaces remove-backlog-quota options
Options:
| Flag | Description | Default |
|---|---|---|
-t, --type |
Backlog quota type to remove. Valid options are: destination_storage, message_age | destination_storage |
Get the persistence policies for a namespace
Command:
$ pulsar-admin namespaces get-persistence options
Set the persistence policies for a namespace
Command:
$ pulsar-admin namespaces set-persistence options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-e, --bookkeeper-ensemble |
Number of bookies to use for a topic | 0 | |
-a, --bookkeeper-ack-quorum |
Number of acks (guaranteed copies) to wait for each entry | 0 | |
-w, --bookkeeper-write-quorum |
How many writes to make of each entry | 0 | |
-r, --ml-mark-delete-max-rate |
Throttling rate of mark-delete operation (0 means no throttle) | 0.0 |
Remove the persistence policies for a namespace
Command:
$ pulsar-admin namespaces remove-persistence options
Get message TTL for a namespace
Command:
$ pulsar-admin namespaces get-message-ttl options
Set Message TTL for a namespace
Command:
$ pulsar-admin namespaces set-message-ttl options
Options:
| Flag | Description | Default |
|---|---|---|
--messageTTL, -ttl |
Message TTL in seconds (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w). When the value is set to 0, TTL is disabled. |
null |
Remove Message TTL for a namespace
Command:
$ pulsar-admin namespaces remove-message-ttl options
Get max subscriptions per topic for a namespace
Command:
$ pulsar-admin namespaces get-max-subscriptions-per-topic options
Set max subscriptions per topic for a namespace
Command:
$ pulsar-admin namespaces set-max-subscriptions-per-topic options
Options:
| Flag | Description | Default |
|---|---|---|
--max-subscriptions-per-topic, -m |
Max subscriptions per topic | 0 |
Remove max subscriptions per topic for a namespace
Command:
$ pulsar-admin namespaces remove-max-subscriptions-per-topic options
Get subscription expiration time for a namespace
Command:
$ pulsar-admin namespaces get-subscription-expiration-time options
Set subscription expiration time for a namespace
Command:
$ pulsar-admin namespaces set-subscription-expiration-time options
Options:
| Flag | Description | Default |
|---|---|---|
-t, --time |
Subscription expiration time in minutes | 0 |
Remove subscription expiration time for a namespace
Command:
$ pulsar-admin namespaces remove-subscription-expiration-time options
Get Anti-affinity group name for a namespace
Command:
$ pulsar-admin namespaces get-anti-affinity-group options
Set Anti-affinity group name for a namespace
Command:
$ pulsar-admin namespaces set-anti-affinity-group options
Options:
| Flag | Description | Default |
|---|---|---|
--group, -g |
Anti-affinity group name | null |
Get Anti-affinity namespaces grouped with the given anti-affinity group name
Command:
$ pulsar-admin namespaces get-anti-affinity-namespaces options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--cluster, -c |
Cluster name | null | |
--group, -g |
Anti-affinity group name | null | |
--tenant, -p |
tenant is only used for authorization. Client has to be admin of any of the tenant to access this api | null |
Remove Anti-affinity group name for a namespace
Command:
$ pulsar-admin namespaces delete-anti-affinity-group options
Enable or disable deduplication for a namespace
Command:
$ pulsar-admin namespaces set-deduplication options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--enable, -e |
Enable deduplication | false | |
--disable, -d |
Disable deduplication | false |
Get Deduplication for a namespace
Command:
$ pulsar-admin namespaces get-deduplication options
Remove Deduplication for a namespace
Command:
$ pulsar-admin namespaces remove-deduplication options
Enable or disable autoTopicCreation for a namespace, overriding broker settings
Command:
$ pulsar-admin namespaces set-auto-topic-creation options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--enable, -e |
Enable allowAutoTopicCreation on namespace | false | |
--num-partitions, -n |
Default number of partitions of topic to be auto-created, applicable to partitioned topics only | null | |
--disable, -d |
Disable allowAutoTopicCreation on namespace | false | |
--type, -t |
Type of topic to be auto-created. Possible values: (partitioned, non-partitioned). Default value: non-partitioned | non-partitioned |
Get autoTopicCreation info for a namespace
Command:
$ pulsar-admin namespaces get-auto-topic-creation options
Remove override of autoTopicCreation for a namespace
Command:
$ pulsar-admin namespaces remove-auto-topic-creation options
Enable autoSubscriptionCreation for a namespace, overriding broker settings
Command:
$ pulsar-admin namespaces set-auto-subscription-creation options
Options:
| Flag | Description | Default |
|---|---|---|
--enable, -e |
Enable allowAutoSubscriptionCreation on namespace | false |
Get the autoSubscriptionCreation for a namespace
Command:
$ pulsar-admin namespaces get-auto-subscription-creation options
Remove override of autoSubscriptionCreation for a namespace
Command:
$ pulsar-admin namespaces remove-auto-subscription-creation options
Get the retention policy for a namespace
Command:
$ pulsar-admin namespaces get-retention options
Set the retention policy for a namespace
Command:
$ pulsar-admin namespaces set-retention options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--size, -s |
Retention size limit (eg: 10M, 16G, 3T). 0 or less than 1MB means no retention and -1 means infinite size retention | null | |
--time, -t |
Retention time in minutes (or minutes, hours,days,weeks eg: 100m, 3h, 2d, 5w). 0 means no retention and -1 means infinite time retention | null |
Remove the retention policy for a namespace
Command:
$ pulsar-admin namespaces remove-retention options
Set the bookie-affinity group name
Command:
$ pulsar-admin namespaces set-bookie-affinity-group options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--primary-group, -pg |
Bookie-affinity primary-groups (comma separated) name where namespace messages should be written | null | |
--secondary-group, -sg |
Bookie-affinity secondary-group (comma separated) name where namespace messages should be written. If you want to verify whether there are enough bookies in groups, use --secondary-group flag. Messages in this namespace are stored in secondary groups. If a group does not contain enough bookies, a topic cannot be created. |
null |
Get the bookie-affinity group name
Command:
$ pulsar-admin namespaces get-bookie-affinity-group options
Set the bookie-affinity group name
Command:
$ pulsar-admin namespaces delete-bookie-affinity-group options
Unload a namespace from the current serving broker
Command:
$ pulsar-admin namespaces unload options
Options:
| Flag | Description | Default |
|---|---|---|
--bundle, -b |
{start-boundary}_{end-boundary} | null |
Split a namespace-bundle from the current serving broker
Command:
$ pulsar-admin namespaces split-bundle options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--unload, -u |
Unload newly split bundles after splitting old bundle | false | |
--split-algorithm-name, -san |
Algorithm name for split namespace bundle. Valid options are: [range_equally_divide, topic_count_equally_divide, specified_positions_divide]. Use broker side config if absent | null | |
--bundle-type, -bt |
bundle type (mutually exclusive with --bundle) | null | |
--split-boundaries, -sb |
Specified split boundary for bundle split, will split one bundle to multi bundles only works with specified_positions_divide algorithm | null | |
--bundle, -b |
{start-boundary}_{end-boundary} (mutually exclusive with --bundle-type) | null |
Get the positions for one or more topic(s) in a namespace bundle
Command:
$ pulsar-admin namespaces get-topic-positions options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--topic-list, -tl |
The list of topics(both non-partitioned topic and partitioned topic) to get positions in this bundle, if none topic provided, will get the positions of all topics in this bundle | null | |
--bundle, -b |
{start-boundary}_{end-boundary} format namespace bundle | null |
Set message-dispatch-rate for all topics of the namespace
Command:
$ pulsar-admin namespaces set-dispatch-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--msg-dispatch-rate, -md |
message-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--dispatch-rate-period, -dt |
dispatch-rate-period in second type (default 1 second will be overwrite if not passed) | 1 | |
--relative-to-publish-rate, -rp |
dispatch rate relative to publish-rate (if publish-relative flag is enabled then broker will apply throttling value to (publish-rate + dispatch rate)) | false | |
--byte-dispatch-rate, -bd |
byte-dispatch-rate (default -1 will be overwrite if not passed) | -1 |
Remove configured message-dispatch-rate for all topics of the namespace
Command:
$ pulsar-admin namespaces remove-dispatch-rate options
Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)
Command:
$ pulsar-admin namespaces get-dispatch-rate options
Set subscribe-rate per consumer for all topics of the namespace
Command:
$ pulsar-admin namespaces set-subscribe-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--subscribe-rate, -sr |
subscribe-rate (default -1 will be overwrite if not passed) | -1 | |
--subscribe-rate-period, -st |
subscribe-rate-period in second type (default 30 second will be overwrite if not passed) | 30 |
Get configured subscribe-rate per consumer for all topics of the namespace
Command:
$ pulsar-admin namespaces get-subscribe-rate options
Remove configured subscribe-rate per consumer for all topics of the namespace
Command:
$ pulsar-admin namespaces remove-subscribe-rate options
Set subscription message-dispatch-rate for all subscription of the namespace
Command:
$ pulsar-admin namespaces set-subscription-dispatch-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--byte-dispatch-rate, -bd |
byte-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--dispatch-rate-period, -dt |
dispatch-rate-period in second type (default 1 second will be overwrite if not passed) | 1 | |
--relative-to-publish-rate, -rp |
dispatch rate relative to publish-rate (if publish-relative flag is enabled then broker will apply throttling value to (publish-rate + dispatch rate)) | false | |
--msg-dispatch-rate, -md |
message-dispatch-rate (default -1 will be overwrite if not passed) | -1 |
Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)
Command:
$ pulsar-admin namespaces get-subscription-dispatch-rate options
Remove subscription configured message-dispatch-rate for all topics of the namespace
Command:
$ pulsar-admin namespaces remove-subscription-dispatch-rate options
Set publish-rate for all topics of the namespace
Command:
$ pulsar-admin namespaces set-publish-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--byte-publish-rate, -b |
byte-publish-rate (default -1 will be overwrite if not passed) | -1 | |
--msg-publish-rate, -m |
message-publish-rate (default -1 will be overwrite if not passed) | -1 |
Get configured message-publish-rate for all topics of the namespace (Disabled if value < 0)
Command:
$ pulsar-admin namespaces get-publish-rate options
Remove publish-rate for all topics of the namespace
Command:
$ pulsar-admin namespaces remove-publish-rate options
Set replicator message-dispatch-rate for all topics of the namespace
Command:
$ pulsar-admin namespaces set-replicator-dispatch-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--dispatch-rate-period, -dt |
dispatch-rate-period in second type (default 1 second will be overwrite if not passed) | 1 | |
--byte-dispatch-rate, -bd |
byte-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--msg-dispatch-rate, -md |
message-dispatch-rate (default -1 will be overwrite if not passed) | -1 |
Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)
Command:
$ pulsar-admin namespaces get-replicator-dispatch-rate options
Remove replicator configured message-dispatch-rate for all topics of the namespace
Command:
$ pulsar-admin namespaces remove-replicator-dispatch-rate options
Clear backlog for a namespace
Command:
$ pulsar-admin namespaces clear-backlog options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--sub, -s |
subscription name | null | |
--bundle, -b |
{start-boundary}_{end-boundary} | null | |
--force, -force |
Whether to force clear backlog without prompt | false |
Unsubscribe the given subscription on all topics on a namespace
Command:
$ pulsar-admin namespaces unsubscribe options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--bundle, -b |
{start-boundary}_{end-boundary} | null | |
--sub, -s |
subscription name | null |
Enable or disable message encryption required for a namespace
Command:
$ pulsar-admin namespaces set-encryption-required options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--disable, -d |
Disable message encryption required | false | |
--enable, -e |
Enable message encryption required | false |
Get encryption required for a namespace
Command:
$ pulsar-admin namespaces get-encryption-required options
Set subscription auth mode on a namespace
Command:
$ pulsar-admin namespaces set-subscription-auth-mode options
Options:
| Flag | Description | Default |
|---|---|---|
-m, --subscription-auth-mode |
Subscription authorization mode for Pulsar policies. Valid options are: [None, Prefix] | null |
Get subscriptionAuthMod for a namespace
Command:
$ pulsar-admin namespaces get-subscription-auth-mode options
Set the delayed delivery policy on a namespace
Command:
$ pulsar-admin namespaces set-delayed-delivery options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--disable, -d |
Disable delayed delivery messages | false | |
--time, -t |
The tick time for when retrying on delayed delivery messages, affecting the accuracy of the delivery time compared to the scheduled time. (eg: 1s, 10s, 1m, 5h, 3d) | 1s | |
--enable, -e |
Enable delayed delivery messages | false |
Get the delayed delivery policy for a namespace
Command:
$ pulsar-admin namespaces get-delayed-delivery options
Remove delayed delivery policies from a namespace
Command:
$ pulsar-admin namespaces remove-delayed-delivery options
Get the inactive topic policy for a namespace
Command:
$ pulsar-admin namespaces get-inactive-topic-policies options
Set the inactive topic policies on a namespace
Command:
$ pulsar-admin namespaces set-inactive-topic-policies options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--max-inactive-duration, -t |
Max duration of topic inactivity in seconds, topics that are inactive for longer than this value will be deleted (eg: 1s, 10s, 1m, 5h, 3d) | null | |
--disable-delete-while-inactive, -d |
Disable delete while inactive | false | |
--enable-delete-while-inactive, -e |
Enable delete while inactive | false | |
--delete-mode, -m |
Mode of delete inactive topic, Valid options are: [delete_when_no_subscriptions, delete_when_subscriptions_caught_up] | null |
Remove inactive topic policies from a namespace
Command:
$ pulsar-admin namespaces remove-inactive-topic-policies options
Get maxProducersPerTopic for a namespace
Command:
$ pulsar-admin namespaces get-max-producers-per-topic options
Set maxProducersPerTopic for a namespace
Command:
$ pulsar-admin namespaces set-max-producers-per-topic options
Options:
| Flag | Description | Default |
|---|---|---|
--max-producers-per-topic, -p |
maxProducersPerTopic for a namespace | 0 |
Remove max producers per topic for a namespace
Command:
$ pulsar-admin namespaces remove-max-producers-per-topic options
Get maxConsumersPerTopic for a namespace
Command:
$ pulsar-admin namespaces get-max-consumers-per-topic options
Set maxConsumersPerTopic for a namespace
Command:
$ pulsar-admin namespaces set-max-consumers-per-topic options
Options:
| Flag | Description | Default |
|---|---|---|
--max-consumers-per-topic, -c |
maxConsumersPerTopic for a namespace | 0 |
Remove max consumers per topic for a namespace
Command:
$ pulsar-admin namespaces remove-max-consumers-per-topic options
Get maxConsumersPerSubscription for a namespace
Command:
$ pulsar-admin namespaces get-max-consumers-per-subscription options
Set maxConsumersPerSubscription for a namespace
Command:
$ pulsar-admin namespaces set-max-consumers-per-subscription options
Options:
| Flag | Description | Default |
|---|---|---|
--max-consumers-per-subscription, -c |
maxConsumersPerSubscription for a namespace | 0 |
Remove maxConsumersPerSubscription for a namespace
Command:
$ pulsar-admin namespaces remove-max-consumers-per-subscription options
Get maxUnackedMessagesPerSubscription for a namespace
Command:
$ pulsar-admin namespaces get-max-unacked-messages-per-subscription options
Set maxUnackedMessagesPerSubscription for a namespace
Command:
$ pulsar-admin namespaces set-max-unacked-messages-per-subscription options
Options:
| Flag | Description | Default |
|---|---|---|
--max-unacked-messages-per-subscription, -c |
maxUnackedMessagesPerSubscription for a namespace | 0 |
Remove maxUnackedMessagesPerSubscription for a namespace
Command:
$ pulsar-admin namespaces remove-max-unacked-messages-per-subscription options
Get maxUnackedMessagesPerConsumer for a namespace
Command:
$ pulsar-admin namespaces get-max-unacked-messages-per-consumer options
Set maxUnackedMessagesPerConsumer for a namespace
Command:
$ pulsar-admin namespaces set-max-unacked-messages-per-consumer options
Options:
| Flag | Description | Default |
|---|---|---|
--max-unacked-messages-per-topic, -c |
maxUnackedMessagesPerConsumer for a namespace | 0 |
Remove maxUnackedMessagesPerConsumer for a namespace
Command:
$ pulsar-admin namespaces remove-max-unacked-messages-per-consumer options
Get compactionThreshold for a namespace
Command:
$ pulsar-admin namespaces get-compaction-threshold options
Set compactionThreshold for a namespace
Command:
$ pulsar-admin namespaces set-compaction-threshold options
Options:
| Flag | Description | Default |
|---|---|---|
--threshold, -t |
Maximum number of bytes in a topic backlog before compaction is triggered (eg: 10M, 16G, 3T). 0 disables automatic compaction | 0 |
Remove compactionThreshold for a namespace
Command:
$ pulsar-admin namespaces remove-compaction-threshold options
Get offloadThreshold for a namespace
Command:
$ pulsar-admin namespaces get-offload-threshold options
Set offloadThreshold for a namespace
Command:
$ pulsar-admin namespaces set-offload-threshold options
Options:
| Flag | Description | Default |
|---|---|---|
--size, -s |
Maximum number of bytes stored in the pulsar cluster for a topic before data will start being automatically offloaded to longterm storage (eg: 10M, 16G, 3T, 100). -1 falls back to the cluster's namespace default. Negative values disable automatic offload. 0 triggers offloading as soon as possible. | -1 |
Get offloadDeletionLag, in minutes, for a namespace
Command:
$ pulsar-admin namespaces get-offload-deletion-lag options
Set offloadDeletionLag for a namespace
Command:
$ pulsar-admin namespaces set-offload-deletion-lag options
Options:
| Flag | Description | Default |
|---|---|---|
--lag, -l |
Duration to wait after offloading a ledger segment, before deleting the copy of that segment from cluster local storage. (eg: 10m, 5h, 3d, 2w). | -1 |
Clear offloadDeletionLag for a namespace
Command:
$ pulsar-admin namespaces clear-offload-deletion-lag options
Get the schema auto-update strategy for a namespace
Command:
$ pulsar-admin namespaces get-schema-autoupdate-strategy options
Set the schema auto-update strategy for a namespace
Command:
$ pulsar-admin namespaces set-schema-autoupdate-strategy options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--compatibility, -c |
Compatibility level required for new schemas created via a Producer. Possible values (Full, Backward, Forward). | null | |
--disabled, -d |
Disable automatic schema updates | false |
Get the schema compatibility strategy for a namespace
Command:
$ pulsar-admin namespaces get-schema-compatibility-strategy options
Set the schema compatibility strategy for a namespace
Command:
$ pulsar-admin namespaces set-schema-compatibility-strategy options
Options:
| Flag | Description | Default |
|---|---|---|
--compatibility, -c |
Compatibility level required for new schemas created via a Producer. Possible values (FULL, BACKWARD, FORWARD, UNDEFINED, BACKWARD_TRANSITIVE, FORWARD_TRANSITIVE, FULL_TRANSITIVE, ALWAYS_INCOMPATIBLE,ALWAYS_COMPATIBLE). | null |
Get the namespace whether allow auto update schema
Command:
$ pulsar-admin namespaces get-is-allow-auto-update-schema options
Set the namespace whether allow auto update schema
Command:
$ pulsar-admin namespaces set-is-allow-auto-update-schema options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--disable, -d |
Disable schema validation enforced | false | |
--enable, -e |
Enable schema validation enforced | false |
Get the schema validation enforced
Command:
$ pulsar-admin namespaces get-schema-validation-enforce options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the namespace | false |
Set the schema whether open schema validation enforced
Command:
$ pulsar-admin namespaces set-schema-validation-enforce options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--disable, -d |
Disable schema validation enforced | false | |
--enable, -e |
Enable schema validation enforced | false |
Set the offload policies for a namespace
Command:
$ pulsar-admin namespaces set-offload-policies options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--offloadAfterThreshold, -oat |
Offload after threshold size (eg: 1M, 5M) | null | |
--s3-role-session-name, -rsn |
S3 role session name used for STSAssumeRoleSessionCredentialsProvider | null | |
--bucket, -b |
Bucket to place offloaded ledger into | null | |
--aws-secret, -s |
AWS Credential Secret to use when using driver S3 or aws-s3 | null | |
--offloadAfterElapsed, -oae |
Offload after elapsed in minutes (or minutes, hours,days,weeks eg: 100m, 3h, 2d, 5w). | null | |
--region, -r |
The long term storage region, default is s3ManagedLedgerOffloadRegion or gcsManagedLedgerOffloadRegion in broker.conf | null | |
--s3-role, -ro |
S3 Role used for STSAssumeRoleSessionCredentialsProvider | null | |
--maxBlockSize, -mbs |
Max block size (eg: 32M, 64M), default is 64MB | null | |
--readBufferSize, -rbs |
Read buffer size (eg: 1M, 5M), default is 1MB | null | |
--driver, -d |
Driver to use to offload old data to long term storage, (Possible values: S3, aws-s3, google-cloud-storage, filesystem, azureblob) | null | |
--endpoint, -e |
Alternative endpoint to connect to, s3 default is s3ManagedLedgerOffloadServiceEndpoint in broker.conf | null | |
--aws-id, -i |
AWS Credential Id to use when using driver S3 or aws-s3 | null | |
--offloadedReadPriority, -orp |
Read priority for offloaded messages. By default, once messages are offloaded to long-term storage, brokers read messages from long-term storage, but messages can still exist in BookKeeper for a period depends on your configuration. For messages that exist in both long-term storage and BookKeeper, you can set where to read messages from with the option tiered-storage-first or bookkeeper-first. |
null |
Remove the offload policies for a namespace
Command:
$ pulsar-admin namespaces remove-offload-policies options
Get the offload policies for a namespace
Command:
$ pulsar-admin namespaces get-offload-policies options
Set deduplicationSnapshotInterval for a namespace
Command:
$ pulsar-admin namespaces set-deduplication-snapshot-interval options
Options:
| Flag | Description | Default |
|---|---|---|
--interval, -i |
deduplicationSnapshotInterval for a namespace | 0 |
Get deduplicationSnapshotInterval for a namespace
Command:
$ pulsar-admin namespaces get-deduplication-snapshot-interval options
Remove deduplicationSnapshotInterval for a namespace
Command:
$ pulsar-admin namespaces remove-deduplication-snapshot-interval options
Set max topics per namespace
Command:
$ pulsar-admin namespaces set-max-topics-per-namespace options
Options:
| Flag | Description | Default |
|---|---|---|
--max-topics-per-namespace, -t |
max topics per namespace | 0 |
Get max topics per namespace
Command:
$ pulsar-admin namespaces get-max-topics-per-namespace options
Remove max topics per namespace
Command:
$ pulsar-admin namespaces remove-max-topics-per-namespace options
Set property for a namespace
Command:
$ pulsar-admin namespaces set-property options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--key, -k |
Key of the property | null | |
--value, -v |
Value of the property | null |
Get property for a namespace
Command:
$ pulsar-admin namespaces get-property options
Options:
| Flag | Description | Default |
|---|---|---|
--key, -k |
Key of the property | null |
Remove property for a namespace
Command:
$ pulsar-admin namespaces remove-property options
Options:
| Flag | Description | Default |
|---|---|---|
--key, -k |
Key of the property | null |
Set properties of a namespace
Command:
$ pulsar-admin namespaces set-properties options
Options:
| Flag | Description | Default |
|---|---|---|
--properties, -p |
key value pair properties(a=a,b=b,c=c) | null |
Get properties of a namespace
Command:
$ pulsar-admin namespaces get-properties options
Clear all properties for a namespace
Command:
$ pulsar-admin namespaces clear-properties options
Get ResourceGroup for a namespace
Command:
$ pulsar-admin namespaces get-resource-group options
Set ResourceGroup for a namespace
Command:
$ pulsar-admin namespaces set-resource-group options
Options:
| Flag | Description | Default |
|---|---|---|
--resource-group-name, -rgn |
ResourceGroup name | null |
Remove ResourceGroup from a namespace
Command:
$ pulsar-admin namespaces remove-resource-group options
$ns-isolation-policy
Operations about namespace isolation policy
$ pulsar-admin ns-isolation-policy subcommand
setgetlistdeletebrokersbrokerCreate/Update a namespace isolation policy for a cluster. This operation requires Pulsar super-user privileges
Command:
$ pulsar-admin ns-isolation-policy set options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--auto-failover-policy-type |
auto failover policy type name ['min_available'] | null | |
--namespaces |
comma separated namespaces-regex list | null | |
--primary |
comma separated primary-broker-regex list. In Pulsar, when namespaces (more specifically, namespace bundles) are assigned dynamically to brokers, the namespace isolation policy limits the set of brokers that can be used for assignment. Before topics are assigned to brokers, you can set the namespace isolation policy with a primary or a secondary regex to select desired brokers. If no broker matches the specified regex, you cannot create a topic. If there are not enough primary brokers, topics are assigned to secondary brokers. If there are not enough secondary brokers, topics are assigned to other brokers which do not have any isolation policies. | null | |
--secondary |
comma separated secondary-broker-regex list | [] | |
--auto-failover-policy-params |
comma separated name=value auto failover policy parameters | null |
Get namespace isolation policy of a cluster. This operation requires Pulsar super-user privileges
Command:
$ pulsar-admin ns-isolation-policy get options
List all namespace isolation policies of a cluster. This operation requires Pulsar super-user privileges
Command:
$ pulsar-admin ns-isolation-policy list options
Delete namespace isolation policy of a cluster. This operation requires Pulsar super-user privileges
Command:
$ pulsar-admin ns-isolation-policy delete options
List all brokers with namespace-isolation policies attached to it. This operation requires Pulsar super-user privileges
Command:
$ pulsar-admin ns-isolation-policy brokers options
Get broker with namespace-isolation policies attached to it. This operation requires Pulsar super-user privileges
Command:
$ pulsar-admin ns-isolation-policy broker options
Options:
| Flag | Description | Default |
|---|---|---|
--broker |
Broker-name to get namespace-isolation policies attached to it | null |
$packages
Operations about packages
$ pulsar-admin packages subcommand
get-metadataupdate-metadatauploaddownloadlistlist-versionsdeleteGet a package metadata information.
Command:
$ pulsar-admin packages get-metadata options
Update a package metadata information.
Command:
$ pulsar-admin packages update-metadata options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-d, --description |
descriptions of a package | null | |
--properties, -P |
external information of a package | {} | |
-c, --contact |
contact info of a package | null |
Upload a package
Command:
$ pulsar-admin packages upload options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--contact |
contact information of a package | null | |
--path |
file path of the package | null | |
--properties, -P |
external infromations of a package | {} | |
--description |
descriptions of a package | null |
Download a package
Command:
$ pulsar-admin packages download options
Options:
| Flag | Description | Default |
|---|---|---|
--path |
download destiny path of the package | null |
List all packages with given type in the specified namespace
Command:
$ pulsar-admin packages list options
Options:
| Flag | Description | Default |
|---|---|---|
--type |
type of the package | null |
List all versions of the given package
Command:
$ pulsar-admin packages list-versions options
Delete a package
Command:
$ pulsar-admin packages delete options
$proxy-stats
Operations to collect Proxy statistics
$ pulsar-admin proxy-stats subcommand
connectionstopicsdump connections metrics for Monitoring
Command:
$ pulsar-admin proxy-stats connections options
Options:
| Flag | Description | Default |
|---|---|---|
-i, --indent |
Indent JSON output | false |
dump topics metrics for Monitoring
Command:
$ pulsar-admin proxy-stats topics options
Options:
| Flag | Description | Default |
|---|---|---|
-i, --indent |
Indent JSON output | false |
$resource-quotas
Operations about resource quotas
$ pulsar-admin resource-quotas subcommand
getsetreset-namespace-bundle-quotaGet the resource quota for specified namespace bundle, or default quota if no namespace/bundle specified.
Command:
$ pulsar-admin resource-quotas get options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--namespace, -n |
tenant/namespace, must be specified together with '--bundle' | null | |
--bundle, -b |
{start-boundary}_{end-boundary}, must be specified together with '--namespace' | null |
Set the resource quota for specified namespace bundle, or default quota if no namespace/bundle specified.
Command:
$ pulsar-admin resource-quotas set options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--msgRateIn, -mi |
expected incoming messages per second | 0 | |
--bandwidthIn, -bi |
expected inbound bandwidth (bytes/second) | 0 | |
--msgRateOut, -mo |
expected outgoing messages per second | 0 | |
--namespace, -n |
tenant/namespace, must be specified together with '--bundle' | null | |
--bundle, -b |
{start-boundary}_{end-boundary}, must be specified together with '--namespace' | null | |
--memory, -mem |
expected memory usage (Mbytes) | 0 | |
--dynamic, -d |
dynamic (allow to be dynamically re-calculated) or not | false | |
--bandwidthOut, -bo |
expected outbound bandwidth (bytes/second) | 0 |
Reset the specified namespace bundle's resource quota to default value.
Command:
$ pulsar-admin resource-quotas reset-namespace-bundle-quota options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--bundle, -b |
{start-boundary}_{end-boundary} | null | |
--namespace, -n |
tenant/namespace | null |
$resourcegroups
Operations about ResourceGroups
$ pulsar-admin resourcegroups subcommand
listgetcreateupdatedeleteList the existing resourcegroups
Command:
$ pulsar-admin resourcegroups list options
Gets the configuration of a resourcegroup
Command:
$ pulsar-admin resourcegroups get options
Creates a new resourcegroup
Command:
$ pulsar-admin resourcegroups create options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--msg-publish-rate, -mp |
message-publish-rate (default -1 will be overwrite if not passed) | null | |
--byte-dispatch-rate, -bd |
byte-dispatch-rate (default -1 will be overwrite if not passed) | null | |
--byte-publish-rate, -bp |
byte-publish-rate (default -1 will be overwrite if not passed) | null | |
--msg-dispatch-rate, -md |
message-dispatch-rate (default -1 will be overwrite if not passed) | null |
Updates a resourcegroup
Command:
$ pulsar-admin resourcegroups update options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--byte-publish-rate, -bp |
byte-publish-rate | null | |
--msg-publish-rate, -mp |
message-publish-rate | null | |
--msg-dispatch-rate, -md |
message-dispatch-rate | null | |
--byte-dispatch-rate, -bd |
byte-dispatch-rate | null |
Deletes an existing ResourceGroup
Command:
$ pulsar-admin resourcegroups delete options
$schemas
Operations about schemas
$ pulsar-admin schemas subcommand
getdeleteuploadextractGet the schema for a topic
Command:
$ pulsar-admin schemas get options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-a, --all-version |
all version | false | |
-v, --version |
version | null |
Delete the latest schema for a topic
Command:
$ pulsar-admin schemas delete options
Options:
| Flag | Description | Default |
|---|---|---|
-f, --force |
whether to delete schema completely. If true, delete all resources (including metastore and ledger), otherwise only do a mark deletion and not remove any resources indeed | false |
Update the schema for a topic
Command:
$ pulsar-admin schemas upload options
Options:
| Flag | Description | Default |
|---|---|---|
-f, --filename |
filename | null |
Provide the schema via a topic
Command:
$ pulsar-admin schemas extract options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-n, --dry-run |
dost not apply to schema registry, just prints the post schema payload | false | |
-c, --classname |
class name of pojo | null | |
-j, --jar |
jar filepath | null | |
-a, --always-allow-null |
set schema whether always allow null or not | true | |
-t, --type |
type avro or json | null |
$sinks
Interface for managing Pulsar IO sinks (egress data from Pulsar)
$ pulsar-admin sinks subcommand
createupdatedeletelistgetstatusstopstartrestartlocalrunavailable-sinksreloadSubmit a Pulsar IO sink connector to run in a Pulsar cluster
Command:
$ pulsar-admin sinks create options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The sink's name | null | |
--retain-key-ordering |
Sink consumes and processes messages in key order | null | |
--topics-pattern |
The topic pattern to consume from a list of topics under a namespace that matches the pattern. [--input] and [--topics-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs | null | |
--sink-config-file |
The path to a YAML config file specifying the sink's configuration | null | |
--sink-config |
User defined configs key/values | null | |
--cpu |
The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime) | null | |
--tenant |
The sink's tenant | null | |
--disk |
The disk (in bytes) that need to be allocated per sink instance (applicable only to Docker runtime) | null | |
--dead-letter-topic |
Name of the dead topic where the failing messages will be sent. | null | |
-i, --inputs |
The sink's input topic or topics (multiple topics can be specified as a comma-separated list) | null | |
--processing-guarantees |
The processing guarantees (aka delivery semantics) applied to the sink | null | |
--subs-position |
Pulsar source subscription position if user wants to consume messages from the specified location | null | |
--ram |
The RAM (in bytes) that need to be allocated per sink instance (applicable only to the process and Docker runtimes) | null | |
--custom-serde-inputs |
The map of input topics to SerDe class names (as a JSON string) | null | |
-t, --sink-type |
The sinks's connector provider | null | |
--custom-schema-inputs |
The map of input topics to Schema types or class names (as a JSON string) | null | |
--namespace |
The sink's namespace | null | |
--retain-ordering |
Sink consumes and sinks messages in order | null | |
--parallelism |
The sink's parallelism factor (i.e. the number of sink instances to run) | null | |
--secrets |
The map of secretName to an object that encapsulates how the secret is fetched by the underlying secrets provider | null | |
--input-specs |
The map of inputs to custom configuration (as a JSON string) | null | |
--classname |
The sink's class name if archive is file-url-path (file://) | null | |
--custom-runtime-options |
A string that encodes options to customize the runtime, see docs for configured runtime for details | null | |
--timeout-ms |
The message timeout in milliseconds | null | |
--negative-ack-redelivery-delay-ms |
The negative ack message redelivery delay in milliseconds | null | |
--subs-name |
Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer | null | |
--auto-ack |
Whether or not the framework will automatically acknowledge messages | null | |
--max-redeliver-count |
Maximum number of times that a message will be redelivered before being sent to the dead letter queue | null | |
-a, --archive |
Path to the archive file for the sink. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. | null |
Update a Pulsar IO sink connector
Command:
$ pulsar-admin sinks update options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The sink's name | null | |
--retain-key-ordering |
Sink consumes and processes messages in key order | null | |
--topics-pattern |
The topic pattern to consume from a list of topics under a namespace that matches the pattern. [--input] and [--topics-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs | null | |
--sink-config-file |
The path to a YAML config file specifying the sink's configuration | null | |
--sink-config |
User defined configs key/values | null | |
--cpu |
The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime) | null | |
--tenant |
The sink's tenant | null | |
--update-auth-data |
Whether or not to update the auth data | false | |
--disk |
The disk (in bytes) that need to be allocated per sink instance (applicable only to Docker runtime) | null | |
--dead-letter-topic |
Name of the dead topic where the failing messages will be sent. | null | |
-i, --inputs |
The sink's input topic or topics (multiple topics can be specified as a comma-separated list) | null | |
--processing-guarantees |
The processing guarantees (aka delivery semantics) applied to the sink | null | |
--subs-position |
Pulsar source subscription position if user wants to consume messages from the specified location | null | |
--ram |
The RAM (in bytes) that need to be allocated per sink instance (applicable only to the process and Docker runtimes) | null | |
--custom-serde-inputs |
The map of input topics to SerDe class names (as a JSON string) | null | |
-t, --sink-type |
The sinks's connector provider | null | |
--custom-schema-inputs |
The map of input topics to Schema types or class names (as a JSON string) | null | |
--namespace |
The sink's namespace | null | |
--retain-ordering |
Sink consumes and sinks messages in order | null | |
--parallelism |
The sink's parallelism factor (i.e. the number of sink instances to run) | null | |
--secrets |
The map of secretName to an object that encapsulates how the secret is fetched by the underlying secrets provider | null | |
--input-specs |
The map of inputs to custom configuration (as a JSON string) | null | |
--classname |
The sink's class name if archive is file-url-path (file://) | null | |
--custom-runtime-options |
A string that encodes options to customize the runtime, see docs for configured runtime for details | null | |
--timeout-ms |
The message timeout in milliseconds | null | |
--negative-ack-redelivery-delay-ms |
The negative ack message redelivery delay in milliseconds | null | |
--subs-name |
Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer | null | |
--auto-ack |
Whether or not the framework will automatically acknowledge messages | null | |
--max-redeliver-count |
Maximum number of times that a message will be redelivered before being sent to the dead letter queue | null | |
-a, --archive |
Path to the archive file for the sink. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. | null |
Stops a Pulsar IO sink connector
Command:
$ pulsar-admin sinks delete options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The sink's name | null | |
--namespace |
The sink's namespace | null | |
--tenant |
The sink's tenant | null |
List all running Pulsar IO sink connectors
Command:
$ pulsar-admin sinks list options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--tenant |
The sink's tenant | null | |
--namespace |
The sink's namespace | null |
Gets the information about a Pulsar IO sink connector
Command:
$ pulsar-admin sinks get options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The sink's name | null | |
--namespace |
The sink's namespace | null | |
--tenant |
The sink's tenant | null |
Check the current status of a Pulsar Sink
Command:
$ pulsar-admin sinks status options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The sink's name | null | |
--namespace |
The sink's namespace | null | |
--instance-id |
The sink instanceId (Get-status of all instances if instance-id is not provided | null | |
--tenant |
The sink's tenant | null |
Stops sink instance
Command:
$ pulsar-admin sinks stop options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The sink's name | null | |
--namespace |
The sink's namespace | null | |
--tenant |
The sink's tenant | null | |
--instance-id |
The sink instanceId (stop all instances if instance-id is not provided | null |
Starts sink instance
Command:
$ pulsar-admin sinks start options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--name |
The sink's name | null | |
--namespace |
The sink's namespace | null | |
--tenant |
The sink's tenant | null | |
--instance-id |
The sink instanceId (start all instances if instance-id is not provided | null |
Restart sink instance
Command:
$ pulsar-admin sinks restart options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--instance-id |
The sink instanceId (restart all instances if instance-id is not provided | null | |
--name |
The sink's name | null | |
--namespace |
The sink's namespace | null | |
--tenant |
The sink's tenant | null |
Run a Pulsar IO sink connector locally (rather than deploying it to the Pulsar cluster)
Command:
$ pulsar-admin sinks localrun options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--tls-allow-insecure |
Allow insecure tls connection | false | |
--secrets-provider-classname |
Whats the classname for secrets provider | null | |
--topics-pattern |
The topic pattern to consume from a list of topics under a namespace that matches the pattern. [--input] and [--topics-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs | null | |
--sink-config-file |
The path to a YAML config file specifying the sink's configuration | null | |
--cpu |
The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime) | null | |
--tenant |
The sink's tenant | null | |
--disk |
The disk (in bytes) that need to be allocated per sink instance (applicable only to Docker runtime) | null | |
--dead-letter-topic |
Name of the dead topic where the failing messages will be sent. | null | |
-i, --inputs |
The sink's input topic or topics (multiple topics can be specified as a comma-separated list) | null | |
--subs-position |
Pulsar source subscription position if user wants to consume messages from the specified location | null | |
--secrets-provider-config |
Config that needs to be passed to secrets provider | null | |
--hostname-verification-enabled |
Enable hostname verification | false | |
--retain-ordering |
Sink consumes and sinks messages in order | null | |
--parallelism |
The sink's parallelism factor (i.e. the number of sink instances to run) | null | |
--input-specs |
The map of inputs to custom configuration (as a JSON string) | null | |
--use-tls |
Use tls connection | false | |
--classname |
The sink's class name if archive is file-url-path (file://) | null | |
--timeout-ms |
The message timeout in milliseconds | null | |
--subs-name |
Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer | null | |
--max-redeliver-count |
Maximum number of times that a message will be redelivered before being sent to the dead letter queue | null | |
-a, --archive |
Path to the archive file for the sink. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. | null | |
--name |
The sink's name | null | |
--retain-key-ordering |
Sink consumes and processes messages in key order | null | |
--sink-config |
User defined configs key/values | null | |
--state-storage-service-url |
The URL for the state storage service (the default is Apache BookKeeper) | null | |
--client-auth-params |
Client authentication param | null | |
--processing-guarantees |
The processing guarantees (aka delivery semantics) applied to the sink | null | |
--client-auth-plugin |
Client authentication plugin using which function-process can connect to broker | null | |
--ram |
The RAM (in bytes) that need to be allocated per sink instance (applicable only to the process and Docker runtimes) | null | |
--custom-serde-inputs |
The map of input topics to SerDe class names (as a JSON string) | null | |
-t, --sink-type |
The sinks's connector provider | null | |
--custom-schema-inputs |
The map of input topics to Schema types or class names (as a JSON string) | null | |
--namespace |
The sink's namespace | null | |
--secrets |
The map of secretName to an object that encapsulates how the secret is fetched by the underlying secrets provider | null | |
--custom-runtime-options |
A string that encodes options to customize the runtime, see docs for configured runtime for details | null | |
--negative-ack-redelivery-delay-ms |
The negative ack message redelivery delay in milliseconds | null | |
--broker-service-url |
The URL for the Pulsar broker | null | |
--tls-trust-cert-path |
tls trust cert file path | null | |
--metrics-port-start |
The starting port range for metrics server | null | |
--auto-ack |
Whether or not the framework will automatically acknowledge messages | null |
Get the list of Pulsar IO connector sinks supported by Pulsar cluster
Command:
$ pulsar-admin sinks available-sinks options
Reload the available built-in connectors
Command:
$ pulsar-admin sinks reload options
$sources
Interface for managing Pulsar IO Sources (ingress data into Pulsar)
$ pulsar-admin sources subcommand
createupdatedeletegetstatusliststopstartrestartlocalrunavailable-sourcesreloadSubmit a Pulsar IO source connector to run in a Pulsar cluster
Command:
$ pulsar-admin sources create options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--processing-guarantees |
The processing guarantees (aka delivery semantics) applied to the source | null | |
--disk |
The disk (in bytes) that need to be allocated per source instance (applicable only to Docker runtime) | null | |
--producer-config |
The custom producer configuration (as a JSON string) | null | |
--batch-builder |
BatchBuilder provides two types of batch construction methods, DEFAULT and KEY_BASED. The default value is: DEFAULT | null | |
--custom-runtime-options |
A string that encodes options to customize the runtime, see docs for configured runtime for details | null | |
--source-config |
Source config key/values | null | |
--ram |
The RAM (in bytes) that need to be allocated per source instance (applicable only to the process and Docker runtimes) | null | |
--secrets |
The map of secretName to an object that encapsulates how the secret is fetched by the underlying secrets provider | null | |
-st, --schema-type |
The schema type (either a builtin schema like 'avro', 'json', etc.. or custom Schema class name to be used to encode messages emitted from the source | null | |
--batch-source-config |
Batch source config key/values | null | |
--deserialization-classname |
The SerDe classname for the source | null | |
--cpu |
The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime) | null | |
-a, --archive |
The path to the NAR archive for the Source. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. | null | |
--source-config-file |
The path to a YAML config file specifying the source's configuration | null | |
--parallelism |
The source's parallelism factor (i.e. the number of source instances to run) | null | |
--namespace |
The source's namespace | null | |
--name |
The source's name | null | |
--destination-topic-name |
The Pulsar topic to which data is sent | null | |
-t, --source-type |
The source's connector provider | null | |
--classname |
The source's class name if archive is file-url-path (file://) | null | |
--tenant |
The source's tenant | null |
Update a Pulsar IO source connector
Command:
$ pulsar-admin sources update options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--processing-guarantees |
The processing guarantees (aka delivery semantics) applied to the source | null | |
--disk |
The disk (in bytes) that need to be allocated per source instance (applicable only to Docker runtime) | null | |
--producer-config |
The custom producer configuration (as a JSON string) | null | |
--batch-builder |
BatchBuilder provides two types of batch construction methods, DEFAULT and KEY_BASED. The default value is: DEFAULT | null | |
--custom-runtime-options |
A string that encodes options to customize the runtime, see docs for configured runtime for details | null | |
--source-config |
Source config key/values | null | |
--ram |
The RAM (in bytes) that need to be allocated per source instance (applicable only to the process and Docker runtimes) | null | |
--secrets |
The map of secretName to an object that encapsulates how the secret is fetched by the underlying secrets provider | null | |
--update-auth-data |
Whether or not to update the auth data | false | |
-st, --schema-type |
The schema type (either a builtin schema like 'avro', 'json', etc.. or custom Schema class name to be used to encode messages emitted from the source | null | |
--batch-source-config |
Batch source config key/values | null | |
--deserialization-classname |
The SerDe classname for the source | null | |
--cpu |
The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime) | null | |
-a, --archive |
The path to the NAR archive for the Source. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. | null | |
--source-config-file |
The path to a YAML config file specifying the source's configuration | null | |
--parallelism |
The source's parallelism factor (i.e. the number of source instances to run) | null | |
--namespace |
The source's namespace | null | |
--name |
The source's name | null | |
--destination-topic-name |
The Pulsar topic to which data is sent | null | |
-t, --source-type |
The source's connector provider | null | |
--classname |
The source's class name if archive is file-url-path (file://) | null | |
--tenant |
The source's tenant | null |
Stops a Pulsar IO source connector
Command:
$ pulsar-admin sources delete options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--namespace |
The source's namespace | null | |
--name |
The source's name | null | |
--tenant |
The source's tenant | null |
Gets the information about a Pulsar IO source connector
Command:
$ pulsar-admin sources get options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--namespace |
The source's namespace | null | |
--name |
The source's name | null | |
--tenant |
The source's tenant | null |
Check the current status of a Pulsar Source
Command:
$ pulsar-admin sources status options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--instance-id |
The source instanceId (Get-status of all instances if instance-id is not provided | null | |
--namespace |
The source's namespace | null | |
--name |
The source's name | null | |
--tenant |
The source's tenant | null |
List all running Pulsar IO source connectors
Command:
$ pulsar-admin sources list options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--namespace |
The sink's namespace | null | |
--tenant |
The sink's tenant | null |
Stop source instance
Command:
$ pulsar-admin sources stop options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--instance-id |
The source instanceId (stop all instances if instance-id is not provided | null | |
--namespace |
The source's namespace | null | |
--name |
The source's name | null | |
--tenant |
The source's tenant | null |
Start source instance
Command:
$ pulsar-admin sources start options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--instance-id |
The source instanceId (start all instances if instance-id is not provided | null | |
--namespace |
The source's namespace | null | |
--name |
The source's name | null | |
--tenant |
The source's tenant | null |
Restart source instance
Command:
$ pulsar-admin sources restart options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--instance-id |
The source instanceId (restart all instances if instance-id is not provided | null | |
--namespace |
The source's namespace | null | |
--name |
The source's name | null | |
--tenant |
The source's tenant | null |
Run a Pulsar IO source connector locally (rather than deploying it to the Pulsar cluster)
Command:
$ pulsar-admin sources localrun options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--processing-guarantees |
The processing guarantees (aka delivery semantics) applied to the source | null | |
--disk |
The disk (in bytes) that need to be allocated per source instance (applicable only to Docker runtime) | null | |
--producer-config |
The custom producer configuration (as a JSON string) | null | |
--batch-builder |
BatchBuilder provides two types of batch construction methods, DEFAULT and KEY_BASED. The default value is: DEFAULT | null | |
--custom-runtime-options |
A string that encodes options to customize the runtime, see docs for configured runtime for details | null | |
--broker-service-url |
The URL for the Pulsar broker | null | |
--tls-allow-insecure |
Allow insecure tls connection | false | |
--secrets-provider-classname |
Whats the classname for secrets provider | null | |
--secrets-provider-config |
Config that needs to be passed to secrets provider | null | |
--source-config |
Source config key/values | null | |
--ram |
The RAM (in bytes) that need to be allocated per source instance (applicable only to the process and Docker runtimes) | null | |
--secrets |
The map of secretName to an object that encapsulates how the secret is fetched by the underlying secrets provider | null | |
--use-tls |
Use tls connection | false | |
-st, --schema-type |
The schema type (either a builtin schema like 'avro', 'json', etc.. or custom Schema class name to be used to encode messages emitted from the source | null | |
--batch-source-config |
Batch source config key/values | null | |
--deserialization-classname |
The SerDe classname for the source | null | |
--hostname-verification-enabled |
Enable hostname verification | false | |
--cpu |
The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime) | null | |
--client-auth-plugin |
Client authentication plugin using which function-process can connect to broker | null | |
--state-storage-service-url |
The URL for the state storage service (the default is Apache BookKeeper) | null | |
-a, --archive |
The path to the NAR archive for the Source. It also supports url-path [http/https/file (file protocol assumes that file already exists on worker host)] from which worker can download the package. | null | |
--source-config-file |
The path to a YAML config file specifying the source's configuration | null | |
--tls-trust-cert-path |
tls trust cert file path | null | |
--parallelism |
The source's parallelism factor (i.e. the number of source instances to run) | null | |
--namespace |
The source's namespace | null | |
--client-auth-params |
Client authentication param | null | |
--name |
The source's name | null | |
--metrics-port-start |
The starting port range for metrics server | null | |
--destination-topic-name |
The Pulsar topic to which data is sent | null | |
-t, --source-type |
The source's connector provider | null | |
--classname |
The source's class name if archive is file-url-path (file://) | null | |
--tenant |
The source's tenant | null |
Get the list of Pulsar IO connector sources supported by Pulsar cluster
Command:
$ pulsar-admin sources available-sources options
Reload the available built-in connectors
Command:
$ pulsar-admin sources reload options
$tenants
Operations about tenants
$ pulsar-admin tenants subcommand
listgetcreateupdatedeleteList the existing tenants
Command:
$ pulsar-admin tenants list options
Gets the configuration of a tenant
Command:
$ pulsar-admin tenants get options
Creates a new tenant
Command:
$ pulsar-admin tenants create options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--allowed-clusters, -c |
Comma separated allowed clusters. If empty, the tenant will have access to all clusters | null | |
--admin-roles, -r |
Comma separated list of auth principal allowed to administrate the tenant | null |
Updates the configuration for a tenant
Command:
$ pulsar-admin tenants update options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--allowed-clusters, -c |
Comma separated allowed clusters. If omitted, the current set of clusters will be preserved | null | |
--admin-roles, -r |
Comma separated list of auth principal allowed to administrate the tenant. If empty the current set of roles won't be modified | null |
Deletes an existing tenant
Command:
$ pulsar-admin tenants delete options
Options:
| Flag | Description | Default |
|---|---|---|
-f, --force |
Delete a tenant forcefully by deleting all namespaces under it. | false |
$topics
Operations on persistent topics
$ pulsar-admin topics subcommand
listlist-partitioned-topicspermissionsgrant-permissionrevoke-permissionlookuppartitioned-lookupbundle-rangedeletetruncateunloadsubscriptionsunsubscribecreate-subscriptionupdate-subscription-propertiesget-subscription-propertiesstatsstats-internalinfo-internalpartitioned-statspartitioned-stats-internalskipclear-backlogexpire-messagesexpire-messages-all-subscriptionscreate-partitioned-topiccreate-missed-partitionscreateupdate-partitioned-topicget-partitioned-topic-metadataget-propertiesdelete-partitioned-topicpeek-messagesexamine-messagesget-message-by-idget-message-idreset-cursorterminatepartitioned-terminatecompactcompaction-statusoffloadoffload-statuslast-message-idget-backlog-quotasset-backlog-quotaremove-backlog-quotaget-message-ttlset-message-ttlremove-message-ttlget-retentionset-retentionremove-retentionenable-deduplicationdisable-deduplicationget-deduplication-enabledset-deduplicationget-deduplicationremove-deduplicationget-deduplication-snapshot-intervalset-deduplication-snapshot-intervalremove-deduplication-snapshot-intervalget-delayed-deliveryset-delayed-deliveryremove-delayed-deliveryget-persistenceset-persistenceremove-persistenceget-offload-policiesset-offload-policiesremove-offload-policiesget-dispatch-rateset-dispatch-rateremove-dispatch-rateget-subscription-dispatch-rateset-subscription-dispatch-rateremove-subscription-dispatch-rateget-replicator-dispatch-rateset-replicator-dispatch-rateremove-replicator-dispatch-rateget-compaction-thresholdset-compaction-thresholdremove-compaction-thresholdget-max-unacked-messages-on-consumerset-max-unacked-messages-on-consumerremove-max-unacked-messages-on-consumerget-max-unacked-messages-on-subscriptionset-max-unacked-messages-on-subscriptionremove-max-unacked-messages-on-subscriptionget-max-unacked-messages-per-consumerset-max-unacked-messages-per-consumerremove-max-unacked-messages-per-consumerget-max-unacked-messages-per-subscriptionset-max-unacked-messages-per-subscriptionremove-max-unacked-messages-per-subscriptionget-publish-rateset-publish-rateremove-publish-rateset-subscription-types-enabledget-subscription-types-enabledremove-subscription-types-enabledget-maxProducersset-maxProducersremove-maxProducersget-max-producersset-max-producersremove-max-producersget-max-subscriptionsset-max-subscriptionsremove-max-subscriptionsget-max-message-sizeset-max-message-sizeremove-max-message-sizeget-max-consumers-per-subscriptionset-max-consumers-per-subscriptionremove-max-consumers-per-subscriptionget-inactive-topic-policiesset-inactive-topic-policiesremove-inactive-topic-policiesget-max-consumersset-max-consumersremove-max-consumersget-subscribe-rateset-subscribe-rateremove-subscribe-rateset-replicated-subscription-statusget-replicated-subscription-statusget-backlog-sizeanalyze-backlogget-replication-clustersset-replication-clustersremove-replication-clustersget-schema-validation-enforceset-schema-validation-enforceGet the list of topics under a namespace.
Command:
$ pulsar-admin topics list options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-b, --bundle |
Namespace bundle to get list of topics | null | |
-ist, --include-system-topic |
Include system topic | false | |
-td, --topic-domain |
Allowed topic domain (persistent, non_persistent). | null |
Get the list of partitioned topics under a namespace.
Command:
$ pulsar-admin topics list-partitioned-topics options
Options:
| Flag | Description | Default |
|---|---|---|
-ist, --include-system-topic |
Include system topic | false |
Get the permissions on a topic. Retrieve the effective permissions for a topic. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permission set on the topic.
Command:
$ pulsar-admin topics permissions options
Grant a new permission to a client role on a single topic.
Command:
$ pulsar-admin topics grant-permission options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-r, --role |
Client role to which grant permissions | null | |
-a, --actions |
Actions to be granted (produce,consume,sources,sinks,functions,packages) | null |
Revoke permissions on a topic. Revoke permissions to a client role on a single topic. If the permission was not set at the topic level, but rather at the namespace level, this operation will return an error (HTTP status code 412).
Command:
$ pulsar-admin topics revoke-permission options
Options:
| Flag | Description | Default |
|---|---|---|
-r, --role |
Client role to which revoke permissions | null |
Lookup a topic from the current serving broker
Command:
$ pulsar-admin topics lookup options
Lookup a partitioned topic from the current serving broker
Command:
$ pulsar-admin topics partitioned-lookup options
Options:
| Flag | Description | Default |
|---|---|---|
-s, --sort-by-broker |
Sort partitioned-topic by Broker Url | false |
Get Namespace bundle range of a topic
Command:
$ pulsar-admin topics bundle-range options
Delete a topic. The topic cannot be deleted if there's any active subscription or producers connected to it.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later.
Command:
$ pulsar-admin topics delete options
Options:
| Flag | Description | Default |
|---|---|---|
-f, --force |
Close all producer/consumer/replicator and delete topic forcefully | false |
Truncate a topic. The truncate operation will move all cursors to the end of the topic and delete all inactive ledgers.
Command:
$ pulsar-admin topics truncate options
Unload a topic.
Command:
$ pulsar-admin topics unload options
Get the list of subscriptions on the topic
Command:
$ pulsar-admin topics subscriptions options
Delete a durable subscriber from a topic. The subscription cannot be deleted if there are any active consumers attached to it
Command:
$ pulsar-admin topics unsubscribe options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-f, --force |
Disconnect and close all consumers and delete subscription forcefully | false | |
-s, --subscription |
Subscription to be deleted | null |
Create a new subscription on a topic
Command:
$ pulsar-admin topics create-subscription options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-s, --subscription |
Subscription to reset position on | null | |
-m, --messageId |
messageId where to create the subscription. It can be either 'latest', 'earliest' or (ledgerId:entryId) | latest | |
-r, --replicated |
replicated subscriptions | false | |
--property, -p |
key value pair properties(-p a=b -p c=d) | null |
Update the properties of a subscription on a topic
Command:
$ pulsar-admin topics update-subscription-properties options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--property, -p |
key value pair properties(-p a=b -p c=d) | null | |
-s, --subscription |
Subscription to update | null | |
--clear, -c |
Remove all properties | false |
Get the properties of a subscription on a topic
Command:
$ pulsar-admin topics get-subscription-properties options
Options:
| Flag | Description | Default |
|---|---|---|
-s, --subscription |
Subscription to describe | null |
Get the stats for the topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.
Command:
$ pulsar-admin topics stats options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-sbs, --get-subscription-backlog-size |
Set true to get backlog size for each subscription, locking required. | false | |
-gpb, --get-precise-backlog |
Set true to get precise backlog | false | |
-etb, --get-earliest-time-in-backlog |
Set true to get earliest time in backlog | false |
Get the internal stats for the topic
Command:
$ pulsar-admin topics stats-internal options
Options:
| Flag | Description | Default |
|---|---|---|
-m, --metadata |
Flag to include ledger metadata | false |
Get the internal metadata info for the topic
Command:
$ pulsar-admin topics info-internal options
Get the stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.
Command:
$ pulsar-admin topics partitioned-stats options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-gpb, --get-precise-backlog |
Set true to get precise backlog | false | |
-sbs, --get-subscription-backlog-size |
Set true to get backlog size for each subscription, locking required. | false | |
-etb, --get-earliest-time-in-backlog |
Set true to get earliest time in backlog | false | |
--per-partition |
Get per partition stats | false |
Get the internal stats for the partitioned topic and its connected producers and consumers. All the rates are computed over a 1 minute window and are relative the last completed 1 minute period.
Command:
$ pulsar-admin topics partitioned-stats-internal options
Skip some messages for the subscription
Command:
$ pulsar-admin topics skip options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-s, --subscription |
Subscription to be skip messages on | null | |
-n, --count |
Number of messages to skip | 0 |
Skip all the messages for the subscription
Command:
$ pulsar-admin topics clear-backlog options
Options:
| Flag | Description | Default |
|---|---|---|
-s, --subscription |
Subscription to be cleared | null |
Expire messages that older than given expiry time (in seconds) for the subscription
Command:
$ pulsar-admin topics expire-messages options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-e, --exclude-reset-position |
Exclude the reset position, start consume messages from the next position. | false | |
-s, --subscription |
Subscription to be skip messages on | null | |
-t, --expireTime |
Expire messages older than time in seconds (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w) | null | |
--position, -p |
message position to reset back to (ledgerId:entryId) | null |
Expire messages that older than given expiry time (in seconds) for all subscriptions
Command:
$ pulsar-admin topics expire-messages-all-subscriptions options
Options:
| Flag | Description | Default |
|---|---|---|
-t, --expireTime |
Expire messages older than time in seconds (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w) | null |
Create a partitioned topic. The partitioned topic has to be created before creating a producer on it.
Command:
$ pulsar-admin topics create-partitioned-topic options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-p, --partitions |
Number of partitions for the topic | 0 | |
--metadata, -m |
key value pair properties(a=a,b=b,c=c) | null |
Try to create partitions for partitioned topic. The partitions of partition topic has to be created, can be used by repair partitions when topic auto creation is disabled
Command:
$ pulsar-admin topics create-missed-partitions options
Create a non-partitioned topic.
Command:
$ pulsar-admin topics create options
Options:
| Flag | Description | Default |
|---|---|---|
--metadata, -m |
key value pair properties(a=a,b=b,c=c) | null |
Update existing non-global partitioned topic. New updating number of partitions must be greater than existing number of partitions.
Command:
$ pulsar-admin topics update-partitioned-topic options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-p, --partitions |
Number of partitions for the topic | 0 | |
-f, --force |
Update forcefully without validating existing partitioned topic | false |
Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, it returns empty topic with 0 partitions
Command:
$ pulsar-admin topics get-partitioned-topic-metadata options
Get the topic properties.
Command:
$ pulsar-admin topics get-properties options
Delete a partitioned topic. It will also delete all the partitions of the topic if it exists.And the application is not able to connect to the topic(delete then re-create with same name) again if the schema auto uploading is disabled. Besides, users should to use the truncate cmd to clean up data of the topic instead of delete cmd if users continue to use this topic later.
Command:
$ pulsar-admin topics delete-partitioned-topic options
Options:
| Flag | Description | Default |
|---|---|---|
-f, --force |
Close all producer/consumer/replicator and delete topic forcefully | false |
Peek some messages for the subscription
Command:
$ pulsar-admin topics peek-messages options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-n, --count |
Number of messages (default 1) | 1 | |
-s, --subscription |
Subscription to get messages from | null |
Examine a specific message on a topic by position relative to the earliest or the latest message.
Command:
$ pulsar-admin topics examine-messages options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-i, --initialPosition |
Relative start position to examine message.It can be 'latest' or 'earliest', default is latest | latest | |
-m, --messagePosition |
The position of messages (default 1) | 1 |
Get message by its ledgerId and entryId
Command:
$ pulsar-admin topics get-message-by-id options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-l, --ledgerId |
ledger id pointing to the desired ledger | 0 | |
-e, --entryId |
entry id pointing to the desired entry | 0 |
Get message ID
Command:
$ pulsar-admin topics get-message-id options
Options:
| Flag | Description | Default |
|---|---|---|
-d, --datetime |
datetime at or before this messageId. This datetime is in format of ISO_OFFSET_DATE_TIME, e.g. 2021-06-28T16:53:08Z or 2021-06-28T16:53:08.123456789+08:00 | null |
Reset position for subscription to a position that is closest to timestamp or messageId.
Command:
$ pulsar-admin topics reset-cursor options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-e, --exclude-reset-position |
Exclude the reset position, start consume messages from the next position. | false | |
--time, -t |
time in minutes to reset back to (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w) | null | |
-s, --subscription |
Subscription to reset position on | null | |
--messageId, -m |
messageId to reset back to ('latest', 'earliest', or 'ledgerId:entryId') | null |
Terminate a topic and don't allow any more messages to be published
Command:
$ pulsar-admin topics terminate options
Terminate a partitioned topic and don't allow any more messages to be published
Command:
$ pulsar-admin topics partitioned-terminate options
Compact a topic
Command:
$ pulsar-admin topics compact options
Status of compaction on a topic
Command:
$ pulsar-admin topics compaction-status options
Options:
| Flag | Description | Default |
|---|---|---|
-w, --wait-complete |
Wait for compaction to complete | false |
Trigger offload of data from a topic to long-term storage (e.g. Amazon S3)
Command:
$ pulsar-admin topics offload options
Options:
| Flag | Description | Default |
|---|---|---|
-s, --size-threshold |
Maximum amount of data to keep in BookKeeper for the specified topic (e.g. 10M, 5G). | null |
Check the status of data offloading from a topic to long-term storage
Command:
$ pulsar-admin topics offload-status options
Options:
| Flag | Description | Default |
|---|---|---|
-w, --wait-complete |
Wait for offloading to complete | false |
get the last commit message id of topic
Command:
$ pulsar-admin topics last-message-id options
Get the backlog quota policies for a topic
Command:
$ pulsar-admin topics get-backlog-quotas options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set a backlog quota policy for a topic
Command:
$ pulsar-admin topics set-backlog-quota options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-l, --limit |
Size limit (eg: 10M, 16G) | -1 | |
-p, --policy |
Retention policy to enforce when the limit is reached. Valid options are: [producer_request_hold, producer_exception, consumer_backlog_eviction] | null | |
-t, --type |
Backlog quota type to set. Valid options are: destination_storage and message_age. destination_storage limits backlog by size (in bytes). message_age limits backlog by time, that is, message timestamp (broker or publish timestamp). You can set size or time to control the backlog, or combine them together to control the backlog. | destination_storage | |
-lt, --limitTime |
Time limit in second (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w), non-positive number for disabling time limit. | null |
Remove a backlog quota policy from a topic
Command:
$ pulsar-admin topics remove-backlog-quota options
Options:
| Flag | Description | Default |
|---|---|---|
-t, --type |
Backlog quota type to remove | destination_storage |
Get the message TTL for a topic
Command:
$ pulsar-admin topics get-message-ttl options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set message TTL for a topic
Command:
$ pulsar-admin topics set-message-ttl options
Options:
| Flag | Description | Default |
|---|---|---|
-t, --ttl |
Message TTL for topic in second (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w), allowed range from 1 to Integer.MAX_VALUE | null |
Remove message TTL for a topic
Command:
$ pulsar-admin topics remove-message-ttl options
Get the retention policy for a topic
Command:
$ pulsar-admin topics get-retention options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set the retention policy for a topic
Command:
$ pulsar-admin topics set-retention options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--size, -s |
Retention size limit (eg: 10M, 16G, 3T). 0 or less than 1MB means no retention and -1 means infinite size retention | null | |
--time, -t |
Retention time in minutes (or minutes, hours,days,weeks eg: 100m, 3h, 2d, 5w). 0 means no retention and -1 means infinite time retention | null |
Remove the retention policy for a topic
Command:
$ pulsar-admin topics remove-retention options
Enable the deduplication policy for a topic
Command:
$ pulsar-admin topics enable-deduplication options
Disable the deduplication policy for a topic
Command:
$ pulsar-admin topics disable-deduplication options
Get the deduplication policy for a topic
Command:
$ pulsar-admin topics get-deduplication-enabled options
Enable or disable deduplication for a topic
Command:
$ pulsar-admin topics set-deduplication options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--disable, -d |
Disable deduplication | false | |
--enable, -e |
Enable deduplication | false |
Get the deduplication policy for a topic
Command:
$ pulsar-admin topics get-deduplication options
Remove the deduplication policy for a topic
Command:
$ pulsar-admin topics remove-deduplication options
Get deduplication snapshot interval for a topic
Command:
$ pulsar-admin topics get-deduplication-snapshot-interval options
Set deduplication snapshot interval for a topic
Command:
$ pulsar-admin topics set-deduplication-snapshot-interval options
Options:
| Flag | Description | Default |
|---|---|---|
-i, --interval |
Deduplication snapshot interval for topic in second, allowed range from 0 to Integer.MAX_VALUE | 0 |
Remove deduplication snapshot interval for a topic
Command:
$ pulsar-admin topics remove-deduplication-snapshot-interval options
Get the delayed delivery policy for a topic
Command:
$ pulsar-admin topics get-delayed-delivery options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set the delayed delivery policy on a topic
Command:
$ pulsar-admin topics set-delayed-delivery options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--disable, -d |
Disable delayed delivery messages | false | |
--enable, -e |
Enable delayed delivery messages | false | |
--time, -t |
The tick time for when retrying on delayed delivery messages, affecting the accuracy of the delivery time compared to the scheduled time. (eg: 1s, 10s, 1m, 5h, 3d) | 1s |
Remove the delayed delivery policy on a topic
Command:
$ pulsar-admin topics remove-delayed-delivery options
Get the persistence policies for a topic
Command:
$ pulsar-admin topics get-persistence options
Set the persistence policies for a topic
Command:
$ pulsar-admin topics set-persistence options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-e, --bookkeeper-ensemble |
Number of bookies to use for a topic | 0 | |
-a, --bookkeeper-ack-quorum |
Number of acks (guaranteed copies) to wait for each entry | 0 | |
-r, --ml-mark-delete-max-rate |
Throttling rate of mark-delete operation (0 means no throttle) | 0.0 | |
-w, --bookkeeper-write-quorum |
How many writes to make of each entry | 0 |
Remove the persistence policy for a topic
Command:
$ pulsar-admin topics remove-persistence options
Get the offload policies for a topic
Command:
$ pulsar-admin topics get-offload-policies options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set the offload policies for a topic
Command:
$ pulsar-admin topics set-offload-policies options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-b, --bucket |
ManagedLedger offload bucket, s3 and google-cloud-storage requires this parameter | null | |
-r, --region |
ManagedLedger offload region, s3 and google-cloud-storage requires this parameter | null | |
--s3-role-session-name, -rsn |
S3 role session name used for STSAssumeRoleSessionCredentialsProvider | null | |
--offloadedReadPriority, -orp |
Read priority for offloaded messages. By default, once messages are offloaded to long-term storage, brokers read messages from long-term storage, but messages can still exist in BookKeeper for a period depends on your configuration. For messages that exist in both long-term storage and BookKeeper, you can set where to read messages from with the option tiered-storage-first or bookkeeper-first. |
null | |
-e, --endpoint |
ManagedLedger offload service endpoint, only s3 requires this parameter | null | |
-dl, --offloadDeletionLagInMillis |
ManagedLedger offload deletion lag in bytes | null | |
-rb, --readBufferSizeInBytes |
ManagedLedger offload read buffer size in bytes,s3 and google-cloud-storage requires this parameter | 0 | |
-i, --aws-id |
AWS Credential Id to use when using driver S3 or aws-s3 | null | |
-d, --driver |
ManagedLedger offload driver | null | |
--ro, --s3-role |
S3 Role used for STSAssumeRoleSessionCredentialsProvider | null | |
-m, --maxBlockSizeInBytes |
ManagedLedger offload max block Size in bytes,s3 and google-cloud-storage requires this parameter | 0 | |
-t, --offloadThresholdInBytes |
ManagedLedger offload threshold in bytes | 0 | |
-s, --aws-secret |
AWS Credential Secret to use when using driver S3 or aws-s3 | null |
Remove the offload policies for a topic
Command:
$ pulsar-admin topics remove-offload-policies options
Get message dispatch rate for a topic
Command:
$ pulsar-admin topics get-dispatch-rate options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set message dispatch rate for a topic
Command:
$ pulsar-admin topics set-dispatch-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--byte-dispatch-rate, -bd |
byte-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--msg-dispatch-rate, -md |
message-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--dispatch-rate-period, -dt |
dispatch-rate-period in second type (default 1 second will be overwrite if not passed) | 1 | |
--relative-to-publish-rate, -rp |
dispatch rate relative to publish-rate (if publish-relative flag is enabled then broker will apply throttling value to (publish-rate + dispatch rate)) | false |
Remove message dispatch rate for a topic
Command:
$ pulsar-admin topics remove-dispatch-rate options
Get subscription message-dispatch-rate for a topic
Command:
$ pulsar-admin topics get-subscription-dispatch-rate options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set subscription message-dispatch-rate for a topic
Command:
$ pulsar-admin topics set-subscription-dispatch-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--relative-to-publish-rate, -rp |
dispatch rate relative to publish-rate (if publish-relative flag is enabled then broker will apply throttling value to (publish-rate + dispatch rate)) | false | |
--dispatch-rate-period, -dt |
dispatch-rate-period in second type (default 1 second will be overwrite if not passed) | 1 | |
--byte-dispatch-rate, -bd |
byte-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--msg-dispatch-rate, -md |
message-dispatch-rate (default -1 will be overwrite if not passed) | -1 |
Remove subscription message-dispatch-rate for a topic
Command:
$ pulsar-admin topics remove-subscription-dispatch-rate options
Get replicator message-dispatch-rate for a topic
Command:
$ pulsar-admin topics get-replicator-dispatch-rate options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set replicator message-dispatch-rate for a topic
Command:
$ pulsar-admin topics set-replicator-dispatch-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--byte-dispatch-rate, -bd |
byte-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--dispatch-rate-period, -dt |
dispatch-rate-period in second type (default 1 second will be overwrite if not passed) | 1 | |
--msg-dispatch-rate, -md |
message-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--relative-to-publish-rate, -rp |
dispatch rate relative to publish-rate (if publish-relative flag is enabled then broker will apply throttling value to (publish-rate + dispatch rate)) | false |
Remove replicator message-dispatch-rate for a topic
Command:
$ pulsar-admin topics remove-replicator-dispatch-rate options
Get compaction threshold for a topic
Command:
$ pulsar-admin topics get-compaction-threshold options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set compaction threshold for a topic
Command:
$ pulsar-admin topics set-compaction-threshold options
Options:
| Flag | Description | Default |
|---|---|---|
--threshold, -t |
Maximum number of bytes in a topic backlog before compaction is triggered (eg: 10M, 16G, 3T). 0 disables automatic compaction | 0 |
Remove compaction threshold for a topic
Command:
$ pulsar-admin topics remove-compaction-threshold options
Get max unacked messages policy on consumer for a topic
Command:
$ pulsar-admin topics get-max-unacked-messages-on-consumer options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set max unacked messages policy on consumer for a topic
Command:
$ pulsar-admin topics set-max-unacked-messages-on-consumer options
Options:
| Flag | Description | Default |
|---|---|---|
-m, --maxNum |
max unacked messages num on consumer | 0 |
Remove max unacked messages policy on consumer for a topic
Command:
$ pulsar-admin topics remove-max-unacked-messages-on-consumer options
Get max unacked messages policy on subscription for a topic
Command:
$ pulsar-admin topics get-max-unacked-messages-on-subscription options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set max unacked messages policy on subscription for a topic
Command:
$ pulsar-admin topics set-max-unacked-messages-on-subscription options
Options:
| Flag | Description | Default |
|---|---|---|
-m, --maxNum |
max unacked messages num on subscription | 0 |
Remove max unacked messages policy on subscription for a topic
Command:
$ pulsar-admin topics remove-max-unacked-messages-on-subscription options
Get max unacked messages policy on consumer for a topic
Command:
$ pulsar-admin topics get-max-unacked-messages-per-consumer options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set max unacked messages policy on consumer for a topic
Command:
$ pulsar-admin topics set-max-unacked-messages-per-consumer options
Options:
| Flag | Description | Default |
|---|---|---|
-m, --maxNum |
max unacked messages num on consumer | 0 |
Remove max unacked messages policy on consumer for a topic
Command:
$ pulsar-admin topics remove-max-unacked-messages-per-consumer options
Get max unacked messages policy on subscription for a topic
Command:
$ pulsar-admin topics get-max-unacked-messages-per-subscription options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set max unacked messages policy on subscription for a topic
Command:
$ pulsar-admin topics set-max-unacked-messages-per-subscription options
Options:
| Flag | Description | Default |
|---|---|---|
-m, --maxNum |
max unacked messages num on subscription | 0 |
Remove max unacked messages policy on subscription for a topic
Command:
$ pulsar-admin topics remove-max-unacked-messages-per-subscription options
Get publish rate for a topic
Command:
$ pulsar-admin topics get-publish-rate options
Set publish rate for a topic
Command:
$ pulsar-admin topics set-publish-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--byte-publish-rate, -b |
byte-publish-rate (default -1 will be overwrite if not passed) | -1 | |
--msg-publish-rate, -m |
message-publish-rate (default -1 will be overwrite if not passed) | -1 |
Remove publish rate for a topic
Command:
$ pulsar-admin topics remove-publish-rate options
Set subscription types enabled for a topic
Command:
$ pulsar-admin topics set-subscription-types-enabled options
Options:
| Flag | Description | Default |
|---|---|---|
--types, -t |
Subscription types enabled list (comma separated values). Possible values: (Exclusive, Shared, Failover, Key_Shared). | null |
Get subscription types enabled for a topic
Command:
$ pulsar-admin topics get-subscription-types-enabled options
Remove subscription types enabled for a topic
Command:
$ pulsar-admin topics remove-subscription-types-enabled options
Get max number of producers for a topic
Command:
$ pulsar-admin topics get-maxProducers options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set max number of producers for a topic
Command:
$ pulsar-admin topics set-maxProducers options
Options:
| Flag | Description | Default |
|---|---|---|
--max-producers, -p |
Max producers for a topic | 0 |
Remove max number of producers for a topic
Command:
$ pulsar-admin topics remove-maxProducers options
Get max number of producers for a topic
Command:
$ pulsar-admin topics get-max-producers options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set max number of producers for a topic
Command:
$ pulsar-admin topics set-max-producers options
Options:
| Flag | Description | Default |
|---|---|---|
--max-producers, -p |
Max producers for a topic | 0 |
Remove max number of producers for a topic
Command:
$ pulsar-admin topics remove-max-producers options
Get max number of subscriptions for a topic
Command:
$ pulsar-admin topics get-max-subscriptions options
Set max number of subscriptions for a topic
Command:
$ pulsar-admin topics set-max-subscriptions options
Options:
| Flag | Description | Default |
|---|---|---|
--max-subscriptions-per-topic, -m |
Maximum subscription limit for a topic | 0 |
Remove max number of subscriptions for a topic
Command:
$ pulsar-admin topics remove-max-subscriptions options
Get max message size for a topic
Command:
$ pulsar-admin topics get-max-message-size options
Set max message size for a topic
Command:
$ pulsar-admin topics set-max-message-size options
Options:
| Flag | Description | Default |
|---|---|---|
--max-message-size, -m |
Max message size for a topic | 0 |
Remove max message size for a topic
Command:
$ pulsar-admin topics remove-max-message-size options
Get max consumers per subscription for a topic
Command:
$ pulsar-admin topics get-max-consumers-per-subscription options
Set max consumers per subscription for a topic
Command:
$ pulsar-admin topics set-max-consumers-per-subscription options
Options:
| Flag | Description | Default |
|---|---|---|
--max-consumers-per-subscription, -c |
maxConsumersPerSubscription for a namespace | 0 |
Remove max consumers per subscription for a topic
Command:
$ pulsar-admin topics remove-max-consumers-per-subscription options
Get the inactive topic policies on a topic
Command:
$ pulsar-admin topics get-inactive-topic-policies options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set the inactive topic policies on a topic
Command:
$ pulsar-admin topics set-inactive-topic-policies options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--delete-mode, -m |
Mode of delete inactive topic, Valid options are: [delete_when_no_subscriptions, delete_when_subscriptions_caught_up] | null | |
--enable-delete-while-inactive, -e |
Enable delete while inactive | false | |
--disable-delete-while-inactive, -d |
Disable delete while inactive | false | |
--max-inactive-duration, -t |
Max duration of topic inactivity in seconds, topics that are inactive for longer than this value will be deleted (eg: 1s, 10s, 1m, 5h, 3d) | null |
Remove inactive topic policies from a topic
Command:
$ pulsar-admin topics remove-inactive-topic-policies options
Get max number of consumers for a topic
Command:
$ pulsar-admin topics get-max-consumers options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set max number of consumers for a topic
Command:
$ pulsar-admin topics set-max-consumers options
Options:
| Flag | Description | Default |
|---|---|---|
--max-consumers, -c |
Max consumers for a topic | 0 |
Remove max number of consumers for a topic
Command:
$ pulsar-admin topics remove-max-consumers options
Get consumer subscribe rate for a topic
Command:
$ pulsar-admin topics get-subscribe-rate options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set consumer subscribe rate for a topic
Command:
$ pulsar-admin topics set-subscribe-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--subscribe-rate-period, -st |
subscribe-rate-period in second type (default 30 second will be overwrite if not passed) | 30 | |
--subscribe-rate, -sr |
subscribe-rate (default -1 will be overwrite if not passed) | -1 |
Remove consumer subscribe rate for a topic
Command:
$ pulsar-admin topics remove-subscribe-rate options
Enable or disable a replicated subscription on a topic
Command:
$ pulsar-admin topics set-replicated-subscription-status options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--disable, -d |
Disable replication | false | |
-s, --subscription |
Subscription name to enable or disable replication | null | |
--enable, -e |
Enable replication | false |
Get replicated subscription status on a topic
Command:
$ pulsar-admin topics get-replicated-subscription-status options
Options:
| Flag | Description | Default |
|---|---|---|
-s, --subscription |
Subscription name | null |
Calculate backlog size by a message ID (in bytes).
Command:
$ pulsar-admin topics get-backlog-size options
Options:
| Flag | Description | Default |
|---|---|---|
--messageId, -m |
messageId used to calculate backlog size. It can be (ledgerId:entryId). | -1:-1 |
Analyze the backlog of a subscription.
Command:
$ pulsar-admin topics analyze-backlog options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-s, --subscription |
Subscription to be analyzed | null | |
--position, -p |
message position to start the scan from (ledgerId:entryId) | null |
Get the replication clusters for a topic
Command:
$ pulsar-admin topics get-replication-clusters options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set the replication clusters for a topic
Command:
$ pulsar-admin topics set-replication-clusters options
Options:
| Flag | Description | Default |
|---|---|---|
--clusters, -c |
Replication Cluster Ids list (comma separated values) | null |
Remove the replication clusters for a topic
Command:
$ pulsar-admin topics remove-replication-clusters options
Get the schema validation enforced
Command:
$ pulsar-admin topics get-schema-validation-enforce options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
Set the schema whether open schema validation enforced
Command:
$ pulsar-admin topics set-schema-validation-enforce options
Options:
| Flag | Description | Default |
|---|---|---|
--enable, -e |
Enable schema validation enforced | false |
$topicPolicies
Operations on persistent topics
$ pulsar-admin topicPolicies subcommand
get-message-ttlset-message-ttlremove-message-ttlget-max-unacked-messages-per-consumerset-max-unacked-messages-per-consumerremove-max-unacked-messages-per-consumerget-max-consumers-per-subscriptionset-max-consumers-per-subscriptionremove-max-consumers-per-subscriptionset-subscription-types-enabledget-subscription-types-enabledremove-subscription-types-enabledget-retentionset-retentionremove-retentionget-backlog-quotaset-backlog-quotaremove-backlog-quotaget-max-producersset-max-producersremove-max-producersget-max-message-sizeset-max-message-sizeremove-max-message-sizeset-deduplicationget-deduplicationremove-deduplicationget-deduplication-snapshot-intervalset-deduplication-snapshot-intervalremove-deduplication-snapshot-intervalget-persistenceset-persistenceremove-persistenceget-subscription-dispatch-rateset-subscription-dispatch-rateremove-subscription-dispatch-rateget-replicator-dispatch-rateset-replicator-dispatch-rateremove-replicator-dispatch-rateget-publish-rateset-publish-rateremove-publish-rateget-compaction-thresholdset-compaction-thresholdremove-compaction-thresholdget-subscribe-rateset-subscribe-rateremove-subscribe-rateget-max-consumersset-max-consumersremove-max-consumersget-delayed-deliveryset-delayed-deliveryremove-delayed-deliveryget-dispatch-rateset-dispatch-rateremove-dispatch-rateget-offload-policiesset-offload-policiesremove-offload-policiesget-max-unacked-messages-per-subscriptionset-max-unacked-messages-per-subscriptionremove-max-unacked-messages-per-subscriptionget-inactive-topic-policiesset-inactive-topic-policiesremove-inactive-topic-policiesget-max-subscriptions-per-topicset-max-subscriptions-per-topicremove-max-subscriptions-per-topicremove-schema-compatibility-strategyset-schema-compatibility-strategyget-schema-compatibility-strategyGet the message TTL for a topic
Command:
$ pulsar-admin topicPolicies get-message-ttl options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false | |
-ap, --applied |
Get the applied policy of the topic | false |
Set message TTL for a topic
Command:
$ pulsar-admin topicPolicies set-message-ttl options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-t, --ttl |
Message TTL for topic in seconds (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w), allowed range from 1 to Integer.MAX_VALUE | null | |
--global, -g |
Whether to set this policy globally. If set to true, broker returned global topic policies | false |
Remove message TTL for a topic
Command:
$ pulsar-admin topicPolicies remove-message-ttl options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, broker returned global topic policies | false |
Get max unacked messages policy per consumer for a topic
Command:
$ pulsar-admin topicPolicies get-max-unacked-messages-per-consumer options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false | |
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false |
Set max unacked messages policy per consumer for a topic
Command:
$ pulsar-admin topicPolicies set-max-unacked-messages-per-consumer options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to set this policy globally. If set to true, broker returned global topic policies | false | |
-m, --maxNum |
max unacked messages num on consumer | 0 |
Remove max unacked messages policy per consumer for a topic
Command:
$ pulsar-admin topicPolicies remove-max-unacked-messages-per-consumer options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, broker returned global topic policies | false |
Get max consumers per subscription for a topic
Command:
$ pulsar-admin topicPolicies get-max-consumers-per-subscription options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false |
Set max consumers per subscription for a topic
Command:
$ pulsar-admin topicPolicies set-max-consumers-per-subscription options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--max-consumers-per-subscription, -c |
maxConsumersPerSubscription for a namespace | 0 | |
--global, -g |
Whether to set this policy globally. If set to true, broker returned global topic policies | false |
Remove max consumers per subscription for a topic
Command:
$ pulsar-admin topicPolicies remove-max-consumers-per-subscription options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, broker returned global topic policies | false |
Set subscription types enabled for a topic
Command:
$ pulsar-admin topicPolicies set-subscription-types-enabled options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false | |
--types, -t |
Subscription types enabled list (comma separated values). Possible values: (Exclusive, Shared, Failover, Key_Shared). | null |
Get subscription types enabled for a topic
Command:
$ pulsar-admin topicPolicies get-subscription-types-enabled options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false |
Remove subscription types enabled for a topic
Command:
$ pulsar-admin topicPolicies remove-subscription-types-enabled options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to set this policy globally. If set to true, the removing operation will be replicate to other clusters asynchronously | false |
Get the retention policy for a topic
Command:
$ pulsar-admin topicPolicies get-retention options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to get this policy globally. If set to true, the broker returns global topic policiesIf set to false or not set, the broker returns local topic policies | false | |
-ap, --applied |
Get the applied policy of the topic | false |
Set the retention policy for a topic
Command:
$ pulsar-admin topicPolicies set-retention options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--size, -s |
Retention size limit (eg: 10M, 16G, 3T). 0 or less than 1MB means no retention and -1 means infinite size retention | null | |
--time, -t |
Retention time in minutes (or minutes, hours,days,weeks eg: 100m, 3h, 2d, 5w). 0 means no retention and -1 means infinite time retention | null | |
--global, -g |
Whether to set this policy globally. If set to true, the policy is replicated to other clusters asynchronously, If set to false or not set, the topic retention policy is replicated to local clusters. | false |
Remove the retention policy for a topic
Command:
$ pulsar-admin topicPolicies remove-retention options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, the removing operation is replicated to other clusters asynchronouslyIf set to false or not set, the topic retention policy is replicated to local clusters. | false |
Get the backlog quota policies for a topic
Command:
$ pulsar-admin topicPolicies get-backlog-quota options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false | |
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false |
Set a backlog quota policy for a topic
Command:
$ pulsar-admin topicPolicies set-backlog-quota options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-t, --type |
Backlog quota type to set. Valid options are: destination_storage and message_age. destination_storage limits backlog by size (in bytes). message_age limits backlog by time, that is, message timestamp (broker or publish timestamp). You can set size or time to control the backlog, or combine them together to control the backlog. | destination_storage | |
-p, --policy |
Retention policy to enforce when the limit is reached. Valid options are: [producer_request_hold, producer_exception, consumer_backlog_eviction] | null | |
-lt, --limitTime |
Time limit in second (or minutes, hours, days, weeks eg: 100m, 3h, 2d, 5w), non-positive number for disabling time limit. | null | |
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false | |
-l, --limit |
Size limit (eg: 10M, 16G) | -1 |
Remove a backlog quota policy from a topic
Command:
$ pulsar-admin topicPolicies remove-backlog-quota options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, the removing operation will be replicate to other clusters asynchronously | false | |
-t, --type |
Backlog quota type to remove | destination_storage |
Get max number of producers for a topic
Command:
$ pulsar-admin topicPolicies get-max-producers options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false | |
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false |
Set max number of producers for a topic
Command:
$ pulsar-admin topicPolicies set-max-producers options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false | |
--max-producers, -p |
Max producers for a topic | 0 |
Remove max number of producers for a topic
Command:
$ pulsar-admin topicPolicies remove-max-producers options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to set this policy globally. If set to true, the removing operation will be replicate to other clusters asynchronously | false |
Get max message size for a topic
Command:
$ pulsar-admin topicPolicies get-max-message-size options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to get this policy globally. If set to true, broker returns global topic policies | false |
Set max message size for a topic
Command:
$ pulsar-admin topicPolicies set-max-message-size options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to set this policy globally. | false | |
--max-message-size, -m |
Max message size for a topic | 0 |
Remove max message size for a topic
Command:
$ pulsar-admin topicPolicies remove-max-message-size options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. | false |
Enable or disable status for a topic
Command:
$ pulsar-admin topicPolicies set-deduplication options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to set this policy globally. If set to true, the removing operation will be replicate to other clusters asynchronously | false | |
--disable, -d |
Disable deduplication | false | |
--enable, -e |
Enable deduplication | false |
Get the deduplication status for a topic
Command:
$ pulsar-admin topicPolicies get-deduplication options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to get this policy globally. | false |
Remove the deduplication status for a topic
Command:
$ pulsar-admin topicPolicies remove-deduplication options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, the removing operation will be replicate to other clusters asynchronously | false |
Get deduplication snapshot interval for a topic
Command:
$ pulsar-admin topicPolicies get-deduplication-snapshot-interval options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to get this policy globally. If set to true, broker returns global topic policies | false |
Set deduplication snapshot interval for a topic
Command:
$ pulsar-admin topicPolicies set-deduplication-snapshot-interval options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-i, --interval |
Deduplication snapshot interval for topic in second, allowed range from 0 to Integer.MAX_VALUE | 0 | |
--global, -g |
Whether to set this policy globally. | false |
Remove deduplication snapshot interval for a topic
Command:
$ pulsar-admin topicPolicies remove-deduplication-snapshot-interval options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. | false |
Get the persistence policies for a topic
Command:
$ pulsar-admin topicPolicies get-persistence options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false |
Set the persistence policies for a topic
Command:
$ pulsar-admin topicPolicies set-persistence options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-r, --ml-mark-delete-max-rate |
Throttling rate of mark-delete operation (0 means no throttle) | 0.0 | |
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false | |
-w, --bookkeeper-write-quorum |
How many writes to make of each entry | 0 | |
-a, --bookkeeper-ack-quorum |
Number of acks (guaranteed copies) to wait for each entry | 0 | |
-e, --bookkeeper-ensemble |
Number of bookies to use for a topic | 0 |
Remove the persistence policy for a topic
Command:
$ pulsar-admin topicPolicies remove-persistence options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, the removing operation will be replicate to other clusters asynchronously | false |
Get subscription message-dispatch-rate for a topic
Command:
$ pulsar-admin topicPolicies get-subscription-dispatch-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--subscription, -s |
Get message-dispatch-rate of a specific subscription | null | |
-ap, --applied |
Get the applied policy of the topic | false | |
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false |
Set subscription message-dispatch-rate for a topic
Command:
$ pulsar-admin topicPolicies set-subscription-dispatch-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--subscription, -s |
Set message-dispatch-rate for a specific subscription | null | |
--dispatch-rate-period, -dt |
dispatch-rate-period in second type (default 1 second will be overwrite if not passed) | 1 | |
--msg-dispatch-rate, -md |
message-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false | |
--byte-dispatch-rate, -bd |
byte-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--relative-to-publish-rate, -rp |
dispatch rate relative to publish-rate (if publish-relative flag is enabled then broker will apply throttling value to (publish-rate + dispatch rate)) | false |
Remove subscription message-dispatch-rate for a topic
Command:
$ pulsar-admin topicPolicies remove-subscription-dispatch-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false | |
--subscription, -s |
Remove message-dispatch-rate for a specific subscription | null |
Get replicator message-dispatch-rate for a topic
Command:
$ pulsar-admin topicPolicies get-replicator-dispatch-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false | |
-ap, --applied |
Get the applied policy of the topic | false |
Set replicator message-dispatch-rate for a topic
Command:
$ pulsar-admin topicPolicies set-replicator-dispatch-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false | |
--byte-dispatch-rate, -bd |
byte-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--dispatch-rate-period, -dt |
dispatch-rate-period in second type (default 1 second will be overwrite if not passed) | 1 | |
--msg-dispatch-rate, -md |
message-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--relative-to-publish-rate, -rp |
dispatch rate relative to publish-rate (if publish-relative flag is enabled then broker will apply throttling value to (publish-rate + dispatch rate)) | false |
Remove replicator message-dispatch-rate for a topic
Command:
$ pulsar-admin topicPolicies remove-replicator-dispatch-rate options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false |
Get publish rate for a topic
Command:
$ pulsar-admin topicPolicies get-publish-rate options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to get this policy globally. If set to true, broker returns global topic policies | false |
Set publish rate for a topic
Command:
$ pulsar-admin topicPolicies set-publish-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--msg-publish-rate, -m |
message-publish-rate (default -1 will be overwrite if not passed) | -1 | |
--global, -g |
Whether to set this policy globally. | false | |
--byte-publish-rate, -b |
byte-publish-rate (default -1 will be overwrite if not passed) | -1 |
Remove publish rate for a topic
Command:
$ pulsar-admin topicPolicies remove-publish-rate options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. | false |
Get compaction threshold for a topic
Command:
$ pulsar-admin topicPolicies get-compaction-threshold options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false | |
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false |
Set compaction threshold for a topic
Command:
$ pulsar-admin topicPolicies set-compaction-threshold options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--threshold, -t |
Maximum number of bytes in a topic backlog before compaction is triggered (eg: 10M, 16G, 3T). 0 disables automatic compaction | 0 | |
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false |
Remove compaction threshold for a topic
Command:
$ pulsar-admin topicPolicies remove-compaction-threshold options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, the removing operation will be replicate to other clusters asynchronously | false |
Get consumer subscribe rate for a topic
Command:
$ pulsar-admin topicPolicies get-subscribe-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false | |
--global, -g |
Whether to get this policy globally. If set to true, broker returns global topic policies | false |
Set consumer subscribe rate for a topic
Command:
$ pulsar-admin topicPolicies set-subscribe-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--subscribe-rate, -sr |
subscribe-rate (default -1 will be overwrite if not passed) | -1 | |
--global, -g |
Whether to set this policy globally. | false | |
--subscribe-rate-period, -st |
subscribe-rate-period in second type (default 30 second will be overwrite if not passed) | 30 |
Remove consumer subscribe rate for a topic
Command:
$ pulsar-admin topicPolicies remove-subscribe-rate options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. | false |
Get max number of consumers for a topic
Command:
$ pulsar-admin topicPolicies get-max-consumers options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false | |
--global, -g |
Whether to get this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false |
Set max number of consumers for a topic
Command:
$ pulsar-admin topicPolicies set-max-consumers options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--max-consumers, -c |
Max consumers for a topic | 0 | |
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false |
Remove max number of consumers for a topic
Command:
$ pulsar-admin topicPolicies remove-max-consumers options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false |
Get the delayed delivery policy for a topic
Command:
$ pulsar-admin topicPolicies get-delayed-delivery options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to get this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false | |
-ap, --applied |
Get the applied policy of the topic | false |
Set the delayed delivery policy on a topic
Command:
$ pulsar-admin topicPolicies set-delayed-delivery options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--enable, -e |
Enable delayed delivery messages | false | |
--disable, -d |
Disable delayed delivery messages | false | |
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false | |
--time, -t |
The tick time for when retrying on delayed delivery messages, affecting the accuracy of the delivery time compared to the scheduled time. (eg: 1s, 10s, 1m, 5h, 3d) | 1s |
Remove the delayed delivery policy on a topic
Command:
$ pulsar-admin topicPolicies remove-delayed-delivery options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false |
Get message dispatch rate for a topic
Command:
$ pulsar-admin topicPolicies get-dispatch-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false | |
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false |
Set message dispatch rate for a topic
Command:
$ pulsar-admin topicPolicies set-dispatch-rate options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--byte-dispatch-rate, -bd |
byte-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--relative-to-publish-rate, -rp |
dispatch rate relative to publish-rate (if publish-relative flag is enabled then broker will apply throttling value to (publish-rate + dispatch rate)) | false | |
--dispatch-rate-period, -dt |
dispatch-rate-period in second type (default 1 second will be overwrite if not passed) | 1 | |
--msg-dispatch-rate, -md |
message-dispatch-rate (default -1 will be overwrite if not passed) | -1 | |
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false |
Remove message dispatch rate for a topic
Command:
$ pulsar-admin topicPolicies remove-dispatch-rate options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, the removing operation will be replicate to other clusters asynchronously | false |
Get the offload policies for a topic
Command:
$ pulsar-admin topicPolicies get-offload-policies options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false | |
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false |
Set the offload policies for a topic
Command:
$ pulsar-admin topicPolicies set-offload-policies options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-t, --offloadThresholdInBytes |
ManagedLedger offload threshold in bytes | 0 | |
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false | |
-m, --maxBlockSizeInBytes |
ManagedLedger offload max block Size in bytes,s3 and google-cloud-storage requires this parameter | 0 | |
-b, --bucket |
ManagedLedger offload bucket, s3 and google-cloud-storage requires this parameter | null | |
-dl, --offloadDeletionLagInMillis |
ManagedLedger offload deletion lag in bytes | null | |
-r, --region |
ManagedLedger offload region, s3 and google-cloud-storage requires this parameter | null | |
-i, --aws-id |
AWS Credential Id to use when using driver S3 or aws-s3 | null | |
--ro, --s3-role |
S3 Role used for STSAssumeRoleSessionCredentialsProvider | null | |
--s3-role-session-name, -rsn |
S3 role session name used for STSAssumeRoleSessionCredentialsProvider | null | |
--offloadedReadPriority, -orp |
Read priority for offloaded messages. By default, once messages are offloaded to long-term storage, brokers read messages from long-term storage, but messages can still exist in BookKeeper for a period depends on your configuration. For messages that exist in both long-term storage and BookKeeper, you can set where to read messages from with the option tiered-storage-first or bookkeeper-first. |
null | |
-d, --driver |
ManagedLedger offload driver | null | |
-e, --endpoint |
ManagedLedger offload service endpoint, only s3 requires this parameter | null | |
-s, --aws-secret |
AWS Credential Secret to use when using driver S3 or aws-s3 | null | |
-rb, --readBufferSizeInBytes |
ManagedLedger offload read buffer size in bytes,s3 and google-cloud-storage requires this parameter | 0 |
Remove the offload policies for a topic
Command:
$ pulsar-admin topicPolicies remove-offload-policies options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, the removing operation will be replicate to other clusters asynchronously | false |
Get max unacked messages policy per subscription for a topic
Command:
$ pulsar-admin topicPolicies get-max-unacked-messages-per-subscription options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to get this policy globally. If set to true, the removing operation will be replicate to other clusters asynchronously | false | |
-ap, --applied |
Get the applied policy of the topic | false |
Set max unacked messages policy on subscription for a topic
Command:
$ pulsar-admin topicPolicies set-max-unacked-messages-per-subscription options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--global, -g |
Whether to set this policy globally. If set to true, the removing operation will be replicate to other clusters asynchronously | false | |
-m, --maxNum |
max unacked messages num on subscription | 0 |
Remove max unacked messages policy per subscription for a topic
Command:
$ pulsar-admin topicPolicies remove-max-unacked-messages-per-subscription options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, the removing operation will be replicate to other clusters asynchronously | false |
Get the inactive topic policies on a topic
Command:
$ pulsar-admin topicPolicies get-inactive-topic-policies options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false | |
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false |
Set the inactive topic policies on a topic
Command:
$ pulsar-admin topicPolicies set-inactive-topic-policies options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--enable-delete-while-inactive, -e |
Enable delete while inactive | false | |
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false | |
--max-inactive-duration, -t |
Max duration of topic inactivity in seconds, topics that are inactive for longer than this value will be deleted (eg: 1s, 10s, 1m, 5h, 3d) | null | |
--delete-mode, -m |
Mode of delete inactive topic, Valid options are: [delete_when_no_subscriptions, delete_when_subscriptions_caught_up] | null | |
--disable-delete-while-inactive, -d |
Disable delete while inactive | false |
Remove inactive topic policies from a topic
Command:
$ pulsar-admin topicPolicies remove-inactive-topic-policies options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, the removing operation will be replicate to other clusters asynchronously | false |
Get max subscriptions for a topic
Command:
$ pulsar-admin topicPolicies get-max-subscriptions-per-topic options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to get this policy globally. If set to true, broker returned global topic policies | false |
Set max subscriptions for a topic
Command:
$ pulsar-admin topicPolicies set-max-subscriptions-per-topic options
Options:
| Flag | Description | Default | |
|---|---|---|---|
--max-subscriptions-per-topic, -s |
max subscriptions for a topic (default -1 will be overwrite if not passed) | 0 | |
--global, -g |
Whether to set this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false |
Remove max subscriptions for a topic
Command:
$ pulsar-admin topicPolicies remove-max-subscriptions-per-topic options
Options:
| Flag | Description | Default |
|---|---|---|
--global, -g |
Whether to remove this policy globally. If set to true, the policy will be replicate to other clusters asynchronously | false |
Remove schema compatibility strategy on a topic
Command:
$ pulsar-admin topicPolicies remove-schema-compatibility-strategy options
Set schema compatibility strategy on a topic
Command:
$ pulsar-admin topicPolicies set-schema-compatibility-strategy options
Options:
| Flag | Description | Default |
|---|---|---|
--strategy, -s |
Schema compatibility strategy: [UNDEFINED, ALWAYS_INCOMPATIBLE, ALWAYS_COMPATIBLE, BACKWARD, FORWARD, FULL, BACKWARD_TRANSITIVE, FORWARD_TRANSITIVE, FULL_TRANSITIVE] | null |
Get schema compatibility strategy on a topic
Command:
$ pulsar-admin topicPolicies get-schema-compatibility-strategy options
Options:
| Flag | Description | Default |
|---|---|---|
-ap, --applied |
Get the applied policy of the topic | false |
$transactions
Operations on transactions
$ pulsar-admin transactions subcommand
coordinator-internal-statspending-ack-internal-statscoordinator-statstransaction-buffer-statspending-ack-statstransaction-in-buffer-statstransaction-in-pending-ack-statstransaction-metadataslow-transactionsscale-transactionCoordinatorsposition-stats-in-pending-ackGet transaction coordinator internal stats
Command:
$ pulsar-admin transactions coordinator-internal-stats options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-c, --coordinator-id |
The coordinator id | 0 | |
-m, --metadata |
Flag to include ledger metadata | false |
Get pending ack internal stats
Command:
$ pulsar-admin transactions pending-ack-internal-stats options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-s, --subscription-name |
Subscription name | null | |
-m, --metadata |
Flag to include ledger metadata | false | |
-t, --topic |
Topic name | null |
Get transaction coordinator stats
Command:
$ pulsar-admin transactions coordinator-stats options
Options:
| Flag | Description | Default |
|---|---|---|
-c, --coordinator-id |
The coordinator id | null |
Get transaction buffer stats
Command:
$ pulsar-admin transactions transaction-buffer-stats options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-l, --low-water-mark |
Whether to get information about lowWaterMarks stored in transaction buffer. | false | |
-t, --topic |
The topic | null |
Get transaction pending ack stats
Command:
$ pulsar-admin transactions pending-ack-stats options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-t, --topic |
The topic name | null | |
-s, --sub-name |
The subscription name | null | |
-l, --low-water-mark |
Whether to get information about lowWaterMarks stored in transaction pending ack. | false |
Get transaction in buffer stats
Command:
$ pulsar-admin transactions transaction-in-buffer-stats options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-l, --least-sig-bits |
The least sig bits | 0 | |
-t, --topic |
The topic name | null | |
-m, --most-sig-bits |
The most sig bits | 0 |
Get transaction in pending ack stats
Command:
$ pulsar-admin transactions transaction-in-pending-ack-stats options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-t, --topic |
The topic name | null | |
-s, --sub-name |
The subscription name | null | |
-m, --most-sig-bits |
The most sig bits | 0 | |
-l, --least-sig-bits |
The least sig bits | 0 |
Get transaction metadata
Command:
$ pulsar-admin transactions transaction-metadata options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-m, --most-sig-bits |
The most sig bits | 0 | |
-l, --least-sig-bits |
The least sig bits | 0 |
Get slow transactions.
Command:
$ pulsar-admin transactions slow-transactions options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-c, --coordinator-id |
The coordinator id | null | |
-t, --time |
The transaction timeout time. (eg: 1s, 10s, 1m, 5h, 3d) | 1s |
Update the scale of transaction coordinators
Command:
$ pulsar-admin transactions scale-transactionCoordinators options
Options:
| Flag | Description | Default |
|---|---|---|
-r, --replicas |
The scale of the transaction coordinators | 0 |
Get the position stats in transaction pending ack
Command:
$ pulsar-admin transactions position-stats-in-pending-ack options
Options:
| Flag | Description | Default | |
|---|---|---|---|
-e, --entry-id |
Entry ID of the position | null | |
-b, --batch-index |
Batch index of the position | null | |
-t, --topic |
The topic name | null | |
-l, --ledger-id |
Ledger ID of the position | null | |
-s, --subscription-name |
Subscription name | null |