Current section
Files
Jump to
Current section
Files
doc/Riak.Bucket.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.0"> <meta name="generator" content="ExDoc v0.16.2"> <title>Riak.Bucket – Riak Elixir Client v1.1.6</title> <link rel="stylesheet" href="dist/app-268c9dc719.css" /> <link rel="canonical" href="https://hexdocs.pm/riak/Riak.Bucket.html" /> <script src="dist/sidebar_items-8bfd31e79d.js"></script> </head> <body data-type="modules"> <script>try { if(localStorage.getItem('night-mode')) document.body.className += ' night-mode'; } catch (e) { }</script> <div class="main"><button class="sidebar-toggle"> <span class="icon-menu" aria-hidden="true"></span> <span class="sr-only">Toggle Sidebar</span></button><section class="sidebar"> <a href="api-reference.html" class="sidebar-projectLink"> <div class="sidebar-projectDetails"> <h1 class="sidebar-projectName"> Riak Elixir Client </h1> <h2 class="sidebar-projectVersion"> v1.1.6 </h2> </div> </a> <div class="sidebar-search"> <span class="icon-search" aria-hidden="true"></span> <input type="text" class="sidebar-searchInput" placeholder="search" aria-label="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> <div class="gradient"></div> <ul id="full-list" class="sidebar-fullList"></ul></section><section class="content"> <div class="content-outer"> <div id="content" class="content-inner"> <h1> <small class="visible-xs">Riak Elixir Client v1.1.6</small> 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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </a> </h1> <section id="summary" class="details-list"> <h1 class="section-heading"> <a class="hover-link" href="#summary"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this section</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this section</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </a> <span class="signature">keys(pid, bucket)</span> <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L32" class="view-source" rel="help" title="View Source"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </a> <span class="signature">keys(pid, type, bucket)</span> <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L32" class="view-source" rel="help" title="View Source"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </a> <span class="signature">keys!(pid, bucket)</span> <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L44" class="view-source" rel="help" title="View Source"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </a> <span class="signature">keys!(pid, type, bucket)</span> <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/bucket.ex#L44" class="view-source" rel="help" title="View Source"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </a> <span class="signature">list(pid)</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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </a> <span class="signature">list!(pid)</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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </a> <span class="signature">put(pid, bucket, 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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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"> <span class="icon-link" aria-hidden="true"></span> <span class="sr-only">Link to this function</span> </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"> <span class="icon-code" aria-hidden="true"></span> <span class="sr-only">View Source</span> </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.16.2), </span> <span class="line"> designed by <a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>. </span> </p> <button class="night-mode-toggle"><span class="sr-only">Switch theme</span></button> </footer> </div> </div></section></div> <script src="dist/app-4988ddd06b.js"></script> </body></html>