Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
tree: 16f7aa1794
Fetching contributors…

Cannot retrieve contributors at this time

924 lines (303 sloc) 12.748 kB
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Keyspace</title>
<script src="http://shjs.sourceforge.net/sh_main.min.js"> </script>
<script src="http://shjs.sourceforge.net/lang/sh_javascript.min.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/node-dark.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Class: Keyspace</h1>
<section>
<header>
<h2>
Keyspace
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h4 class="name" id="Keyspace"><span class="type-signature"></span>new Keyspace</h4>
</dt>
<dd>
<p class="description">
Creates an instance of a keyspace
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>keyspace.js, line 17</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="columnFamilies"><span class="type-signature"></span>columnFamilies<span class="type-signature"></span></h4>
</dt>
<dd>
<p class="description">
A cache of column familes to help with performance
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>keyspace.js, line 37</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="connection"><span class="type-signature"></span>connection<span class="type-signature"></span></h4>
</dt>
<dd>
<p class="description">
The connection object
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>keyspace.js, line 22</li></ul></dd>
<dt class="tag-see">See:</dt>
<dd class="tag-see">
<ul>
<li><a href="Connection.html">Connection</a></li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="definition"><span class="type-signature"></span>definition<span class="type-signature"></span></h4>
</dt>
<dd>
<p class="description">
The thrift definition of the keyspace
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>keyspace.js, line 32</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="name"><span class="type-signature"></span>name<span class="type-signature"></span></h4>
</dt>
<dd>
<p class="description">
The name of the keyspace
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>keyspace.js, line 27</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="NOOP"><span class="type-signature">&lt;private, static, constant> </span>NOOP<span class="type-signature"></span></h4>
</dt>
<dd>
<p class="description">
A No-Operation default for callbacks
</p>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>keyspace.js, line 11</li></ul></dd>
</dl>
</dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="createColumnFamily"><span class="type-signature"></span>createColumnFamily</h4>
</dt>
<dd>
<p class="description">
Creates a column family with options
</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>name</code></td>
<td class="type">
String
</td>
<td class="description last">The name of the column family to create</td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
Object
</td>
<td class="description last">The options for the columns family, options are:
<ul>
<li>column_type: Can be "Standard" or "Super" Defaults to "Standard" </li>
<li>comparator_type: The default comparator type</li>
<li>subcomparator_type: The default subcomparator type</li>
<li>comment: A comment for the cf</li>
<li>read_repair_chance: </li>
<li>column_metadata: </li>
<li>gc_grace_seconds: </li>
<li>default_validation_class: </li>
<li>min_compaction_threshold: </li>
<li>max_compaction_threshold: </li>
<li>replicate_on_write: </li>
<li>merge_shards_chance: </li>
<li>key_validation_class: </li>
<li>key_alias: </li>
<li>compaction_strategy: </li>
<li>compaction_strategy_options: </li>
<li>compression_options: </li>
<li>bloom_filter_fp_chance: </li>
<li>columns: Columns is an array of column options each element in the array is an object with these options:
<ul>
<li>name: *REQUIRED* The name of the column</li>
<li>validation_class: *REQUIRED* The validation class. Defaults to BytesType</li>
<li>index_type: The type of index</li>
<li>index_name: The name of the index</li>
<li>index_options: The options for the index, </li>
</ul>
</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 column family has been created</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>keyspace.js, line 130</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="describe"><span class="type-signature"></span>describe</h4>
</dt>
<dd>
<p class="description">
Loads gets all the column families and calls back with them
</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>callback</code></td>
<td class="type">
Function
</td>
<td class="description last">The callback to invoke once the column families have been retreived</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>keyspace.js, line 72</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="dropColumnFamily"><span class="type-signature"></span>dropColumnFamily</h4>
</dt>
<dd>
<p class="description">
Drops a column family
</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>name</code></td>
<td class="type">
String
</td>
<td class="description last">The name of the column family to drop</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 column family has been created</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>keyspace.js, line 188</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="get"><span class="type-signature"></span>get</h4>
</dt>
<dd>
<p class="description">
Gets a column family from the cache or loads it up
</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>columnFamily</code></td>
<td class="type">
String
</td>
<td class="description last">The name of the columnFamily to get the definition for</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 column family has been retreived</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>keyspace.js, line 45</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h3>Classes</h3><ul><li><a href="Column.html">Column</a></li><li><a href="ColumnFamily.html">ColumnFamily</a></li><li><a href="Connection.html">Connection</a></li><li><a href="Deserializers.html">Deserializers</a></li><li><a href="Helenus.html">Helenus</a></li><li><a href="Keyspace.html">Keyspace</a></li><li><a href="Marshal.html">Marshal</a></li><li><a href="Pool.html">Pool</a></li><li><a href="Row.html">Row</a></li><li><a href="Serializers.html">Serializers</a></li><li><a href="TimeUUID.html">TimeUUID</a></li><li><a href="UUID.html">UUID</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/micmath/jsdoc">JSDoc 3</a> on Fri Apr 20 2012 11:58:20 GMT-0400 (EDT)
</footer>
<script> sh_highlightDocument(); </script>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.