Packages

riak

1.1.0
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.Object.html
Raw

doc/Riak.Object.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.Object – Riak Elixir Client v1.1.0</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.0
      </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.Object
        
        
          <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L1" title="View Source" class="view-source" rel="help">
            <i class="icon-code"></i>
          </a>
        
      </h1>
      
        <section id="moduledoc" class="docstring">
          <p>The Data wrapper makes it convenient to work with Riak data in Elixir</p>
        </section>
      
      
        <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="#__struct__/0">__struct__()</a>
  </div>
  
    <div class="summary-synopsis"><p>Struct representing a Riak Object. Attributes:</p>
<ul>
<li><code class="inline">type</code>: String; Bucket Type with a unique name within the cluster namespace
</li>
<li><code class="inline">bucket</code>: String; Bucket with a unique name within the bucket type namespace
</li>
<li><code class="inline">key</code>: String; Not required; Key with a unique name within the bucket namespace
</li>
<li><code class="inline">data</code>: Any; Value to be stored under the key
</li>
<li><code class="inline">metadata</code>: Orddict; User specified metadata
</li>
<li><code class="inline">vclock</code>: String; Dotted Version Vector / Causal Context for object
</li>
<li><code class="inline">content_type</code>: String; Content Type for object
</li>
</ul>
</div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#create/1">create(args \\ [bucket: &quot;default&quot;])</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#delete_all_indexes/1">delete_all_indexes(obj)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#delete_all_links/1">delete_all_links(obj)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#delete_all_metadata/1">delete_all_metadata(obj)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#delete_index/2">delete_index(obj, arg)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#delete_link/2">delete_link(obj, tag)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#delete_metadata/2">delete_metadata(obj, key)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#from_robj/1">from_robj(robj)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#get_all_indexes/1">get_all_indexes(obj)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#get_all_links/1">get_all_links(obj)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#get_all_metadata/1">get_all_metadata(obj)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#get_index/2">get_index(obj, arg)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#get_link/2">get_link(obj, tag)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#get_metadata/2">get_metadata(obj, key)</a>
  </div>
  
    <div class="summary-synopsis"><p>Get all metadata entries</p>
</div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#index_id/1">index_id(arg)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#put_index/3">put_index(obj, arg, values)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#put_link/4">put_link(obj, tag, bucket, key)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#put_metadata/2">put_metadata(obj, arg)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#to_robj/1">to_robj(obj)</a>
  </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="__struct__/0">
  <div class="detail-header">
    <a href="#__struct__/0" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">__struct__()</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L16" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    <p>Struct representing a Riak Object. Attributes:</p>
<ul>
<li><code class="inline">type</code>: String; Bucket Type with a unique name within the cluster namespace
</li>
<li><code class="inline">bucket</code>: String; Bucket with a unique name within the bucket type namespace
</li>
<li><code class="inline">key</code>: String; Not required; Key with a unique name within the bucket namespace
</li>
<li><code class="inline">data</code>: Any; Value to be stored under the key
</li>
<li><code class="inline">metadata</code>: Orddict; User specified metadata
</li>
<li><code class="inline">vclock</code>: String; Dotted Version Vector / Causal Context for object
</li>
<li><code class="inline">content_type</code>: String; Content Type for object
</li>
</ul>
  </section>
</div>
<div class="detail" id="create/1">
  <div class="detail-header">
    <a href="#create/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">create(args \\ [bucket: &quot;default&quot;])</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L158" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="delete_all_indexes/1">
  <div class="detail-header">
    <a href="#delete_all_indexes/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">delete_all_indexes(obj)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L72" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="delete_all_links/1">
  <div class="detail-header">
    <a href="#delete_all_links/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">delete_all_links(obj)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L102" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="delete_all_metadata/1">
  <div class="detail-header">
    <a href="#delete_all_metadata/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">delete_all_metadata(obj)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.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="delete_index/2">
  <div class="detail-header">
    <a href="#delete_index/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">delete_index(obj, arg)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L66" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="delete_link/2">
  <div class="detail-header">
    <a href="#delete_link/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">delete_link(obj, tag)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L98" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="delete_metadata/2">
  <div class="detail-header">
    <a href="#delete_metadata/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">delete_metadata(obj, key)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L34" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="from_robj/1">
  <div class="detail-header">
    <a href="#from_robj/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">from_robj(robj)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L113" 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_all_indexes/1">
  <div class="detail-header">
    <a href="#get_all_indexes/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">get_all_indexes(obj)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L62" 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_all_links/1">
  <div class="detail-header">
    <a href="#get_all_links/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">get_all_links(obj)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L93" 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_all_metadata/1">
  <div class="detail-header">
    <a href="#get_all_metadata/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">get_all_metadata(obj)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L29" 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_index/2">
  <div class="detail-header">
    <a href="#get_index/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">get_index(obj, arg)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L53" 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_link/2">
  <div class="detail-header">
    <a href="#get_link/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">get_link(obj, tag)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L85" 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_metadata/2">
  <div class="detail-header">
    <a href="#get_metadata/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">get_metadata(obj, key)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L21" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    <p>Get all metadata entries</p>
  </section>
</div>
<div class="detail" id="index_id/1">
  <div class="detail-header">
    <a href="#index_id/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">index_id(arg)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L50" 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_index/3">
  <div class="detail-header">
    <a href="#put_index/3" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">put_index(obj, arg, values)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L77" 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_link/4">
  <div class="detail-header">
    <a href="#put_link/4" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">put_link(obj, tag, bucket, key)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L107" 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_metadata/2">
  <div class="detail-header">
    <a href="#put_metadata/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">put_metadata(obj, arg)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L44" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="to_robj/1">
  <div class="detail-header">
    <a href="#to_robj/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">to_robj(obj)</span>
      
      <a href="https://github.com/drewkerrigan/riak-elixir-client/blob/master/lib/riak/object.ex#L130" class="view-source" rel="help" title="View Source">
       <i class="icon-code"></i>
     </a>
    
  </div>
  
  <section class="docstring">
    
  </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>