| </div></div><nav aria-label="Main" class="navbar navbar--fixed-top"><div class="navbar__inner"><div class="navbar__items"><button aria-label="Toggle navigation bar" aria-expanded="false" class="navbar__toggle clean-btn" type="button"><svg width="30" height="30" viewBox="0 0 30 30" aria-hidden="true"><path stroke="currentColor" stroke-linecap="round" stroke-miterlimit="10" stroke-width="2" d="M4 7h22M4 15h22M4 23h22"></path></svg></button><a class="navbar__brand" href="/"><div class="navbar__logo"><img src="/img/logo-black.svg" alt="Apache Pulsar logo" class="themedImage_ToTc themedImage--light_HNdA" height="25" width="127"><img src="/img/logo-black.svg" alt="Apache Pulsar logo" class="themedImage_ToTc themedImage--dark_i4oU" height="25" width="127"></div><b class="navbar__title text--truncate"></b></a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Get Started</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/docs/3.2.x/concepts-overview/">Concepts</a></li><li><a class="dropdown__link" href="/docs/3.2.x/">Quickstart</a></li><li><a class="dropdown__link" href="/ecosystem/">Ecosystem</a></li></ul></div><a class="navbar__item navbar__link" href="/docs/3.0.x/">Docs</a><a class="navbar__item navbar__link" href="/features/">Features</a><a class="navbar__item navbar__link" href="/use-cases/">Use Cases</a><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link community-dropdown">Community</a><ul class="dropdown__menu"><li><a class="dropdown__link scroll-link scroll-welcome" id="scroll-welcome" href="/community/">Welcome</a></li><li><a class="dropdown__link scroll-link scroll-discussions" id="scroll-discussions" href="/community/#section-discussions">Discussions</a></li><li><a class="dropdown__link scroll-link" id="scroll-governance" href="/community/#section-governance">Governance</a></li><li><a class="dropdown__link scroll-link" id="scroll-community" href="/community/#section-community">Meet the Community</a></li><li><a class="dropdown__link scroll-link" id="scroll-contribute" href="/community/#section-contribute">Contribute</a></li><li><a class="dropdown__link" href="/contribute/">Contribution Guide</a></li><li><a href="https://github.com/apache/pulsar/wiki" target="_blank" rel="noopener noreferrer" class="dropdown__link">Wiki</a></li><li><a href="https://github.com/apache/pulsar/issues" target="_blank" rel="noopener noreferrer" class="dropdown__link">Issue Tracking</a></li></ul></div><div class="navbar__item dropdown dropdown--hoverable"><a href="#" aria-haspopup="true" aria-expanded="false" role="button" class="navbar__link">Learn</a><ul class="dropdown__menu"><li><a class="dropdown__link" href="/blog/">Blog</a></li><li><a class="dropdown__link" href="/books/">Books</a></li><li><a class="dropdown__link" href="/case-studies/">Case Studies</a></li><li><a class="dropdown__link" href="/articles/">Articles</a></li><li><a class="dropdown__link" href="/presentations/">Presentations</a></li><li><a class="dropdown__link" href="/events/">Events</a></li></ul></div></div><div class="navbar__items navbar__items--right"><a class="navbar__item navbar__link navbar_download_button" href="/download/">Download</a><div class="searchBox_ZlJk"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20" aria-hidden="true"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div></div></div><div role="presentation" class="navbar-sidebar__backdrop"></div></nav><div id="docusaurus_skipToContent_fallback" class="main-wrapper mainWrapper_z2l0 docsWrapper_BCFX"><button aria-label="Scroll back to top" class="clean-btn theme-back-to-top-button backToTopButton_sjWU" type="button"></button><div class="docPage__5DB"><main class="docMainContainer_gTbr docMainContainerEnhanced_Uz_u"><div class="container padding-top--md padding-bottom--lg"><div class="row"><div class="col docItemCol_VOVn"><div class="docItemContainer_Djhp"><article><div class="tocCollapsible_ETCw theme-doc-toc-mobile tocMobile_ITEo"><button type="button" class="clean-btn tocCollapsibleButton_TO0P">On this page</button></div><div class="theme-doc-markdown markdown"><header><h1>Connector Admin CLI</h1></header><div class="theme-admonition theme-admonition-tip alert alert--success admonition_LlT9"><div class="admonitionHeading_tbUL"><span class="admonitionIcon_kALy"><svg viewBox="0 0 12 16"><path fill-rule="evenodd" d="M6.5 0C3.48 0 1 2.19 1 5c0 .92.55 2.25 1 3 1.34 2.25 1.78 2.78 2 4v1h5v-1c.22-1.22.66-1.75 2-4 .45-.75 1-2.08 1-3 0-2.81-2.48-5-5.5-5zm3.64 7.48c-.25.44-.47.8-.67 1.11-.86 1.41-1.25 2.06-1.45 3.23-.02.05-.02.11-.02.17H5c0-.06 0-.13-.02-.17-.2-1.17-.59-1.83-1.45-3.23-.2-.31-.42-.67-.67-1.11C2.44 6.78 2 5.65 2 5c0-2.2 2.02-4 4.5-4 1.22 0 2.36.42 3.22 1.19C10.55 2.94 11 3.94 11 5c0 .66-.44 1.78-.86 2.48zM4 14h5c-.23 1.14-1.3 2-2.5 2s-2.27-.86-2.5-2z"></path></svg></span>tip</div><div class="admonitionContent_S0QG"><p>This page is deprecated and not updated anymore. For the latest and complete information about <code>Pulsar-admin</code>, including commands, flags, descriptions, and more, see <a href="/reference/#/3.0.x/pulsar-admin/" target="_blank" rel="noopener noreferrer">Pulsar admin docs</a>.</p></div></div><p>The <code>pulsar-admin</code> tool helps you manage Pulsar connectors.</p><h2 class="anchor anchorWithStickyNavbar_LWe7" id="sources"><code>sources</code><a href="#sources" class="hash-link" aria-label="Direct link to sources" title="Direct link to sources"></a></h2><p>An interface for managing Pulsar IO sources (ingress data into Pulsar).</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sources subcommands</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Subcommands are:</p><ul><li><code>create</code></li><li><code>update</code></li><li><code>delete</code></li><li><code>get</code></li><li><code>status</code></li><li><code>list</code></li><li><code>stop</code></li><li><code>start</code></li><li><code>restart</code></li><li><code>localrun</code></li><li><code>available-sources</code></li><li><code>reload</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="create"><code>create</code><a href="#create" class="hash-link" aria-label="Direct link to create" title="Direct link to create"></a></h3><p>Submit a Pulsar IO source connector to run in a Pulsar cluster.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage">Usage<a href="#usage" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sources create options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options">Options<a href="#options" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>-a</code>, <code>--archive</code></td><td>The absolute path to the NAR archive for the source. <br> It also supports url-path (http/https/file <!-- -->[file protocol assumes that file already exists on worker host]<!-- -->) from which worker can download the package.</td></tr><tr><td><code>--classname</code></td><td>The source's class name.</td></tr><tr><td><code>--cpu</code></td><td>The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime).</td></tr><tr><td><code>--deserialization-classname</code></td><td>The SerDe classname for the source.</td></tr><tr><td><code>--destination-topic-name</code></td><td>The Pulsar topic to which data is sent.</td></tr><tr><td><code>--disk</code></td><td>The disk (in bytes) that needs to be allocated per source instance (applicable only to Docker runtime).</td></tr><tr><td><code>--name</code></td><td>The source's name.</td></tr><tr><td><code>--namespace</code></td><td>The source's namespace.</td></tr><tr><td><code> --parallelism</code></td><td>The source's parallelism factor, that is, the number of source instances to run.</td></tr><tr><td><code>--processing-guarantees</code></td><td>The processing guarantees (also named as delivery semantics) applied to the source. A source connector receives messages from external system and writes messages to a Pulsar topic. The <code>--processing-guarantees</code> is used to ensure the processing guarantees for writing messages to the Pulsar topic. <br>The available values are ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.</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 process and Docker runtimes).</td></tr><tr><td><code>-st</code>, <code>--schema-type</code></td><td>The schema type.<br> Either a built-in schema (for example, AVRO and JSON) or custom schema class name to be used to encode messages emitted from source.</td></tr><tr><td><code>--source-config</code></td><td>Source config key/values.</td></tr><tr><td><code>--source-config-file</code></td><td>The absolute path to a YAML config file specifying the source's configuration.</td></tr><tr><td><code>-t</code>, <code>--source-type</code></td><td>The source's connector provider.</td></tr><tr><td><code>--tenant</code></td><td>The source's tenant.</td></tr><tr><td><code>--producer-config</code></td><td>The custom producer configuration (as a JSON string).</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="update"><code>update</code><a href="#update" class="hash-link" aria-label="Direct link to update" title="Direct link to update"></a></h3><p>Update a already submitted Pulsar IO source connector.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-1">Usage<a href="#usage-1" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sources update options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-1">Options<a href="#options-1" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>-a</code>, <code>--archive</code></td><td>The absolute path to the NAR archive for the source. <br> It also supports url-path (http/https/file <!-- -->[file protocol assumes that file already exists on worker host]<!-- -->) from which worker can download the package.</td></tr><tr><td><code>--classname</code></td><td>The source's class name.</td></tr><tr><td><code>--cpu</code></td><td>The CPU (in cores) that needs to be allocated per source instance (applicable only to Docker runtime).</td></tr><tr><td><code>--deserialization-classname</code></td><td>The SerDe classname for the source.</td></tr><tr><td><code>--destination-topic-name</code></td><td>The Pulsar topic to which data is sent.</td></tr><tr><td><code>--disk</code></td><td>The disk (in bytes) that needs to be allocated per source instance (applicable only to Docker runtime).</td></tr><tr><td><code>--name</code></td><td>The source's name.</td></tr><tr><td><code>--namespace</code></td><td>The source's namespace.</td></tr><tr><td><code> --parallelism</code></td><td>The source's parallelism factor, that is, the number of source instances to run.</td></tr><tr><td><code>--processing-guarantees</code></td><td>The processing guarantees (also named as delivery semantics) applied to the source. A source connector receives messages from external system and writes messages to a Pulsar topic. The <code>--processing-guarantees</code> is used to ensure the processing guarantees for writing messages to the Pulsar topic. <br>The available values are ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.</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 process and Docker runtimes).</td></tr><tr><td><code>-st</code>, <code>--schema-type</code></td><td>The schema type.<br> Either a built-in schema (for example, AVRO and JSON) or custom schema class name to be used to encode messages emitted from source.</td></tr><tr><td><code>--source-config</code></td><td>Source config key/values.</td></tr><tr><td><code>--source-config-file</code></td><td>The absolute path to a YAML config file specifying the source's configuration.</td></tr><tr><td><code>-t</code>, <code>--source-type</code></td><td>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></tr><tr><td><code>--tenant</code></td><td>The source's tenant.</td></tr><tr><td><code>--update-auth-data</code></td><td>Whether or not to update the auth data.<br><strong>Default value: false.</strong></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete"><code>delete</code><a href="#delete" class="hash-link" aria-label="Direct link to delete" title="Direct link to delete"></a></h3><p>Delete a Pulsar IO source connector.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-2">Usage<a href="#usage-2" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sources delete options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="option">Option<a href="#option" class="hash-link" aria-label="Direct link to Option" title="Direct link to Option"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--name</code></td><td>The source's name.</td></tr><tr><td><code>--namespace</code></td><td>The source's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The source's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get"><code>get</code><a href="#get" class="hash-link" aria-label="Direct link to get" title="Direct link to get"></a></h3><p>Get the information about a Pulsar IO source connector.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-3">Usage<a href="#usage-3" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sources get options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-2">Options<a href="#options-2" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--name</code></td><td>The source's name.</td></tr><tr><td><code>--namespace</code></td><td>The source's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The source's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="status"><code>status</code><a href="#status" class="hash-link" aria-label="Direct link to status" title="Direct link to status"></a></h3><p>Check the current status of a Pulsar Source.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-4">Usage<a href="#usage-4" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sources status options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-3">Options<a href="#options-3" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--instance-id</code></td><td>The source ID.<br>If <code>instance-id</code> is not provided, Pulsar gets status of all instances.</td></tr><tr><td><code>--name</code></td><td>The source's name.</td></tr><tr><td><code>--namespace</code></td><td>The source's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The source's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list"><code>list</code><a href="#list" class="hash-link" aria-label="Direct link to list" title="Direct link to list"></a></h3><p>List all running Pulsar IO source connectors.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-5">Usage<a href="#usage-5" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sources list options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-4">Options<a href="#options-4" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--namespace</code></td><td>The source's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The source's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="stop"><code>stop</code><a href="#stop" class="hash-link" aria-label="Direct link to stop" title="Direct link to stop"></a></h3><p>Stop a source instance.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-6">Usage<a href="#usage-6" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sources stop options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-5">Options<a href="#options-5" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--instance-id</code></td><td>The source instanceID.<br>If <code>instance-id</code> is not provided, Pulsar stops all instances.</td></tr><tr><td><code>--name</code></td><td>The source's name.</td></tr><tr><td><code>--namespace</code></td><td>The source's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The source's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="start"><code>start</code><a href="#start" class="hash-link" aria-label="Direct link to start" title="Direct link to start"></a></h3><p>Start a source instance.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-7">Usage<a href="#usage-7" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sources start options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-6">Options<a href="#options-6" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--instance-id</code></td><td>The source instanceID.<br>If <code>instance-id</code> is not provided, Pulsar starts all instances.</td></tr><tr><td><code>--name</code></td><td>The source's name.</td></tr><tr><td><code>--namespace</code></td><td>The source's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The source's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="restart"><code>restart</code><a href="#restart" class="hash-link" aria-label="Direct link to restart" title="Direct link to restart"></a></h3><p>Restart a source instance.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-8">Usage<a href="#usage-8" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sources restart options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-7">Options<a href="#options-7" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--instance-id</code></td><td>The source instanceID.<br>If <code>instance-id</code> is not provided, Pulsar restarts all instances.</td></tr><tr><td><code>--name</code></td><td>The source's name.</td></tr><tr><td><code>--namespace</code></td><td>The source's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The source's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="localrun"><code>localrun</code><a href="#localrun" class="hash-link" aria-label="Direct link to localrun" title="Direct link to localrun"></a></h3><p>Run a Pulsar IO source connector locally rather than deploying it to the Pulsar cluster.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-9">Usage<a href="#usage-9" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sources localrun options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-8">Options<a href="#options-8" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>-a</code>, <code>--archive</code></td><td>The absolute path to the NAR archive for the Source. <br> It also supports url-path (http/https/file <!-- -->[file protocol assumes that file already exists on worker host]<!-- -->) from which worker can download the package.</td></tr><tr><td><code>--broker-service-url</code></td><td>The URL for the Pulsar broker.</td></tr><tr><td><code>--classname</code></td><td>The source's class name.</td></tr><tr><td><code>--client-auth-params</code></td><td>Client authentication parameter.</td></tr><tr><td><code>--client-auth-plugin</code></td><td>Client authentication plugin using which function-process can connect to broker.</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></tr><tr><td><code>--deserialization-classname</code></td><td>The SerDe classname for the source.</td></tr><tr><td><code>--destination-topic-name</code></td><td>The Pulsar topic to which data is sent.</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></tr><tr><td><code>--hostname-verification-enabled</code></td><td>Enable hostname verification.<br><strong>Default value: false</strong>.</td></tr><tr><td><code>--name</code></td><td>The source's name.</td></tr><tr><td><code>--namespace</code></td><td>The source's namespace.</td></tr><tr><td><code>--parallelism</code></td><td>The source's parallelism factor, that is, the number of source instances to run).</td></tr><tr><td><code>--processing-guarantees</code></td><td>The processing guarantees (also named as delivery semantics) applied to the source. A source connector receives messages from external system and writes messages to a Pulsar topic. The <code>--processing-guarantees</code> is used to ensure the processing guarantees for writing messages to the Pulsar topic. <br>The available values are ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.</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></tr><tr><td><code>-st</code>, <code>--schema-type</code></td><td>The schema type.<br> Either a built-in schema (for example, AVRO and JSON) or custom schema class name to be used to encode messages emitted from source.</td></tr><tr><td><code>--source-config</code></td><td>Source config key/values.</td></tr><tr><td><code>--source-config-file</code></td><td>The absolute path to a YAML config file specifying the source's configuration.</td></tr><tr><td><code>--source-type</code></td><td>The source's connector provider.</td></tr><tr><td><code>--tenant</code></td><td>The source's tenant.</td></tr><tr><td><code>--tls-allow-insecure</code></td><td>Allow insecure tls connection.<br><strong>Default value: false</strong>.</td></tr><tr><td><code>--tls-trust-cert-path</code></td><td>The tls trust cert file path.</td></tr><tr><td><code>--use-tls</code></td><td>Use tls connection.<br><strong>Default value: false</strong>.</td></tr><tr><td><code>--producer-config</code></td><td>The custom producer configuration (as a JSON string).</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="available-sources"><code>available-sources</code><a href="#available-sources" class="hash-link" aria-label="Direct link to available-sources" title="Direct link to available-sources"></a></h3><p>Get the list of Pulsar IO connector sources supported by Pulsar cluster.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-10">Usage<a href="#usage-10" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sources available-sources</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="reload"><code>reload</code><a href="#reload" class="hash-link" aria-label="Direct link to reload" title="Direct link to reload"></a></h3><p>Reload the available built-in connectors.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-11">Usage<a href="#usage-11" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sources reload</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h2 class="anchor anchorWithStickyNavbar_LWe7" id="sinks"><code>sinks</code><a href="#sinks" class="hash-link" aria-label="Direct link to sinks" title="Direct link to sinks"></a></h2><p>An interface for managing Pulsar IO sinks (egress data from Pulsar).</p><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sinks subcommands</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><p>Subcommands are:</p><ul><li><code>create</code></li><li><code>update</code></li><li><code>delete</code></li><li><code>get</code></li><li><code>status</code></li><li><code>list</code></li><li><code>stop</code></li><li><code>start</code></li><li><code>restart</code></li><li><code>localrun</code></li><li><code>available-sinks</code></li><li><code>reload</code></li></ul><h3 class="anchor anchorWithStickyNavbar_LWe7" id="create-1"><code>create</code><a href="#create-1" class="hash-link" aria-label="Direct link to create-1" title="Direct link to create-1"></a></h3><p>Submit a Pulsar IO sink connector to run in a Pulsar cluster.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-12">Usage<a href="#usage-12" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sinks create options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-9">Options<a href="#options-9" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>-a</code>, <code>--archive</code></td><td>The absolute path to the archive file for the sink. <br> It also supports url-path (http/https/file <!-- -->[file protocol assumes that file already exists on worker host]<!-- -->) from which worker can download the package.</td></tr><tr><td><code>--auto-ack</code></td><td>Whether or not the framework will automatically acknowledge messages.</td></tr><tr><td><code>--classname</code></td><td>The sink's class name.</td></tr><tr><td><code>--cpu</code></td><td>The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime).</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></tr><tr><td><code>--custom-serde-inputs</code></td><td>The map of input topics to SerDe class names (as a JSON string).</td></tr><tr><td><code>--disk</code></td><td>The disk (in bytes) that needs to be allocated per sink instance (applicable only to Docker runtime).</td></tr><tr><td><code>-i, --inputs</code></td><td>The sink's input topic or topics (multiple topics can be specified as a comma-separated list).</td></tr><tr><td><code>--name</code></td><td>The sink's name.</td></tr><tr><td><code>--namespace</code></td><td>The sink's namespace.</td></tr><tr><td><code> --parallelism</code></td><td>The sink's parallelism factor, that is, the number of sink instances to run.</td></tr><tr><td><code>--processing-guarantees</code></td><td>The processing guarantees (also known as delivery semantics) applied to the sink. The <code>--processing-guarantees</code> implementation in Pulsar also relies on sink implementation. <br>The available values are ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.</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 process and Docker runtimes).</td></tr><tr><td><code>--retain-ordering</code></td><td>Sink consumes and sinks messages in order.</td></tr><tr><td><code>--sink-config</code></td><td>sink config key/values.</td></tr><tr><td><code>--sink-config-file</code></td><td>The absolute path to a YAML config file specifying the sink's configuration.</td></tr><tr><td><code>-t</code>, <code>--sink-type</code></td><td>The sink'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></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></tr><tr><td><code>--tenant</code></td><td>The sink's tenant.</td></tr><tr><td><code>--timeout-ms</code></td><td>The message timeout in milliseconds.</td></tr><tr><td><code>--topics-pattern</code></td><td>The topic pattern to consume from a list of topics under a namespace that matches the pattern. <br><code>--input</code> and <code>--topics-pattern</code> are mutually exclusive. <br>Add SerDe class name for a pattern in <code>--custom-serde-inputs</code>.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="update-1"><code>update</code><a href="#update-1" class="hash-link" aria-label="Direct link to update-1" title="Direct link to update-1"></a></h3><p>Update a Pulsar IO sink connector.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-13">Usage<a href="#usage-13" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sinks update options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-10">Options<a href="#options-10" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>-a</code>, <code>--archive</code></td><td>The absolute path to the archive file for the sink. <br> It also supports url-path (http/https/file <!-- -->[file protocol assumes that file already exists on worker host]<!-- -->) from which worker can download the package.</td></tr><tr><td><code>--auto-ack</code></td><td>Whether or not the framework will automatically acknowledge messages.</td></tr><tr><td><code>--classname</code></td><td>The sink's class name.</td></tr><tr><td><code>--cpu</code></td><td>The CPU (in cores) that needs to be allocated per sink instance (applicable only to Docker runtime).</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></tr><tr><td><code>--custom-serde-inputs</code></td><td>The map of input topics to SerDe class names (as a JSON string).</td></tr><tr><td><code>--disk</code></td><td>The disk (in bytes) that needs to be allocated per sink instance (applicable only to Docker runtime).</td></tr><tr><td><code>-i, --inputs</code></td><td>The sink's input topic or topics (multiple topics can be specified as a comma-separated list).</td></tr><tr><td><code>--name</code></td><td>The sink's name.</td></tr><tr><td><code>--namespace</code></td><td>The sink's namespace.</td></tr><tr><td><code> --parallelism</code></td><td>The sink's parallelism factor, that is, the number of sink instances to run.</td></tr><tr><td><code>--processing-guarantees</code></td><td>The processing guarantees (also known as delivery semantics) applied to the sink. The <code>--processing-guarantees</code> implementation in Pulsar also relies on sink implementation. <br>The available values are ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.</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 process and Docker runtimes).</td></tr><tr><td><code>--retain-ordering</code></td><td>Sink consumes and sinks messages in order.</td></tr><tr><td><code>--sink-config</code></td><td>sink config key/values.</td></tr><tr><td><code>--sink-config-file</code></td><td>The absolute path to a YAML config file specifying the sink's configuration.</td></tr><tr><td><code>-t</code>, <code>--sink-type</code></td><td>The sink's connector provider.</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></tr><tr><td><code>--tenant</code></td><td>The sink's tenant.</td></tr><tr><td><code>--timeout-ms</code></td><td>The message timeout in milliseconds.</td></tr><tr><td><code>--topics-pattern</code></td><td>The topic pattern to consume from a list of topics under a namespace that matches the pattern. <br><code>--input</code> and <code>--topics-pattern</code> are mutually exclusive. <br>Add SerDe class name for a pattern in <code>--custom-serde-inputs</code>.</td></tr><tr><td><code>--update-auth-data</code></td><td>Whether or not to update the auth data.<br><strong>Default value: false.</strong></td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="delete-1"><code>delete</code><a href="#delete-1" class="hash-link" aria-label="Direct link to delete-1" title="Direct link to delete-1"></a></h3><p>Delete a Pulsar IO sink connector.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-14">Usage<a href="#usage-14" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sinks delete options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="option-1">Option<a href="#option-1" class="hash-link" aria-label="Direct link to Option" title="Direct link to Option"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--name</code></td><td>The sink's name.</td></tr><tr><td><code>--namespace</code></td><td>The sink's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The sink's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="get-1"><code>get</code><a href="#get-1" class="hash-link" aria-label="Direct link to get-1" title="Direct link to get-1"></a></h3><p>Get the information about a Pulsar IO sink connector.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-15">Usage<a href="#usage-15" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sinks get options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-11">Options<a href="#options-11" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--name</code></td><td>The sink's name.</td></tr><tr><td><code>--namespace</code></td><td>The sink's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The sink's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="status-1"><code>status</code><a href="#status-1" class="hash-link" aria-label="Direct link to status-1" title="Direct link to status-1"></a></h3><p>Check the current status of a Pulsar sink.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-16">Usage<a href="#usage-16" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sinks status options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-12">Options<a href="#options-12" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--instance-id</code></td><td>The sink ID.<br>If <code>instance-id</code> is not provided, Pulsar gets status of all instances.</td></tr><tr><td><code>--name</code></td><td>The sink's name.</td></tr><tr><td><code>--namespace</code></td><td>The sink's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The sink's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="list-1"><code>list</code><a href="#list-1" class="hash-link" aria-label="Direct link to list-1" title="Direct link to list-1"></a></h3><p>List all running Pulsar IO sink connectors.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-17">Usage<a href="#usage-17" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sinks list options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-13">Options<a href="#options-13" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--namespace</code></td><td>The sink's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The sink's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="stop-1"><code>stop</code><a href="#stop-1" class="hash-link" aria-label="Direct link to stop-1" title="Direct link to stop-1"></a></h3><p>Stop a sink instance.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-18">Usage<a href="#usage-18" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sinks stop options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-14">Options<a href="#options-14" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--instance-id</code></td><td>The sink instanceID.<br>If <code>instance-id</code> is not provided, Pulsar stops all instances.</td></tr><tr><td><code>--name</code></td><td>The sink's name.</td></tr><tr><td><code>--namespace</code></td><td>The sink's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The sink's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="start-1"><code>start</code><a href="#start-1" class="hash-link" aria-label="Direct link to start-1" title="Direct link to start-1"></a></h3><p>Start a sink instance.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-19">Usage<a href="#usage-19" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sinks start options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-15">Options<a href="#options-15" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--instance-id</code></td><td>The sink instanceID.<br>If <code>instance-id</code> is not provided, Pulsar starts all instances.</td></tr><tr><td><code>--name</code></td><td>The sink's name.</td></tr><tr><td><code>--namespace</code></td><td>The sink's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The sink's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="restart-1"><code>restart</code><a href="#restart-1" class="hash-link" aria-label="Direct link to restart-1" title="Direct link to restart-1"></a></h3><p>Restart a sink instance.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-20">Usage<a href="#usage-20" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sinks restart options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-16">Options<a href="#options-16" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>--instance-id</code></td><td>The sink instanceID.<br>If <code>instance-id</code> is not provided, Pulsar restarts all instances.</td></tr><tr><td><code>--name</code></td><td>The sink's name.</td></tr><tr><td><code>--namespace</code></td><td>The sink's namespace.</td></tr><tr><td><code>--tenant</code></td><td>The sink's tenant.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="localrun-1"><code>localrun</code><a href="#localrun-1" class="hash-link" aria-label="Direct link to localrun-1" title="Direct link to localrun-1"></a></h3><p>Run a Pulsar IO sink connector locally rather than deploying it to the Pulsar cluster.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-21">Usage<a href="#usage-21" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sinks localrun options</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h4 class="anchor anchorWithStickyNavbar_LWe7" id="options-17">Options<a href="#options-17" class="hash-link" aria-label="Direct link to Options" title="Direct link to Options"></a></h4><table><thead><tr><th>Flag</th><th>Description</th></tr></thead><tbody><tr><td><code>-a</code>, <code>--archive</code></td><td>The absolute path to the archive file for the sink. <br> It also supports url-path (http/https/file <!-- -->[file protocol assumes that file already exists on worker host]<!-- -->) from which worker can download the package.</td></tr><tr><td><code>--auto-ack</code></td><td>Whether or not the framework will automatically acknowledge messages.</td></tr><tr><td><code>--broker-service-url</code></td><td>The URL for the Pulsar broker.</td></tr><tr><td><code>--classname</code></td><td>The sink's class name.</td></tr><tr><td><code>--client-auth-params</code></td><td>Client authentication parameter.</td></tr><tr><td><code>--client-auth-plugin</code></td><td>Client authentication plugin using which function-process can connect to broker.</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></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></tr><tr><td><code>--max-redeliver-count</code></td><td>Maximum number of times that a message is redelivered before being sent to the dead letter queue.</td></tr><tr><td><code>--dead-letter-topic</code></td><td>Name of the dead letter topic where the failing messages are sent.</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></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></tr><tr><td><code>--hostname-verification-enabled</code></td><td>Enable hostname verification.<br><strong>Default value: false</strong>.</td></tr><tr><td><code>-i</code>, <code>--inputs</code></td><td>The sink's input topic or topics (multiple topics can be specified as a comma-separated list).</td></tr><tr><td><code>--name</code></td><td>The sink's name.</td></tr><tr><td><code>--namespace</code></td><td>The sink's namespace.</td></tr><tr><td><code>--parallelism</code></td><td>The sink's parallelism factor, that is, the number of sink instances to run).</td></tr><tr><td><code>--processing-guarantees</code></td><td>The processing guarantees (also known as delivery semantics) applied to the sink. The <code>--processing-guarantees</code> implementation in Pulsar also relies on sink implementation. <br>The available values are ATLEAST_ONCE, ATMOST_ONCE, EFFECTIVELY_ONCE.</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></tr><tr><td><code>--retain-ordering</code></td><td>Sink consumes and sinks messages in order.</td></tr><tr><td><code>--sink-config</code></td><td>sink config key/values.</td></tr><tr><td><code>--sink-config-file</code></td><td>The absolute path to a YAML config file specifying the sink's configuration.</td></tr><tr><td><code>--sink-type</code></td><td>The sink's connector provider.</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></tr><tr><td><code>--tenant</code></td><td>The sink's tenant.</td></tr><tr><td><code>--timeout-ms</code></td><td>The message timeout in milliseconds.</td></tr><tr><td><code>--negative-ack-redelivery-delay-ms</code></td><td>The negatively-acknowledged message redelivery delay in milliseconds.</td></tr><tr><td><code>--tls-allow-insecure</code></td><td>Allow insecure tls connection.<br><strong>Default value: false</strong>.</td></tr><tr><td><code>--tls-trust-cert-path</code></td><td>The tls trust cert file path.</td></tr><tr><td><code>--topics-pattern</code></td><td>The topic pattern to consume from a list of topics under a namespace that matches the pattern. <br><code>--input</code> and <code>--topics-pattern</code> are mutually exclusive. <br>Add SerDe class name for a pattern in <code>--custom-serde-inputs</code>.</td></tr><tr><td><code>--use-tls</code></td><td>Use tls connection.<br><strong>Default value: false</strong>.</td></tr></tbody></table><h3 class="anchor anchorWithStickyNavbar_LWe7" id="available-sinks"><code>available-sinks</code><a href="#available-sinks" class="hash-link" aria-label="Direct link to available-sinks" title="Direct link to available-sinks"></a></h3><p>Get the list of Pulsar IO connector sinks supported by Pulsar cluster.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-22">Usage<a href="#usage-22" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sinks available-sinks</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div><h3 class="anchor anchorWithStickyNavbar_LWe7" id="reload-1"><code>reload</code><a href="#reload-1" class="hash-link" aria-label="Direct link to reload-1" title="Direct link to reload-1"></a></h3><p>Reload the available built-in connectors.</p><h4 class="anchor anchorWithStickyNavbar_LWe7" id="usage-23">Usage<a href="#usage-23" class="hash-link" aria-label="Direct link to Usage" title="Direct link to Usage"></a></h4><div class="language-bash codeBlockContainer_Ckt0 theme-code-block" style="--prism-color:#F8F8F2;--prism-background-color:#282A36"><div class="codeBlockContent_biex"><pre tabindex="0" class="prism-code language-bash codeBlock_bY9V thin-scrollbar"><code class="codeBlockLines_e6Vv"><span class="token-line" style="color:#F8F8F2"><span class="token plain">pulsar-admin sinks reload</span><br></span></code></pre><div class="buttonGroup__atx"><button type="button" aria-label="Copy code to clipboard" title="Copy" class="clean-btn"><span class="copyButtonIcons_eSgA" aria-hidden="true"><svg class="copyButtonIcon_y97N" viewBox="0 0 24 24"><path d="M19,21H8V7H19M19,5H8A2,2 0 0,0 6,7V21A2,2 0 0,0 8,23H19A2,2 0 0,0 21,21V7A2,2 0 0,0 19,5M16,1H4A2,2 0 0,0 2,3V17H4V3H16V1Z"></path></svg><svg class="copyButtonSuccessIcon_LjdS" viewBox="0 0 24 24"><path d="M21,7L9,19L3.5,13.5L4.91,12.09L9,16.17L19.59,5.59L21,7Z"></path></svg></span></button></div></div></div></div><footer class="theme-doc-footer docusaurus-mt-lg"><div class="theme-doc-footer-edit-meta-row row"><div class="col"><a href="https://github.com/apache/pulsar-site/edit/main/versioned_docs/version-3.0.x/io-cli.md" target="_blank" rel="noreferrer noopener" class="theme-edit-this-page"><svg fill="currentColor" height="20" width="20" viewBox="0 0 40 40" class="iconEdit_Z9Sw" aria-hidden="true"><g><path d="m34.5 11.7l-3 3.1-6.3-6.3 3.1-3q0.5-0.5 1.2-0.5t1.1 0.5l3.9 3.9q0.5 0.4 0.5 1.1t-0.5 1.2z m-29.5 17.1l18.4-18.5 6.3 6.3-18.4 18.4h-6.3v-6.2z"></path></g></svg>Edit this page</a></div><div class="col lastUpdated_vwxv"></div></div></footer></article><nav class="pagination-nav docusaurus-mt-lg" aria-label="Docs pages navigation"></nav></div></div><div class="col col--3"><div class="tableOfContents_jeP5 thin-scrollbar theme-doc-toc-desktop"><div class="border"><div style="color:var(--ifm-toc-link-color)">Was this helpful?</div><div style="border-width:1px;padding:3px;display:flex"><div style="justify-content:center;display:flex;border-radius:99999px;width:2.5rem;height:2.5rem;cursor:pointer;background:;color:"><svg style="width:initial;height:initial" width="12" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M10.086 1.594A1 1 0 0 1 11 1a4 4 0 0 1 4 4v3h4.655a3 3 0 0 1 2.994 3.45l-1.38 9A3.002 3.002 0 0 1 18.275 23H4a3 3 0 0 1-3-3v-7a3 3 0 0 1 3-3h2.35l3.736-8.406ZM8 11.212l3.608-8.117A2 2 0 0 1 13 5v4a1 1 0 0 0 1 1h5.671a1 1 0 0 1 1 1.15l-1.38 9a1 1 0 0 1-1 .85H8v-9.788ZM6 21v-9H4a1 1 0 0 0-1 1v7a1 1 0 0 0 1 1h2Z" fill="currentColor"></path></svg></div><div style="justify-content:center;display:flex;border-radius:99999px;width:2.5rem;height:2.5rem;cursor:pointer;background:;color:"><svg style="width:initial;height:initial" width="12" height="24" viewBox="0 0 24 24" fill="none" xmlns="http://www.w3.org/2000/svg"><path fill-rule="evenodd" clip-rule="evenodd" d="M20.563 3.316A1.31 1.31 0 0 0 19.687 3h-1.688v9h1.688a1.31 1.31 0 0 0 1.312-1.077V4.077a1.31 1.31 0 0 0-.436-.761ZM16 12.788l-3.608 8.117A1.999 1.999 0 0 1 11 19v-4a1 1 0 0 0-1-1H4.328a1.002 1.002 0 0 1-1-1.15l1.38-9a1 1 0 0 1 1-.85h10.291v9.788ZM19.661 1a3.31 3.31 0 0 1 3.329 2.866c.006.044.01.09.01.134v7c0 .045-.004.09-.01.134A3.31 3.31 0 0 1 19.661 14h-2.012l-3.736 8.406a1 1 0 0 1-.914.594 4 4 0 0 1-4-4v-3H4.344a3 3 0 0 1-2.994-3.45l1.38-9A3.002 3.002 0 0 1 5.724 1h13.937Z" fill="currentColor"></path></svg></div></div><div class="Actions_uugI"><a target="_blank" class="Action_iBHd" href="https://github.com/apache/pulsar/issues/new?assignees=&labels=doc-required&projects=&template=doc.yml&title=%5BDoc%5D+">💡 Suggest changes</a><a target="_blank" class="Action_iBHd" href="https://github.com/apache/pulsar/discussions/new?category=q-a">🛟 Get support</a></div></div><ul class="table-of-contents table-of-contents__left-border"><li><a href="#sources" class="table-of-contents__link toc-highlight"><code>sources</code></a><ul><li><a href="#create" class="table-of-contents__link toc-highlight"><code>create</code></a></li><li><a href="#update" class="table-of-contents__link toc-highlight"><code>update</code></a></li><li><a href="#delete" class="table-of-contents__link toc-highlight"><code>delete</code></a></li><li><a href="#get" class="table-of-contents__link toc-highlight"><code>get</code></a></li><li><a href="#status" class="table-of-contents__link toc-highlight"><code>status</code></a></li><li><a href="#list" class="table-of-contents__link toc-highlight"><code>list</code></a></li><li><a href="#stop" class="table-of-contents__link toc-highlight"><code>stop</code></a></li><li><a href="#start" class="table-of-contents__link toc-highlight"><code>start</code></a></li><li><a href="#restart" class="table-of-contents__link toc-highlight"><code>restart</code></a></li><li><a href="#localrun" class="table-of-contents__link toc-highlight"><code>localrun</code></a></li><li><a href="#available-sources" class="table-of-contents__link toc-highlight"><code>available-sources</code></a></li><li><a href="#reload" class="table-of-contents__link toc-highlight"><code>reload</code></a></li></ul></li><li><a href="#sinks" class="table-of-contents__link toc-highlight"><code>sinks</code></a><ul><li><a href="#create-1" class="table-of-contents__link toc-highlight"><code>create</code></a></li><li><a href="#update-1" class="table-of-contents__link toc-highlight"><code>update</code></a></li><li><a href="#delete-1" class="table-of-contents__link toc-highlight"><code>delete</code></a></li><li><a href="#get-1" class="table-of-contents__link toc-highlight"><code>get</code></a></li><li><a href="#status-1" class="table-of-contents__link toc-highlight"><code>status</code></a></li><li><a href="#list-1" class="table-of-contents__link toc-highlight"><code>list</code></a></li><li><a href="#stop-1" class="table-of-contents__link toc-highlight"><code>stop</code></a></li><li><a href="#start-1" class="table-of-contents__link toc-highlight"><code>start</code></a></li><li><a href="#restart-1" class="table-of-contents__link toc-highlight"><code>restart</code></a></li><li><a href="#localrun-1" class="table-of-contents__link toc-highlight"><code>localrun</code></a></li><li><a href="#available-sinks" class="table-of-contents__link toc-highlight"><code>available-sinks</code></a></li><li><a href="#reload-1" class="table-of-contents__link toc-highlight"><code>reload</code></a></li></ul></li></ul></div></div></div></div></main></div></div><footer class="footer"><div class="container container-fluid"><div class="row footer__links"><div class="col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.apache.org/" target="_blank" rel="noopener noreferrer" class="footer__link-item">Foundation<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.apache.org/events/current-event.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Events<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><a href="https://www.apache.org/licenses/" target="_blank" rel="noopener noreferrer" class="footer__link-item">License<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.apache.org/foundation/thanks" target="_blank" rel="noopener noreferrer" class="footer__link-item">Thanks<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a href="https://www.apache.org/foundation/sponsorship" target="_blank" rel="noopener noreferrer" class="footer__link-item">Sponsorship<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li></ul></div><div class="col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"><a class="footer__link-item" href="/security/">Security</a></li><li class="footer__item"><a href="https://www.apache.org/foundation/policies/privacy.html" target="_blank" rel="noopener noreferrer" class="footer__link-item">Privacy<svg width="13.5" height="13.5" aria-hidden="true" viewBox="0 0 24 24" class="iconExternalLink_nPIU"><path fill="currentColor" d="M21 13v10h-21v-19h12v2h-10v15h17v-8h2zm3-12h-10.988l4.035 4-6.977 7.07 2.828 2.828 6.977-7.07 4.125 4.172v-11z"></path></svg></a></li><li class="footer__item"><a class="footer__link-item" href="/contact/">Contact</a></li></ul></div><div class="col footer__col"><div class="footer__title"></div><ul class="footer__items clean-list"><li class="footer__item"> |
