Permalink
Browse files

added getIndexed to columnfamily

  • Loading branch information...
1 parent fc786d7 commit aaca8447fcba7e07c44891a904a559fdf375a94d @devdazed devdazed committed Feb 20, 2012
View
@@ -67,4 +67,9 @@
==================
* Added binary support for strings in the serializer
- * Some serializer optimizations
+ * Some serializer optimizations
+
+0.3.0 / 2012-02-20
+==================
+
+ * Added getIndexed to ColumnFamily to get an array of rows by indexed columns
View
@@ -108,6 +108,7 @@ Currently Helenus supports the following command for the thrift side of the driv
* keyspace.dropColumnFamily
* columnFamily.insert
* columnFamily.get
+ * columnFamily.getIndexed
The following support is going to be added in later releases:
View
@@ -540,7 +540,7 @@ <h3>Classes</h3><ul><li><a href="Column.html">Column</a></li><li><a href="Column
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Sat Feb 04 2012 15:52:52 GMT-0500 (EST)
+ Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Mon Feb 20 2012 14:17:33 GMT-0500 (EST)
</footer>
<script> sh_highlightDocument(); </script>
View
@@ -104,7 +104,7 @@ <h5>Parameters:</h5>
<dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>./lib/column_family.js, line 59</li></ul></dd>
+ <dd class="tag-source"><ul class="dummy"><li>./lib/column_family.js, line 86</li></ul></dd>
@@ -248,7 +248,7 @@ <h4 class="name" id="get"><span class="type-signature"></span>get</h4>
<p class="description">
- Get a column in a row by its key
+ Get a row by its key
</p>
@@ -358,7 +358,157 @@ <h5>Parameters:</h5>
<dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>./lib/column_family.js, line 135</li></ul></dd>
+ <dd class="tag-source"><ul class="dummy"><li>./lib/column_family.js, line 165</li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+
+
+
+</dd>
+<dt>
+ <h4 class="name" id="getIndexed"><span class="type-signature"></span>getIndexed</h4>
+
+
+</dt>
+<dd>
+
+
+ <p class="description">
+ Gets rows by their indexed fields
+ </p>
+
+
+
+
+ <h5>Parameters:</h5>
+
+<table class="params">
+ <thead>
+ <tr>
+
+ <th>Name</th>
+
+
+ <th>Type</th>
+
+
+
+
+
+ <th class="last">Description</th>
+ </tr>
+ </thead>
+
+ <tbody>
+
+
+ <tr>
+
+ <td class="name"><code>query</code></td>
+
+
+ <td class="type">
+ Object
+ </td>
+
+
+
+
+
+ <td class="description last">Options for the rows part of the get
+ <ul>
+ <li>fields: an array of objects thjat contain { column:column_name, operator: 'EQ', value:value }
+ <ul>
+ <li>column: {String} The name of the column with the index</li>
+ <li>operator: {String} The operator to use, can be EQ, GTE, GT, LTE, ot LT</li>
+ <li>value: {String} The value to query by</li>
+ </ul>
+ </li>
+ <li>start: the start key to get</li>
+ <li>max: the total amount of rows to return</li>
+ </ul></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>options</code></td>
+
+
+ <td class="type">
+ Object
+ </td>
+
+
+
+
+
+ <td class="description last">Options for the get, can have start, end, max, consistencyLevel
+ <ul>
+ <li>start: the from part of the column name</li>
+ <li>end: the to part of the column name</li>
+ <li>max: the max amount of columns to return</li>
+ <li>columns: an {Array} of column names to get</li>
+ <li>consistencyLevel: the read consistency level</li>
+ </ul></td>
+ </tr>
+
+
+
+ <tr>
+
+ <td class="name"><code>callback</code></td>
+
+
+ <td class="type">
+ Function
+ </td>
+
+
+
+
+
+ <td class="description last">The callback to invoke once the response has been received</td>
+ </tr>
+
+
+ </tbody>
+</table>
+
+ <dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>./lib/column_family.js, line 214</li></ul></dd>
@@ -508,7 +658,7 @@ <h5>Parameters:</h5>
<dt class="tag-source">Source:</dt>
- <dd class="tag-source"><ul class="dummy"><li>./lib/column_family.js, line 89</li></ul></dd>
+ <dd class="tag-source"><ul class="dummy"><li>./lib/column_family.js, line 120</li></ul></dd>
@@ -643,6 +793,78 @@ <h5>Returns:</h5>
+</dd>
+<dt>
+ <h4 class="name" id="getSlicePredicate"><span class="type-signature">&lt;private, static> </span>getSlicePredicate</h4>
+
+
+</dt>
+<dd>
+
+
+ <p class="description">
+ Gets a slcie predicate based on some options
+ </p>
+
+
+
+
+
+
+ <dl class="details">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <dt class="tag-source">Source:</dt>
+ <dd class="tag-source"><ul class="dummy"><li>./lib/column_family.js, line 59</li></ul></dd>
+
+
+
+
+
+
+
+</dl>
+
+
+
+
+
+
+
+ <h5>Returns:</h5>
+
+
+
+
+<dl>
+ <dt>
+ Type
+ </dt>
+ <dd>
+
+ <span class="param-type">SlicePredicate</span>
+
+ </dd>
+</dl>
+
+
+
+
</dd>
<dt>
<h4 class="name" id="NOOP"><span class="type-signature">&lt;private, static> </span>NOOP</h4>
@@ -720,7 +942,7 @@ <h3>Classes</h3><ul><li><a href="Column.html">Column</a></li><li><a href="Column
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Sat Feb 04 2012 15:52:52 GMT-0500 (EST)
+ Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Mon Feb 20 2012 14:17:33 GMT-0500 (EST)
</footer>
<script> sh_highlightDocument(); </script>
View
@@ -1606,7 +1606,7 @@ <h3>Classes</h3><ul><li><a href="Column.html">Column</a></li><li><a href="Column
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Sat Feb 04 2012 15:52:52 GMT-0500 (EST)
+ Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Mon Feb 20 2012 14:17:33 GMT-0500 (EST)
</footer>
<script> sh_highlightDocument(); </script>
View
@@ -1515,7 +1515,7 @@ <h3>Classes</h3><ul><li><a href="Column.html">Column</a></li><li><a href="Column
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Sat Feb 04 2012 15:52:52 GMT-0500 (EST)
+ Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Mon Feb 20 2012 14:17:33 GMT-0500 (EST)
</footer>
<script> sh_highlightDocument(); </script>
View
@@ -618,7 +618,7 @@ <h3>Classes</h3><ul><li><a href="Column.html">Column</a></li><li><a href="Column
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Sat Feb 04 2012 15:52:52 GMT-0500 (EST)
+ Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Mon Feb 20 2012 14:17:33 GMT-0500 (EST)
</footer>
<script> sh_highlightDocument(); </script>
View
@@ -844,7 +844,7 @@ <h3>Classes</h3><ul><li><a href="Column.html">Column</a></li><li><a href="Column
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Sat Feb 04 2012 15:52:53 GMT-0500 (EST)
+ Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Mon Feb 20 2012 14:17:33 GMT-0500 (EST)
</footer>
<script> sh_highlightDocument(); </script>
View
@@ -931,7 +931,7 @@ <h3>Classes</h3><ul><li><a href="Column.html">Column</a></li><li><a href="Column
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Sat Feb 04 2012 15:52:53 GMT-0500 (EST)
+ Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Mon Feb 20 2012 14:17:33 GMT-0500 (EST)
</footer>
<script> sh_highlightDocument(); </script>
View
@@ -835,7 +835,7 @@ <h3>Classes</h3><ul><li><a href="Column.html">Column</a></li><li><a href="Column
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Sat Feb 04 2012 15:52:53 GMT-0500 (EST)
+ Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Mon Feb 20 2012 14:17:34 GMT-0500 (EST)
</footer>
<script> sh_highlightDocument(); </script>
View
@@ -910,7 +910,7 @@ <h3>Classes</h3><ul><li><a href="Column.html">Column</a></li><li><a href="Column
<br clear="both">
<footer>
- Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Sat Feb 04 2012 15:52:53 GMT-0500 (EST)
+ Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Mon Feb 20 2012 14:17:34 GMT-0500 (EST)
</footer>
<script> sh_highlightDocument(); </script>
Oops, something went wrong.

0 comments on commit aaca844

Please sign in to comment.