atomicrecord
Version:
Super lightweight node.js ActiveRecord ORM layer for FoundationDB
480 lines (456 loc) • 9.52 kB
HTML
<html>
<head>
<meta charset='UTF-8'>
<title>Documentation</title>
<script src='../javascript/application.js'></script>
<script src='../javascript/search.js'></script>
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
<script>
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'undefined']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</head>
<body>
<div id='base' data-path='../'></div>
<div id='header'>
<div id='menu'>
<a href='../extra/README.md.html' title='AtomicRecord'>
AtomicRecord
</a>
»
<a href='../alphabetical_index.html' title='Index'>
Index
</a>
»
<span class='title'>AtomicRecord</span>
</div>
</div>
<div id='content'>
<h1>
Class:
AtomicRecord
</h1>
<table class='box'>
<tr>
<td>Defined in:</td>
<td>src/atomicrecord.coffee</td>
</tr>
</table>
<h2>Variables Summary</h2>
<dl class='constants'>
<dt id='database-variable'>
database
=
</dt>
<dd>
<pre><code class='coffeescript'>database</code></pre>
<div class='docstring'>
<h2 id="initializers">Initializers</h2>
</div>
<div class='tags'>
</div>
</dd>
<dt id='dataset-variable'>
dataset
=
</dt>
<dd>
<pre><code class='coffeescript'>dataset</code></pre>
</dd>
<dt id='keySize-variable'>
keySize
=
</dt>
<dd>
<pre><code class='coffeescript'>0</code></pre>
</dd>
<dt id='valueSize-variable'>
valueSize
=
</dt>
<dd>
<pre><code class='coffeescript'>0</code></pre>
</dd>
<dt id='partition-variable'>
partition
=
</dt>
<dd>
<pre><code class='coffeescript'>partition</code></pre>
</dd>
<dt id='_key-variable'>
_key
=
</dt>
<dd>
<pre><code class='coffeescript'>null</code></pre>
</dd>
<dt id='_keyValueSize-variable'>
_keyValueSize
=
</dt>
<dd>
<pre><code class='coffeescript'>null</code></pre>
</dd>
<dt id='keyFrag-variable'>
keyFrag
=
</dt>
<dd>
<pre><code class='coffeescript'>keyFrag</code></pre>
</dd>
<dt id='index-variable'>
index
=
</dt>
<dd>
<pre><code class='coffeescript'>index</code></pre>
</dd>
</dl>
<h2>Class Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#transactional-static'>
.
(void)
<b>transactional</b><span>(func)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#doTransaction-static'>
.
(void)
<b>doTransaction</b><span>(transaction, callback)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#count-static'>
.
(void)
<b>count</b><span>()</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#findAll-static'>
.
(void)
<b>findAll</b><span>(query, options = {})</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#extend-static'>
.
(void)
<b>extend</b><span>(constructor)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>Instance Method Summary</h2>
<ul class='summary'>
<li>
<span class='signature'>
<a href='#data-dynamic'>
#
(void)
<b>data</b><span>(dest, val)</span>
</a>
</span>
<span class='desc'>
<ul> Get / Set internal value for property alias.
</ul>
</span>
</li>
<li>
<span class='signature'>
<a href='#save-dynamic'>
#
(void)
<b>save</b><span>(tr, callback)</span>
</a>
</span>
<span class='desc'>
<ul> Persists record to the database
<li>@method</li>
<li>@param {object} [tr=null] Transaction.</li>
</ul>
</span>
</li>
<li>
<span class='signature'>
<a href='#remove-dynamic'>
#
(void)
<b>remove</b><span>(tr, callback)</span>
</a>
</span>
<span class='desc'>
<ul> Deletes record from the database
<li>@method</li>
<li>@param {object} [tr=null] Transaction.</li>
</ul>
</span>
</li>
<li>
<span class='signature'>
<a href='#index-dynamic'>
#
(void)
<b>index</b><span>(tr, callback)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
<li>
<span class='signature'>
<a href='#serialize-dynamic'>
#
(void)
<b>serialize</b><span>(callback)</span>
</a>
</span>
<span class='desc'>
</span>
</li>
</ul>
<h2>Class Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='transactional-static'>
.
(void)
<b>transactional</b><span>(func)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='doTransaction-static'>
.
(void)
<b>doTransaction</b><span>(transaction, callback)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='count-static'>
.
(void)
<b>count</b><span>()</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='findAll-static'>
.
(void)
<b>findAll</b><span>(query, options = {})</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='extend-static'>
.
(void)
<b>extend</b><span>(constructor)</span>
<br>
</p>
</div>
</div>
<h2>Constructor Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='constructor-dynamic'>
#
(void)
<b>constructor</b><span>(initializer)</span>
<br>
</p>
<div class='docstring'>
<ul>
<li>Creates a new typed AtomicRecord instance</li>
<li>@class</li>
<li>@param {object} [record] Record object initializer.</li>
<li>@return {Record} a typed AtomicRecord instance.</li>
</ul>
</div>
<div class='tags'>
</div>
</div>
</div>
<h2>Instance Method Details</h2>
<div class='methods'>
<div class='method_details'>
<p class='signature' id='data-dynamic'>
#
(void)
<b>data</b><span>(dest, val)</span>
<br>
</p>
<div class='docstring'>
<ul>
<li>Get / Set internal value for property alias.</li>
<li>@virtual</li>
<li>@param {string} dest Destination property alias.</li>
<li>@param {object} val Optional value to set.</li>
<li>@return {object} Value if val undefined.</li>
</ul>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='save-dynamic'>
#
(void)
<b>save</b><span>(tr, callback)</span>
<br>
</p>
<div class='docstring'>
<ul>
<li>Persists record to the database</li>
<li>@method</li>
<li>@param {object} [tr=null] Transaction.</li>
<li>@param {saveCallback} callback Calback.</li>
<li>@return {Future}</li>
</ul>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='remove-dynamic'>
#
(void)
<b>remove</b><span>(tr, callback)</span>
<br>
</p>
<div class='docstring'>
<ul>
<li>Deletes record from the database</li>
<li>@method</li>
<li>@param {object} [tr=null] Transaction.</li>
<li>@param {saveCallback} callback Calback.</li>
<li>@return {Future}</li>
</ul>
</div>
<div class='tags'>
</div>
</div>
<div class='method_details'>
<p class='signature' id='index-dynamic'>
#
(void)
<b>index</b><span>(tr, callback)</span>
<br>
</p>
</div>
<div class='method_details'>
<p class='signature' id='serialize-dynamic'>
#
(void)
<b>serialize</b><span>(callback)</span>
<br>
</p>
</div>
</div>
</div>
<div id='footer'>
January 20, 15 12:49:54 by
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
Codo
</a>
2.0.9
✲
Press H to see the keyboard shortcuts
✲
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
✲
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
<input type='text'>
<ol></ol>
</div>
<div id='help'>
<p>
Quickly fuzzy find classes, mixins, methods, file:
</p>
<ul>
<li>
<span>T</span>
Open fuzzy finder dialog
</li>
</ul>
<p>
Control the navigation frame:
</p>
<ul>
<li>
<span>L</span>
Toggle list view
</li>
<li>
<span>C</span>
Show class list
</li>
<li>
<span>I</span>
Show mixin list
</li>
<li>
<span>F</span>
Show file list
</li>
<li>
<span>M</span>
Show method list
</li>
<li>
<span>E</span>
Show extras list
</li>
</ul>
<p>
You can focus and blur the search input:
</p>
<ul>
<li>
<span>S</span>
Focus search input
</li>
<li>
<span>Esc</span>
Blur search input
</li>
</ul>
</div>
</body>
</html>