Google Git
Sign in
apache / pulsar-site / aee2d9089b6b8e327f04261353077211f4abd636 / . / content / docs / en / next / admin-api-packages / index.html
blob: 74e0465665be5e5f549d5b2f0227872bd1ce811b [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>Manage packages · Apache Pulsar</title><meta name="viewport" content="width=device-width, initial-scale=1.0"/><meta name="generator" content="Docusaurus"/><meta name="description" content="&gt; **Important**"/><meta name="docsearch:version" content="next"/><meta name="docsearch:language" content="en"/><meta property="og:title" content="Manage packages · Apache Pulsar"/><meta property="og:type" content="website"/><meta property="og:url" content="https://pulsar.apache.org/"/><meta property="og:description" content="&gt; **Important**"/><meta name="twitter:card" content="summary"/><meta name="twitter:image" content="https://pulsar.apache.org/img/pulsar.svg"/><link rel="shortcut icon" href="/img/pulsar.ico"/><link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/atom-one-dark.min.css"/><link rel="alternate" type="application/atom+xml" href="https://pulsar.apache.org/blog/atom.xml" title="Apache Pulsar Blog ATOM Feed"/><link rel="alternate" type="application/rss+xml" href="https://pulsar.apache.org/blog/feed.xml" title="Apache Pulsar Blog RSS Feed"/><link rel="stylesheet" href="/css/code-blocks-buttons.css"/><script type="text/javascript" src="https://buttons.github.io/buttons.js"></script><script type="text/javascript" src="https://cdnjs.cloudflare.com/ajax/libs/clipboard.js/2.0.0/clipboard.min.js"></script><script type="text/javascript" src="/js/custom.js"></script><script src="/js/scrollSpy.js"></script><link rel="stylesheet" href="/css/main.css"/><script src="/js/codetabs.js"></script></head><body class="sideNavVisible separateOnPageNav"><div class="fixedHeaderContainer"><div class="headerWrapper wrapper"><header><a href="/en"><img class="logo" src="/img/pulsar.svg" alt="Apache Pulsar"/></a><a href="/en/versions"><h3>next</h3></a><div class="navigationWrapper navigationSlider"><nav class="slidingNav"><ul class="nav-site nav-site-internal"><li class="siteNavGroupActive"><a href="/docs/en/next/getting-started-standalone" target="_self">Docs</a></li><li class=""><a href="/en/download" target="_self">Download</a></li><li class="siteNavGroupActive"><a href="/docs/en/next/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/next/admin-api-packages">日本語</a></li><li><a href="/docs/fr/next/admin-api-packages">Français</a></li><li><a href="/docs/ko/next/admin-api-packages">한국어</a></li><li><a href="/docs/zh-CN/next/admin-api-packages">中文</a></li><li><a href="/docs/zh-TW/next/admin-api-packages">繁體中文</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="docsNavContainer" id="docsNav"><nav class="toc"><div class="toggleNav"><section class="navWrapper wrapper"><div class="navBreadcrumb wrapper"><div class="navToggle" id="navToggler"><div class="hamburger-menu"><div class="line1"></div><div class="line2"></div><div class="line3"></div></div></div><h2><i>›</i><span>Admin API</span></h2><div class="tocToggler" id="tocToggler"><i class="icon-toc"></i></div></div><div class="navGroups"><div class="navGroup"><h3 class="navGroupCategoryTitle">Get Started</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/getting-started-standalone">Run Pulsar locally</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/getting-started-docker">Run Pulsar in Docker</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/getting-started-helm">Run Pulsar in Kubernetes</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Concepts and Architecture</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/concepts-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/concepts-messaging">Messaging</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/concepts-architecture-overview">Architecture</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/concepts-clients">Clients</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/concepts-replication">Geo Replication</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/concepts-multi-tenancy">Multi Tenancy</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/concepts-authentication">Authentication and Authorization</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/concepts-topic-compaction">Topic Compaction</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/concepts-proxy-sni-routing">Proxy support with SNI routing</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/concepts-multiple-advertised-listeners">Multiple advertised listeners</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar Schema</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/schema-get-started">Get started</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/schema-understand">Understand schema</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/schema-evolution-compatibility">Schema evolution and compatibility</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/schema-manage">Manage schema</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar Functions</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/functions-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/functions-runtime">Setup: Configure Functions runtime</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/functions-worker">Setup: Pulsar Functions Worker</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/functions-develop">How-to: Develop</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/functions-package">How-to: Package</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/functions-debug">How-to: Debug</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/functions-deploy">How-to: Deploy</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/functions-cli">Reference: CLI</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/window-functions-context">Window Functions: Context</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar IO</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/io-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/io-quickstart">Get started</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/io-use">Use</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/io-debug">Debug</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/io-connectors">Built-in connector</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/io-cdc">CDC connector</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/io-develop">Develop</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/io-cli">CLI</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Pulsar SQL</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/sql-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/sql-getting-started">Query data</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/sql-deployment-configurations">Configuration and deployment</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/sql-rest-api">REST APIs</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Tiered Storage</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/tiered-storage-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/tiered-storage-aws">AWS S3 offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/tiered-storage-gcs">GCS offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/tiered-storage-filesystem">Filesystem offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/tiered-storage-azure">Azure BlobStore offloader</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/tiered-storage-aliyun">Aliyun OSS offloader</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Transactions</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/txn-why">Why transactions?</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/txn-what">What are transactions?</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/txn-how">How transactions work?</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/txn-use">How to use transactions?</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/txn-monitor">How to monitor transactions?</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Kubernetes (Helm)</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/helm-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/helm-prepare">Prepare</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/helm-install">Install</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/helm-deploy">Deployment</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/helm-upgrade">Upgrade</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/helm-tools">Required Tools</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Deployment</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/deploy-aws">Amazon Web Services</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/deploy-kubernetes">Kubernetes</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/deploy-bare-metal">Bare metal</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/deploy-bare-metal-multi-cluster">Bare metal multi-cluster</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/deploy-docker">Docker</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/deploy-monitoring">Monitor</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Administration</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/administration-zk-bk">ZooKeeper and BookKeeper</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/administration-geo">Geo-replication</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/administration-pulsar-manager">Pulsar Manager</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/administration-stats">Pulsar statistics</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/administration-load-balance">Load balance</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/administration-proxy">Pulsar proxy</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/administration-upgrade">Upgrade</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/administration-isolation">Pulsar isolation</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Security</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/security-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/security-policy-and-supported-versions">Security Policy and Supported Versions</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/security-tls-transport">Transport Encryption using TLS</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/security-tls-authentication">Authentication using TLS</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/security-tls-keystore">Using TLS with KeyStore configure</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/security-jwt">Authentication using JWT</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/security-athenz">Authentication using Athenz</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/security-kerberos">Authentication using Kerberos</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/security-oauth2">Authentication using OAuth 2.0 access tokens</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/security-authorization">Authorization and ACLs</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/security-encryption">End-to-End Encryption</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/security-extending">Extend Authentication and Authorization</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/security-bouncy-castle">Bouncy Castle Providers</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Performance</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/performance-pulsar-perf">Pulsar Perf</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Client Libraries</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/client-libraries">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/client-libraries-java">Java</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/client-libraries-go">Go</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/client-libraries-python">Python</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/client-libraries-cpp">C++</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/client-libraries-node">Node.js</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/client-libraries-websocket">WebSocket</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/client-libraries-dotnet">C#</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/client-libraries-rest">REST</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Admin API</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/admin-api-overview">Overview</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/admin-api-clusters">Clusters</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/admin-api-tenants">Tenants</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/admin-api-brokers">Brokers</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/admin-api-namespaces">Namespaces</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/admin-api-permissions">Permissions</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/admin-api-topics">Topics</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/admin-api-functions">Functions</a></li><li class="navListItem navListItemActive"><a class="navItem" href="/docs/en/next/admin-api-packages">Packages</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Adaptors</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/adaptors-kafka">Kafka client wrapper</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/adaptors-spark">Apache Spark</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/adaptors-storm">Apache Storm</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Cookbooks</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/cookbooks-compaction">Topic compaction</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/cookbooks-deduplication">Message deduplication</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/cookbooks-non-persistent">Non-persistent messaging</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/cookbooks-retention-expiry">Message retention and expiry</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/cookbooks-encryption">Encryption</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/cookbooks-message-queue">Message queue</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/cookbooks-bookkeepermetadata">BookKeeper Ledger Metadata</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Development</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/develop-tools">Simulation tools</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/developing-binary-protocol">Binary protocol</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/develop-load-manager">Modular load manager</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/develop-plugin">Plugin</a></li></ul></div><div class="navGroup"><h3 class="navGroupCategoryTitle">Reference</h3><ul class=""><li class="navListItem"><a class="navItem" href="/docs/en/next/reference-terminology">Terminology</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/reference-cli-tools">Pulsar CLI tools</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/reference-configuration">Pulsar configuration</a></li><li class="navListItem"><a class="navItem" href="/docs/en/next/reference-metrics">Pulsar Metrics</a></li></ul></div></div></section></div><script>
var coll = document.getElementsByClassName('collapsible');
var checkActiveCategory = true;
for (var i = 0; i < coll.length; i++) {
var links = coll[i].nextElementSibling.getElementsByTagName('*');
if (checkActiveCategory){
for (var j = 0; j < links.length; j++) {
if (links[j].classList.contains('navListItemActive')){
coll[i].nextElementSibling.classList.toggle('hide');
coll[i].childNodes[1].classList.toggle('rotate');
checkActiveCategory = false;
break;
}
}
}
coll[i].addEventListener('click', function() {
var arrow = this.childNodes[1];
arrow.classList.toggle('rotate');
var content = this.nextElementSibling;
content.classList.toggle('hide');
});
}
document.addEventListener('DOMContentLoaded', function() {
createToggler('#navToggler', '#docsNav', 'docsSliderActive');
createToggler('#tocToggler', 'body', 'tocActive');
var headings = document.querySelector('.toc-headings');
headings && headings.addEventListener('click', function(event) {
var el = event.target;
while(el !== headings){
if (el.tagName === 'A') {
document.body.classList.remove('tocActive');
break;
} else{
el = el.parentNode;
}
}
}, false);
function createToggler(togglerSelector, targetSelector, className) {
var toggler = document.querySelector(togglerSelector);
var target = document.querySelector(targetSelector);
if (!toggler) {
return;
}
toggler.onclick = function(event) {
event.preventDefault();
target.classList.toggle(className);
};
}
});
</script></nav></div><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/admin-api-packages.md" target="_blank" rel="noreferrer noopener">Edit</a><h1 id="__docusaurus" class="postHeaderTitle">Manage packages</h1></header><article><div><span><blockquote>
<p><strong>Important</strong></p>
<p>This page only shows <strong>some frequently used operations</strong>.</p>
<ul>
<li><p>For the latest and complete information about <code>Pulsar admin</code>, including commands, flags, descriptions, and more, see <a href="https://pulsar.apache.org/tools/pulsar-admin/">Pulsar admin doc</a>.</p></li>
<li><p>For the latest and complete information about <code>REST API</code>, including parameters, responses, samples, and more, see <a href="https://pulsar.apache.org/admin-rest-api#/">REST</a>
API doc.</p></li>
<li><p>For the latest and complete information about <code>Java admin API</code>, including classes, methods, descriptions, and more, see <a href="https://pulsar.apache.org/api/admin/2.10.0-SNAPSHOT/">Java admin API doc</a>.</p></li>
</ul>
</blockquote>
<p>Package managers or package-management systems automatically manage packages in a consistent manner. These tools simplify the installation tasks, upgrade process, and deletion operations for users. A package is a minimal unit that a package manager deals with. In Pulsar, packages are organized at the tenant- and namespace-level to manage Pulsar Functions and Pulsar IO connectors (i.e., source and sink).</p>
<h2><a class="anchor" aria-hidden="true" id="what-is-a-package"></a><a href="#what-is-a-package" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>What is a package?</h2>
<p>A package is a set of elements that the user would like to reuse in later operations. In Pulsar, a package can be a group of functions, sources, and sinks. You can define a package according to your needs.</p>
<p>The package management system in Pulsar stores the data and metadata of each package (as shown in the table below) and tracks the package versions.</p>
<table>
<thead>
<tr><th>Metadata</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td>description</td><td>The description of the package.</td></tr>
<tr><td>contact</td><td>The contact information of a package. For example, an email address of the developer team.</td></tr>
<tr><td>create_time</td><td>The time when the package is created.</td></tr>
<tr><td>modification_time</td><td>The time when the package is lastly modified.</td></tr>
<tr><td>properties</td><td>A user-defined key/value map to store other information.</td></tr>
</tbody>
</table>
<h2><a class="anchor" aria-hidden="true" id="how-to-use-a-package"></a><a href="#how-to-use-a-package" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>How to use a package</h2>
<p>Packages can efficiently use the same set of functions and IO connectors. For example, you can use the same function, source, and sink in multiple namespaces. The main steps are:</p>
<ol>
<li><p>Create a package in the package manager by providing the following information: type, tenant, namespace, package name, and version.</p>
<table>
<thead>
<tr><th>Component</th><th>Description</th></tr>
</thead>
<tbody>
<tr><td>type</td><td>Specify one of the supported package types: function, sink and source.</td></tr>
<tr><td>tenant</td><td>Specify the tenant where you want to create the package.</td></tr>
<tr><td>namespace</td><td>Specify the namespace where you want to create the package.</td></tr>
<tr><td>name</td><td>Specify the complete name of the package, using the format <code>&lt;tenant&gt;/&lt;namespace&gt;/&lt;package name&gt;</code>.</td></tr>
<tr><td>version</td><td>Specify the version of the package using the format <code>MajorVerion.MinorVersion</code> in numerals.</td></tr>
</tbody>
</table>
<p>The information you provide creates a URL for a package, in the format <code>&lt;type&gt;://&lt;tenant&gt;/&lt;namespace&gt;/&lt;package name&gt;/&lt;version&gt;</code>.</p></li>
<li><p>Upload the elements to the package, i.e., the functions, sources, and sinks that you want to use across namespaces.</p></li>
<li><p>Apply permissions to this package from various namespaces.</p></li>
</ol>
<p>Now, you can use the elements you defined in the package by calling this package from within the package manager. The package manager locates it by the URL. For example,</p>
<pre><code class="hljs">sink:<span class="hljs-regexp">//</span>public<span class="hljs-regexp">/default/my</span>sql-sink@<span class="hljs-number">1.0</span>
<span class="hljs-keyword">function</span>:<span class="hljs-regexp">//my</span>-tenant<span class="hljs-regexp">/my-ns/my</span>-<span class="hljs-keyword">function</span>@<span class="hljs-number">0.1</span>
source:<span class="hljs-regexp">//my</span>-tenant<span class="hljs-regexp">/my-ns/my</span>sql-cdc-source@<span class="hljs-number">2.3</span>
</code></pre>
<h2><a class="anchor" aria-hidden="true" id="package-management-in-pulsar"></a><a href="#package-management-in-pulsar" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Package management in Pulsar</h2>
<p>You can use the command line tools, REST API, or the Java client to manage your package resources in Pulsar. More specifically, you can use these tools to <a href="#upload-a-package">upload</a>, <a href="#download-a-package">download</a>, and <a href="#delete-a-package">delete</a> a package, <a href="#get-the-metadata-of-a-package">get the metadata</a> and <a href="#update-the-metadata-of-a-package">update the metadata</a> of a package, <a href="#list-all-versions-of-a-package">get the versions</a> of a package, and <a href="#list-all-packages-of-a-specific-type-under-a-namespace">get all packages of a specific type under a namespace</a>.</p>
<p>To use package management service, ensure that the package management service has been enabled in your cluster by setting the following properties in <code>broker.conf</code>.</p>
<blockquote>
<p>Note: Package management service is not enabled by default.</p>
</blockquote>
<pre><code class="hljs css language-yaml"><span class="hljs-string">enablePackagesManagement=true</span>
<span class="hljs-string">packagesManagementStorageProvider=org.apache.pulsar.packages.management.storage.bookkeeper.BookKeeperPackagesStorageProvider</span>
<span class="hljs-string">packagesReplicas=1</span>
<span class="hljs-string">packagesManagementLedgerRootPath=/ledgers</span>
</code></pre>
<h3><a class="anchor" aria-hidden="true" id="upload-a-package"></a><a href="#upload-a-package" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Upload a package</h3>
<p>You can use the following commands to upload a package.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-245-tab-246" class="nav-link active" data-group="group_245" data-tab="tab-group-245-content-246">pulsar-admin</div><div id="tab-group-245-tab-247" class="nav-link" data-group="group_245" data-tab="tab-group-245-content-247">REST API</div><div id="tab-group-245-tab-248" class="nav-link" data-group="group_245" data-tab="tab-group-245-content-248">JAVA</div></div><div class="tab-content"><div id="tab-group-245-content-246" class="tab-pane active" data-group="group_245" tabindex="-1"><div><span><pre><code class="hljs css language-shell">bin/pulsar-admin packages upload function://public/default/example@v0.1 --path package-file --description package-description<br /></code></pre>
</span></div></div><div id="tab-group-245-content-247" class="tab-pane" data-group="group_245" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/admin-rest-api#/admin/v3/packages/:type/:tenant/:namespace/:packageName/:versionversion=master&amp;apiVersion=v3"><b>POST</b> <i>/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version</i></a>
</p>
</span></div></div><div id="tab-group-245-content-248" class="tab-pane" data-group="group_245" tabindex="-1"><div><span><p>Upload a package to the package management service synchronously.</p>
<pre><code class="hljs css language-java"> <span class="hljs-function"><span class="hljs-keyword">void</span> <span class="hljs-title">upload</span><span class="hljs-params">(PackageMetadata metadata, String packageName, String path)</span> <span class="hljs-keyword">throws</span> PulsarAdminException</span>;<br /></code></pre>
<p>Upload a package to the package management service asynchronously.</p>
<pre><code class="hljs css language-java"> <span class="hljs-function">CompletableFuture&lt;Void&gt; <span class="hljs-title">uploadAsync</span><span class="hljs-params">(PackageMetadata metadata, String packageName, String path)</span></span>;<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="download-a-package"></a><a href="#download-a-package" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Download a package</h3>
<p>You can use the following commands to download a package.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-249-tab-250" class="nav-link active" data-group="group_249" data-tab="tab-group-249-content-250">pulsar-admin</div><div id="tab-group-249-tab-251" class="nav-link" data-group="group_249" data-tab="tab-group-249-content-251">REST API</div><div id="tab-group-249-tab-252" class="nav-link" data-group="group_249" data-tab="tab-group-249-content-252">JAVA</div></div><div class="tab-content"><div id="tab-group-249-content-250" class="tab-pane active" data-group="group_249" tabindex="-1"><div><span><pre><code class="hljs css language-shell">bin/pulsar-admin packages download function://public/default/example@v0.1 --path package-file<br /></code></pre>
</span></div></div><div id="tab-group-249-content-251" class="tab-pane" data-group="group_249" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/admin-rest-api#/admin/v3/packages/:type/:tenant/:namespace/:packageName/:versionversion=master&amp;apiVersion=v3"><b>GET</b> <i>/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version</i></a>
</p>
</span></div></div><div id="tab-group-249-content-252" class="tab-pane" data-group="group_249" tabindex="-1"><div><span><p>Download a package from the package management service synchronously.</p>
<pre><code class="hljs css language-java"> <span class="hljs-function"><span class="hljs-keyword">void</span> <span class="hljs-title">download</span><span class="hljs-params">(String packageName, String path)</span> <span class="hljs-keyword">throws</span> PulsarAdminException</span>;<br /></code></pre>
<p>Download a package from the package management service asynchronously.</p>
<pre><code class="hljs css language-java"> <span class="hljs-function">CompletableFuture&lt;Void&gt; <span class="hljs-title">downloadAsync</span><span class="hljs-params">(String packageName, String path)</span></span>;<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="delete-a-package"></a><a href="#delete-a-package" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Delete a package</h3>
<p>You can use the following commands to delete a package.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-253-tab-254" class="nav-link active" data-group="group_253" data-tab="tab-group-253-content-254">pulsar-admin</div><div id="tab-group-253-tab-255" class="nav-link" data-group="group_253" data-tab="tab-group-253-content-255">REST API</div><div id="tab-group-253-tab-256" class="nav-link" data-group="group_253" data-tab="tab-group-253-content-256">JAVA</div></div><div class="tab-content"><div id="tab-group-253-content-254" class="tab-pane active" data-group="group_253" tabindex="-1"><div><span><p>The following command deletes a package of version 0.1.</p>
<pre><code class="hljs css language-shell">bin/pulsar-admin packages delete functions://public/default/example@v0.1<br /></code></pre>
</span></div></div><div id="tab-group-253-content-255" class="tab-pane" data-group="group_253" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/admin-rest-api#/admin/v3/packages/:type/:tenant/:namespace/:packageName/:versionversion=master&amp;apiVersion=v3"><b>DELETE</b> <i>/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version</i></a>
</p>
</span></div></div><div id="tab-group-253-content-256" class="tab-pane" data-group="group_253" tabindex="-1"><div><span><p>Delete a specified package synchronously.</p>
<pre><code class="hljs css language-java"> <span class="hljs-function"><span class="hljs-keyword">void</span> <span class="hljs-title">delete</span><span class="hljs-params">(String packageName)</span> <span class="hljs-keyword">throws</span> PulsarAdminException</span>;<br /></code></pre>
<p>Delete a specified package asynchronously.</p>
<pre><code class="hljs css language-java"> <span class="hljs-function">CompletableFuture&lt;Void&gt; <span class="hljs-title">deleteAsync</span><span class="hljs-params">(String packageName)</span></span>;<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="get-the-metadata-of-a-package"></a><a href="#get-the-metadata-of-a-package" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Get the metadata of a package</h3>
<p>You can use the following commands to get the metadate of a package.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-257-tab-258" class="nav-link active" data-group="group_257" data-tab="tab-group-257-content-258">pulsar-admin</div><div id="tab-group-257-tab-259" class="nav-link" data-group="group_257" data-tab="tab-group-257-content-259">REST API</div><div id="tab-group-257-tab-260" class="nav-link" data-group="group_257" data-tab="tab-group-257-content-260">JAVA</div></div><div class="tab-content"><div id="tab-group-257-content-258" class="tab-pane active" data-group="group_257" tabindex="-1"><div><span><pre><code class="hljs css language-shell">bin/pulsar-admin packages get-metadata function://public/default/test@v1<br /></code></pre>
</span></div></div><div id="tab-group-257-content-259" class="tab-pane" data-group="group_257" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/admin-rest-api#/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version/metadataversion=master&amp;apiVersion=v3"><b>GET</b> <i>/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version/metadata</i></a>
</p>
</span></div></div><div id="tab-group-257-content-260" class="tab-pane" data-group="group_257" tabindex="-1"><div><span><p>Get the metadata of a package synchronously.</p>
<pre><code class="hljs css language-java"> <span class="hljs-function">PackageMetadata <span class="hljs-title">getMetadata</span><span class="hljs-params">(String packageName)</span> <span class="hljs-keyword">throws</span> PulsarAdminException</span>;<br /></code></pre>
<p>Get the metadata of a package asynchronously.</p>
<pre><code class="hljs css language-java"> <span class="hljs-function">CompletableFuture&lt;PackageMetadata&gt; <span class="hljs-title">getMetadataAsync</span><span class="hljs-params">(String packageName)</span></span>;<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="update-the-metadata-of-a-package"></a><a href="#update-the-metadata-of-a-package" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>Update the metadata of a package</h3>
<p>You can use the following commands to update the metadata of a package.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-261-tab-262" class="nav-link active" data-group="group_261" data-tab="tab-group-261-content-262">pulsar-admin</div><div id="tab-group-261-tab-263" class="nav-link" data-group="group_261" data-tab="tab-group-261-content-263">REST API</div><div id="tab-group-261-tab-264" class="nav-link" data-group="group_261" data-tab="tab-group-261-content-264">JAVA</div></div><div class="tab-content"><div id="tab-group-261-content-262" class="tab-pane active" data-group="group_261" tabindex="-1"><div><span><pre><code class="hljs css language-shell">bin/pulsar-admin packages update-metadata function://public/default/example@v0.1 --description update-description<br /></code></pre>
</span></div></div><div id="tab-group-261-content-263" class="tab-pane" data-group="group_261" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/admin-rest-api#/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version/metadataversion=master&amp;apiVersion=v3"><b>PUT</b> <i>/admin/v3/packages/:type/:tenant/:namespace/:packageName/:version/metadata</i></a>
</p>
</span></div></div><div id="tab-group-261-content-264" class="tab-pane" data-group="group_261" tabindex="-1"><div><span><p>Update the metadata of a package synchronously.</p>
<pre><code class="hljs css language-java"> <span class="hljs-function"><span class="hljs-keyword">void</span> <span class="hljs-title">updateMetadata</span><span class="hljs-params">(String packageName, PackageMetadata metadata)</span> <span class="hljs-keyword">throws</span> PulsarAdminException</span>;<br /></code></pre>
<p>Update the metadata of a package asynchronously.</p>
<pre><code class="hljs css language-java"> <span class="hljs-function">CompletableFuture&lt;Void&gt; <span class="hljs-title">updateMetadataAsync</span><span class="hljs-params">(String packageName, PackageMetadata metadata)</span></span>;<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="list-all-versions-of-a-package"></a><a href="#list-all-versions-of-a-package" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>List all versions of a package</h3>
<p>You can use the following commands to list all versions of a package.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-265-tab-266" class="nav-link active" data-group="group_265" data-tab="tab-group-265-content-266">pulsar-admin</div><div id="tab-group-265-tab-267" class="nav-link" data-group="group_265" data-tab="tab-group-265-content-267">REST API</div><div id="tab-group-265-tab-268" class="nav-link" data-group="group_265" data-tab="tab-group-265-content-268">JAVA</div></div><div class="tab-content"><div id="tab-group-265-content-266" class="tab-pane active" data-group="group_265" tabindex="-1"><div><span><pre><code class="hljs css language-shell">bin/pulsar-admin packages list-versions type://tenant/namespace/packageName<br /></code></pre>
</span></div></div><div id="tab-group-265-content-267" class="tab-pane" data-group="group_265" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/admin-rest-api#/admin/v3/packages/:type/:tenant/:namespace/:packageNameversion=master&amp;apiVersion=v3"><b>GET</b> <i>/admin/v3/packages/:type/:tenant/:namespace/:packageName</i></a>
</p>
</span></div></div><div id="tab-group-265-content-268" class="tab-pane" data-group="group_265" tabindex="-1"><div><span><p>List all versions of a package synchronously.</p>
<pre><code class="hljs css language-java"> <span class="hljs-function">List&lt;String&gt; <span class="hljs-title">listPackageVersions</span><span class="hljs-params">(String packageName)</span> <span class="hljs-keyword">throws</span> PulsarAdminException</span>;<br /></code></pre>
<p>List all versions of a package asynchronously.</p>
<pre><code class="hljs css language-java"> CompletableFuture&lt;List&lt;String&gt;&gt; listPackageVersionsAsync(String packageName);<br /></code></pre>
</span></div></div></div></div>
<h3><a class="anchor" aria-hidden="true" id="list-all-packages-of-a-specific-type-under-a-namespace"></a><a href="#list-all-packages-of-a-specific-type-under-a-namespace" aria-hidden="true" class="hash-link"><svg class="hash-link-icon" aria-hidden="true" height="16" version="1.1" viewBox="0 0 16 16" width="16"><path fill-rule="evenodd" d="M4 9h1v1H4c-1.5 0-3-1.69-3-3.5S2.55 3 4 3h4c1.45 0 3 1.69 3 3.5 0 1.41-.91 2.72-2 3.25V8.59c.58-.45 1-1.27 1-2.09C10 5.22 8.98 4 8 4H4c-.98 0-2 1.22-2 2.5S3 9 4 9zm9-3h-1v1h1c1 0 2 1.22 2 2.5S13.98 12 13 12H9c-.98 0-2-1.22-2-2.5 0-.83.42-1.64 1-2.09V6.25c-1.09.53-2 1.84-2 3.25C6 11.31 7.55 13 9 13h4c1.45 0 3-1.69 3-3.5S14.5 6 13 6z"></path></svg></a>List all packages of a specific type under a namespace</h3>
<p>You can use the following commands to list all packages of a specific type under a namespace.</p>
<div class="tabs"><div class="nav-tabs"><div id="tab-group-269-tab-270" class="nav-link active" data-group="group_269" data-tab="tab-group-269-content-270">pulsar-admin</div><div id="tab-group-269-tab-271" class="nav-link" data-group="group_269" data-tab="tab-group-269-content-271">REST API</div><div id="tab-group-269-tab-272" class="nav-link" data-group="group_269" data-tab="tab-group-269-content-272">JAVA</div></div><div class="tab-content"><div id="tab-group-269-content-270" class="tab-pane active" data-group="group_269" tabindex="-1"><div><span><pre><code class="hljs css language-shell">bin/pulsar-admin packages list --type function public/default<br /></code></pre>
</span></div></div><div id="tab-group-269-content-271" class="tab-pane" data-group="group_269" tabindex="-1"><div><span><p><a href="https://pulsar.apache.org/admin-rest-api#/admin/v3/packages/:type/:tenant/:namespaceversion=master&amp;apiVersion=v3"><b>PUT</b> <i>/admin/v3/packages/:type/:tenant/:namespace</i></a>
</p>
</span></div></div><div id="tab-group-269-content-272" class="tab-pane" data-group="group_269" tabindex="-1"><div><span><p>List all packages of a specific type under a namespace synchronously.</p>
<pre><code class="hljs css language-java"> <span class="hljs-function">List&lt;String&gt; <span class="hljs-title">listPackages</span><span class="hljs-params">(String type, String namespace)</span> <span class="hljs-keyword">throws</span> PulsarAdminException</span>;<br /></code></pre>
<p>List all packages of a specific type under a namespace asynchronously.</p>
<pre><code class="hljs css language-java"> CompletableFuture&lt;List&lt;String&gt;&gt; listPackagesAsync(String type, String namespace);<br /></code></pre>
</span></div></div></div></div>
</span></div></article></div><div class="docs-prevnext"><a class="docs-prev button" href="/docs/en/next/admin-api-functions"><span class="arrow-prev">← </span><span>Functions</span></a><a class="docs-next button" href="/docs/en/next/adaptors-kafka"><span>Kafka client wrapper</span><span class="arrow-next"> →</span></a></div></div></div><nav class="onPageNav"><ul class="toc-headings"><li><a href="#what-is-a-package">What is a package?</a></li><li><a href="#how-to-use-a-package">How to use a package</a></li><li><a href="#package-management-in-pulsar">Package management in Pulsar</a><ul class="toc-headings"><li><a href="#upload-a-package">Upload a package</a></li><li><a href="#download-a-package">Download a package</a></li><li><a href="#delete-a-package">Delete a package</a></li><li><a href="#get-the-metadata-of-a-package">Get the metadata of a package</a></li><li><a href="#update-the-metadata-of-a-package">Update the metadata of a package</a></li><li><a href="#list-all-versions-of-a-package">List all versions of a package</a></li><li><a href="#list-all-packages-of-a-specific-type-under-a-namespace">List all packages of a specific type under a namespace</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">&nbsp;▼</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 &#x2750</a></li>' +
'<li><a href="https://github.com/apache/pulsar/wiki" target="_blank">Wiki &#x2750</a></li>' +
'<li><a href="https://github.com/apache/pulsar/issues" target="_blank">Issue tracking &#x2750</a></li>' +
'<li><a href="https://pulsar-summit.org/" target="_blank">Pulsar Summit &#x2750</a></li>' +
'<li>&nbsp;</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>