| <!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Pulsar admin CLI · Apache Pulsar</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="> **Important**"/><meta name="docsearch:version" content="2.7.3"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Pulsar admin CLI · Apache Pulsar"/><meta property="og:type" content="website"/><meta property="og:url" content="https://pulsar.apache.org/"/><meta property="og:description" content="> **Important**"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://pulsar.apache.org/img/pulsar.svg"/><link rel="shortcut icon" href="/img/pulsar.ico"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://pulsar.apache.org/blog/atom.xml" title="Apache Pulsar Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://pulsar.apache.org/blog/feed.xml" title="Apache Pulsar Blog RSS Feed"/><link rel="stylesheet" href="/css/code-blocks-buttons.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/custom.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/en"><img class="logo" src="/img/pulsar.svg" alt="Apache Pulsar"/></a><a href="/en/versions"><h3>2.7.3</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/en/2.7.3/getting-started-standalone" target="_self">Docs</a></li><li class=""><a href="/en/download" target="_self">Download</a></li><li class=""><a href="/docs/en/2.7.3/client-libraries" target="_self">Clients</a></li><li class=""><a href="#restapis" target="_self">REST APIs</a></li><li class=""><a href="#cli" target="_self">Cli</a></li><li class=""><a href="/blog/" target="_self">Blog</a></li><li class=""><a href="#community" target="_self">Community</a></li><li class=""><a href="#apache" target="_self">Apache</a></li><li class=""><a href="https://pulsar-next.staged.apache.org/" target="_self">New Website (Beta)</a></li><span><li><a id="languages-menu" href="#"><img class="languages-icon" src="/img/language.svg" alt="Languages icon"/>English</a><div id="languages-dropdown" class="hide"><ul id="languages-dropdown-items"><li><a href="/docs/ja/2.7.3/reference-pulsar-admin">日本語</a></li><li><a href="/docs/fr/2.7.3/reference-pulsar-admin">Français</a></li><li><a href="/docs/ko/2.7.3/reference-pulsar-admin">한국어</a></li><li><a href="/docs/zh-CN/2.7.3/reference-pulsar-admin">中文</a></li><li><a href="/docs/zh-TW/2.7.3/reference-pulsar-admin">繁體中文</a></li><li><a href="https://crowdin.com/project/apache-pulsar" target="_blank" rel="noreferrer noopener">Help Translate</a></li></ul></div></li><script> |
| const languagesMenuItem = document.getElementById("languages-menu"); |
| const languagesDropDown = document.getElementById("languages-dropdown"); |
| languagesMenuItem.addEventListener("click", function(event) { |
| event.preventDefault(); |
| |
| if (languagesDropDown.className == "hide") { |
| languagesDropDown.className = "visible"; |
| } else { |
| languagesDropDown.className = "hide"; |
| } |
| }); |
| </script></span></ul></nav></div></header></div></div><div class="navPusher"><div class="docMainWrapper wrapper"><div class="container mainContainer docsContainer"><div class="wrapper"><div class="post"><header class="postHeader"><a class="edit-page-link button" href="https://github.com/apache/pulsar/edit/master/site2/docs/reference-pulsar-admin.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Pulsar admin CLI</h1></header><article><div><span><blockquote> |
| <p><strong>Important</strong></p> |
| <p>This page is deprecated and not updated anymore. For the latest and complete information about <code>pulsar-admin</code>, including commands, flags, descriptions, and more, see <a href="https://pulsar.apache.org/tools/pulsar-admin/">pulsar-admin doc</a>.</p> |
| </blockquote> |
| <p>The <code>pulsar-admin</code> tool enables you to manage Pulsar installations, including clusters, brokers, namespaces, tenants, and more.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">command</span> |
| </code></pre> |
| <p>Commands</p> |
| <ul> |
| <li><p><code>broker-stats</code></p></li> |
| <li><p><code>brokers</code></p></li> |
| <li><p><code>clusters</code></p></li> |
| <li><p><code>functions</code></p></li> |
| <li><p><code>functions-worker</code></p></li> |
| <li><p><code>namespaces</code></p></li> |
| <li><p><code>ns-isolation-policy</code></p></li> |
| <li><p><code>sources</code></p> |
| <p>For more information, see <a href="/docs/en/2.7.3/io-cli#sources">here</a></p></li> |
| <li><p><code>sinks</code></p> |
| <p>For more information, see <a href="/docs/en/2.7.3/io-cli#sinks">here</a></p></li> |
| <li><p><code>topics</code></p></li> |
| <li><p><code>tenants</code></p></li> |
| <li><p><code>resource-quotas</code></p></li> |
| <li><p><code>schemas</code></p></li> |
| </ul> |
| <h2><a class="anchor" aria-hidden="true" id="broker-stats"></a><a href="#broker-stats" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>broker-stats</code></h2> |
| <p>Operations to collect broker statistics</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin broker-stats subcommand |
| </code></pre> |
| <p>Subcommands</p> |
| <ul> |
| <li><code>allocator-stats</code></li> |
| <li><code>topics(destinations)</code></li> |
| <li><code>mbeans</code></li> |
| <li><code>monitoring-metrics</code></li> |
| <li><code>load-report</code></li> |
| </ul> |
| <h3><a class="anchor" aria-hidden="true" id="allocator-stats"></a><a href="#allocator-stats" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>allocator-stats</code></h3> |
| <p>Dump allocator stats</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin broker-stats allocator-stats allocator-name |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="topicsdestinations"></a><a href="#topicsdestinations" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>topics(destinations)</code></h3> |
| <p>Dump topic stats</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin broker-stats topics options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-i</code>, <code>--indent</code></td><td>Indent JSON output</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="mbeans"></a><a href="#mbeans" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>mbeans</code></h3> |
| <p>Dump Mbean stats</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin broker-stats mbeans options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-i</code>, <code>--indent</code></td><td>Indent JSON output</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="monitoring-metrics"></a><a href="#monitoring-metrics" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>monitoring-metrics</code></h3> |
| <p>Dump metrics for monitoring</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin broker-stats monitoring-metrics options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-i</code>, <code>--indent</code></td><td>Indent JSON output</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="load-report"></a><a href="#load-report" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>load-report</code></h3> |
| <p>Dump broker load-report</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin broker-stats load-report |
| </code></pre> |
| <h2><a class="anchor" aria-hidden="true" id="brokers"></a><a href="#brokers" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>brokers</code></h2> |
| <p>Operations about brokers</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin brokers subcommand |
| </code></pre> |
| <p>Subcommands</p> |
| <ul> |
| <li><code>list</code></li> |
| <li><code>namespaces</code></li> |
| <li><code>update-dynamic-config</code></li> |
| <li><code>list-dynamic-config</code></li> |
| <li><code>get-all-dynamic-config</code></li> |
| <li><code>get-internal-config</code></li> |
| <li><code>get-runtime-config</code></li> |
| <li><code>healthcheck</code></li> |
| </ul> |
| <h3><a class="anchor" aria-hidden="true" id="list"></a><a href="#list" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>list</code></h3> |
| <p>List active brokers of the cluster</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin brokers list cluster-name |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="namespaces"></a><a href="#namespaces" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>namespaces</code></h3> |
| <p>List namespaces owned by the broker</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin brokers namespaces cluster-name options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--url</code></td><td>The URL for the broker</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="update-dynamic-config"></a><a href="#update-dynamic-config" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>update-dynamic-config</code></h3> |
| <p>Update a broker's dynamic service configuration</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin brokers update-dynamic-config options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--config</code></td><td>Service configuration parameter name</td><td></td></tr> |
| <tr><td><code>--value</code></td><td>Value for the configuration parameter value specified using the <code>--config</code> flag</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="list-dynamic-config"></a><a href="#list-dynamic-config" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>list-dynamic-config</code></h3> |
| <p>Get list of updatable configuration name</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin brokers list-dynamic-config |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="delete-dynamic-config"></a><a href="#delete-dynamic-config" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>delete-dynamic-config</code></h3> |
| <p>Delete dynamic-serviceConfiguration of broker</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin brokers delete-dynamic-config options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--config</code></td><td>Service configuration parameter name</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-all-dynamic-config"></a><a href="#get-all-dynamic-config" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-all-dynamic-config</code></h3> |
| <p>Get all overridden dynamic-configuration values</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin brokers get-all-dynamic-config |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-internal-config"></a><a href="#get-internal-config" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-internal-config</code></h3> |
| <p>Get internal configuration information</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin brokers get-internal-config |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-runtime-config"></a><a href="#get-runtime-config" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-runtime-config</code></h3> |
| <p>Get runtime configuration values</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin brokers get-runtime-config |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="healthcheck"></a><a href="#healthcheck" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>healthcheck</code></h3> |
| <p>Run a health check against the broker</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin brokers healthcheck |
| </code></pre> |
| <h2><a class="anchor" aria-hidden="true" id="clusters"></a><a href="#clusters" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>clusters</code></h2> |
| <p>Operations about clusters</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin clusters subcommand |
| </code></pre> |
| <p>Subcommands</p> |
| <ul> |
| <li><code>get</code></li> |
| <li><code>create</code></li> |
| <li><code>update</code></li> |
| <li><code>delete</code></li> |
| <li><code>list</code></li> |
| <li><code>update-peer-clusters</code></li> |
| <li><code>get-peer-clusters</code></li> |
| <li><code>get-failure-domain</code></li> |
| <li><code>create-failure-domain</code></li> |
| <li><code>update-failure-domain</code></li> |
| <li><code>delete-failure-domain</code></li> |
| <li><code>list-failure-domains</code></li> |
| </ul> |
| <h3><a class="anchor" aria-hidden="true" id="get"></a><a href="#get" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get</code></h3> |
| <p>Get the configuration data for the specified cluster</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin clusters get cluster-name |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="create"></a><a href="#create" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>create</code></h3> |
| <p>Provisions a new cluster. This operation requires Pulsar super-user privileges.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin clusters create cluster-name options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--broker-url</code></td><td>The URL for the broker service.</td><td></td></tr> |
| <tr><td><code>--broker-url-secure</code></td><td>The broker service URL for a secure connection</td><td></td></tr> |
| <tr><td><code>--url</code></td><td>service-url</td><td></td></tr> |
| <tr><td><code>--url-secure</code></td><td>service-url for secure connection</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="update"></a><a href="#update" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>update</code></h3> |
| <p>Update the configuration for a cluster</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin clusters update cluster-name options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--broker-url</code></td><td>The URL for the broker service.</td><td></td></tr> |
| <tr><td><code>--broker-url-secure</code></td><td>The broker service URL for a secure connection</td><td></td></tr> |
| <tr><td><code>--url</code></td><td>service-url</td><td></td></tr> |
| <tr><td><code>--url-secure</code></td><td>service-url for secure connection</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="delete"></a><a href="#delete" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>delete</code></h3> |
| <p>Deletes an existing cluster</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin clusters delete cluster-name |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="list-1"></a><a href="#list-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>list</code></h3> |
| <p>List the existing clusters</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin clusters list |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="update-peer-clusters"></a><a href="#update-peer-clusters" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>update-peer-clusters</code></h3> |
| <p>Update peer cluster names</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin clusters update-peer-clusters cluster-name options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--peer-clusters</code></td><td>Comma separated peer cluster names (Pass empty string "" to delete list)</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-peer-clusters"></a><a href="#get-peer-clusters" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-peer-clusters</code></h3> |
| <p>Get list of peer clusters</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin clusters get-peer-clusters |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-failure-domain"></a><a href="#get-failure-domain" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-failure-domain</code></h3> |
| <p>Get the configuration brokers of a failure domain</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin clusters get-failure-domain cluster-name options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--domain-name</code></td><td>The failure domain name, which is a logical domain under a Pulsar cluster</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="create-failure-domain"></a><a href="#create-failure-domain" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>create-failure-domain</code></h3> |
| <p>Create a new failure domain for a cluster (updates it if already created)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin clusters create-failure-domain cluster-name options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--broker-list</code></td><td>Comma separated broker list</td><td></td></tr> |
| <tr><td><code>--domain-name</code></td><td>The failure domain name, which is a logical domain under a Pulsar cluster</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="update-failure-domain"></a><a href="#update-failure-domain" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>update-failure-domain</code></h3> |
| <p>Update failure domain for a cluster (creates a new one if not exist)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin clusters update-failure-domain cluster-name options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--broker-list</code></td><td>Comma separated broker list</td><td></td></tr> |
| <tr><td><code>--domain-name</code></td><td>The failure domain name, which is a logical domain under a Pulsar cluster</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="delete-failure-domain"></a><a href="#delete-failure-domain" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>delete-failure-domain</code></h3> |
| <p>Delete an existing failure domain</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin clusters delete-failure-domain cluster-name options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--domain-name</code></td><td>The failure domain name, which is a logical domain under a Pulsar cluster</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="list-failure-domains"></a><a href="#list-failure-domains" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>list-failure-domains</code></h3> |
| <p>List the existing failure domains for a cluster</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin clusters list-failure-domains cluster-name |
| </code></pre> |
| <h2><a class="anchor" aria-hidden="true" id="functions"></a><a href="#functions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>functions</code></h2> |
| <p>A command-line interface for Pulsar Functions</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> subcommand |
| </code></pre> |
| <p>Subcommands</p> |
| <ul> |
| <li><code>localrun</code></li> |
| <li><code>create</code></li> |
| <li><code>delete</code></li> |
| <li><code>update</code></li> |
| <li><code>get</code></li> |
| <li><code>restart</code></li> |
| <li><code>stop</code></li> |
| <li><code>start</code></li> |
| <li><code>status</code></li> |
| <li><code>stats</code></li> |
| <li><code>list</code></li> |
| <li><code>querystate</code></li> |
| <li><code>putstate</code></li> |
| <li><code>trigger</code></li> |
| </ul> |
| <h3><a class="anchor" aria-hidden="true" id="localrun"></a><a href="#localrun" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>localrun</code></h3> |
| <p>Run the Pulsar Function locally (rather than deploying it to the Pulsar cluster)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> localrun options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--cpu</code></td><td>The cpu in cores that need to be allocated per function instance(applicable only to docker runtime)</td><td></td></tr> |
| <tr><td><code>--ram</code></td><td>The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime)</td><td></td></tr> |
| <tr><td><code>--disk</code></td><td>The disk in bytes that need to be allocated per function instance(applicable only to docker runtime)</td><td></td></tr> |
| <tr><td><code>--auto-ack</code></td><td>Whether or not the framework will automatically acknowledge messages</td><td></td></tr> |
| <tr><td><code>--subs-name</code></td><td>Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer</td><td></td></tr> |
| <tr><td><code>--broker-service-url</code></td><td>The URL of the Pulsar broker</td><td></td></tr> |
| <tr><td><code>--classname</code></td><td>The function's class name</td><td></td></tr> |
| <tr><td><code>--custom-serde-inputs</code></td><td>The map of input topics to SerDe class names (as a JSON string)</td><td></td></tr> |
| <tr><td><code>--custom-schema-inputs</code></td><td>The map of input topics to Schema class names (as a JSON string)</td><td></td></tr> |
| <tr><td><code>--client-auth-params</code></td><td>Client authentication param</td><td></td></tr> |
| <tr><td><code>--client-auth-plugin</code></td><td>Client authentication plugin using which function-process can connect to broker</td><td></td></tr> |
| <tr><td><code>--function-config-file</code></td><td>The path to a YAML config file specifying the function's configuration</td><td></td></tr> |
| <tr><td><code>--hostname-verification-enabled</code></td><td>Enable hostname verification</td><td>false</td></tr> |
| <tr><td><code>--instance-id-offset</code></td><td>Start the instanceIds from this offset</td><td>0</td></tr> |
| <tr><td><code>--inputs</code></td><td>The function's input topic or topics (multiple topics can be specified as a comma-separated list)</td><td></td></tr> |
| <tr><td><code>--log-topic</code></td><td>The topic to which the function's logs are produced</td><td></td></tr> |
| <tr><td><code>--jar</code></td><td>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)] from which worker can download the package.</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The function's name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The function's namespace</td><td></td></tr> |
| <tr><td><code>--output</code></td><td>The function's output topic (If none is specified, no output is written)</td><td></td></tr> |
| <tr><td><code>--output-serde-classname</code></td><td>The SerDe class to be used for messages output by the function</td><td></td></tr> |
| <tr><td><code>--parallelism</code></td><td>The function’s parallelism factor, i.e. the number of instances of the function to run</td><td>1</td></tr> |
| <tr><td><code>--processing-guarantees</code></td><td>The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]</td><td>ATLEAST_ONCE</td></tr> |
| <tr><td><code>--py</code></td><td>Path to the main Python file/Python Wheel file for the function (if the function is written in Python)</td><td></td></tr> |
| <tr><td><code>--schema-type</code></td><td>The builtin schema type or custom schema class name to be used for messages output by the function</td><td></td></tr> |
| <tr><td><code>--sliding-interval-count</code></td><td>The number of messages after which the window slides</td><td></td></tr> |
| <tr><td><code>--sliding-interval-duration-ms</code></td><td>The time duration after which the window slides</td><td></td></tr> |
| <tr><td><code>--state-storage-service-url</code></td><td>The URL for the state storage service. By default, it it set to the service URL of the Apache BookKeeper. This service URL must be added manually when the Pulsar Function runs locally.</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The function’s tenant</td><td></td></tr> |
| <tr><td><code>--topics-pattern</code></td><td>The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)</td><td></td></tr> |
| <tr><td><code>--user-config</code></td><td>User-defined config key/values</td><td></td></tr> |
| <tr><td><code>--window-length-count</code></td><td>The number of messages per window</td><td></td></tr> |
| <tr><td><code>--window-length-duration-ms</code></td><td>The time duration of the window in milliseconds</td><td></td></tr> |
| <tr><td><code>--dead-letter-topic</code></td><td>The topic where all messages which could not be processed successfully are sent</td><td></td></tr> |
| <tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr> |
| <tr><td><code>--max-message-retries</code></td><td>How many times should we try to process a message before giving up</td><td></td></tr> |
| <tr><td><code>--retain-ordering</code></td><td>Function consumes and processes messages in order</td><td></td></tr> |
| <tr><td><code>--retain-key-ordering</code></td><td>Function consumes and processes messages in key order</td><td></td></tr> |
| <tr><td><code>--timeout-ms</code></td><td>The message timeout in milliseconds</td><td></td></tr> |
| <tr><td><code>--tls-allow-insecure</code></td><td>Allow insecure tls connection</td><td>false</td></tr> |
| <tr><td><code>--tls-trust-cert-path</code></td><td>The tls trust cert file path</td><td></td></tr> |
| <tr><td><code>--use-tls</code></td><td>Use tls connection</td><td>false</td></tr> |
| <tr><td><code>--producer-config</code></td><td>The custom producer configuration (as a JSON string)</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="create-1"></a><a href="#create-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>create</code></h3> |
| <p>Create a Pulsar Function in cluster mode (i.e. deploy it on a Pulsar cluster)</p> |
| <p>Usage</p> |
| <pre><code class="hljs">$ pulsar-<span class="hljs-keyword">admin</span> <span class="hljs-keyword">functions</span> <span class="hljs-keyword">create</span> <span class="hljs-keyword">options</span> |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--cpu</code></td><td>The cpu in cores that need to be allocated per function instance(applicable only to docker runtime)</td><td></td></tr> |
| <tr><td><code>--ram</code></td><td>The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime)</td><td></td></tr> |
| <tr><td><code>--disk</code></td><td>The disk in bytes that need to be allocated per function instance(applicable only to docker runtime)</td><td></td></tr> |
| <tr><td><code>--auto-ack</code></td><td>Whether or not the framework will automatically acknowledge messages</td><td></td></tr> |
| <tr><td><code>--subs-name</code></td><td>Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer</td><td></td></tr> |
| <tr><td><code>--classname</code></td><td>The function's class name</td><td></td></tr> |
| <tr><td><code>--custom-serde-inputs</code></td><td>The map of input topics to SerDe class names (as a JSON string)</td><td></td></tr> |
| <tr><td><code>--custom-schema-inputs</code></td><td>The map of input topics to Schema class names (as a JSON string)</td><td></td></tr> |
| <tr><td><code>--function-config-file</code></td><td>The path to a YAML config file specifying the function's configuration</td><td></td></tr> |
| <tr><td><code>--inputs</code></td><td>The function's input topic or topics (multiple topics can be specified as a comma-separated list)</td><td></td></tr> |
| <tr><td><code>--log-topic</code></td><td>The topic to which the function's logs are produced</td><td></td></tr> |
| <tr><td><code>--jar</code></td><td>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)] from which worker can download the package.</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The function's name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The function’s namespace</td><td></td></tr> |
| <tr><td><code>--output</code></td><td>The function's output topic (If none is specified, no output is written)</td><td></td></tr> |
| <tr><td><code>--output-serde-classname</code></td><td>The SerDe class to be used for messages output by the function</td><td></td></tr> |
| <tr><td><code>--parallelism</code></td><td>The function’s parallelism factor, i.e. the number of instances of the function to run</td><td>1</td></tr> |
| <tr><td><code>--processing-guarantees</code></td><td>The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]</td><td>ATLEAST_ONCE</td></tr> |
| <tr><td><code>--py</code></td><td>Path to the main Python file/Python Wheel file for the function (if the function is written in Python)</td><td></td></tr> |
| <tr><td><code>--schema-type</code></td><td>The builtin schema type or custom schema class name to be used for messages output by the function</td><td></td></tr> |
| <tr><td><code>--sliding-interval-count</code></td><td>The number of messages after which the window slides</td><td></td></tr> |
| <tr><td><code>--sliding-interval-duration-ms</code></td><td>The time duration after which the window slides</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The function’s tenant</td><td></td></tr> |
| <tr><td><code>--topics-pattern</code></td><td>The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)</td><td></td></tr> |
| <tr><td><code>--user-config</code></td><td>User-defined config key/values</td><td></td></tr> |
| <tr><td><code>--window-length-count</code></td><td>The number of messages per window</td><td></td></tr> |
| <tr><td><code>--window-length-duration-ms</code></td><td>The time duration of the window in milliseconds</td><td></td></tr> |
| <tr><td><code>--dead-letter-topic</code></td><td>The topic where all messages which could not be processed</td><td></td></tr> |
| <tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr> |
| <tr><td><code>--max-message-retries</code></td><td>How many times should we try to process a message before giving up</td><td></td></tr> |
| <tr><td><code>--retain-ordering</code></td><td>Function consumes and processes messages in order</td><td></td></tr> |
| <tr><td><code>--retain-key-ordering</code></td><td>Function consumes and processes messages in key order</td><td></td></tr> |
| <tr><td><code>--timeout-ms</code></td><td>The message timeout in milliseconds</td><td></td></tr> |
| <tr><td><code>--producer-config</code></td><td>The custom producer configuration (as a JSON string)</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="delete-1"></a><a href="#delete-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>delete</code></h3> |
| <p>Delete a Pulsar Function that's running on a Pulsar cluster</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> delete options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The function's name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The function's namespace</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The function's tenant</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="update-1"></a><a href="#update-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>update</code></h3> |
| <p>Update a Pulsar Function that's been deployed to a Pulsar cluster</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> update options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--cpu</code></td><td>The cpu in cores that need to be allocated per function instance(applicable only to docker runtime)</td><td></td></tr> |
| <tr><td><code>--ram</code></td><td>The ram in bytes that need to be allocated per function instance(applicable only to process/docker runtime)</td><td></td></tr> |
| <tr><td><code>--disk</code></td><td>The disk in bytes that need to be allocated per function instance(applicable only to docker runtime)</td><td></td></tr> |
| <tr><td><code>--auto-ack</code></td><td>Whether or not the framework will automatically acknowledge messages</td><td></td></tr> |
| <tr><td><code>--subs-name</code></td><td>Pulsar source subscription name if user wants a specific subscription-name for input-topic consumer</td><td></td></tr> |
| <tr><td><code>--classname</code></td><td>The function's class name</td><td></td></tr> |
| <tr><td><code>--custom-serde-inputs</code></td><td>The map of input topics to SerDe class names (as a JSON string)</td><td></td></tr> |
| <tr><td><code>--custom-schema-inputs</code></td><td>The map of input topics to Schema class names (as a JSON string)</td><td></td></tr> |
| <tr><td><code>--function-config-file</code></td><td>The path to a YAML config file specifying the function's configuration</td><td></td></tr> |
| <tr><td><code>--inputs</code></td><td>The function's input topic or topics (multiple topics can be specified as a comma-separated list)</td><td></td></tr> |
| <tr><td><code>--log-topic</code></td><td>The topic to which the function's logs are produced</td><td></td></tr> |
| <tr><td><code>--jar</code></td><td>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)] from which worker can download the package.</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The function's name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The function’s namespace</td><td></td></tr> |
| <tr><td><code>--output</code></td><td>The function's output topic (If none is specified, no output is written)</td><td></td></tr> |
| <tr><td><code>--output-serde-classname</code></td><td>The SerDe class to be used for messages output by the function</td><td></td></tr> |
| <tr><td><code>--parallelism</code></td><td>The function’s parallelism factor, i.e. the number of instances of the function to run</td><td>1</td></tr> |
| <tr><td><code>--processing-guarantees</code></td><td>The processing guarantees (aka delivery semantics) applied to the function. Possible Values: [ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE]</td><td>ATLEAST_ONCE</td></tr> |
| <tr><td><code>--py</code></td><td>Path to the main Python file/Python Wheel file for the function (if the function is written in Python)</td><td></td></tr> |
| <tr><td><code>--schema-type</code></td><td>The builtin schema type or custom schema class name to be used for messages output by the function</td><td></td></tr> |
| <tr><td><code>--sliding-interval-count</code></td><td>The number of messages after which the window slides</td><td></td></tr> |
| <tr><td><code>--sliding-interval-duration-ms</code></td><td>The time duration after which the window slides</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The function’s tenant</td><td></td></tr> |
| <tr><td><code>--topics-pattern</code></td><td>The topic pattern to consume from list of topics under a namespace that match the pattern. [--input] and [--topic-pattern] are mutually exclusive. Add SerDe class name for a pattern in --custom-serde-inputs (supported for java fun only)</td><td></td></tr> |
| <tr><td><code>--user-config</code></td><td>User-defined config key/values</td><td></td></tr> |
| <tr><td><code>--window-length-count</code></td><td>The number of messages per window</td><td></td></tr> |
| <tr><td><code>--window-length-duration-ms</code></td><td>The time duration of the window in milliseconds</td><td></td></tr> |
| <tr><td><code>--dead-letter-topic</code></td><td>The topic where all messages which could not be processed</td><td></td></tr> |
| <tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr> |
| <tr><td><code>--max-message-retries</code></td><td>How many times should we try to process a message before giving up</td><td></td></tr> |
| <tr><td><code>--retain-ordering</code></td><td>Function consumes and processes messages in order</td><td></td></tr> |
| <tr><td><code>--retain-key-ordering</code></td><td>Function consumes and processes messages in key order</td><td></td></tr> |
| <tr><td><code>--timeout-ms</code></td><td>The message timeout in milliseconds</td><td></td></tr> |
| <tr><td><code>--producer-config</code></td><td>The custom producer configuration (as a JSON string)</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-1"></a><a href="#get-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get</code></h3> |
| <p>Fetch information about a Pulsar Function</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> get options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The function's name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The function's namespace</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The function's tenant</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="restart"></a><a href="#restart" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>restart</code></h3> |
| <p>Restart function instance</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> restart options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr> |
| <tr><td><code>--instance-id</code></td><td>The function instanceId (restart all instances if instance-id is not provided)</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The function's name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The function's namespace</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The function's tenant</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="stop"></a><a href="#stop" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>stop</code></h3> |
| <p>Stops function instance</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> stop options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr> |
| <tr><td><code>--instance-id</code></td><td>The function instanceId (stop all instances if instance-id is not provided)</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The function's name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The function's namespace</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The function's tenant</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="start"></a><a href="#start" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>start</code></h3> |
| <p>Starts a stopped function instance</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> start options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr> |
| <tr><td><code>--instance-id</code></td><td>The function instanceId (start all instances if instance-id is not provided)</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The function's name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The function's namespace</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The function's tenant</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="status"></a><a href="#status" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>status</code></h3> |
| <p>Check the current status of a Pulsar Function</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> status options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr> |
| <tr><td><code>--instance-id</code></td><td>The function instanceId (Get-status of all instances if instance-id is not provided)</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The function's name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The function's namespace</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The function's tenant</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="stats"></a><a href="#stats" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>stats</code></h3> |
| <p>Get the current stats of a Pulsar Function</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> stats options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr> |
| <tr><td><code>--instance-id</code></td><td>The function instanceId (Get-stats of all instances if instance-id is not provided)</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The function's name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The function's namespace</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The function's tenant</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="list-2"></a><a href="#list-2" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>list</code></h3> |
| <p>List all of the Pulsar Functions running under a specific tenant and namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> list options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--namespace</code></td><td>The function's namespace</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The function's tenant</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="querystate"></a><a href="#querystate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>querystate</code></h3> |
| <p>Fetch the current state associated with a Pulsar Function running in cluster mode</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> querystate options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr> |
| <tr><td><code>-k</code>, <code>--key</code></td><td>The key for the state you want to fetch</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The function's name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The function's namespace</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The function's tenant</td><td></td></tr> |
| <tr><td><code>-w</code>, <code>--watch</code></td><td>Watch for changes in the value associated with a key for a Pulsar Function</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="putstate"></a><a href="#putstate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>putstate</code></h3> |
| <p>Put a key/value pair to the state associated with a Pulsar Function</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> putstate options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the Pulsar Function</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The name of a Pulsar Function</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The namespace of a Pulsar Function</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The tenant of a Pulsar Function</td><td></td></tr> |
| <tr><td><code>-s</code>, <code>--state</code></td><td>The FunctionState that needs to be put</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="trigger"></a><a href="#trigger" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>trigger</code></h3> |
| <p>Triggers the specified Pulsar Function with a supplied value</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> trigger options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--fqfn</code></td><td>The Fully Qualified Function Name (FQFN) for the function</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The function's name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The function's namespace</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The function's tenant</td><td></td></tr> |
| <tr><td><code>--topic</code></td><td>The specific topic name that the function consumes from that you want to inject the data to</td><td></td></tr> |
| <tr><td><code>--trigger-file</code></td><td>The path to the file that contains the data with which you'd like to trigger the function</td><td></td></tr> |
| <tr><td><code>--trigger-value</code></td><td>The value with which you want to trigger the function</td><td></td></tr> |
| </tbody> |
| </table> |
| <h2><a class="anchor" aria-hidden="true" id="functions-worker"></a><a href="#functions-worker" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>functions-worker</code></h2> |
| <p>Operations to collect function-worker statistics</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span>-worker subcommand |
| </code></pre> |
| <p>Subcommands</p> |
| <ul> |
| <li><code>function-stats</code></li> |
| <li><code>get-cluster</code></li> |
| <li><code>get-cluster-leader</code></li> |
| <li><code>get-function-assignments</code></li> |
| <li><code>monitoring-metrics</code></li> |
| </ul> |
| <h3><a class="anchor" aria-hidden="true" id="function-stats"></a><a href="#function-stats" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>function-stats</code></h3> |
| <p>Dump all functions stats running on this broker</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span>-worker <span class="hljs-keyword">function</span>-stats |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-cluster"></a><a href="#get-cluster" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-cluster</code></h3> |
| <p>Get all workers belonging to this cluster</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span>-worker get-cluster |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-cluster-leader"></a><a href="#get-cluster-leader" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-cluster-leader</code></h3> |
| <p>Get the leader of the worker cluster</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span>-worker get-cluster-leader |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-function-assignments"></a><a href="#get-function-assignments" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-function-assignments</code></h3> |
| <p>Get the assignments of the functions across the worker cluster</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span>-worker get-function-assignments |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="monitoring-metrics-1"></a><a href="#monitoring-metrics-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>monitoring-metrics</code></h3> |
| <p>Dump metrics for Monitoring</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span>-worker monitoring-metrics |
| </code></pre> |
| <h2><a class="anchor" aria-hidden="true" id="namespaces-1"></a><a href="#namespaces-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>namespaces</code></h2> |
| <p>Operations for managing namespaces</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces subcommand |
| </code></pre> |
| <p>Subcommands</p> |
| <ul> |
| <li><code>list</code></li> |
| <li><code>topics</code></li> |
| <li><code>policies</code></li> |
| <li><code>create</code></li> |
| <li><code>delete</code></li> |
| <li><code>set-deduplication</code></li> |
| <li><code>set-auto-topic-creation</code></li> |
| <li><code>remove-auto-topic-creation</code></li> |
| <li><code>set-auto-subscription-creation</code></li> |
| <li><code>remove-auto-subscription-creation</code></li> |
| <li><code>permissions</code></li> |
| <li><code>grant-permission</code></li> |
| <li><code>revoke-permission</code></li> |
| <li><code>grant-subscription-permission</code></li> |
| <li><code>revoke-subscription-permission</code></li> |
| <li><code>set-clusters</code></li> |
| <li><code>get-clusters</code></li> |
| <li><code>get-backlog-quotas</code></li> |
| <li><code>set-backlog-quota</code></li> |
| <li><code>remove-backlog-quota</code></li> |
| <li><code>get-persistence</code></li> |
| <li><code>set-persistence</code></li> |
| <li><code>get-message-ttl</code></li> |
| <li><code>set-message-ttl</code></li> |
| <li><code>remove-message-ttl</code></li> |
| <li><code>get-anti-affinity-group</code></li> |
| <li><code>set-anti-affinity-group</code></li> |
| <li><code>get-anti-affinity-namespaces</code></li> |
| <li><code>delete-anti-affinity-group</code></li> |
| <li><code>get-retention</code></li> |
| <li><code>set-retention</code></li> |
| <li><code>unload</code></li> |
| <li><code>split-bundle</code></li> |
| <li><code>set-dispatch-rate</code></li> |
| <li><code>get-dispatch-rate</code></li> |
| <li><code>set-replicator-dispatch-rate</code></li> |
| <li><code>get-replicator-dispatch-rate</code></li> |
| <li><code>set-subscribe-rate</code></li> |
| <li><code>get-subscribe-rate</code></li> |
| <li><code>set-subscription-dispatch-rate</code></li> |
| <li><code>get-subscription-dispatch-rate</code></li> |
| <li><code>set-subscription-expiration-time</code></li> |
| <li><code>get-subscription-expiration-time</code></li> |
| <li><code>clear-backlog</code></li> |
| <li><code>unsubscribe</code></li> |
| <li><code>set-encryption-required</code></li> |
| <li><code>set-delayed-delivery</code></li> |
| <li><code>get-delayed-delivery</code></li> |
| <li><code>set-subscription-auth-mode</code></li> |
| <li><code>get-max-producers-per-topic</code></li> |
| <li><code>set-max-producers-per-topic</code></li> |
| <li><code>get-max-consumers-per-topic</code></li> |
| <li><code>set-max-consumers-per-topic</code></li> |
| <li><code>get-max-consumers-per-subscription</code></li> |
| <li><code>set-max-consumers-per-subscription</code></li> |
| <li><code>get-max-unacked-messages-per-subscription</code></li> |
| <li><code>set-max-unacked-messages-per-subscription</code></li> |
| <li><code>get-max-unacked-messages-per-consumer</code></li> |
| <li><code>set-max-unacked-messages-per-consumer</code></li> |
| <li><code>get-compaction-threshold</code></li> |
| <li><code>set-compaction-threshold</code></li> |
| <li><code>get-offload-threshold</code></li> |
| <li><code>set-offload-threshold</code></li> |
| <li><code>get-offload-deletion-lag</code></li> |
| <li><code>set-offload-deletion-lag</code></li> |
| <li><code>clear-offload-deletion-lag</code></li> |
| <li><code>get-schema-autoupdate-strategy</code></li> |
| <li><code>set-schema-autoupdate-strategy</code></li> |
| <li><code>set-offload-policies</code></li> |
| <li><code>get-offload-policies</code></li> |
| <li><code>set-max-subscriptions-per-topic</code></li> |
| <li><code>get-max-subscriptions-per-topic</code></li> |
| <li><code>remove-max-subscriptions-per-topic</code></li> |
| </ul> |
| <h3><a class="anchor" aria-hidden="true" id="list-3"></a><a href="#list-3" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>list</code></h3> |
| <p>Get the namespaces for a tenant</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces list tenant-name |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="topics"></a><a href="#topics" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>topics</code></h3> |
| <p>Get the list of topics for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces topics tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="policies"></a><a href="#policies" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>policies</code></h3> |
| <p>Get the configuration policies of a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces policies tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="create-2"></a><a href="#create-2" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>create</code></h3> |
| <p>Create a new namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces create tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-b</code>, <code>--bundles</code></td><td>The number of bundles to activate</td><td>0</td></tr> |
| <tr><td><code>-c</code>, <code>--clusters</code></td><td>List of clusters this namespace will be assigned</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="delete-2"></a><a href="#delete-2" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>delete</code></h3> |
| <p>Deletes a namespace. The namespace needs to be empty</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces delete tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-deduplication"></a><a href="#set-deduplication" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-deduplication</code></h3> |
| <p>Enable or disable message deduplication on a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-deduplication tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--enable</code>, <code>-e</code></td><td>Enable message deduplication on the specified namespace</td><td>false</td></tr> |
| <tr><td><code>--disable</code>, <code>-d</code></td><td>Disable message deduplication on the specified namespace</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="set-auto-topic-creation"></a><a href="#set-auto-topic-creation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-auto-topic-creation</code></h3> |
| <p>Enable or disable autoTopicCreation for a namespace, overriding broker settings</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-auto-topic-creation tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--enable</code>, <code>-e</code></td><td>Enable allowAutoTopicCreation on namespace</td><td>false</td></tr> |
| <tr><td><code>--disable</code>, <code>-d</code></td><td>Disable allowAutoTopicCreation on namespace</td><td>false</td></tr> |
| <tr><td><code>--type</code>, <code>-t</code></td><td>Type of topic to be auto-created. Possible values: (partitioned, non-partitioned)</td><td>non-partitioned</td></tr> |
| <tr><td><code>--num-partitions</code>, <code>-n</code></td><td>Default number of partitions of topic to be auto-created, applicable to partitioned topics only</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="remove-auto-topic-creation"></a><a href="#remove-auto-topic-creation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-auto-topic-creation</code></h3> |
| <p>Remove override of autoTopicCreation for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces remove-auto-topic-creation tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-auto-subscription-creation"></a><a href="#set-auto-subscription-creation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-auto-subscription-creation</code></h3> |
| <p>Enable autoSubscriptionCreation for a namespace, overriding broker settings</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-auto-subscription-creation tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--enable</code>, <code>-e</code></td><td>Enable allowAutoSubscriptionCreation on namespace</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="remove-auto-subscription-creation"></a><a href="#remove-auto-subscription-creation" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-auto-subscription-creation</code></h3> |
| <p>Remove override of autoSubscriptionCreation for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces remove-auto-subscription-creation tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="permissions"></a><a href="#permissions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>permissions</code></h3> |
| <p>Get the permissions on a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces permissions tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="grant-permission"></a><a href="#grant-permission" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>grant-permission</code></h3> |
| <p>Grant permissions on a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces grant-permission tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--actions</code></td><td>Actions to be granted (<code>produce</code> or <code>consume</code>)</td><td></td></tr> |
| <tr><td><code>--role</code></td><td>The client role to which to grant the permissions</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="revoke-permission"></a><a href="#revoke-permission" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>revoke-permission</code></h3> |
| <p>Revoke permissions on a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces revoke-permission tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--role</code></td><td>The client role to which to revoke the permissions</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="grant-subscription-permission"></a><a href="#grant-subscription-permission" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>grant-subscription-permission</code></h3> |
| <p>Grant permissions to access subscription admin-api</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces grant-subscription-permission tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--roles</code></td><td>The client roles to which to grant the permissions (comma separated roles)</td><td></td></tr> |
| <tr><td><code>--subscription</code></td><td>The subscription name for which permission will be granted to roles</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="revoke-subscription-permission"></a><a href="#revoke-subscription-permission" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>revoke-subscription-permission</code></h3> |
| <p>Revoke permissions to access subscription admin-api</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces revoke-subscription-permission tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--role</code></td><td>The client role to which to revoke the permissions</td><td></td></tr> |
| <tr><td><code>--subscription</code></td><td>The subscription name for which permission will be revoked to roles</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="set-clusters"></a><a href="#set-clusters" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-clusters</code></h3> |
| <p>Set replication clusters for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-clusters tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-c</code>, <code>--clusters</code></td><td>Replication clusters ID list (comma-separated values)</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-clusters"></a><a href="#get-clusters" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-clusters</code></h3> |
| <p>Get replication clusters for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-clusters tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-backlog-quotas"></a><a href="#get-backlog-quotas" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-backlog-quotas</code></h3> |
| <p>Get the backlog quota policies for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-backlog-quotas tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-backlog-quota"></a><a href="#set-backlog-quota" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-backlog-quota</code></h3> |
| <p>Set a backlog quota policy for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-backlog-quota tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-l</code>, <code>--limit</code></td><td>The backlog size limit (for example <code>10M</code> or <code>16G</code>)</td><td></td></tr> |
| <tr><td><code>-p</code>, <code>--policy</code></td><td>The retention policy to enforce when the limit is reached. The valid options are: <code>producer_request_hold</code>, <code>producer_exception</code> or <code>consumer_backlog_eviction</code></td></tr> |
| </tbody> |
| </table> |
| <p>Example</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-backlog-quota my-tenant/my-ns \ |
| --<span class="hljs-built_in">limit</span> 2G \ |
| --policy producer_request_hold |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-backlog-quota"></a><a href="#remove-backlog-quota" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-backlog-quota</code></h3> |
| <p>Remove a backlog quota policy from a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces remove-backlog-quota tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-persistence"></a><a href="#get-persistence" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-persistence</code></h3> |
| <p>Get the persistence policies for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-persistence tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-persistence"></a><a href="#set-persistence" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-persistence</code></h3> |
| <p>Set the persistence policies for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-persistence tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-a</code>, <code>--bookkeeper-ack-quorum</code></td><td>The number of acks (guaranteed copies) to wait for each entry</td><td>0</td></tr> |
| <tr><td><code>-e</code>, <code>--bookkeeper-ensemble</code></td><td>The number of bookies to use for a topic</td><td>0</td></tr> |
| <tr><td><code>-w</code>, <code>--bookkeeper-write-quorum</code></td><td>How many writes to make of each entry</td><td>0</td></tr> |
| <tr><td><code>-r</code>, <code>--ml-mark-delete-max-rate</code></td><td>Throttling rate of mark-delete operation (0 means no throttle)</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-message-ttl"></a><a href="#get-message-ttl" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-message-ttl</code></h3> |
| <p>Get the message TTL for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-message-ttl tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-message-ttl"></a><a href="#set-message-ttl" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-message-ttl</code></h3> |
| <p>Set the message TTL for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-message-ttl tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-ttl</code>, <code>--messageTTL</code></td><td>Message TTL in seconds. When the value is set to <code>0</code>, TTL is disabled. TTL is disabled by default.</td><td>0</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="remove-message-ttl"></a><a href="#remove-message-ttl" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-message-ttl</code></h3> |
| <p>Remove the message TTL for a namespace.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces remove-message-ttl tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-anti-affinity-group"></a><a href="#get-anti-affinity-group" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-anti-affinity-group</code></h3> |
| <p>Get Anti-affinity group name for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-anti-affinity-group tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-anti-affinity-group"></a><a href="#set-anti-affinity-group" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-anti-affinity-group</code></h3> |
| <p>Set Anti-affinity group name for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-anti-affinity-group tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-g</code>, <code>--group</code></td><td>Anti-affinity group name</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-anti-affinity-namespaces"></a><a href="#get-anti-affinity-namespaces" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-anti-affinity-namespaces</code></h3> |
| <p>Get Anti-affinity namespaces grouped with the given anti-affinity group name</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-anti-affinity-namespaces options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-c</code>, <code>--cluster</code></td><td>Cluster name</td><td></td></tr> |
| <tr><td><code>-g</code>, <code>--group</code></td><td>Anti-affinity group name</td><td></td></tr> |
| <tr><td><code>-p</code>, <code>--tenant</code></td><td>Tenant is only used for authorization. Client has to be admin of any of the tenant to access this api</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="delete-anti-affinity-group"></a><a href="#delete-anti-affinity-group" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>delete-anti-affinity-group</code></h3> |
| <p>Remove Anti-affinity group name for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces delete-anti-affinity-group tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-retention"></a><a href="#get-retention" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-retention</code></h3> |
| <p>Get the retention policy that is applied to each topic within the specified namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-retention tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-retention"></a><a href="#set-retention" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-retention</code></h3> |
| <p>Set the retention policy for each topic within the specified namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-retention tenant/namespace |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-s</code>, <code>--size</code></td><td>The retention size limits (for example 10M, 16G or 3T) for each topic in the namespace. 0 means no retention and -1 means infinite size retention</td><td></td></tr> |
| <tr><td><code>-t</code>, <code>--time</code></td><td>The retention time in minutes, hours, days, or weeks. Examples: 100m, 13h, 2d, 5w. 0 means no retention and -1 means infinite time retention</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="unload"></a><a href="#unload" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>unload</code></h3> |
| <p>Unload a namespace or namespace bundle from the current serving broker.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces unload tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-b</code>, <code>--bundle</code></td><td>{start-boundary}_{end-boundary} (e.g. 0x00000000_0xffffffff)</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="split-bundle"></a><a href="#split-bundle" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>split-bundle</code></h3> |
| <p>Split a namespace-bundle from the current serving broker</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces split-bundle tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-b</code>, <code>--bundle</code></td><td>{start-boundary}_{end-boundary} (e.g. 0x00000000_0xffffffff)</td><td></td></tr> |
| <tr><td><code>-u</code>, <code>--unload</code></td><td>Unload newly split bundles after splitting old bundle</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="set-dispatch-rate"></a><a href="#set-dispatch-rate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-dispatch-rate</code></h3> |
| <p>Set message-dispatch-rate for all topics of the namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-dispatch-rate tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-bd</code>, <code>--byte-dispatch-rate</code></td><td>The byte dispatch rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr> |
| <tr><td><code>-dt</code>, <code>--dispatch-rate-period</code></td><td>The dispatch rate period in second type (default 1 second will be overwrite if not passed)</td><td>1</td></tr> |
| <tr><td><code>-md</code>, <code>--msg-dispatch-rate</code></td><td>The message dispatch rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-dispatch-rate"></a><a href="#get-dispatch-rate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-dispatch-rate</code></h3> |
| <p>Get configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-dispatch-rate tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-replicator-dispatch-rate"></a><a href="#set-replicator-dispatch-rate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-replicator-dispatch-rate</code></h3> |
| <p>Set replicator message-dispatch-rate for all topics of the namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-replicator-dispatch-rate tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-bd</code>, <code>--byte-dispatch-rate</code></td><td>The byte dispatch rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr> |
| <tr><td><code>-dt</code>, <code>--dispatch-rate-period</code></td><td>The dispatch rate period in second type (default 1 second will be overwrite if not passed)</td><td>1</td></tr> |
| <tr><td><code>-md</code>, <code>--msg-dispatch-rate</code></td><td>The message dispatch rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-replicator-dispatch-rate"></a><a href="#get-replicator-dispatch-rate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-replicator-dispatch-rate</code></h3> |
| <p>Get replicator configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-replicator-dispatch-rate tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-subscribe-rate"></a><a href="#set-subscribe-rate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-subscribe-rate</code></h3> |
| <p>Set subscribe-rate per consumer for all topics of the namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-subscribe-rate tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-sr</code>, <code>--subscribe-rate</code></td><td>The subscribe rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr> |
| <tr><td><code>-st</code>, <code>--subscribe-rate-period</code></td><td>The subscribe rate period in second type (default 30 second will be overwrite if not passed)</td><td>30</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-subscribe-rate"></a><a href="#get-subscribe-rate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-subscribe-rate</code></h3> |
| <p>Get configured subscribe-rate per consumer for all topics of the namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-subscribe-rate tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-subscription-dispatch-rate"></a><a href="#set-subscription-dispatch-rate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-subscription-dispatch-rate</code></h3> |
| <p>Set subscription message-dispatch-rate for all subscription of the namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-subscription-dispatch-rate tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-bd</code>, <code>--byte-dispatch-rate</code></td><td>The byte dispatch rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr> |
| <tr><td><code>-dt</code>, <code>--dispatch-rate-period</code></td><td>The dispatch rate period in second type (default 1 second will be overwrite if not passed)</td><td>1</td></tr> |
| <tr><td><code>-md</code>, <code>--sub-msg-dispatch-rate</code></td><td>The message dispatch rate (default -1 will be overwrite if not passed)</td><td>-1</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-subscription-dispatch-rate"></a><a href="#get-subscription-dispatch-rate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-subscription-dispatch-rate</code></h3> |
| <p>Get subscription configured message-dispatch-rate for all topics of the namespace (Disabled if value < 0)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-subscription-dispatch-rate tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-subscription-expiration-time"></a><a href="#set-subscription-expiration-time" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-subscription-expiration-time</code></h3> |
| <p>Set the subscription expiration time for a namespace (in minutes).</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-subscription-expiration-time tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-t</code>, <code>--time</code></td><td>Subscription expiration time in minutes</td><td>0</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-subscription-expiration-time"></a><a href="#get-subscription-expiration-time" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-subscription-expiration-time</code></h3> |
| <p>Get the subscription expiration time for a namespace (in minutes).</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-subscription-expiration-time tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="clear-backlog"></a><a href="#clear-backlog" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>clear-backlog</code></h3> |
| <p>Clear the backlog for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces clear-backlog tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-b</code>, <code>--bundle</code></td><td>{start-boundary}_{end-boundary} (e.g. 0x00000000_0xffffffff)</td><td></td></tr> |
| <tr><td><code>-force</code>, <code>--force</code></td><td>Whether to force a clear backlog without prompt</td><td>false</td></tr> |
| <tr><td><code>-s</code>, <code>--sub</code></td><td>The subscription name</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="unsubscribe"></a><a href="#unsubscribe" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>unsubscribe</code></h3> |
| <p>Unsubscribe the given subscription on all destinations on a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces unsubscribe tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-b</code>, <code>--bundle</code></td><td>{start-boundary}_{end-boundary} (e.g. 0x00000000_0xffffffff)</td><td></td></tr> |
| <tr><td><code>-s</code>, <code>--sub</code></td><td>The subscription name</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="set-encryption-required"></a><a href="#set-encryption-required" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-encryption-required</code></h3> |
| <p>Enable or disable message encryption required for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-encryption-required tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-d</code>, <code>--disable</code></td><td>Disable message encryption required</td><td>false</td></tr> |
| <tr><td><code>-e</code>, <code>--enable</code></td><td>Enable message encryption required</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="set-delayed-delivery"></a><a href="#set-delayed-delivery" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-delayed-delivery</code></h3> |
| <p>Set the delayed delivery policy on a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-delayed-delivery tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-d</code>, <code>--disable</code></td><td>Disable delayed delivery messages</td><td>false</td></tr> |
| <tr><td><code>-e</code>, <code>--enable</code></td><td>Enable delayed delivery messages</td><td>false</td></tr> |
| <tr><td><code>-t</code>, <code>--time</code></td><td>The tick time for when retrying on delayed delivery messages</td><td>1s</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-delayed-delivery"></a><a href="#get-delayed-delivery" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-delayed-delivery</code></h3> |
| <p>Get the delayed delivery policy on a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-delayed-delivery-time tenant/namespace |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-t</code>, <code>--time</code></td><td>The tick time for when retrying on delayed delivery messages</td><td>1s</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="set-subscription-auth-mode"></a><a href="#set-subscription-auth-mode" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-subscription-auth-mode</code></h3> |
| <p>Set subscription auth mode on a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-subscription-auth-mode tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-m</code>, <code>--subscription-auth-mode</code></td><td>Subscription authorization mode for Pulsar policies. Valid options are: [None, Prefix]</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-max-producers-per-topic"></a><a href="#get-max-producers-per-topic" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-max-producers-per-topic</code></h3> |
| <p>Get maxProducersPerTopic for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-max-producers-per-topic tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-max-producers-per-topic"></a><a href="#set-max-producers-per-topic" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-max-producers-per-topic</code></h3> |
| <p>Set maxProducersPerTopic for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-max-producers-per-topic tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-p</code>, <code>--max-producers-per-topic</code></td><td>maxProducersPerTopic for a namespace</td><td>0</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-max-consumers-per-topic"></a><a href="#get-max-consumers-per-topic" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-max-consumers-per-topic</code></h3> |
| <p>Get maxConsumersPerTopic for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-max-consumers-per-topic tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-max-consumers-per-topic"></a><a href="#set-max-consumers-per-topic" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-max-consumers-per-topic</code></h3> |
| <p>Set maxConsumersPerTopic for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-max-consumers-per-topic tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-c</code>, <code>--max-consumers-per-topic</code></td><td>maxConsumersPerTopic for a namespace</td><td>0</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-max-consumers-per-subscription"></a><a href="#get-max-consumers-per-subscription" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-max-consumers-per-subscription</code></h3> |
| <p>Get maxConsumersPerSubscription for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-max-consumers-per-subscription tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-max-consumers-per-subscription"></a><a href="#set-max-consumers-per-subscription" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-max-consumers-per-subscription</code></h3> |
| <p>Set maxConsumersPerSubscription for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-max-consumers-per-subscription tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-c</code>, <code>--max-consumers-per-subscription</code></td><td>maxConsumersPerSubscription for a namespace</td><td>0</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-max-unacked-messages-per-subscription"></a><a href="#get-max-unacked-messages-per-subscription" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-max-unacked-messages-per-subscription</code></h3> |
| <p>Get maxUnackedMessagesPerSubscription for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-max-unacked-messages-per-subscription tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-max-unacked-messages-per-subscription"></a><a href="#set-max-unacked-messages-per-subscription" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-max-unacked-messages-per-subscription</code></h3> |
| <p>Set maxUnackedMessagesPerSubscription for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-max-unacked-messages-per-subscription tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-c</code>, <code>--max-unacked-messages-per-subscription</code></td><td>maxUnackedMessagesPerSubscription for a namespace</td><td>-1</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-max-unacked-messages-per-consumer"></a><a href="#get-max-unacked-messages-per-consumer" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-max-unacked-messages-per-consumer</code></h3> |
| <p>Get maxUnackedMessagesPerConsumer for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-max-unacked-messages-per-consumer tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-max-unacked-messages-per-consumer"></a><a href="#set-max-unacked-messages-per-consumer" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-max-unacked-messages-per-consumer</code></h3> |
| <p>Set maxUnackedMessagesPerConsumer for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-max-unacked-messages-per-consumer tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-c</code>, <code>--max-unacked-messages-per-consumer</code></td><td>maxUnackedMessagesPerConsumer for a namespace</td><td>-1</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-compaction-threshold"></a><a href="#get-compaction-threshold" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-compaction-threshold</code></h3> |
| <p>Get compactionThreshold for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-compaction-threshold tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-compaction-threshold"></a><a href="#set-compaction-threshold" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-compaction-threshold</code></h3> |
| <p>Set compactionThreshold for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-compaction-threshold tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-t</code>, <code>--threshold</code></td><td>Maximum number of bytes in a topic backlog before compaction is triggered (eg: 10M, 16G, 3T). 0 disables automatic compaction</td><td>0</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-offload-threshold"></a><a href="#get-offload-threshold" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-offload-threshold</code></h3> |
| <p>Get offloadThreshold for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-offload-threshold tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-offload-threshold"></a><a href="#set-offload-threshold" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-offload-threshold</code></h3> |
| <p>Set offloadThreshold for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-offload-threshold tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-s</code>, <code>--size</code></td><td>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). Negative values disable automatic offload. 0 triggers offloading as soon as possible.</td><td>-1</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-offload-deletion-lag"></a><a href="#get-offload-deletion-lag" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-offload-deletion-lag</code></h3> |
| <p>Get offloadDeletionLag, in minutes, for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-offload-deletion-lag tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-offload-deletion-lag"></a><a href="#set-offload-deletion-lag" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-offload-deletion-lag</code></h3> |
| <p>Set offloadDeletionLag for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-offload-deletion-lag tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-l</code>, <code>--lag</code></td><td>Duration to wait after offloading a ledger segment, before deleting the copy of that segment from cluster local storage. (eg: 10m, 5h, 3d, 2w).</td><td>-1</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="clear-offload-deletion-lag"></a><a href="#clear-offload-deletion-lag" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>clear-offload-deletion-lag</code></h3> |
| <p>Clear offloadDeletionLag for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces clear-offload-deletion-lag tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-schema-autoupdate-strategy"></a><a href="#get-schema-autoupdate-strategy" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-schema-autoupdate-strategy</code></h3> |
| <p>Get the schema auto-update strategy for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-schema-autoupdate-strategy tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-schema-autoupdate-strategy"></a><a href="#set-schema-autoupdate-strategy" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-schema-autoupdate-strategy</code></h3> |
| <p>Set the schema auto-update strategy for a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-schema-autoupdate-strategy tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-c</code>, <code>--compatibility</code></td><td>Compatibility level required for new schemas created via a Producer. Possible values (Full, Backward, Forward, None).</td><td>Full</td></tr> |
| <tr><td><code>-d</code>, <code>--disabled</code></td><td>Disable automatic schema updates.</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-publish-rate"></a><a href="#get-publish-rate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-publish-rate</code></h3> |
| <p>Get the message publish rate for each topic in a namespace, in bytes as well as messages per second</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-publish-rate tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-publish-rate"></a><a href="#set-publish-rate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-publish-rate</code></h3> |
| <p>Set the message publish rate for each topic in a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-publish-rate tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-m</code>, <code>--msg-publish-rate</code></td><td>Threshold for number of messages per second per topic in the namespace (-1 implies not set, 0 for no limit).</td><td>-1</td></tr> |
| <tr><td><code>-b</code>, <code>--byte-publish-rate</code></td><td>Threshold for number of bytes per second per topic in the namespace (-1 implies not set, 0 for no limit).</td><td>-1</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="set-offload-policies"></a><a href="#set-offload-policies" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-offload-policies</code></h3> |
| <p>Set the offload policy for a namespace.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-offload-policies tenant/namespace options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-d</code>, <code>--driver</code></td><td>Driver to use to offload old data to long term storage,(Possible values: S3, aws-s3, google-cloud-storage)</td><td></td></tr> |
| <tr><td><code>-r</code>, <code>--region</code></td><td>The long term storage region</td><td></td></tr> |
| <tr><td><code>-b</code>, <code>--bucket</code></td><td>Bucket to place offloaded ledger into</td><td></td></tr> |
| <tr><td><code>-e</code>, <code>--endpoint</code></td><td>Alternative endpoint to connect to</td><td></td></tr> |
| <tr><td><code>-i</code>, <code>--aws-id</code></td><td>AWS Credential Id to use when using driver S3 or aws-s3</td><td></td></tr> |
| <tr><td><code>-s</code>, <code>--aws-secret</code></td><td>AWS Credential Secret to use when using driver S3 or aws-s3</td><td></td></tr> |
| <tr><td><code>-mbs</code>, <code>--maxBlockSize</code></td><td>Max block size</td><td>64MB</td></tr> |
| <tr><td><code>-rbs</code>, <code>--readBufferSize</code></td><td>Read buffer size</td><td>1MB</td></tr> |
| <tr><td><code>-oat</code>, <code>--offloadAfterThreshold</code></td><td>Offload after threshold size (eg: 1M, 5M)</td><td></td></tr> |
| <tr><td><code>-oae</code>, <code>--offloadAfterElapsed</code></td><td>Offload after elapsed in millis (or minutes, hours,days,weeks eg: 100m, 3h, 2d, 5w).</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-offload-policies"></a><a href="#get-offload-policies" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-offload-policies</code></h3> |
| <p>Get the offload policy for a namespace.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-offload-policies tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-max-subscriptions-per-topic"></a><a href="#set-max-subscriptions-per-topic" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-max-subscriptions-per-topic</code></h3> |
| <p>Set the maximum subscription per topic for a namespace.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces <span class="hljs-built_in">set</span>-max-subscriptions-per-topic tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-max-subscriptions-per-topic"></a><a href="#get-max-subscriptions-per-topic" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-max-subscriptions-per-topic</code></h3> |
| <p>Get the maximum subscription per topic for a namespace.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces get-max-subscriptions-per-topic tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-max-subscriptions-per-topic"></a><a href="#remove-max-subscriptions-per-topic" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-max-subscriptions-per-topic</code></h3> |
| <p>Remove the maximum subscription per topic for a namespace.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin namespaces remove-max-subscriptions-per-topic tenant/namespace |
| </code></pre> |
| <h2><a class="anchor" aria-hidden="true" id="ns-isolation-policy"></a><a href="#ns-isolation-policy" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>ns-isolation-policy</code></h2> |
| <p>Operations for managing namespace isolation policies.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin ns-isolation-policy subcommand |
| </code></pre> |
| <p>Subcommands</p> |
| <ul> |
| <li><code>set</code></li> |
| <li><code>get</code></li> |
| <li><code>list</code></li> |
| <li><code>delete</code></li> |
| <li><code>brokers</code></li> |
| <li><code>broker</code></li> |
| </ul> |
| <h3><a class="anchor" aria-hidden="true" id="set"></a><a href="#set" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set</code></h3> |
| <p>Create/update a namespace isolation policy for a cluster. This operation requires Pulsar superuser privileges.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin ns-isolation-policy <span class="hljs-built_in">set</span> cluster-name policy-name options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--auto-failover-policy-params</code></td><td>Comma-separated name=value auto failover policy parameters</td><td>[]</td></tr> |
| <tr><td><code>--auto-failover-policy-type</code></td><td>Auto failover policy type name. Currently available options: min_available.</td><td>[]</td></tr> |
| <tr><td><code>--namespaces</code></td><td>Comma-separated namespaces regex list</td><td>[]</td></tr> |
| <tr><td><code>--primary</code></td><td>Comma-separated primary broker regex list</td><td>[]</td></tr> |
| <tr><td><code>--secondary</code></td><td>Comma-separated secondary broker regex list</td><td>[]</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-2"></a><a href="#get-2" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get</code></h3> |
| <p>Get the namespace isolation policy of a cluster. This operation requires Pulsar superuser privileges.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin ns-isolation-policy get cluster-name policy-name |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="list-4"></a><a href="#list-4" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>list</code></h3> |
| <p>List all namespace isolation policies of a cluster. This operation requires Pulsar superuser privileges.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin ns-isolation-policy list cluster-name |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="delete-3"></a><a href="#delete-3" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>delete</code></h3> |
| <p>Delete namespace isolation policy of a cluster. This operation requires superuser privileges.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin ns-isolation-policy delete |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="brokers-1"></a><a href="#brokers-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>brokers</code></h3> |
| <p>List all brokers with namespace-isolation policies attached to it. This operation requires Pulsar super-user privileges.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin ns-isolation-policy brokers cluster-name |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="broker"></a><a href="#broker" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>broker</code></h3> |
| <p>Get broker with namespace-isolation policies attached to it. This operation requires Pulsar super-user privileges.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin ns-isolation-policy broker cluster-name options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--broker</code></td><td>Broker name to get namespace-isolation policies attached to it</td><td></td></tr> |
| </tbody> |
| </table> |
| <h2><a class="anchor" aria-hidden="true" id="topics-1"></a><a href="#topics-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>topics</code></h2> |
| <p>Operations for managing Pulsar topics (both persistent and non persistent)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics subcommand |
| </code></pre> |
| <p>Some namespace-level policies are available on topic level. To enable topic-level policy in Pulsar, you need to configure the following parameters in the <code>broker.conf</code> file.</p> |
| <pre><code class="hljs css language-shell">systemTopicEnabled=true |
| topicLevelPoliciesEnabled=true |
| </code></pre> |
| <p>Subcommands</p> |
| <ul> |
| <li><code>compact</code></li> |
| <li><code>compaction-status</code></li> |
| <li><code>offload</code></li> |
| <li><code>offload-status</code></li> |
| <li><code>create-partitioned-topic</code></li> |
| <li><code>create-missed-partitions</code></li> |
| <li><code>delete-partitioned-topic</code></li> |
| <li><code>create</code></li> |
| <li><code>get-partitioned-topic-metadata</code></li> |
| <li><code>update-partitioned-topic</code></li> |
| <li><code>list-partitioned-topics</code></li> |
| <li><code>list</code></li> |
| <li><code>terminate</code></li> |
| <li><code>permissions</code></li> |
| <li><code>grant-permission</code></li> |
| <li><code>revoke-permission</code></li> |
| <li><code>lookup</code></li> |
| <li><code>bundle-range</code></li> |
| <li><code>delete</code></li> |
| <li><code>unload</code></li> |
| <li><code>create-subscription</code></li> |
| <li><code>subscriptions</code></li> |
| <li><code>unsubscribe</code></li> |
| <li><code>stats</code></li> |
| <li><code>stats-internal</code></li> |
| <li><code>info-internal</code></li> |
| <li><code>partitioned-stats</code></li> |
| <li><code>partitioned-stats-internal</code></li> |
| <li><code>skip</code></li> |
| <li><code>clear-backlog</code></li> |
| <li><code>expire-messages</code></li> |
| <li><code>expire-messages-all-subscriptions</code></li> |
| <li><code>peek-messages</code></li> |
| <li><code>reset-cursor</code></li> |
| <li><code>get-message-by-id</code></li> |
| <li><code>last-message-id</code></li> |
| <li><code>get-backlog-quotas</code></li> |
| <li><code>set-backlog-quota</code></li> |
| <li><code>remove-backlog-quota</code></li> |
| <li><code>get-persistence</code></li> |
| <li><code>set-persistence</code></li> |
| <li><code>remove-persistence</code></li> |
| <li><code>get-message-ttl</code></li> |
| <li><code>set-message-ttl</code></li> |
| <li><code>remove-message-ttl</code></li> |
| <li><code>get-deduplication</code></li> |
| <li><code>set-deduplication</code></li> |
| <li><code>remove-deduplication</code></li> |
| <li><code>get-retention</code></li> |
| <li><code>set-retention</code></li> |
| <li><code>remove-retention</code></li> |
| <li><code>get-dispatch-rate</code></li> |
| <li><code>set-dispatch-rate</code></li> |
| <li><code>remove-dispatch-rate</code></li> |
| <li><code>get-max-unacked-messages-per-subscription</code></li> |
| <li><code>set-max-unacked-messages-per-subscription</code></li> |
| <li><code>remove-max-unacked-messages-per-subscription</code></li> |
| <li><code>get-max-unacked-messages-per-consumer</code></li> |
| <li><code>set-max-unacked-messages-per-consumer</code></li> |
| <li><code>remove-max-unacked-messages-per-consumer</code></li> |
| <li><code>get-delayed-delivery</code></li> |
| <li><code>set-delayed-delivery</code></li> |
| <li><code>remove-delayed-delivery</code></li> |
| <li><code>get-max-producers</code></li> |
| <li><code>set-max-producers</code></li> |
| <li><code>remove-max-producers</code></li> |
| <li><code>get-max-consumers</code></li> |
| <li><code>set-max-consumers</code></li> |
| <li><code>remove-max-consumers</code></li> |
| <li><code>get-compaction-threshold</code></li> |
| <li><code>set-compaction-threshold</code></li> |
| <li><code>remove-compaction-threshold</code></li> |
| <li><code>get-offload-policies</code></li> |
| <li><code>set-offload-policies</code></li> |
| <li><code>remove-offload-policies</code></li> |
| <li><code>get-inactive-topic-policies</code></li> |
| <li><code>set-inactive-topic-policies</code></li> |
| <li><code>remove-inactive-topic-policies</code></li> |
| <li><code>set-max-subscriptions</code></li> |
| <li><code>get-max-subscriptions</code></li> |
| <li><code>remove-max-subscriptions</code></li> |
| </ul> |
| <h3><a class="anchor" aria-hidden="true" id="compact"></a><a href="#compact" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>compact</code></h3> |
| <p>Run compaction on the specified topic (persistent topics only)</p> |
| <p>Usage</p> |
| <pre><code class="hljs">$ pulsar-admin topics compact persistent:<span class="hljs-regexp">//</span>tenant<span class="hljs-regexp">/namespace/</span>topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="compaction-status"></a><a href="#compaction-status" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>compaction-status</code></h3> |
| <p>Check the status of a topic compaction (persistent topics only)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics compaction-status persistent://tenant/namespace/topic |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-w</code>, <code>--wait-complete</code></td><td>Wait for compaction to complete</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="offload"></a><a href="#offload" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>offload</code></h3> |
| <p>Trigger offload of data from a topic to long-term storage (e.g. Amazon S3)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics offload persistent://tenant/namespace/topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-s</code>, <code>--size-threshold</code></td><td>The maximum amount of data to keep in BookKeeper for the specific topic</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="offload-status"></a><a href="#offload-status" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>offload-status</code></h3> |
| <p>Check the status of data offloading from a topic to long-term storage</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics offload-status persistent://tenant/namespace/topic op |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-w</code>, <code>--wait-complete</code></td><td>Wait for compaction to complete</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="create-partitioned-topic"></a><a href="#create-partitioned-topic" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>create-partitioned-topic</code></h3> |
| <p>Create a partitioned topic. A partitioned topic must be created before producers can publish to it.</p> |
| <blockquote> |
| <p><strong>Note</strong></p> |
| <p>By default, after 60 seconds of creation, topics are considered inactive and deleted automatically to prevent from generating trash data.</p> |
| <p>To disable this feature, set <code>brokerDeleteInactiveTopicsEnabled</code> to <code>false</code>.</p> |
| <p>To change the frequency of checking inactive topics, set <code>brokerDeleteInactiveTopicsFrequencySeconds</code> to your desired value.</p> |
| <p>For more information about these two parameters, see <a href="/docs/en/2.7.3/reference-configuration#broker">here</a>.</p> |
| </blockquote> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics create-partitioned-topic {persistent|non-persistent}://tenant/namespace/topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-p</code>, <code>--partitions</code></td><td>The number of partitions for the topic</td><td>0</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="create-missed-partitions"></a><a href="#create-missed-partitions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>create-missed-partitions</code></h3> |
| <p>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</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics create-missed-partitions persistent://tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="delete-partitioned-topic"></a><a href="#delete-partitioned-topic" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>delete-partitioned-topic</code></h3> |
| <p>Delete a partitioned topic. This will also delete all the partitions of the topic if they exist.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics delete-partitioned-topic {persistent|non-persistent} |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="create-3"></a><a href="#create-3" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>create</code></h3> |
| <p>Creates a non-partitioned topic. A non-partitioned topic must explicitly be created by the user if allowAutoTopicCreation or createIfMissing is disabled.</p> |
| <blockquote> |
| <p><strong>Note</strong></p> |
| <p>By default, after 60 seconds of creation, topics are considered inactive and deleted automatically to prevent from generating trash data.</p> |
| <p>To disable this feature, set <code>brokerDeleteInactiveTopicsEnabled</code> to <code>false</code>.</p> |
| <p>To change the frequency of checking inactive topics, set <code>brokerDeleteInactiveTopicsFrequencySeconds</code> to your desired value.</p> |
| <p>For more information about these two parameters, see <a href="/docs/en/2.7.3/reference-configuration#broker">here</a>.</p> |
| </blockquote> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics create {persistent|non-persistent}://tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-partitioned-topic-metadata"></a><a href="#get-partitioned-topic-metadata" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-partitioned-topic-metadata</code></h3> |
| <p>Get the partitioned topic metadata. If the topic is not created or is a non-partitioned topic, this will return an empty topic with zero partitions.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-partitioned-topic-metadata {persistent|non-persistent}://tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="update-partitioned-topic"></a><a href="#update-partitioned-topic" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>update-partitioned-topic</code></h3> |
| <p>Update existing non-global partitioned topic. New updating number of partitions must be greater than existing number of partitions.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics update-partitioned-topic {persistent|non-persistent}://tenant/namespace/topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-p</code>, <code>--partitions</code></td><td>The number of partitions for the topic</td><td>0</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="list-partitioned-topics"></a><a href="#list-partitioned-topics" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>list-partitioned-topics</code></h3> |
| <p>Get the list of partitioned topics under a namespace.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics list-partitioned-topics tenant/namespace |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="list-5"></a><a href="#list-5" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>list</code></h3> |
| <p>Get the list of topics under a namespace</p> |
| <p>Usage</p> |
| <pre><code class="hljs">$ pulsar-admin topics <span class="hljs-built_in">list</span> tenant/cluster/<span class="hljs-keyword">namespace</span> |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="terminate"></a><a href="#terminate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>terminate</code></h3> |
| <p>Terminate a persistent topic (disallow further messages from being published on the topic)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics terminate persistent://tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="permissions-1"></a><a href="#permissions-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>permissions</code></h3> |
| <p>Get the permissions on a topic. Retrieve the effective permissions for a destination. These permissions are defined by the permissions set at the namespace level combined (union) with any eventual specific permissions set on the topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics permissions topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="grant-permission-1"></a><a href="#grant-permission-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>grant-permission</code></h3> |
| <p>Grant a new permission to a client role on a single topic</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics grant-permission {persistent|non-persistent}://tenant/namespace/topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--actions</code></td><td>Actions to be granted (<code>produce</code> or <code>consume</code>)</td><td></td></tr> |
| <tr><td><code>--role</code></td><td>The client role to which to grant the permissions</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="revoke-permission-1"></a><a href="#revoke-permission-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>revoke-permission</code></h3> |
| <p>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).</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics revoke-permission topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="lookup"></a><a href="#lookup" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>lookup</code></h3> |
| <p>Look up a topic from the current serving broker</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics lookup topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="bundle-range"></a><a href="#bundle-range" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>bundle-range</code></h3> |
| <p>Get the namespace bundle which contains the given topic</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics bundle-range topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="delete-4"></a><a href="#delete-4" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>delete</code></h3> |
| <p>Delete a topic. The topic cannot be deleted if there are any active subscriptions or producers connected to the topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics delete topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="unload-1"></a><a href="#unload-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>unload</code></h3> |
| <p>Unload a topic</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics unload topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="create-subscription"></a><a href="#create-subscription" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>create-subscription</code></h3> |
| <p>Create a new subscription on a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics create-subscription [options] persistent://tenant/namespace/topic |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-m</code>, <code>--messageId</code></td><td>messageId where to create the subscription. It can be either 'latest', 'earliest' or (ledgerId:entryId)</td><td>latest</td></tr> |
| <tr><td><code>-s</code>, <code>--subscription</code></td><td>Subscription to reset position on</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="subscriptions"></a><a href="#subscriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>subscriptions</code></h3> |
| <p>Get the list of subscriptions on the topic</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics subscriptions topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="unsubscribe-1"></a><a href="#unsubscribe-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>unsubscribe</code></h3> |
| <p>Delete a durable subscriber from a topic</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics unsubscribe topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-s</code>, <code>--subscription</code></td><td>The subscription to delete</td><td></td></tr> |
| <tr><td><code>-f</code>, <code>--force</code></td><td>Disconnect and close all consumers and delete subscription forcefully</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="stats-1"></a><a href="#stats-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>stats</code></h3> |
| <p>Get the stats for the topic and its connected producers and consumers. All rates are computed over a 1-minute window and are relative to the last completed 1-minute period.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics stats topic |
| </code></pre> |
| <blockquote> |
| <p>Note<br> |
| The unit of <code>storageSize</code> and <code>averageMsgSize</code> is Byte.</p> |
| </blockquote> |
| <h3><a class="anchor" aria-hidden="true" id="stats-internal"></a><a href="#stats-internal" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>stats-internal</code></h3> |
| <p>Get the internal stats for the topic</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics stats-internal topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="info-internal"></a><a href="#info-internal" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>info-internal</code></h3> |
| <p>Get the internal metadata info for the topic</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics info-internal topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="partitioned-stats"></a><a href="#partitioned-stats" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>partitioned-stats</code></h3> |
| <p>Get the stats for the partitioned topic and its connected producers and consumers. All rates are computed over a 1-minute window and are relative to the last completed 1-minute period.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics partitioned-stats topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--per-partition</code></td><td>Get per-partition stats</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="partitioned-stats-internal"></a><a href="#partitioned-stats-internal" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>partitioned-stats-internal</code></h3> |
| <p>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.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics partitioned-stats-internal topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="skip"></a><a href="#skip" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>skip</code></h3> |
| <p>Skip some messages for the subscription</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics skip topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-n</code>, <code>--count</code></td><td>The number of messages to skip</td><td>0</td></tr> |
| <tr><td><code>-s</code>, <code>--subscription</code></td><td>The subscription on which to skip messages</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="clear-backlog-1"></a><a href="#clear-backlog-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>clear-backlog</code></h3> |
| <p>Clear backlog (skip all the messages) for the subscription</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics clear-backlog topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-s</code>, <code>--subscription</code></td><td>The subscription to clear</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="expire-messages"></a><a href="#expire-messages" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>expire-messages</code></h3> |
| <p>Expire messages that are older than the given expiry time (in seconds) for the subscription.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics expire-messages topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-t</code>, <code>--expireTime</code></td><td>Expire messages older than the time (in seconds)</td><td>0</td></tr> |
| <tr><td><code>-s</code>, <code>--subscription</code></td><td>The subscription to skip messages on</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="expire-messages-all-subscriptions"></a><a href="#expire-messages-all-subscriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>expire-messages-all-subscriptions</code></h3> |
| <p>Expire messages older than the given expiry time (in seconds) for all subscriptions</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics expire-messages-all-subscriptions topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-t</code>, <code>--expireTime</code></td><td>Expire messages older than the time (in seconds)</td><td>0</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="peek-messages"></a><a href="#peek-messages" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>peek-messages</code></h3> |
| <p>Peek some messages for the subscription.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics peek-messages topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-n</code>, <code>--count</code></td><td>The number of messages</td><td>0</td></tr> |
| <tr><td><code>-s</code>, <code>--subscription</code></td><td>Subscription to get messages from</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="reset-cursor"></a><a href="#reset-cursor" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>reset-cursor</code></h3> |
| <p>Reset position for subscription to a position that is closest to timestamp or messageId.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics reset-cursor topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-s</code>, <code>--subscription</code></td><td>Subscription to reset position on</td><td></td></tr> |
| <tr><td><code>-t</code>, <code>--time</code></td><td>The time in minutes to reset back to (or minutes, hours, days, weeks, etc.). Examples: <code>100m</code>, <code>3h</code>, <code>2d</code>, <code>5w</code>.</td><td></td></tr> |
| <tr><td><code>-m</code>, <code>--messageId</code></td><td>The messageId to reset back to (ledgerId:entryId).</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-message-by-id"></a><a href="#get-message-by-id" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-message-by-id</code></h3> |
| <p>Get message by ledger ID and entry ID.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-message-by-id topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-l</code>, <code>--ledgerId</code></td><td>The ledger id</td><td>0</td></tr> |
| <tr><td><code>-e</code>, <code>--entryId</code></td><td>The entry id</td><td>0</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="last-message-id"></a><a href="#last-message-id" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>last-message-id</code></h3> |
| <p>Get the last commit message ID of the topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics last-message-id persistent://tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-backlog-quotas-1"></a><a href="#get-backlog-quotas-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-backlog-quotas</code></h3> |
| <p>Get the backlog quota policies for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-backlog-quotas tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-backlog-quota-1"></a><a href="#set-backlog-quota-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-backlog-quota</code></h3> |
| <p>Set a backlog quota policy for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-backlog-quota tenant/namespace/topic options |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-backlog-quota-1"></a><a href="#remove-backlog-quota-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-backlog-quota</code></h3> |
| <p>Remove a backlog quota policy from a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-backlog-quota tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-persistence-1"></a><a href="#get-persistence-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-persistence</code></h3> |
| <p>Get the persistence policies for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-persistence tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-persistence-1"></a><a href="#set-persistence-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-persistence</code></h3> |
| <p>Set the persistence policies for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-persistence tenant/namespace/topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-e</code>, <code>--bookkeeper-ensemble</code></td><td>Number of bookies to use for a topic</td><td>0</td></tr> |
| <tr><td><code>-w</code>, <code>--bookkeeper-write-quorum</code></td><td>How many writes to make of each entry</td><td>0</td></tr> |
| <tr><td><code>-a</code>, <code>--bookkeeper-ack-quorum</code></td><td>Number of acks (guaranteed copies) to wait for each entry</td><td>0</td></tr> |
| <tr><td><code>-r</code>, <code>--ml-mark-delete-max-rate</code></td><td>Throttling rate of mark-delete operation (0 means no throttle)</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="remove-persistence"></a><a href="#remove-persistence" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-persistence</code></h3> |
| <p>Remove the persistence policy for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-persistence tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-message-ttl-1"></a><a href="#get-message-ttl-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-message-ttl</code></h3> |
| <p>Get the message TTL for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-message-ttl tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-message-ttl-1"></a><a href="#set-message-ttl-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-message-ttl</code></h3> |
| <p>Set the message TTL for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-message-ttl tenant/namespace/topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-ttl</code>, <code>--messageTTL</code></td><td>Message TTL for a topic in second, allowed range from 1 to <code>Integer.MAX_VALUE</code></td><td>0</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="remove-message-ttl-1"></a><a href="#remove-message-ttl-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-message-ttl</code></h3> |
| <p>Remove the message TTL for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-message-ttl tenant/namespace/topic |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--enable</code>, <code>-e</code></td><td>Enable message deduplication on the specified topic.</td><td>false</td></tr> |
| <tr><td><code>--disable</code>, <code>-d</code></td><td>Disable message deduplication on the specified topic.</td><td>false</td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="get-deduplication"></a><a href="#get-deduplication" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-deduplication</code></h3> |
| <p>Get a deduplication policy for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-deduplication tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-deduplication-1"></a><a href="#set-deduplication-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-deduplication</code></h3> |
| <p>Set a deduplication policy for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-deduplication tenant/namespace/topic options |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-deduplication"></a><a href="#remove-deduplication" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-deduplication</code></h3> |
| <p>Remove a deduplication policy for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-deduplication tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-max-subscriptions"></a><a href="#set-max-subscriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-max-subscriptions</code></h3> |
| <p>Set the maximum number of subscriptions for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-max-subscriptions {persistent|non-persistent}://tenant/namespace/topic options |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-max-subscriptions"></a><a href="#get-max-subscriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-max-subscriptions</code></h3> |
| <p>Get the maximum number of subscriptions for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-max-subscriptions {persistent|non-persistent}://tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-max-subscriptions"></a><a href="#remove-max-subscriptions" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-max-subscriptions</code></h3> |
| <p>Remove the maximum number of subscriptions for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-max-subscriptions {persistent|non-persistent}://tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-retention-1"></a><a href="#get-retention-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-retention</code></h3> |
| <p>Get the retention policy that is applied to a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-retention tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-retention-1"></a><a href="#set-retention-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-retention</code></h3> |
| <p>Set the retention policy that is applied to a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-retention tenant/namespace/topic options |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-retention"></a><a href="#remove-retention" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-retention</code></h3> |
| <p>Remove the retention policy that is applied to a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-retention tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-dispatch-rate-1"></a><a href="#get-dispatch-rate-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-dispatch-rate</code></h3> |
| <p>Get the message dispatch rate for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-dispatch-rate tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-dispatch-rate-1"></a><a href="#set-dispatch-rate-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-dispatch-rate</code></h3> |
| <p>Set the message dispatch rate for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-dispatch-rate tenant/namespace/topic options |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-dispatch-rate"></a><a href="#remove-dispatch-rate" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-dispatch-rate</code></h3> |
| <p>Remove the message dispatch rate for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-dispatch-rate tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-max-unacked-messages-per-subscription-1"></a><a href="#get-max-unacked-messages-per-subscription-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-max-unacked-messages-per-subscription</code></h3> |
| <p>Get the maximum number of unacked messages per subscription for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-max-unacked-messages-per-subscription tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-max-unacked-messages-per-subscription-1"></a><a href="#set-max-unacked-messages-per-subscription-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-max-unacked-messages-per-subscription</code></h3> |
| <p>Set the maximum number of unacked messages per subscription for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-max-unacked-messages-per-subscription tenant/namespace/topic options |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-max-unacked-messages-per-subscription"></a><a href="#remove-max-unacked-messages-per-subscription" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-max-unacked-messages-per-subscription</code></h3> |
| <p>Remove the maximum number of unacked messages per subscription for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-max-unacked-messages-per-subscription tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-max-unacked-messages-per-consumer-1"></a><a href="#get-max-unacked-messages-per-consumer-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-max-unacked-messages-per-consumer</code></h3> |
| <p>Get the maximum number of unacked messages per consumer for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-max-unacked-messages-per-consumer tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-max-unacked-messages-per-consumer-1"></a><a href="#set-max-unacked-messages-per-consumer-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-max-unacked-messages-per-consumer</code></h3> |
| <p>Set the maximum number of unacked messages per consumer for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-max-unacked-messages-per-consumer tenant/namespace/topic options |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-max-unacked-messages-per-consumer"></a><a href="#remove-max-unacked-messages-per-consumer" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-max-unacked-messages-per-consumer</code></h3> |
| <p>Remove the maximum number of unacked messages per consumer for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-max-unacked-messages-per-consumer tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-delayed-delivery-1"></a><a href="#get-delayed-delivery-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-delayed-delivery</code></h3> |
| <p>Get the delayed delivery policy for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-delayed-delivery tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-delayed-delivery-1"></a><a href="#set-delayed-delivery-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-delayed-delivery</code></h3> |
| <p>Set the delayed delivery policy for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-delayed-delivery tenant/namespace/topic options |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-delayed-delivery"></a><a href="#remove-delayed-delivery" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-delayed-delivery</code></h3> |
| <p>Remove the delayed delivery policy for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-delayed-delivery tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-max-producers"></a><a href="#get-max-producers" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-max-producers</code></h3> |
| <p>Get the maximum number of producers for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-max-producers tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-max-producers"></a><a href="#set-max-producers" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-max-producers</code></h3> |
| <p>Set the maximum number of producers for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-max-producers tenant/namespace/topic options |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-max-producers"></a><a href="#remove-max-producers" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-max-producers</code></h3> |
| <p>Remove the maximum number of producers for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-max-producers tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-max-consumers"></a><a href="#get-max-consumers" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-max-consumers</code></h3> |
| <p>Get the maximum number of consumers for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-max-consumers tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-max-consumers"></a><a href="#set-max-consumers" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-max-consumers</code></h3> |
| <p>Set the maximum number of consumers for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-max-consumers tenant/namespace/topic options |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-max-consumers"></a><a href="#remove-max-consumers" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-max-consumers</code></h3> |
| <p>Remove the maximum number of consumers for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-max-consumers tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-compaction-threshold-1"></a><a href="#get-compaction-threshold-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-compaction-threshold</code></h3> |
| <p>Get compaction threshold for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-compaction-threshold tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-compaction-threshold-1"></a><a href="#set-compaction-threshold-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-compaction-threshold</code></h3> |
| <p>Set compaction threshold for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-compaction-threshold tenant/namespace/topic options |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-compaction-threshold"></a><a href="#remove-compaction-threshold" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-compaction-threshold</code></h3> |
| <p>Remove compaction threshold for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-compaction-threshold tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-offload-policies-1"></a><a href="#get-offload-policies-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-offload-policies</code></h3> |
| <p>Get the offload policies for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-offload-policies tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-offload-policies-1"></a><a href="#set-offload-policies-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-offload-policies</code></h3> |
| <p>Set the offload policies for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-offload-policies tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-offload-policies"></a><a href="#remove-offload-policies" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-offload-policies</code></h3> |
| <p>Remove the offload policies for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-offload-policies tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-inactive-topic-policies"></a><a href="#get-inactive-topic-policies" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get-inactive-topic-policies</code></h3> |
| <p>Get the inactive policies for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics get-inactive-topic-policies tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="set-inactive-topic-policies"></a><a href="#set-inactive-topic-policies" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set-inactive-topic-policies</code></h3> |
| <p>Set the inactive policies for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics <span class="hljs-built_in">set</span>-inactive-topic-policies tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="remove-inactive-topic-policies"></a><a href="#remove-inactive-topic-policies" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>remove-inactive-topic-policies</code></h3> |
| <p>Remove the inactive policies for a topic.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics remove-inactive-topic-policies tenant/namespace/topic |
| </code></pre> |
| <h2><a class="anchor" aria-hidden="true" id="tenants"></a><a href="#tenants" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>tenants</code></h2> |
| <p>Operations for managing tenants</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin tenants subcommand |
| </code></pre> |
| <p>Subcommands</p> |
| <ul> |
| <li><code>list</code></li> |
| <li><code>get</code></li> |
| <li><code>create</code></li> |
| <li><code>update</code></li> |
| <li><code>delete</code></li> |
| </ul> |
| <h3><a class="anchor" aria-hidden="true" id="list-6"></a><a href="#list-6" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>list</code></h3> |
| <p>List the existing tenants</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin tenants list |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-3"></a><a href="#get-3" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get</code></h3> |
| <p>Gets the configuration of a tenant</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin tenants get tenant-name |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="create-4"></a><a href="#create-4" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>create</code></h3> |
| <p>Creates a new tenant</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin tenants create tenant-name options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-r</code>, <code>--admin-roles</code></td><td>Comma-separated admin roles</td><td></td></tr> |
| <tr><td><code>-c</code>, <code>--allowed-clusters</code></td><td>Comma-separated allowed clusters</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="update-2"></a><a href="#update-2" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>update</code></h3> |
| <p>Updates a tenant</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin tenants update tenant-name options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-r</code>, <code>--admin-roles</code></td><td>Comma-separated admin roles</td><td></td></tr> |
| <tr><td><code>-c</code>, <code>--allowed-clusters</code></td><td>Comma-separated allowed clusters</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="delete-5"></a><a href="#delete-5" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>delete</code></h3> |
| <p>Deletes an existing tenant</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin tenants delete tenant-name |
| </code></pre> |
| <h2><a class="anchor" aria-hidden="true" id="resource-quotas"></a><a href="#resource-quotas" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>resource-quotas</code></h2> |
| <p>Operations for managing resource quotas</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin resource-quotas subcommand |
| </code></pre> |
| <p>Subcommands</p> |
| <ul> |
| <li><code>get</code></li> |
| <li><code>set</code></li> |
| <li><code>reset-namespace-bundle-quota</code></li> |
| </ul> |
| <h3><a class="anchor" aria-hidden="true" id="get-4"></a><a href="#get-4" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get</code></h3> |
| <p>Get the resource quota for a specified namespace bundle, or default quota if no namespace/bundle is specified.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin resource-quotas get options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-b</code>, <code>--bundle</code></td><td>A bundle of the form {start-boundary}_{end_boundary}. This must be specified together with -n/--namespace.</td><td></td></tr> |
| <tr><td><code>-n</code>, <code>--namespace</code></td><td>The namespace</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="set-1"></a><a href="#set-1" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>set</code></h3> |
| <p>Set the resource quota for the specified namespace bundle, or default quota if no namespace/bundle is specified.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin resource-quotas <span class="hljs-built_in">set</span> options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-bi</code>, <code>--bandwidthIn</code></td><td>The expected inbound bandwidth (in bytes/second)</td><td>0</td></tr> |
| <tr><td><code>-bo</code>, <code>--bandwidthOut</code></td><td>Expected outbound bandwidth (in bytes/second)0</td></tr> |
| <tr><td><code>-b</code>, <code>--bundle</code></td><td>A bundle of the form {start-boundary}_{end_boundary}. This must be specified together with -n/--namespace.</td><td></td></tr> |
| <tr><td><code>-d</code>, <code>--dynamic</code></td><td>Allow to be dynamically re-calculated (or not)</td><td>false</td></tr> |
| <tr><td><code>-mem</code>, <code>--memory</code></td><td>Expectred memory usage (in megabytes)</td><td>0</td></tr> |
| <tr><td><code>-mi</code>, <code>--msgRateIn</code></td><td>Expected incoming messages per second</td><td>0</td></tr> |
| <tr><td><code>-mo</code>, <code>--msgRateOut</code></td><td>Expected outgoing messages per second</td><td>0</td></tr> |
| <tr><td><code>-n</code>, <code>--namespace</code></td><td>The namespace as tenant/namespace, for example my-tenant/my-ns. Must be specified together with -b/--bundle.</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="reset-namespace-bundle-quota"></a><a href="#reset-namespace-bundle-quota" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>reset-namespace-bundle-quota</code></h3> |
| <p>Reset the specified namespace bundle's resource quota to a default value.</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin resource-quotas reset-namespace-bundle-quota options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-b</code>, <code>--bundle</code></td><td>A bundle of the form {start-boundary}_{end_boundary}. This must be specified together with -n/--namespace.</td><td></td></tr> |
| <tr><td><code>-n</code>, <code>--namespace</code></td><td>The namespace</td><td></td></tr> |
| </tbody> |
| </table> |
| <h2><a class="anchor" aria-hidden="true" id="schemas"></a><a href="#schemas" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>schemas</code></h2> |
| <p>Operations related to Schemas associated with Pulsar topics.</p> |
| <p>Usage</p> |
| <pre><code class="hljs">$ pulsar-admin <span class="hljs-keyword">schemas </span><span class="hljs-keyword">subcommand |
| </span></code></pre> |
| <p>Subcommands</p> |
| <ul> |
| <li><code>upload</code></li> |
| <li><code>delete</code></li> |
| <li><code>get</code></li> |
| <li><code>extract</code></li> |
| </ul> |
| <h3><a class="anchor" aria-hidden="true" id="upload"></a><a href="#upload" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>upload</code></h3> |
| <p>Upload the schema definition for a topic</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin schemas upload persistent://tenant/namespace/topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--filename</code></td><td>The path to the schema definition file. An example schema file is available under conf directory.</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="delete-6"></a><a href="#delete-6" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>delete</code></h3> |
| <p>Delete the schema definition associated with a topic</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin schemas delete persistent://tenant/namespace/topic |
| </code></pre> |
| <h3><a class="anchor" aria-hidden="true" id="get-5"></a><a href="#get-5" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>get</code></h3> |
| <p>Retrieve the schema definition associated with a topic (at a given version if version is supplied).</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin schemas get persistent://tenant/namespace/topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--version</code></td><td>The version of the schema definition to retrieve for a topic.</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="extract"></a><a href="#extract" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a><code>extract</code></h3> |
| <p>Provide the schema definition for a topic via Java class name contained in a JAR file</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin schemas extract persistent://tenant/namespace/topic options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>-c</code>, <code>--classname</code></td><td>The Java class name</td><td></td></tr> |
| <tr><td><code>-j</code>, <code>--jar</code></td><td>A path to the JAR file which contains the above Java class</td><td></td></tr> |
| <tr><td><code>-t</code>, <code>--type</code></td><td>The type of the schema (avro or json)</td><td></td></tr> |
| </tbody> |
| </table> |
| </span></div></article></div><div class="docs-prevnext"></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#broker-stats"><code>broker-stats</code></a><ul class="toc-headings"><li><a href="#allocator-stats"><code>allocator-stats</code></a></li><li><a href="#topicsdestinations"><code>topics(destinations)</code></a></li><li><a href="#mbeans"><code>mbeans</code></a></li><li><a href="#monitoring-metrics"><code>monitoring-metrics</code></a></li><li><a href="#load-report"><code>load-report</code></a></li></ul></li><li><a href="#brokers"><code>brokers</code></a><ul class="toc-headings"><li><a href="#list"><code>list</code></a></li><li><a href="#namespaces"><code>namespaces</code></a></li><li><a href="#update-dynamic-config"><code>update-dynamic-config</code></a></li><li><a href="#list-dynamic-config"><code>list-dynamic-config</code></a></li><li><a href="#delete-dynamic-config"><code>delete-dynamic-config</code></a></li><li><a href="#get-all-dynamic-config"><code>get-all-dynamic-config</code></a></li><li><a href="#get-internal-config"><code>get-internal-config</code></a></li><li><a href="#get-runtime-config"><code>get-runtime-config</code></a></li><li><a href="#healthcheck"><code>healthcheck</code></a></li></ul></li><li><a href="#clusters"><code>clusters</code></a><ul class="toc-headings"><li><a href="#get"><code>get</code></a></li><li><a href="#create"><code>create</code></a></li><li><a href="#update"><code>update</code></a></li><li><a href="#delete"><code>delete</code></a></li><li><a href="#list-1"><code>list</code></a></li><li><a href="#update-peer-clusters"><code>update-peer-clusters</code></a></li><li><a href="#get-peer-clusters"><code>get-peer-clusters</code></a></li><li><a href="#get-failure-domain"><code>get-failure-domain</code></a></li><li><a href="#create-failure-domain"><code>create-failure-domain</code></a></li><li><a href="#update-failure-domain"><code>update-failure-domain</code></a></li><li><a href="#delete-failure-domain"><code>delete-failure-domain</code></a></li><li><a href="#list-failure-domains"><code>list-failure-domains</code></a></li></ul></li><li><a href="#functions"><code>functions</code></a><ul class="toc-headings"><li><a href="#localrun"><code>localrun</code></a></li><li><a href="#create-1"><code>create</code></a></li><li><a href="#delete-1"><code>delete</code></a></li><li><a href="#update-1"><code>update</code></a></li><li><a href="#get-1"><code>get</code></a></li><li><a href="#restart"><code>restart</code></a></li><li><a href="#stop"><code>stop</code></a></li><li><a href="#start"><code>start</code></a></li><li><a href="#status"><code>status</code></a></li><li><a href="#stats"><code>stats</code></a></li><li><a href="#list-2"><code>list</code></a></li><li><a href="#querystate"><code>querystate</code></a></li><li><a href="#putstate"><code>putstate</code></a></li><li><a href="#trigger"><code>trigger</code></a></li></ul></li><li><a href="#functions-worker"><code>functions-worker</code></a><ul class="toc-headings"><li><a href="#function-stats"><code>function-stats</code></a></li><li><a href="#get-cluster"><code>get-cluster</code></a></li><li><a href="#get-cluster-leader"><code>get-cluster-leader</code></a></li><li><a href="#get-function-assignments"><code>get-function-assignments</code></a></li><li><a href="#monitoring-metrics-1"><code>monitoring-metrics</code></a></li></ul></li><li><a href="#namespaces-1"><code>namespaces</code></a><ul class="toc-headings"><li><a href="#list-3"><code>list</code></a></li><li><a href="#topics"><code>topics</code></a></li><li><a href="#policies"><code>policies</code></a></li><li><a href="#create-2"><code>create</code></a></li><li><a href="#delete-2"><code>delete</code></a></li><li><a href="#set-deduplication"><code>set-deduplication</code></a></li><li><a href="#set-auto-topic-creation"><code>set-auto-topic-creation</code></a></li><li><a href="#remove-auto-topic-creation"><code>remove-auto-topic-creation</code></a></li><li><a href="#set-auto-subscription-creation"><code>set-auto-subscription-creation</code></a></li><li><a href="#remove-auto-subscription-creation"><code>remove-auto-subscription-creation</code></a></li><li><a href="#permissions"><code>permissions</code></a></li><li><a href="#grant-permission"><code>grant-permission</code></a></li><li><a href="#revoke-permission"><code>revoke-permission</code></a></li><li><a href="#grant-subscription-permission"><code>grant-subscription-permission</code></a></li><li><a href="#revoke-subscription-permission"><code>revoke-subscription-permission</code></a></li><li><a href="#set-clusters"><code>set-clusters</code></a></li><li><a href="#get-clusters"><code>get-clusters</code></a></li><li><a href="#get-backlog-quotas"><code>get-backlog-quotas</code></a></li><li><a href="#set-backlog-quota"><code>set-backlog-quota</code></a></li><li><a href="#remove-backlog-quota"><code>remove-backlog-quota</code></a></li><li><a href="#get-persistence"><code>get-persistence</code></a></li><li><a href="#set-persistence"><code>set-persistence</code></a></li><li><a href="#get-message-ttl"><code>get-message-ttl</code></a></li><li><a href="#set-message-ttl"><code>set-message-ttl</code></a></li><li><a href="#remove-message-ttl"><code>remove-message-ttl</code></a></li><li><a href="#get-anti-affinity-group"><code>get-anti-affinity-group</code></a></li><li><a href="#set-anti-affinity-group"><code>set-anti-affinity-group</code></a></li><li><a href="#get-anti-affinity-namespaces"><code>get-anti-affinity-namespaces</code></a></li><li><a href="#delete-anti-affinity-group"><code>delete-anti-affinity-group</code></a></li><li><a href="#get-retention"><code>get-retention</code></a></li><li><a href="#set-retention"><code>set-retention</code></a></li><li><a href="#unload"><code>unload</code></a></li><li><a href="#split-bundle"><code>split-bundle</code></a></li><li><a href="#set-dispatch-rate"><code>set-dispatch-rate</code></a></li><li><a href="#get-dispatch-rate"><code>get-dispatch-rate</code></a></li><li><a href="#set-replicator-dispatch-rate"><code>set-replicator-dispatch-rate</code></a></li><li><a href="#get-replicator-dispatch-rate"><code>get-replicator-dispatch-rate</code></a></li><li><a href="#set-subscribe-rate"><code>set-subscribe-rate</code></a></li><li><a href="#get-subscribe-rate"><code>get-subscribe-rate</code></a></li><li><a href="#set-subscription-dispatch-rate"><code>set-subscription-dispatch-rate</code></a></li><li><a href="#get-subscription-dispatch-rate"><code>get-subscription-dispatch-rate</code></a></li><li><a href="#set-subscription-expiration-time"><code>set-subscription-expiration-time</code></a></li><li><a href="#get-subscription-expiration-time"><code>get-subscription-expiration-time</code></a></li><li><a href="#clear-backlog"><code>clear-backlog</code></a></li><li><a href="#unsubscribe"><code>unsubscribe</code></a></li><li><a href="#set-encryption-required"><code>set-encryption-required</code></a></li><li><a href="#set-delayed-delivery"><code>set-delayed-delivery</code></a></li><li><a href="#get-delayed-delivery"><code>get-delayed-delivery</code></a></li><li><a href="#set-subscription-auth-mode"><code>set-subscription-auth-mode</code></a></li><li><a href="#get-max-producers-per-topic"><code>get-max-producers-per-topic</code></a></li><li><a href="#set-max-producers-per-topic"><code>set-max-producers-per-topic</code></a></li><li><a href="#get-max-consumers-per-topic"><code>get-max-consumers-per-topic</code></a></li><li><a href="#set-max-consumers-per-topic"><code>set-max-consumers-per-topic</code></a></li><li><a href="#get-max-consumers-per-subscription"><code>get-max-consumers-per-subscription</code></a></li><li><a href="#set-max-consumers-per-subscription"><code>set-max-consumers-per-subscription</code></a></li><li><a href="#get-max-unacked-messages-per-subscription"><code>get-max-unacked-messages-per-subscription</code></a></li><li><a href="#set-max-unacked-messages-per-subscription"><code>set-max-unacked-messages-per-subscription</code></a></li><li><a href="#get-max-unacked-messages-per-consumer"><code>get-max-unacked-messages-per-consumer</code></a></li><li><a href="#set-max-unacked-messages-per-consumer"><code>set-max-unacked-messages-per-consumer</code></a></li><li><a href="#get-compaction-threshold"><code>get-compaction-threshold</code></a></li><li><a href="#set-compaction-threshold"><code>set-compaction-threshold</code></a></li><li><a href="#get-offload-threshold"><code>get-offload-threshold</code></a></li><li><a href="#set-offload-threshold"><code>set-offload-threshold</code></a></li><li><a href="#get-offload-deletion-lag"><code>get-offload-deletion-lag</code></a></li><li><a href="#set-offload-deletion-lag"><code>set-offload-deletion-lag</code></a></li><li><a href="#clear-offload-deletion-lag"><code>clear-offload-deletion-lag</code></a></li><li><a href="#get-schema-autoupdate-strategy"><code>get-schema-autoupdate-strategy</code></a></li><li><a href="#set-schema-autoupdate-strategy"><code>set-schema-autoupdate-strategy</code></a></li><li><a href="#get-publish-rate"><code>get-publish-rate</code></a></li><li><a href="#set-publish-rate"><code>set-publish-rate</code></a></li><li><a href="#set-offload-policies"><code>set-offload-policies</code></a></li><li><a href="#get-offload-policies"><code>get-offload-policies</code></a></li><li><a href="#set-max-subscriptions-per-topic"><code>set-max-subscriptions-per-topic</code></a></li><li><a href="#get-max-subscriptions-per-topic"><code>get-max-subscriptions-per-topic</code></a></li><li><a href="#remove-max-subscriptions-per-topic"><code>remove-max-subscriptions-per-topic</code></a></li></ul></li><li><a href="#ns-isolation-policy"><code>ns-isolation-policy</code></a><ul class="toc-headings"><li><a href="#set"><code>set</code></a></li><li><a href="#get-2"><code>get</code></a></li><li><a href="#list-4"><code>list</code></a></li><li><a href="#delete-3"><code>delete</code></a></li><li><a href="#brokers-1"><code>brokers</code></a></li><li><a href="#broker"><code>broker</code></a></li></ul></li><li><a href="#topics-1"><code>topics</code></a><ul class="toc-headings"><li><a href="#compact"><code>compact</code></a></li><li><a href="#compaction-status"><code>compaction-status</code></a></li><li><a href="#offload"><code>offload</code></a></li><li><a href="#offload-status"><code>offload-status</code></a></li><li><a href="#create-partitioned-topic"><code>create-partitioned-topic</code></a></li><li><a href="#create-missed-partitions"><code>create-missed-partitions</code></a></li><li><a href="#delete-partitioned-topic"><code>delete-partitioned-topic</code></a></li><li><a href="#create-3"><code>create</code></a></li><li><a href="#get-partitioned-topic-metadata"><code>get-partitioned-topic-metadata</code></a></li><li><a href="#update-partitioned-topic"><code>update-partitioned-topic</code></a></li><li><a href="#list-partitioned-topics"><code>list-partitioned-topics</code></a></li><li><a href="#list-5"><code>list</code></a></li><li><a href="#terminate"><code>terminate</code></a></li><li><a href="#permissions-1"><code>permissions</code></a></li><li><a href="#grant-permission-1"><code>grant-permission</code></a></li><li><a href="#revoke-permission-1"><code>revoke-permission</code></a></li><li><a href="#lookup"><code>lookup</code></a></li><li><a href="#bundle-range"><code>bundle-range</code></a></li><li><a href="#delete-4"><code>delete</code></a></li><li><a href="#unload-1"><code>unload</code></a></li><li><a href="#create-subscription"><code>create-subscription</code></a></li><li><a href="#subscriptions"><code>subscriptions</code></a></li><li><a href="#unsubscribe-1"><code>unsubscribe</code></a></li><li><a href="#stats-1"><code>stats</code></a></li><li><a href="#stats-internal"><code>stats-internal</code></a></li><li><a href="#info-internal"><code>info-internal</code></a></li><li><a href="#partitioned-stats"><code>partitioned-stats</code></a></li><li><a href="#partitioned-stats-internal"><code>partitioned-stats-internal</code></a></li><li><a href="#skip"><code>skip</code></a></li><li><a href="#clear-backlog-1"><code>clear-backlog</code></a></li><li><a href="#expire-messages"><code>expire-messages</code></a></li><li><a href="#expire-messages-all-subscriptions"><code>expire-messages-all-subscriptions</code></a></li><li><a href="#peek-messages"><code>peek-messages</code></a></li><li><a href="#reset-cursor"><code>reset-cursor</code></a></li><li><a href="#get-message-by-id"><code>get-message-by-id</code></a></li><li><a href="#last-message-id"><code>last-message-id</code></a></li><li><a href="#get-backlog-quotas-1"><code>get-backlog-quotas</code></a></li><li><a href="#set-backlog-quota-1"><code>set-backlog-quota</code></a></li><li><a href="#remove-backlog-quota-1"><code>remove-backlog-quota</code></a></li><li><a href="#get-persistence-1"><code>get-persistence</code></a></li><li><a href="#set-persistence-1"><code>set-persistence</code></a></li><li><a href="#remove-persistence"><code>remove-persistence</code></a></li><li><a href="#get-message-ttl-1"><code>get-message-ttl</code></a></li><li><a href="#set-message-ttl-1"><code>set-message-ttl</code></a></li><li><a href="#remove-message-ttl-1"><code>remove-message-ttl</code></a></li><li><a href="#get-deduplication"><code>get-deduplication</code></a></li><li><a href="#set-deduplication-1"><code>set-deduplication</code></a></li><li><a href="#remove-deduplication"><code>remove-deduplication</code></a></li><li><a href="#set-max-subscriptions"><code>set-max-subscriptions</code></a></li><li><a href="#get-max-subscriptions"><code>get-max-subscriptions</code></a></li><li><a href="#remove-max-subscriptions"><code>remove-max-subscriptions</code></a></li><li><a href="#get-retention-1"><code>get-retention</code></a></li><li><a href="#set-retention-1"><code>set-retention</code></a></li><li><a href="#remove-retention"><code>remove-retention</code></a></li><li><a href="#get-dispatch-rate-1"><code>get-dispatch-rate</code></a></li><li><a href="#set-dispatch-rate-1"><code>set-dispatch-rate</code></a></li><li><a href="#remove-dispatch-rate"><code>remove-dispatch-rate</code></a></li><li><a href="#get-max-unacked-messages-per-subscription-1"><code>get-max-unacked-messages-per-subscription</code></a></li><li><a href="#set-max-unacked-messages-per-subscription-1"><code>set-max-unacked-messages-per-subscription</code></a></li><li><a href="#remove-max-unacked-messages-per-subscription"><code>remove-max-unacked-messages-per-subscription</code></a></li><li><a href="#get-max-unacked-messages-per-consumer-1"><code>get-max-unacked-messages-per-consumer</code></a></li><li><a href="#set-max-unacked-messages-per-consumer-1"><code>set-max-unacked-messages-per-consumer</code></a></li><li><a href="#remove-max-unacked-messages-per-consumer"><code>remove-max-unacked-messages-per-consumer</code></a></li><li><a href="#get-delayed-delivery-1"><code>get-delayed-delivery</code></a></li><li><a href="#set-delayed-delivery-1"><code>set-delayed-delivery</code></a></li><li><a href="#remove-delayed-delivery"><code>remove-delayed-delivery</code></a></li><li><a href="#get-max-producers"><code>get-max-producers</code></a></li><li><a href="#set-max-producers"><code>set-max-producers</code></a></li><li><a href="#remove-max-producers"><code>remove-max-producers</code></a></li><li><a href="#get-max-consumers"><code>get-max-consumers</code></a></li><li><a href="#set-max-consumers"><code>set-max-consumers</code></a></li><li><a href="#remove-max-consumers"><code>remove-max-consumers</code></a></li><li><a href="#get-compaction-threshold-1"><code>get-compaction-threshold</code></a></li><li><a href="#set-compaction-threshold-1"><code>set-compaction-threshold</code></a></li><li><a href="#remove-compaction-threshold"><code>remove-compaction-threshold</code></a></li><li><a href="#get-offload-policies-1"><code>get-offload-policies</code></a></li><li><a href="#set-offload-policies-1"><code>set-offload-policies</code></a></li><li><a href="#remove-offload-policies"><code>remove-offload-policies</code></a></li><li><a href="#get-inactive-topic-policies"><code>get-inactive-topic-policies</code></a></li><li><a href="#set-inactive-topic-policies"><code>set-inactive-topic-policies</code></a></li><li><a href="#remove-inactive-topic-policies"><code>remove-inactive-topic-policies</code></a></li></ul></li><li><a href="#tenants"><code>tenants</code></a><ul class="toc-headings"><li><a href="#list-6"><code>list</code></a></li><li><a href="#get-3"><code>get</code></a></li><li><a href="#create-4"><code>create</code></a></li><li><a href="#update-2"><code>update</code></a></li><li><a href="#delete-5"><code>delete</code></a></li></ul></li><li><a href="#resource-quotas"><code>resource-quotas</code></a><ul class="toc-headings"><li><a href="#get-4"><code>get</code></a></li><li><a href="#set-1"><code>set</code></a></li><li><a href="#reset-namespace-bundle-quota"><code>reset-namespace-bundle-quota</code></a></li></ul></li><li><a href="#schemas"><code>schemas</code></a><ul class="toc-headings"><li><a href="#upload"><code>upload</code></a></li><li><a href="#delete-6"><code>delete</code></a></li><li><a href="#get-5"><code>get</code></a></li><li><a href="#extract"><code>extract</code></a></li></ul></li></ul></nav></div><footer class="nav-footer" id="footer"><section class="copyright">Copyright © 2022 The Apache Software Foundation. All Rights Reserved. Apache, Apache Pulsar and the Apache feather logo are trademarks of The Apache Software Foundation.</section><span><script> |
| const community = document.querySelector("a[href='#community']").parentNode; |
| const communityMenu = |
| '<li>' + |
| '<a id="community-menu" href="#">Community <span style="font-size: 0.75em"> ▼</span></a>' + |
| '<div id="community-dropdown" class="hide">' + |
| '<ul id="community-dropdown-items">' + |
| '<li><a href="/en/contact">Contact</a></li>' + |
| '<li><a href="/en/contributing">Contributing</a></li>' + |
| '<li><a href="/en/coding-guide">Coding guide</a></li>' + |
| '<li><a href="/en/events">Events</a></li>' + |
| '<li><a href="https://twitter.com/Apache_Pulsar" target="_blank">Twitter ❐</a></li>' + |
| '<li><a href="https://github.com/apache/pulsar/wiki" target="_blank">Wiki ❐</a></li>' + |
| '<li><a href="https://github.com/apache/pulsar/issues" target="_blank">Issue tracking ❐</a></li>' + |
| '<li><a href="https://pulsar-summit.org/" target="_blank">Pulsar Summit ❐</a></li>' + |
| '<li> </li>' + |
| '<li><a href="/en/resources">Resources</a></li>' + |
| '<li><a href="/en/team">Team</a></li>' + |
| '<li><a href="/en/powered-by">Powered By</a></li>' + |
| '</ul>' + |
| '</div>' + |
| '</li>'; |
| |
| community.innerHTML = communityMenu; |
| |
| const communityMenuItem = document.getElementById("community-menu"); |
| const communityDropDown = document.getElementById("community-dropdown"); |
| communityMenuItem.addEventListener("click", function(event) { |
| event.preventDefault(); |
| |
| if (communityDropDown.className == 'hide') { |
| communityDropDown.className = 'visible'; |
| } else { |
| communityDropDown.className = 'hide'; |
| } |
| }); |
| </script></span></footer></div><script>window.twttr=(function(d,s, id){var js,fjs=d.getElementsByTagName(s)[0],t=window.twttr||{};if(d.getElementById(id))return t;js=d.createElement(s);js.id=id;js.src='https://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js, fjs);t._e = [];t.ready = function(f) {t._e.push(f);};return t;}(document, 'script', 'twitter-wjs'));</script></body></html> |
