Current section
Files
Jump to
Current section
Files
doc/api-reference.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>API Reference – Riak Elixir Client v1.1.6</title>
<link rel="stylesheet" href="dist/app-268c9dc719.css" />
<link rel="canonical" href="https://hexdocs.pm/riak/api-reference.html" />
<script src="dist/sidebar_items-8bfd31e79d.js"></script>
</head>
<body data-type="extras">
<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>
API Reference
</h1>
<section class="details-list">
<h2 id="modules" class="section-heading">
<a href="#modules" class="hover-link"><span class="icon-link" aria-hidden="true"></span></a>
Modules
</h2>
<div class="summary">
<div class="summary-row">
<div class="summary-signature"><a href="Riak.html">Riak</a></div>
<div class="summary-synopsis"><h1>Riak Elixir Client</h1>
<p><a href="https://travis-ci.org/drewkerrigan/riak-elixir-client"><img src="https://travis-ci.org/drewkerrigan/riak-elixir-client.svg?branch=master" alt="Build Status"/></a></p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.Bucket.html">Riak.Bucket</a></div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.Bucket.Type.html">Riak.Bucket.Type</a></div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.CRDT.html">Riak.CRDT</a></div>
<div class="summary-synopsis"><p>Common CRDT module</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.CRDT.Counter.html">Riak.CRDT.Counter</a></div>
<div class="summary-synopsis"><p>Counter data-type on Riak 2.0</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.CRDT.Flag.html">Riak.CRDT.Flag</a></div>
<div class="summary-synopsis"><p>Encapsulates a boolean datatype inside a CRDT.Map</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.CRDT.HyperLogLog.html">Riak.CRDT.HyperLogLog</a></div>
<div class="summary-synopsis"><p>Encapsulates Riak HLL</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.CRDT.Map.html">Riak.CRDT.Map</a></div>
<div class="summary-synopsis"><p>Encapsulates Riak maps</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.CRDT.Register.html">Riak.CRDT.Register</a></div>
<div class="summary-synopsis"><p>Encapsulates a binary data to be used on CRDT.Map’s</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.CRDT.Set.html">Riak.CRDT.Set</a></div>
<div class="summary-synopsis"><p>Encapsulates riakc_set using elixir Set functions as interface.
It accepts only binary as items</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.Connection.html">Riak.Connection</a></div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.Index.html">Riak.Index</a></div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.Mapred.html">Riak.Mapred</a></div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.Mapred.Bucket.html">Riak.Mapred.Bucket</a></div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.Object.html">Riak.Object</a></div>
<div class="summary-synopsis"><p>The Data wrapper makes it convenient to work with Riak data in Elixir</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.Pool.html">Riak.Pool</a></div>
<div class="summary-synopsis"><p>[EXPERIMENTAL]
This module adds defpool to define functions with a
lower arity for each function so</p>
</div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.Search.html">Riak.Search</a></div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.Search.Index.html">Riak.Search.Index</a></div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.Search.Schema.html">Riak.Search.Schema</a></div>
</div>
<div class="summary-row">
<div class="summary-signature"><a href="Riak.Timeseries.html">Riak.Timeseries</a></div>
</div>
</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>