docs/0.5.0-beta/shell/bucketcommands.html - ozone-site - Git at Google



 <!DOCTYPE html>
 <html lang="en">
   <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">

     <meta name="description" content="Hadoop Ozone Documentation">

     <title>Documentation for Apache Hadoop Ozone</title>


     <link href="../css/bootstrap.min.css" rel="stylesheet">


     <link href="../css/ozonedoc.css" rel="stylesheet">

   </head>


 <body>


 <nav class="navbar navbar-inverse navbar-fixed-top">
   <div class="container-fluid">
     <div class="navbar-header">
       <button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#sidebar" aria-expanded="false" aria-controls="navbar">
         <span class="sr-only">Toggle navigation</span>
         <span class="icon-bar"></span>
         <span class="icon-bar"></span>
         <span class="icon-bar"></span>
       </button>
       <a href="#" class="navbar-left" style="height: 50px; padding: 5px 5px 5px 0;">
         <img src="../ozone-logo-small.png" width="40"/>
       </a>
       <a class="navbar-brand hidden-xs" href="#">
         Apache Hadoop Ozone/HDDS documentation
       </a>
       <a class="navbar-brand visible-xs-inline" href="#">Hadoop Ozone</a>
     </div>
     <div id="navbar" class="navbar-collapse collapse">
       <ul class="nav navbar-nav navbar-right">
         <li><a href="https://github.com/apache/hadoop-ozone">Source</a></li>
         <li><a href="https://hadoop.apache.org">Apache Hadoop</a></li>
         <li><a href="https://apache.org">ASF</a></li>
       </ul>
     </div>
   </div>
 </nav>


   <div class="container-fluid">
     <div class="row">

 <div class="col-sm-2 col-md-2 sidebar" id="sidebar">
   <ul class="nav nav-sidebar">


             <li class="">

                    <a href="../index.html">


                     <span>Overview</span>
                 </a>
             </li>


             <li class="">

                    <a href="../start.html">


                     <span>Getting Started</span>
                 </a>
             </li>


             <li class="">

                    <a href="../shell.html">


                     <span>Command Line Interface</span>
                 </a>
             </li>


             <li class="">

                    <a href="../interface.html">


                     <span>Programming Interfaces</span>
                 </a>
             </li>


             <li class="">

                    <a href="../gdpr.html">


                     <span>GDPR</span>
                 </a>
             </li>


             <li class="">

                    <a href="../security.html">


                     <span>Security</span>
                 </a>
             </li>


             <li class="">

                    <a href="../concept.html">


                     <span>Concepts</span>
                 </a>
             </li>


             <li class="">

                    <a href="../beyond.html">


                     <span>Beyond Basics</span>
                 </a>
             </li>


             <li class="">

                    <a href="../tools.html">


                     <span>Tools</span>
                 </a>
             </li>


             <li class="">

                    <a href="../recipe.html">


                     <span>Recipes</span>
                 </a>
             </li>


     <li class="visible-xs"><a href="#">References</a>
     <ul class="nav">
         <li><a href="https://github.com/apache/hadoop"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> Source</a></li>
         <li><a href="https://hadoop.apache.org"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> Apache Hadoop</a></li>
         <li><a href="https://apache.org"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> ASF</a></li>
     </ul></li>
   </ul>

 </div>

       <div class="col-sm-10 col-sm-offset-2 col-md-10 col-md-offset-2 main">


         <div class="col-md-9">
             <nav aria-label="breadcrumb">
                 <ol class="breadcrumb">
                   <li class="breadcrumb-item"><a href="../">Home</a></li>
                   <li class="breadcrumb-item" aria-current="page"><a href="../shell.html">Command Line Interface</a></li>
                   <li class="breadcrumb-item active" aria-current="page">Bucket Commands</li>
                 </ol>
               </nav>


 <div class="pull-right">


     <a href="../zh/shell/bucketcommands.html"><span class="label label-success">中文</span></a>


 </div>


           <div class="col-md-9">
             <h1>Bucket Commands</h1>


 <!---
   Licensed to the Apache Software Foundation (ASF) under one or more
   contributor license agreements.  See the NOTICE file distributed with
   this work for additional information regarding copyright ownership.
   The ASF licenses this file to You under the Apache License, Version 2.0
   (the "License"); you may not use this file except in compliance with
   the License.  You may obtain a copy of the License at

       http://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.
 -->

 <p>Ozone shell supports the following bucket commands.</p>

 <ul>
 <li><a href="#create">create</a></li>
 <li><a href="#delete">delete</a></li>
 <li><a href="#info">info</a></li>
 <li><a href="#list">list</a></li>
 </ul>

 <h3 id="create">Create</h3>

 <p>The <code>bucket create</code> command allows users to create a bucket.</p>

 <p><strong><em>Params:</em></strong></p>

 <table>
 <thead>
 <tr>
 <th>Arguments</th>
 <th>Comment</th>
 </tr>
 </thead>

 <tbody>
 <tr>
 <td>-g, --enforcegdpr</td>
 <td>Optional, if set to true it creates a GDPR compliant bucket, if not specified or set to false, it creates an ordinary bucket.</td>
 </tr>

 <tr>
 <td>-k, --bucketKey</td>
 <td>Optional, if a bucket encryption key name from the configured KMS server is specified, the files in the bucket will be transparently encrypted. Instruction on KMS configuration can be found from Hadoop KMS document.</td>
 </tr>

 <tr>
 <td>Uri</td>
 <td>The name of the bucket in <strong>/volume/bucket</strong> format.</td>
 </tr>
 </tbody>
 </table>

 <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">ozone sh bucket create /hive/jan</code></pre></div>

 <p>The above command will create a bucket called <em>jan</em> in the <em>hive</em> volume.
 Since no scheme was specified this command defaults to O3 (RPC) protocol.</p>

 <h3 id="delete">Delete</h3>

 <p>The <code>bucket delete</code> command allows users to delete a bucket. If the
 bucket is not empty then this command will fail.</p>

 <p><strong><em>Params:</em></strong></p>

 <table>
 <thead>
 <tr>
 <th>Arguments</th>
 <th>Comment</th>
 </tr>
 </thead>

 <tbody>
 <tr>
 <td>Uri</td>
 <td>The name of the bucket</td>
 </tr>
 </tbody>
 </table>

 <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">ozone sh bucket delete /hive/jan</code></pre></div>

 <p>The above command will delete <em>jan</em> bucket if it is empty.</p>

 <h3 id="info">Info</h3>

 <p>The <code>bucket info</code> commands returns the information about the bucket.</p>

 <p><strong><em>Params:</em></strong></p>

 <table>
 <thead>
 <tr>
 <th>Arguments</th>
 <th>Comment</th>
 </tr>
 </thead>

 <tbody>
 <tr>
 <td>Uri</td>
 <td>The name of the bucket.</td>
 </tr>
 </tbody>
 </table>

 <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">ozone sh bucket info /hive/jan</code></pre></div>

 <p>The above command will print out the information about <em>jan</em> bucket.</p>

 <h3 id="list">List</h3>

 <p>The <code>bucket list</code> command allows users to list the buckets in a volume.</p>

 <p><strong><em>Params:</em></strong></p>

 <table>
 <thead>
 <tr>
 <th>Arguments</th>
 <th>Comment</th>
 </tr>
 </thead>

 <tbody>
 <tr>
 <td>-l, --length</td>
 <td>Maximum number of results to return. Default: 100</td>
 </tr>

 <tr>
 <td>-p, --prefix</td>
 <td>Optional, Only buckets that match this prefix will be returned.</td>
 </tr>

 <tr>
 <td>-s, --start</td>
 <td>The listing will start from key after the start key.</td>
 </tr>

 <tr>
 <td>Uri</td>
 <td>The name of the <em>volume</em>.</td>
 </tr>
 </tbody>
 </table>

 <div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">ozone sh bucket list /hive</code></pre></div>

 <p>This command will list all buckets on the volume <em>hive</em>.</p>


           <a class="btn  btn-success btn-lg" href="../shell/keycommands.html">Next >></a>

           </div>

         </div>
       </div>
     </div>
   </div>


 <script src="../js/jquery-3.4.1.min.js"></script>
 <script src="../js/ozonedoc.js"></script>
 <script src="../js/bootstrap.min.js"></script>


 </body>

 </html>


	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<meta name="viewport" content="width=device-width, initial-scale=1">

	<meta name="description" content="Hadoop Ozone Documentation">

	<title>Documentation for Apache Hadoop Ozone</title>


	<link href="../css/bootstrap.min.css" rel="stylesheet">


	<link href="../css/ozonedoc.css" rel="stylesheet">

	</head>


	<body>


	<nav class="navbar navbar-inverse navbar-fixed-top">
	<div class="container-fluid">
	<div class="navbar-header">
	<button type="button" class="navbar-toggle collapsed" data-toggle="collapse" data-target="#sidebar" aria-expanded="false" aria-controls="navbar">
	<span class="sr-only">Toggle navigation</span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	<span class="icon-bar"></span>
	</button>
	<a href="#" class="navbar-left" style="height: 50px; padding: 5px 5px 5px 0;">
	<img src="../ozone-logo-small.png" width="40"/>
	</a>
	<a class="navbar-brand hidden-xs" href="#">
	Apache Hadoop Ozone/HDDS documentation
	</a>
	<a class="navbar-brand visible-xs-inline" href="#">Hadoop Ozone</a>
	</div>
	<div id="navbar" class="navbar-collapse collapse">
	<ul class="nav navbar-nav navbar-right">
	<li><a href="https://github.com/apache/hadoop-ozone">Source</a></li>
	<li><a href="https://hadoop.apache.org">Apache Hadoop</a></li>
	<li><a href="https://apache.org">ASF</a></li>
	</ul>
	</div>
	</div>
	</nav>


	<div class="container-fluid">
	<div class="row">

	<div class="col-sm-2 col-md-2 sidebar" id="sidebar">
	<ul class="nav nav-sidebar">



	<li class="">

	<a href="../index.html">



	<span>Overview</span>
	</a>
	</li>



	<li class="">

	<a href="../start.html">



	<span>Getting Started</span>
	</a>
	</li>



	<li class="">

	<a href="../shell.html">



	<span>Command Line Interface</span>
	</a>
	</li>



	<li class="">

	<a href="../interface.html">



	<span>Programming Interfaces</span>
	</a>
	</li>



	<li class="">

	<a href="../gdpr.html">



	<span>GDPR</span>
	</a>
	</li>



	<li class="">

	<a href="../security.html">



	<span>Security</span>
	</a>
	</li>



	<li class="">

	<a href="../concept.html">



	<span>Concepts</span>
	</a>
	</li>



	<li class="">

	<a href="../beyond.html">



	<span>Beyond Basics</span>
	</a>
	</li>



	<li class="">

	<a href="../tools.html">



	<span>Tools</span>
	</a>
	</li>



	<li class="">

	<a href="../recipe.html">



	<span>Recipes</span>
	</a>
	</li>


	<li class="visible-xs"><a href="#">References</a>
	<ul class="nav">
	<li><a href="https://github.com/apache/hadoop"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> Source</a></li>
	<li><a href="https://hadoop.apache.org"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> Apache Hadoop</a></li>
	<li><a href="https://apache.org"><span class="glyphicon glyphicon-new-window" aria-hidden="true"></span> ASF</a></li>
	</ul></li>
	</ul>

	</div>

	<div class="col-sm-10 col-sm-offset-2 col-md-10 col-md-offset-2 main">



	<div class="col-md-9">
	<nav aria-label="breadcrumb">
	<ol class="breadcrumb">
	<li class="breadcrumb-item"><a href="../">Home</a></li>
	<li class="breadcrumb-item" aria-current="page"><a href="../shell.html">Command Line Interface</a></li>
	<li class="breadcrumb-item active" aria-current="page">Bucket Commands</li>
	</ol>
	</nav>



	<div class="pull-right">




	<a href="../zh/shell/bucketcommands.html"><span class="label label-success">中文</span></a>


	</div>


	<div class="col-md-9">
	<h1>Bucket Commands</h1>



	<!---
	Licensed to the Apache Software Foundation (ASF) under one or more
	contributor license agreements. See the NOTICE file distributed with
	this work for additional information regarding copyright ownership.
	The ASF licenses this file to You under the Apache License, Version 2.0
	(the "License"); you may not use this file except in compliance with
	the License. You may obtain a copy of the License at

	http://www.apache.org/licenses/LICENSE-2.0

	Unless required by applicable law or agreed to in writing, software
	distributed under the License is distributed on an "AS IS" BASIS,
	WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	See the License for the specific language governing permissions and
	limitations under the License.
	-->

	<p>Ozone shell supports the following bucket commands.</p>

	<ul>
	<li><a href="#create">create</a></li>
	<li><a href="#delete">delete</a></li>
	<li><a href="#info">info</a></li>
	<li><a href="#list">list</a></li>
	</ul>

	<h3 id="create">Create</h3>

	<p>The <code>bucket create</code> command allows users to create a bucket.</p>

	<p><strong><em>Params:</em></strong></p>

	<table>
	<thead>
	<tr>
	<th>Arguments</th>
	<th>Comment</th>
	</tr>
	</thead>

	<tbody>
	<tr>
	<td>-g, --enforcegdpr</td>
	<td>Optional, if set to true it creates a GDPR compliant bucket, if not specified or set to false, it creates an ordinary bucket.</td>
	</tr>

	<tr>
	<td>-k, --bucketKey</td>
	<td>Optional, if a bucket encryption key name from the configured KMS server is specified, the files in the bucket will be transparently encrypted. Instruction on KMS configuration can be found from Hadoop KMS document.</td>
	</tr>

	<tr>
	<td>Uri</td>
	<td>The name of the bucket in <strong>/volume/bucket</strong> format.</td>
	</tr>
	</tbody>
	</table>

	<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">ozone sh bucket create /hive/jan</code></pre></div>

	<p>The above command will create a bucket called <em>jan</em> in the <em>hive</em> volume.
	Since no scheme was specified this command defaults to O3 (RPC) protocol.</p>

	<h3 id="delete">Delete</h3>

	<p>The <code>bucket delete</code> command allows users to delete a bucket. If the
	bucket is not empty then this command will fail.</p>

	<p><strong><em>Params:</em></strong></p>

	<table>
	<thead>
	<tr>
	<th>Arguments</th>
	<th>Comment</th>
	</tr>
	</thead>

	<tbody>
	<tr>
	<td>Uri</td>
	<td>The name of the bucket</td>
	</tr>
	</tbody>
	</table>

	<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">ozone sh bucket delete /hive/jan</code></pre></div>

	<p>The above command will delete <em>jan</em> bucket if it is empty.</p>

	<h3 id="info">Info</h3>

	<p>The <code>bucket info</code> commands returns the information about the bucket.</p>

	<p><strong><em>Params:</em></strong></p>

	<table>
	<thead>
	<tr>
	<th>Arguments</th>
	<th>Comment</th>
	</tr>
	</thead>

	<tbody>
	<tr>
	<td>Uri</td>
	<td>The name of the bucket.</td>
	</tr>
	</tbody>
	</table>

	<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">ozone sh bucket info /hive/jan</code></pre></div>

	<p>The above command will print out the information about <em>jan</em> bucket.</p>

	<h3 id="list">List</h3>

	<p>The <code>bucket list</code> command allows users to list the buckets in a volume.</p>

	<p><strong><em>Params:</em></strong></p>

	<table>
	<thead>
	<tr>
	<th>Arguments</th>
	<th>Comment</th>
	</tr>
	</thead>

	<tbody>
	<tr>
	<td>-l, --length</td>
	<td>Maximum number of results to return. Default: 100</td>
	</tr>

	<tr>
	<td>-p, --prefix</td>
	<td>Optional, Only buckets that match this prefix will be returned.</td>
	</tr>

	<tr>
	<td>-s, --start</td>
	<td>The listing will start from key after the start key.</td>
	</tr>

	<tr>
	<td>Uri</td>
	<td>The name of the <em>volume</em>.</td>
	</tr>
	</tbody>
	</table>

	<div class="highlight"><pre style="color:#f8f8f2;background-color:#272822;-moz-tab-size:4;-o-tab-size:4;tab-size:4"><code class="language-bash" data-lang="bash">ozone sh bucket list /hive</code></pre></div>

	<p>This command will list all buckets on the volume <em>hive</em>.</p>



	<a class="btn btn-success btn-lg" href="../shell/keycommands.html">Next >></a>

	</div>

	</div>
	</div>
	</div>
	</div>




	<script src="../js/jquery-3.4.1.min.js"></script>
	<script src="../js/ozonedoc.js"></script>
	<script src="../js/bootstrap.min.js"></script>


	</body>

	</html>