| <!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="The `pulsar-admin` tool enables you to manage Pulsar installations, including clusters, brokers, namespaces, tenants, and more."/><meta name="docsearch:version" content="2.3.0"/><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="The `pulsar-admin` tool enables you to manage Pulsar installations, including clusters, brokers, namespaces, tenants, and more."/><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.3.0</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class=""><a href="/docs/en/2.3.0/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.3.0/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.3.0/reference-pulsar-admin">日本語</a></li><li><a href="/docs/fr/2.3.0/reference-pulsar-admin">Français</a></li><li><a href="/docs/ko/2.3.0/reference-pulsar-admin">한국어</a></li><li><a href="/docs/zh-CN/2.3.0/reference-pulsar-admin">中文</a></li><li><a href="/docs/zh-TW/2.3.0/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><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><code>broker-stats</code></li> |
| <li><code>brokers</code></li> |
| <li><code>clusters</code></li> |
| <li><code>functions</code></li> |
| <li><code>namespaces</code></li> |
| <li><code>ns-isolation-policy</code></li> |
| <li><code>sink</code></li> |
| <li><code>source</code></li> |
| <li><code>topics</code></li> |
| <li><code>tenants</code></li> |
| <li><code>resource-quotas</code></li> |
| <li><code>schemas</code></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="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>getstatus</code></li> |
| <li><code>list</code></li> |
| <li><code>querystate</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 a Pulsar Function locally</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 to allocate to each function instance (in number of cores)</td><td></td></tr> |
| <tr><td><code>--ram</code></td><td>The RAM to allocate to each function instance (in bytes)</td><td></td></tr> |
| <tr><td><code>--disk</code></td><td>The disk space to allocate to each function instance (in bytes)</td><td></td></tr> |
| <tr><td><code>--auto-ack</code></td><td>Let the functions framework manage acking</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 name of the function’s class</td><td></td></tr> |
| <tr><td><code>--custom-serde-inputs</code></td><td>A map of the input topic to SerDe name</td><td></td></tr> |
| <tr><td><code>--custom-schema-inputs</code></td><td>A map of the input topic to Schema class name</td><td></td></tr> |
| <tr><td><code>--client-auth-params</code></td><td>Client Authentication Params</td><td></td></tr> |
| <tr><td><code>--function-config-file</code></td><td>The path of the YAML config file used to configure the function</td><td></td></tr> |
| <tr><td><code>--hostname-verification-enabled</code></td><td>Enable Hostname verification</td><td></td></tr> |
| <tr><td><code>--instance-id-offset</code></td><td>Instance ids will be assigned starting from this offset</td><td></td></tr> |
| <tr><td><code>--inputs</code></td><td>The input topics for the function (as a comma-separated list if more than one topic is desired)</td><td></td></tr> |
| <tr><td><code>--log-topic</code></td><td>The topic to which logs from this function are published</td><td></td></tr> |
| <tr><td><code>--jar</code></td><td>A path to the JAR file for the function (if the function is written in Java)</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The name of the function</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 name of the topic to which the function publishes its output (if any)</td><td></td></tr> |
| <tr><td><code>--output-serde-classname</code></td><td>The SerDe class used for the function’s output</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 applied to the function. Can be one of: ATLEAST_ONCE, ATMOST_ONCE, or EFFECTIVELY_ONCE</td><td>ATLEAST_ONCE</td></tr> |
| <tr><td><code>--py</code></td><td>The path of the Python file containing the function’s processing logic (if the function is written in Python)</td><td></td></tr> |
| <tr><td><code>--schema-type</code></td><td>Schema Type to be used for storing output messages</td><td></td></tr> |
| <tr><td><code>--sliding-interval-count</code></td><td>Number of messages after which the window ends</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 service URL for the function’s state storage (if the function uses a storage system different from the Apache BookKeeper cluster used by Pulsar). 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</td><td></td></tr> |
| <tr><td><code>--user-config</code></td><td>A user-supplied config value, set as a key/value pair. You can set multiple user config 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> |
| </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>Creates a new Pulsar Function on the target infrastructure</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 to allocate to each function instance (in number of cores)</td><td></td></tr> |
| <tr><td><code>--ram</code></td><td>The RAM to allocate to each function instance (in bytes)</td><td></td></tr> |
| <tr><td><code>--disk</code></td><td>The disk space to allocate to each function instance (in bytes)</td><td></td></tr> |
| <tr><td><code>--auto-ack</code></td><td>Let the functions framework manage acking</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 name of the function’s class</td><td></td></tr> |
| <tr><td><code>--custom-serde-inputs</code></td><td>A map of the input topic to SerDe name</td><td></td></tr> |
| <tr><td><code>--custom-schema-inputs</code></td><td>A map of the input topic to Schema class name</td><td></td></tr> |
| <tr><td><code>--function-config-file</code></td><td>The path of the YAML config file used to configure the function</td><td></td></tr> |
| <tr><td><code>--inputs</code></td><td>The input topics for the function (as a comma-separated list if more than one topic is desired)</td><td></td></tr> |
| <tr><td><code>--log-topic</code></td><td>The topic to which logs from this function are published</td><td></td></tr> |
| <tr><td><code>--jar</code></td><td>A path to the JAR file for the function (if the function is written in Java)</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The name of the function</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 name of the topic to which the function publishes its output (if any)</td><td></td></tr> |
| <tr><td><code>--output-serde-classname</code></td><td>The SerDe class used for the function’s output</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 applied to the function. Can be one of: ATLEAST_ONCE, ATMOST_ONCE, or EFFECTIVELY_ONCE</td><td>ATLEAST_ONCE</td></tr> |
| <tr><td><code>--py</code></td><td>The path of the Python file containing the function’s processing logic (if the function is written in Python)</td><td></td></tr> |
| <tr><td><code>--schema-type</code></td><td>Schema Type to be used for storing output messages</td><td></td></tr> |
| <tr><td><code>--sliding-interval-count</code></td><td>Number of messages after which the window ends</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</td><td></td></tr> |
| <tr><td><code>--user-config</code></td><td>A user-supplied config value, set as a key/value pair. You can set multiple user config 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> |
| </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>Deletes an existing Pulsar Function</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>--name</code></td><td>The name of the function to delete</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The namespace of the function to delete</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The tenant of the function to delete</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>Updates an existing Pulsar Function</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 to allocate to each function instance (in number of cores)</td><td></td></tr> |
| <tr><td><code>--ram</code></td><td>The RAM to allocate to each function instance (in bytes)</td><td></td></tr> |
| <tr><td><code>--disk</code></td><td>The disk space to allocate to each function instance (in bytes)</td><td></td></tr> |
| <tr><td><code>--auto-ack</code></td><td>Let the functions framework manage acking</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 name of the function’s class</td><td></td></tr> |
| <tr><td><code>--custom-serde-inputs</code></td><td>A map of the input topic to SerDe name</td><td></td></tr> |
| <tr><td><code>--custom-schema-inputs</code></td><td>A map of the input topic to Schema class name</td><td></td></tr> |
| <tr><td><code>--function-config-file</code></td><td>The path of the YAML config file used to configure the function</td><td></td></tr> |
| <tr><td><code>--inputs</code></td><td>The input topics for the function (as a comma-separated list if more than one topic is desired)</td><td></td></tr> |
| <tr><td><code>--log-topic</code></td><td>The topic to which logs from this function are published</td><td></td></tr> |
| <tr><td><code>--jar</code></td><td>A path to the JAR file for the function (if the function is written in Java)</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The name of the function</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 name of the topic to which the function publishes its output (if any)</td><td></td></tr> |
| <tr><td><code>--output-serde-classname</code></td><td>The SerDe class used for the function’s output</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 applied to the function. Can be one of: ATLEAST_ONCE, ATMOST_ONCE, or EFFECTIVELY_ONCE</td><td>ATLEAST_ONCE</td></tr> |
| <tr><td><code>--py</code></td><td>The path of the Python file containing the function’s processing logic (if the function is written in Python)</td><td></td></tr> |
| <tr><td><code>--schema-type</code></td><td>Schema Type to be used for storing output messages</td><td></td></tr> |
| <tr><td><code>--sliding-interval-count</code></td><td>Number of messages after which the window ends</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</td><td></td></tr> |
| <tr><td><code>--user-config</code></td><td>A user-supplied config value, set as a key/value pair. You can set multiple user config 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> |
| </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 an existing 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>--name</code></td><td>The name of the function</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The namespace of the function</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The tenant of the function</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>Restarts either all instances or one particular instance of a function</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>--name</code></td><td>The name of the function</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The namespace of the function</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The tenant of 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> |
| </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>Temporary stops function instance. (If worker restarts then it reassigns and starts functiona again)</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>--name</code></td><td>The name of the function</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The namespace of the function</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The tenant of 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> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="getstatus"></a><a href="#getstatus" 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>getstatus</code></h3> |
| <p>Get the status of an existing Pulsar Function</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">functions</span> getstatus options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--name</code></td><td>The name of the function</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The namespace of the function</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The tenant of 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> |
| </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 Pulsar Functions for 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 namespace of the function</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The tenant of the function</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>Retrieve the current state of a Pulsar Function by key</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>-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 name of the function whose state you want to query</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The namespace of the function whose state you want to query</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The tenant of the function whose state you want to query</td><td></td></tr> |
| <tr><td><code>-u</code>, <code>--storage-service-url</code></td><td>The service URL for the function’s state storage (if the function uses a storage system different from the Apache BookKeeper cluster used by Pulsar)</td><td></td></tr> |
| <tr><td><code>-w</code>, <code>--watch</code></td><td>If set, watching for state changes is enabled</td><td>false</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 or file data</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>--name</code></td><td>The name of the Pulsar Function to trigger</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The namespace of the Pulsar Function to trigger</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The tenant of the Pulsar Function to trigger</td><td></td></tr> |
| <tr><td><code>--trigger-file</code></td><td>The path to the file containing the data with which the Pulsar Function is to be triggered</td><td></td></tr> |
| <tr><td><code>--trigger-value</code></td><td>The value with which the Pulsar Function is to be triggered</td><td></td></tr> |
| </tbody> |
| </table> |
| <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>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>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-subscribe-rate</code></li> |
| <li><code>get-subscribe-rate</code></li> |
| <li><code>clear-backlog</code></li> |
| <li><code>unsubscribe</code></li> |
| <li><code>set-encryption-required</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-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> |
| </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="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="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 for a 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 a 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). 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-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="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-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-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).</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> |
| <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="sink"></a><a href="#sink" 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>sink</code></h2> |
| <p>An interface for managing Pulsar IO sinks (egress data from Pulsar)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin sink subcommand |
| </code></pre> |
| <p>Subcommands</p> |
| <ul> |
| <li><code>create</code></li> |
| <li><code>update</code></li> |
| <li><code>delete</code></li> |
| <li><code>localrun</code></li> |
| <li><code>available-sinks</code></li> |
| </ul> |
| <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>Submit a Pulsar IO sink connector to run in a Pulsar cluster</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin sink create options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--classname</code></td><td>The sink’s Java class name</td><td></td></tr> |
| <tr><td><code>--cpu</code></td><td>The CPU (in cores) that needs to be allocated per sink instance (applicable only to the Docker runtime)</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 types or class names (as a JSON string)</td><td></td></tr> |
| <tr><td><code>--disk</code></td><td>The disk (in bytes) that needs to be allocated per sink instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--inputs</code></td><td>The sink’s input topic(s) (multiple topics can be specified as a comma-separated list)</td><td></td></tr> |
| <tr><td><code>--archive</code></td><td>Path to the archive file for the sink</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The sink’s name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The sink’s namespace</td><td></td></tr> |
| <tr><td><code>--parallelism</code></td><td>“The sink’s parallelism factor (i.e. the number of sink instances to run).”</td><td></td></tr> |
| <tr><td><code>--processing-guarantees</code></td><td>“The processing guarantees (aka delivery semantics) applied to the sink. Available values: ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.”</td><td></td></tr> |
| <tr><td><code>--ram</code></td><td>The RAM (in bytes) that needs to be allocated per sink instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--sink-config</code></td><td>Sink config key/values</td><td></td></tr> |
| <tr><td><code>--sink-config-file</code></td><td>The path to a YAML config file specifying the sink’s configuration</td><td></td></tr> |
| <tr><td><code>--sink-type</code></td><td>The built-in sinks's connector provider. The <code>sink-type</code> parameter of the currently built-in connectors is determined by the setting of the <code>name</code> parameter specified in the pulsar-io.yaml file.</td><td></td></tr> |
| <tr><td><code>--topics-pattern</code></td><td>TopicsPattern to consume from list of topics under a namespace that match the pattern.</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The sink’s tenant</td><td></td></tr> |
| <tr><td><code>--auto-ack</code></td><td>Let the functions framework manage acking</td><td></td></tr> |
| <tr><td><code>--timeout-ms</code></td><td>The message timeout in milliseconds</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>Submit a Pulsar IO sink connector to run in a Pulsar cluster</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin sink 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>--classname</code></td><td>The sink’s Java class name</td><td></td></tr> |
| <tr><td><code>--cpu</code></td><td>The CPU (in cores) that needs to be allocated per sink instance (applicable only to the Docker runtime)</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 types or class names (as a JSON string)</td><td></td></tr> |
| <tr><td><code>--disk</code></td><td>The disk (in bytes) that needs to be allocated per sink instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--inputs</code></td><td>The sink’s input topic(s) (multiple topics can be specified as a comma-separated list)</td><td></td></tr> |
| <tr><td><code>--archive</code></td><td>Path to the archive file for the sink</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The sink’s name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The sink’s namespace</td><td></td></tr> |
| <tr><td><code>--parallelism</code></td><td>“The sink’s parallelism factor (i.e. the number of sink instances to run).”</td><td></td></tr> |
| <tr><td><code>--processing-guarantees</code></td><td>“The processing guarantees (aka delivery semantics) applied to the sink. Available values: ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.”</td><td></td></tr> |
| <tr><td><code>--ram</code></td><td>The RAM (in bytes) that needs to be allocated per sink instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--sink-config</code></td><td>Sink config key/values</td><td></td></tr> |
| <tr><td><code>--sink-config-file</code></td><td>The path to a YAML config file specifying the sink’s configuration</td><td></td></tr> |
| <tr><td><code>--sink-type</code></td><td>The built-in sinks's connector provider. The <code>sink-type</code> parameter of the currently built-in connectors is determined by the setting of the <code>name</code> parameter specified in the pulsar-io.yaml file.</td><td></td></tr> |
| <tr><td><code>--topics-pattern</code></td><td>TopicsPattern to consume from list of topics under a namespace that match the pattern.</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The sink’s tenant</td><td></td></tr> |
| </tbody> |
| </table> |
| <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>Stops a Pulsar IO sink</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin sink 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>--name</code></td><td>The name of the function to delete</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The namespace of the function to delete</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The tenant of the function to delete</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="localrun-1"></a><a href="#localrun-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>localrun</code></h3> |
| <p>Run the Pulsar sink locally (rather than in the Pulsar cluster)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin sink 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>--broker-service-url</code></td><td>The URL for the Pulsar broker</td><td></td></tr> |
| <tr><td><code>--classname</code></td><td>The sink’s Java class name</td><td></td></tr> |
| <tr><td><code>--cpu</code></td><td>The CPU (in cores) that needs to be allocated per sink instance (applicable only to the Docker runtime)</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 types or class names (as a JSON string)</td><td></td></tr> |
| <tr><td><code>--disk</code></td><td>The disk (in bytes) that needs to be allocated per sink instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--inputs</code></td><td>The sink’s input topic(s) (multiple topics can be specified as a comma-separated list)</td><td></td></tr> |
| <tr><td><code>--archive</code></td><td>Path to the archive file for the sink</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The sink’s name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The sink’s namespace</td><td></td></tr> |
| <tr><td><code>--parallelism</code></td><td>“The sink’s parallelism factor (i.e. the number of sink instances to run).”</td><td></td></tr> |
| <tr><td><code>--processing-guarantees</code></td><td>“The processing guarantees (aka delivery semantics) applied to the sink. Available values: ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.”</td><td></td></tr> |
| <tr><td><code>--ram</code></td><td>The RAM (in bytes) that needs to be allocated per sink instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--sink-config</code></td><td>Sink config key/values</td><td></td></tr> |
| <tr><td><code>--sink-config-file</code></td><td>The path to a YAML config file specifying the sink’s configuration</td><td></td></tr> |
| <tr><td><code>--sink-type</code></td><td>The built-in sinks's connector provider. The <code>sink-type</code> parameter of the currently built-in connectors is determined by the setting of the <code>name</code> parameter specified in the pulsar-io.yaml file.</td><td></td></tr> |
| <tr><td><code>--topics-pattern</code></td><td>TopicsPattern to consume from list of topics under a namespace that match the pattern.</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The sink’s tenant</td><td></td></tr> |
| <tr><td><code>--auto-ack</code></td><td>Let the functions framework manage acking</td><td></td></tr> |
| <tr><td><code>--timeout-ms</code></td><td>The message timeout in milliseconds</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="available-sinks"></a><a href="#available-sinks" 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>available-sinks</code></h3> |
| <p>Get a list of all built-in sink connectors</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin sink available-sinks |
| </code></pre> |
| <h2><a class="anchor" aria-hidden="true" id="source"></a><a href="#source" 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>source</code></h2> |
| <p>An interface for managing Pulsar IO sources (ingress data into Pulsar)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">source</span> subcommand |
| </code></pre> |
| <p>Subcommands</p> |
| <ul> |
| <li><code>create</code></li> |
| <li><code>update</code></li> |
| <li><code>delete</code></li> |
| <li><code>localrun</code></li> |
| <li><code>available-sources</code></li> |
| </ul> |
| <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>Submit a Pulsar IO source connector to run in a Pulsar cluster</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">source</span> create options |
| </code></pre> |
| <p>Options</p> |
| <table> |
| <thead> |
| <tr><th>Flag</th><th>Description</th><th>Default</th></tr> |
| </thead> |
| <tbody> |
| <tr><td><code>--classname</code></td><td>The source’s Java class name</td><td></td></tr> |
| <tr><td><code>--cpu</code></td><td>The CPU (in cores) that needs to be allocated per source instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--deserialization-classname</code></td><td>The SerDe classname for the source</td><td></td></tr> |
| <tr><td><code>--destination-topic-name</code></td><td>The Pulsar topic to which data is sent</td><td></td></tr> |
| <tr><td><code>--disk</code></td><td>The disk (in bytes) that needs to be allocated per source instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--archive</code></td><td>The path to the NAR archive for the Source</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The source’s name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The source’s namespace</td><td></td></tr> |
| <tr><td><code>--parallelism</code></td><td>The source’s parallelism factor (i.e. the number of source instances to run).</td><td></td></tr> |
| <tr><td><code>--processing-guarantees</code></td><td>“The processing guarantees (aka delivery semantics) applied to the source. Available values: ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.”</td><td></td></tr> |
| <tr><td><code>--ram</code></td><td>The RAM (in bytes) that needs to be allocated per source instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--schema-type</code></td><td>The schema type (either a builtin schema like 'avro', 'json', etc, or custom Schema class name to be used to encode messages emitted from the source</td><td></td></tr> |
| <tr><td><code>--source-type</code></td><td>One of the built-in source's connector provider。 The source's connector provider. The <code>source-type</code> parameter of the currently built-in connectors is determined by the setting of the <code>name</code> parameter specified in the pulsar-io.yaml file.</td><td></td></tr> |
| <tr><td><code>--source-config</code></td><td>Source config key/values</td><td></td></tr> |
| <tr><td><code>--source-config-file</code></td><td>The path to a YAML config file specifying the source’s configuration</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The source’s tenant</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="update-3"></a><a href="#update-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>update</code></h3> |
| <p>Update a already submitted Pulsar IO source connector</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">source</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>--classname</code></td><td>The source’s Java class name</td><td></td></tr> |
| <tr><td><code>--cpu</code></td><td>The CPU (in cores) that needs to be allocated per source instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--deserialization-classname</code></td><td>The SerDe classname for the source</td><td></td></tr> |
| <tr><td><code>--destination-topic-name</code></td><td>The Pulsar topic to which data is sent</td><td></td></tr> |
| <tr><td><code>--disk</code></td><td>The disk (in bytes) that needs to be allocated per source instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--archive</code></td><td>The path to the NAR archive for the Source</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The source’s name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The source’s namespace</td><td></td></tr> |
| <tr><td><code>--parallelism</code></td><td>The source’s parallelism factor (i.e. the number of source instances to run).</td><td></td></tr> |
| <tr><td><code>--processing-guarantees</code></td><td>“The processing guarantees (aka delivery semantics) applied to the source. Available values: ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.”</td><td></td></tr> |
| <tr><td><code>--ram</code></td><td>The RAM (in bytes) that needs to be allocated per source instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--schema-type</code></td><td>The schema type (either a builtin schema like 'avro', 'json', etc, or custom Schema class name to be used to encode messages emitted from the source</td><td></td></tr> |
| <tr><td><code>--source-type</code></td><td>One of the built-in source's connector provider. The <code>source-type</code> parameter of the currently built-in connectors is determined by the setting of the <code>name</code> parameter specified in the pulsar-io.yaml file.</td><td></td></tr> |
| <tr><td><code>--source-config</code></td><td>Source config key/values</td><td></td></tr> |
| <tr><td><code>--source-config-file</code></td><td>The path to a YAML config file specifying the source’s configuration</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The source’s tenant</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>Stops a Pulsar IO source</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">source</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>--name</code></td><td>The name of the function to delete</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The namespace of the function to delete</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The tenant of the function to delete</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="localrun-2"></a><a href="#localrun-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>localrun</code></h3> |
| <p>Run the Pulsar source locally (rather than in the Pulsar cluster)</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">source</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>--classname</code></td><td>The source’s Java class name</td><td></td></tr> |
| <tr><td><code>--cpu</code></td><td>The CPU (in cores) that needs to be allocated per source instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--deserialization-classname</code></td><td>The SerDe classname for the source</td><td></td></tr> |
| <tr><td><code>--destination-topic-name</code></td><td>The Pulsar topic to which data is sent</td><td></td></tr> |
| <tr><td><code>--disk</code></td><td>The disk (in bytes) that needs to be allocated per source instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--archive</code></td><td>The path to the NAR archive for the Source</td><td></td></tr> |
| <tr><td><code>--name</code></td><td>The source’s name</td><td></td></tr> |
| <tr><td><code>--namespace</code></td><td>The source’s namespace</td><td></td></tr> |
| <tr><td><code>--parallelism</code></td><td>The source’s parallelism factor (i.e. the number of source instances to run).</td><td></td></tr> |
| <tr><td><code>--processing-guarantees</code></td><td>“The processing guarantees (aka delivery semantics) applied to the source. Available values: ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.”</td><td></td></tr> |
| <tr><td><code>--ram</code></td><td>The RAM (in bytes) that needs to be allocated per source instance (applicable only to the Docker runtime)</td><td></td></tr> |
| <tr><td><code>--schema-type</code></td><td>The schema type (either a builtin schema like 'avro', 'json', etc, or custom Schema class name to be used to encode messages emitted from the source</td><td></td></tr> |
| <tr><td><code>--source-type</code></td><td>One of the built-in source's connector provider. The <code>source-type</code> parameter of the currently built-in connectors is determined by the setting of the <code>name</code> parameter specified in the pulsar-io.yaml file.</td><td></td></tr> |
| <tr><td><code>--source-config</code></td><td>Source config key/values</td><td></td></tr> |
| <tr><td><code>--source-config-file</code></td><td>The path to a YAML config file specifying the source’s configuration</td><td></td></tr> |
| <tr><td><code>--tenant</code></td><td>The source’s tenant</td><td></td></tr> |
| </tbody> |
| </table> |
| <h3><a class="anchor" aria-hidden="true" id="available-sources"></a><a href="#available-sources" 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>available-sources</code></h3> |
| <p>Get a list of all built-in source connectors</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin <span class="hljs-built_in">source</span> available-sources |
| </code></pre> |
| <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>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>delete-partitioned-topic</code></li> |
| <li><code>get-partitioned-topic-metadata</code></li> |
| <li><code>update-partitioned-topic</code></li> |
| <li><code>list</code></li> |
| <li><code>list-in-bundle</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>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>skip</code></li> |
| <li><code>skip-all</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> |
| </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> |
| <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="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="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-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="list-in-bundle"></a><a href="#list-in-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>list-in-bundle</code></h3> |
| <p>Get a list of non-persistent topics present under a namespace bundle</p> |
| <p>Usage</p> |
| <pre><code class="hljs">$ <span class="hljs-string">pulsar-admin </span><span class="hljs-string">topics </span><span class="hljs-built_in">list-in-bundle</span> <span class="hljs-string">tenant/</span><span class="hljs-string">namespace </span><span class="hljs-string">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>-b</code>, <code>--bundle</code></td><td>The bundle range</td><td></td></tr> |
| </tbody> |
| </table> |
| <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-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 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="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> |
| </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 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> |
| <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="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="skip-all"></a><a href="#skip-all" 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-all</code></h3> |
| <p>Skip all the messages for the subscription</p> |
| <p>Usage</p> |
| <pre><code class="hljs css language-bash">$ pulsar-admin topics skip-all 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 closest to timestamp</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> |
| </tbody> |
| </table> |
| <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-5"></a><a href="#create-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>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-4"></a><a href="#update-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>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-7"></a><a href="#delete-7" 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-8"></a><a href="#delete-8" 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="#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="#getstatus"><code>getstatus</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="#trigger"><code>trigger</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="#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="#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-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="#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-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-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></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="#sink"><code>sink</code></a><ul class="toc-headings"><li><a href="#create-3"><code>create</code></a></li><li><a href="#update-2"><code>update</code></a></li><li><a href="#delete-4"><code>delete</code></a></li><li><a href="#localrun-1"><code>localrun</code></a></li><li><a href="#available-sinks"><code>available-sinks</code></a></li></ul></li><li><a href="#source"><code>source</code></a><ul class="toc-headings"><li><a href="#create-4"><code>create</code></a></li><li><a href="#update-3"><code>update</code></a></li><li><a href="#delete-5"><code>delete</code></a></li><li><a href="#localrun-2"><code>localrun</code></a></li><li><a href="#available-sources"><code>available-sources</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="#delete-partitioned-topic"><code>delete-partitioned-topic</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-5"><code>list</code></a></li><li><a href="#list-in-bundle"><code>list-in-bundle</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-6"><code>delete</code></a></li><li><a href="#unload-1"><code>unload</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"><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="#skip"><code>skip</code></a></li><li><a href="#skip-all"><code>skip-all</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></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-5"><code>create</code></a></li><li><a href="#update-4"><code>update</code></a></li><li><a href="#delete-7"><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-8"><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> |
