Packages

riak

1.1.4
1.1.6 1.1.5 1.1.4 1.1.3 1.1.2 1.1.1 1.1.0 1.0.0

A Riak client written in Elixir.

HexDocs

Current section

Files

Jump to
Readme
8 Versions
3 Dependencies
1 Dependant
Files
Activity
riak doc Riak.Bucket.html
Raw

doc/Riak.Bucket.html 

    <!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8">
    <meta http-equiv="x-ua-compatible" content="ie=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Riak.Bucket – Riak Elixir Client v1.1.4</title>
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="generator" content="ExDoc v0.10.0">
    <link rel="stylesheet" href="dist/app.css" />
    <script src="dist/sidebar_items.js"></script>
  </head>
  <body data-type="modules">
    <div class="main">
<button class="sidebar-toggle">
  <i class="icon-menu"></i>
</button>
<section class="sidebar">
  <button class="sidebar-toggle">
    <i class="icon-menu"></i>
  </button>
  
  <a href="extra-api-reference.html" class="sidebar-projectLink">
    <div class="sidebar-projectDetails">
      <h1 class="sidebar-projectName">
        Riak Elixir Client
      </h1>
      <h2 class="sidebar-projectVersion">
        v1.1.4
      </h2>
    </div>
    
  </a>
  <div class="sidebar-search">
    <i class="icon-search"></i>
    <input type="text" class="sidebar-searchInput" placeholder="search" autocomplete="off" />
  </div>
  <ul class="sidebar-listNav">
    <li><a id="extras-list" href="#full-list">Pages</a></li>
    
      <li><a id="modules-list" href="#full-list">Modules</a></li>
    
    
    
  </ul>
  <ul id="full-list" class="sidebar-fullList"></ul>
  <div class="sidebar-noResults"></div>
</section>
<section class="content">
  <div id="content" class="content-inner">
      <h1>
        Riak.Bucket
        
        
          <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L1" title="View Source" class="view-source" rel="help">
            <i class="icon-code"></i>
          </a>
        
      </h1>
      
      
        <section id="summary" class="details-list">
          <h1 class="section-heading">
            <a class="hover-link" href="#summary">
              <i class="icon-link"></i>
            </a>
            Summary
          </h1>
          
          
  <div class="summary-functions summary">
    <h2>
      <a href="#functions">Functions</a>
    </h2>
    <div class="summary-row">
  <div class="summary-signature">
    <a href="#get/1">get(bucket)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#get/2">get(pid, bucket)</a>
  </div>
  
    <div class="summary-synopsis"><p>Get bucket properties</p>
</div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#keys/1">keys(bucket)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#keys/2">keys(pid, bucket)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#keys/3">keys(pid, type, bucket)</a>
  </div>
  
    <div class="summary-synopsis"><p>List all keys in a bucket.
<strong><em>This is a potentially expensive operation and should not be used in production.</em></strong></p>
</div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#keys/4">keys(pid, type, bucket, timeout)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#keys!/1">keys!(bucket)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#keys!/2">keys!(pid, bucket)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#keys!/3">keys!(pid, type, bucket)</a>
  </div>
  
    <div class="summary-synopsis"><p>List all keys in a bucket. Return only buckets.
<strong><em>This is a potentially expensive operation and should not be used in production.</em></strong></p>
</div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#keys!/4">keys!(pid, type, bucket, timeout)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#list/0">list()</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#list/1">list(pid)</a>
  </div>
  
    <div class="summary-synopsis"><p>List all buckets on the server with or without server-side timeout.
<strong><em>This is a potentially expensive operation and should not be used in production.</em></strong></p>
</div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#list/2">list(pid, timeout)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#list!/0">list!()</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#list!/1">list!(pid)</a>
  </div>
  
    <div class="summary-synopsis"><p>List all buckets on the server with or without server-side timeout. Return only buckets.
<strong><em>This is a potentially expensive operation and should not be used in production.</em></strong></p>
</div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#list!/2">list!(pid, timeout)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#possible_props/0">possible_props()</a>
  </div>
  
    <div class="summary-synopsis"><p>Used to “register” the atoms used by the protobuf interface, not for public use</p>
</div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#put/2">put(bucket, props)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#put/3">put(pid, bucket, props)</a>
  </div>
  
    <div class="summary-synopsis"><p>Set bucket properties</p>
</div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#put/4">put(pid, bucket, type, props)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#reset/1">reset(bucket)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#reset/2">reset(pid, bucket)</a>
  </div>
  
    <div class="summary-synopsis"><p>Reset bucket properties back to the defaults</p>
</div>
  
</div>
  </div>
          
          
        </section>
      
      
      
        <section id="functions" class="details-list">
          <h1 class="section-heading">
            <a class="hover-link" href="#functions">
              <i class="icon-link"></i>
            </a>
            Functions
          </h1>
          <div class="detail" id="get/1">
  <div class="detail-header">
    <a href="#get/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">get(bucket)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L52" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="get/2">
  <div class="detail-header">
    <a href="#get/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">get(pid, bucket)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L52" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    <p>Get bucket properties.</p>
  </section>
</div>
<div class="detail" id="keys/1">
  <div class="detail-header">
    <a href="#keys/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">keys(bucket)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L31" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="keys/2">
  <div class="detail-header">
    <a href="#keys/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">keys(pid, bucket)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L31" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="keys/3">
  <div class="detail-header">
    <a href="#keys/3" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">keys(pid, type, bucket)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L29" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    <p>List all keys in a bucket.
<strong><em>This is a potentially expensive operation and should not be used in production.</em></strong></p>
  </section>
</div>
<div class="detail" id="keys/4">
  <div class="detail-header">
    <a href="#keys/4" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">keys(pid, type, bucket, timeout)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L30" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="keys!/1">
  <div class="detail-header">
    <a href="#keys!/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">keys!(bucket)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L40" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="keys!/2">
  <div class="detail-header">
    <a href="#keys!/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">keys!(pid, bucket)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L40" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="keys!/3">
  <div class="detail-header">
    <a href="#keys!/3" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">keys!(pid, type, bucket)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L38" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    <p>List all keys in a bucket. Return only buckets.
<strong><em>This is a potentially expensive operation and should not be used in production.</em></strong></p>
  </section>
</div>
<div class="detail" id="keys!/4">
  <div class="detail-header">
    <a href="#keys!/4" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">keys!(pid, type, bucket, timeout)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L39" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="list/0">
  <div class="detail-header">
    <a href="#list/0" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">list()</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L9" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="list/1">
  <div class="detail-header">
    <a href="#list/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">list(pid)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L9" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    <p>List all buckets on the server with or without server-side timeout.
<strong><em>This is a potentially expensive operation and should not be used in production.</em></strong></p>
  </section>
</div>
<div class="detail" id="list/2">
  <div class="detail-header">
    <a href="#list/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">list(pid, timeout)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L10" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="list!/0">
  <div class="detail-header">
    <a href="#list!/0" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">list!()</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L16" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="list!/1">
  <div class="detail-header">
    <a href="#list!/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">list!(pid)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L16" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    <p>List all buckets on the server with or without server-side timeout. Return only buckets.
<strong><em>This is a potentially expensive operation and should not be used in production.</em></strong></p>
  </section>
</div>
<div class="detail" id="list!/2">
  <div class="detail-header">
    <a href="#list!/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">list!(pid, timeout)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L20" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="possible_props/0">
  <div class="detail-header">
    <a href="#possible_props/0" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">possible_props()</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L94" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    <p>Used to “register” the atoms used by the protobuf interface, not for public use.</p>
  </section>
</div>
<div class="detail" id="put/2">
  <div class="detail-header">
    <a href="#put/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">put(bucket, props)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L57" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="put/3">
  <div class="detail-header">
    <a href="#put/3" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">put(pid, bucket, props)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L57" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    <p>Set bucket properties.</p>
  </section>
</div>
<div class="detail" id="put/4">
  <div class="detail-header">
    <a href="#put/4" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">put(pid, bucket, type, props)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L58" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="reset/1">
  <div class="detail-header">
    <a href="#reset/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">reset(bucket)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L65" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="reset/2">
  <div class="detail-header">
    <a href="#reset/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">reset(pid, bucket)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L65" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    <p>Reset bucket properties back to the defaults.</p>
  </section>
</div>
        </section>
      
      
      
        <footer class="footer">
      <p>
        <span class="line">
          Built using
          <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.10.0),
        </span>
        <span class="line">
          designed by
          <a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
          </span>
      </p>
    </footer>
  </div>
</section>
</div>
    <script src="dist/app.js"></script>
  </body>
</html>