Permalink
Browse files

Updated doc for 0.1.3 release

  • Loading branch information...
1 parent b2b2849 commit d0924ab6e916b1afd8a3cdbc0f9d9aa9a455eeef @pingles committed Feb 3, 2012
Showing with 167 additions and 109 deletions.
  1. +59 −31 api-index.html
  2. +2 −2 clj-hector.consistency-api.html
  3. +4 −4 clj-hector.core-api.html
  4. +3 −3 clj-hector.ddl-api.html
  5. +17 −3 clj-hector.serialize-api.html
  6. +3 −3 clj-hector.time-api.html
  7. +73 −57 index.clj
  8. +6 −6 index.html
View
@@ -1,6 +1,6 @@
<html>
<head>
- <title>Index - clj-hector nil API documentation</title>
+ <title>Index - clj-hector API documentation</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
@@ -48,7 +48,7 @@
<div class="contentBox"><div class="innerContentBox">
<div id="content_view" class="wiki wikiPage">
<div id="right-sidebar"></div>
- <div id="content-tag"><h1 id="overview">Index of Public Functions and Variables - <span id="header-project">clj-hector</span> <span id="header-version"></span> (<span id="header-status"></span>)</h1>
+ <div id="content-tag"><h1 id="overview">Index of Public Functions and Variables - <span id="header-project">clj-hector</span> <span id="header-version"></span></h1>
This page has an alphabetical index of all the documented functions and variables
in <span class="project-name-span">clj-hector</span>.
@@ -79,11 +79,13 @@ <h2 id="A"><span id="section-head">A</span></h2>
<pre>
<span id="section-content"> <a href="clj-hector.ddl-api.html#clj-hector.ddl/add-column-family">add-column-family</a><span id="line-content"> function clj-hector.ddl Adds a column family to a keyspace.
</span></span><span id="section-content"> <a href="clj-hector.ddl-api.html#clj-hector.ddl/add-keyspace">add-keyspace</a><span id="line-content"> function clj-hector.ddl Creates a new keyspace from the definition passed ...
-</span></span></pre>
+</span></span>
+ </pre>
</div><div id="index-body">
<h2 id="B"><span id="section-head">B</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="C"><span id="section-head">C</span></h2>
<pre>
@@ -92,7 +94,8 @@ <h2 id="C"><span id="section-head">C</span></h2>
</span></span><span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/count-columns">count-columns</a><span id="line-content"> function clj-hector.core Counts number of columns for pk in column family c...
</span></span><span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/create-composite">create-composite</a><span id="line-content"> function clj-hector.core Given a list create a Composite Supply a list of ...
</span></span><span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/create-dynamic-composite">create-dynamic-composite</a><span id="line-content"> function clj-hector.core Given a list create a DynamicComposite Supply a l...
-</span></span></pre>
+</span></span>
+ </pre>
</div><div id="index-body">
<h2 id="D"><span id="section-head">D</span></h2>
<pre>
@@ -101,17 +104,20 @@ <h2 id="D"><span id="section-head">D</span></h2>
</span></span><span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/delete-super-columns">delete-super-columns</a><span id="line-content"> function clj-hector.core Coll is a map of keys, super column names and colu...
</span></span><span id="section-content"> <a href="clj-hector.ddl-api.html#clj-hector.ddl/drop-column-family">drop-column-family</a><span id="line-content"> function clj-hector.ddl Removes a column family from a keyspace.
</span></span><span id="section-content"> <a href="clj-hector.ddl-api.html#clj-hector.ddl/drop-keyspace">drop-keyspace</a><span id="line-content"> function clj-hector.ddl Deletes a whole keyspace from the cluster.
-</span></span></pre>
+</span></span>
+ </pre>
</div><div id="index-body">
<h2 id="E"><span id="section-head">E</span></h2>
<pre>
<span id="section-content"> <a href="clj-hector.time-api.html#clj-hector.time/epoch">epoch</a><span id="line-content"> function clj-hector.time Returns the milliseconds since epoch. Epoch can be...
-</span></span></pre>
+</span></span>
+ </pre>
</div><div id="index-body">
<h2 id="F"><span id="section-head">F</span></h2>
<pre>
<span id="section-content"> <a href="clj-hector.time-api.html#clj-hector.time/from-bytes">from-bytes</a><span id="line-content"> function clj-hector.time Deserializes a TimeUUID object from a byte array..
-</span></span></pre>
+</span></span>
+ </pre>
</div><div id="index-body">
<h2 id="G"><span id="section-head">G</span></h2>
<pre>
@@ -121,99 +127,121 @@ <h2 id="G"><span id="section-head">G</span></h2>
</span></span><span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/get-counter-columns">get-counter-columns</a><span id="line-content"> function clj-hector.core Queries counter column values. c is a sequence of ...
</span></span><span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/get-counter-rows">get-counter-rows</a><span id="line-content"> function clj-hector.core Load data for specified keys and columns.
</span></span><span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/get-counter-super-columns">get-counter-super-columns</a><span id="line-content"> function clj-hector.core Queries for counter values in a super column colum...
-</span></span><span id="section-content"> <a href="clj-hector.time-api.html#clj-hector.time/get-date">get-date</a><span id="line-content"> multimethod clj-hector.time Retrieves the date from a TimeUUID object. TimeUUI...
+</span></span><span id="section-content"> <a href="clj-hector.time-api.html#clj-hector.time/get-date">get-date</a><span id="line-content"> function clj-hector.time Retrieves the date from a TimeUUID object. TimeUUI...
</span></span><span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/get-rows">get-rows</a><span id="line-content"> function clj-hector.core In keyspace ks, retrieve rows for pks within colum...
</span></span><span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/get-super-columns">get-super-columns</a><span id="line-content"> function clj-hector.core In keyspace ks, for row pk, retrieve columns in c ...
</span></span><span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/get-super-rows">get-super-rows</a><span id="line-content"> function clj-hector.core In keyspace ks, from Super Column Family cf, retri...
-</span></span></pre>
+</span></span>
+ </pre>
</div><div id="index-body">
<h2 id="H"><span id="section-head">H</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="I"><span id="section-head">I</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="J"><span id="section-head">J</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="K"><span id="section-head">K</span></h2>
<pre>
<span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/keyspace">keyspace</a><span id="line-content"> function clj-hector.core Connects the client to the specified Keyspace. All...
</span></span><span id="section-content"> <a href="clj-hector.ddl-api.html#clj-hector.ddl/keyspaces">keyspaces</a><span id="line-content"> function clj-hector.ddl Description of the keyspaces available in the Cass...
-</span></span></pre>
+</span></span>
+ </pre>
</div><div id="index-body">
<h2 id="L"><span id="section-head">L</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="M"><span id="section-head">M</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="N"><span id="section-head">N</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="O"><span id="section-head">O</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="P"><span id="section-head">P</span></h2>
<pre>
-<span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/put">put</a><span id="line-content"> function clj-hector.core Stores values in columns in map m against row key ...
-</span></span></pre>
+<span id="section-content"> <a href="clj-hector.serialize-api.html#clj-hector.serialize/partial&gt;">partial&gt;</a><span id="line-content"> function clj-hector.serialize Like clojure.core/partial, but appends args to t...
+</span></span><span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/put">put</a><span id="line-content"> function clj-hector.core Stores values in columns in map m against row key ...
+</span></span>
+ </pre>
</div><div id="index-body">
<h2 id="Q"><span id="section-head">Q</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="R"><span id="section-head">R</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="S"><span id="section-head">S</span></h2>
<pre>
<span id="section-content"> <a href="clj-hector.serialize-api.html#clj-hector.serialize/serializer">serializer</a><span id="line-content"> function clj-hector.serialize Returns an instance of the specified serializer....
-</span></span></pre>
+</span></span>
+ </pre>
</div><div id="index-body">
<h2 id="T"><span id="section-head">T</span></h2>
<pre>
<span id="section-content"> <a href="clj-hector.time-api.html#clj-hector.time/to-bytes">to-bytes</a><span id="line-content"> function clj-hector.time Converts a TimeUUID object to a byte array suitabl...
</span></span><span id="section-content"> <a href="clj-hector.serialize-api.html#clj-hector.serialize/to-clojure">to-clojure</a><span id="line-content"> function clj-hector.serialize Convert hector types to Clojure data structures..
-</span></span></pre>
+</span></span>
+ </pre>
</div><div id="index-body">
<h2 id="U"><span id="section-head">U</span></h2>
<pre>
<span id="section-content"> <a href="clj-hector.time-api.html#clj-hector.time/uuid">uuid</a><span id="line-content"> function clj-hector.time Creates a UUID from an epoch value.
-</span></span></pre>
+</span></span>
+ </pre>
</div><div id="index-body">
<h2 id="V"><span id="section-head">V</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="W"><span id="section-head">W</span></h2>
<pre>
<span id="section-content"> <a href="clj-hector.core-api.html#clj-hector.core/with-schemas">with-schemas</a><span id="line-content"> macro clj-hector.core Binds schema information to *schemas*. Allows othe...
-</span></span></pre>
+</span></span>
+ </pre>
</div><div id="index-body">
<h2 id="X"><span id="section-head">X</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="Y"><span id="section-head">Y</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="Z"><span id="section-head">Z</span></h2>
<pre>
-</pre>
+
+ </pre>
</div><div id="index-body">
<h2 id="Other"><span id="section-head">Other</span></h2>
<pre>
-</pre>
+
+ </pre>
</div>
<style type="text/css">
#AllContentContainer {min-width: 96em;}
@@ -1,6 +1,6 @@
<html>
<head>
- <title>clj-hector.consistency - clj-hector nil API documentation</title>
+ <title>clj-hector.consistency - clj-hector API documentation</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
@@ -57,7 +57,7 @@ <h1 class="nopad">Table of Contents</h1>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">clj-hector.consistency</span>
- - <span id="header-project">clj-hector</span> <span id="header-version"></span> (<span id="header-status"></span>)
+ - <span id="header-project">clj-hector</span> <span id="header-version"></span>
</h1>
<br />Full namespace name: <span id="long-name">clj-hector.consistency</span>
View
@@ -1,6 +1,6 @@
<html>
<head>
- <title>clj-hector.core - clj-hector nil API documentation</title>
+ <title>clj-hector.core - clj-hector API documentation</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
@@ -95,13 +95,13 @@ <h1 class="nopad">Table of Contents</h1>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">clj-hector.core</span>
- - <span id="header-project">clj-hector</span> <span id="header-version"></span> (<span id="header-status"></span>)
+ - <span id="header-project">clj-hector</span> <span id="header-version"></span>
</h1>
-
+<span id="author-line">by <span id="author-name">Paul Ingles</span><br /></span>
<br />Full namespace name: <span id="long-name">clj-hector.core</span>
<p></p>
<h2>Overview</h2>
-<pre id="namespace-docstr"></pre>
+<pre id="namespace-docstr">Hector-based Cassandra client</pre>
<br />
View
@@ -1,6 +1,6 @@
<html>
<head>
- <title>clj-hector.ddl - clj-hector nil API documentation</title>
+ <title>clj-hector.ddl - clj-hector API documentation</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
@@ -69,7 +69,7 @@ <h1 class="nopad">Table of Contents</h1>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">clj-hector.ddl</span>
- - <span id="header-project">clj-hector</span> <span id="header-version"></span> (<span id="header-status"></span>)
+ - <span id="header-project">clj-hector</span> <span id="header-version"></span>
</h1>
<span id="author-line">by <span id="author-name">Antonio Garrote, Paul Ingles</span><br /></span>
<br />Full namespace name: <span id="long-name">clj-hector.ddl</span>
@@ -85,7 +85,7 @@ <h1 class="nopad">Table of Contents</h1>
<hr />
<h2 id="clj-hector.ddl/add-column-family">add-column-family</h2>
<span id="var-type">function</span><br />
- <pre id="var-usage">Usage: (add-column-family cluster keyspace {:keys [name comparator type]})
+ <pre id="var-usage">Usage: (add-column-family cluster keyspace opts)
</pre>
<pre id="var-docstr">Adds a column family to a keyspace</pre>
@@ -1,6 +1,6 @@
<html>
<head>
- <title>clj-hector.serialize - clj-hector nil API documentation</title>
+ <title>clj-hector.serialize - clj-hector API documentation</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
@@ -52,6 +52,8 @@ <h1 class="nopad">Table of Contents</h1>
<div style="margin-left: 1em;" class="toc-section">
<a href="#toc0">Overview</a>
<div style="margin-left: 1em;" class="toc-entry">
+ <a href="#clj-hector.serialize/partial&gt;">partial&gt;</a>
+ </div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clj-hector.serialize/serializer">serializer</a>
</div><div style="margin-left: 1em;" class="toc-entry">
<a href="#clj-hector.serialize/to-clojure">to-clojure</a>
@@ -61,9 +63,9 @@ <h1 class="nopad">Table of Contents</h1>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">clj-hector.serialize</span>
- - <span id="header-project">clj-hector</span> <span id="header-version"></span> (<span id="header-status"></span>)
+ - <span id="header-project">clj-hector</span> <span id="header-version"></span>
</h1>
-
+<span id="author-line">by <span id="author-name">Paul Ingles</span><br /></span>
<br />Full namespace name: <span id="long-name">clj-hector.serialize</span>
<p></p>
<h2>Overview</h2>
@@ -75,6 +77,18 @@ <h1 class="nopad">Table of Contents</h1>
<div id="var-entry">
<br />
<hr />
+ <h2 id="clj-hector.serialize/partial&gt;">partial&gt;</h2>
+ <span id="var-type">function</span><br />
+ <pre id="var-usage">Usage: (partial&gt; f &amp; args)
+</pre>
+ <pre id="var-docstr">Like clojure.core/partial, but appends args to the end of
+the argument list when f is applied.</pre>
+
+
+
+</div><div id="var-entry">
+ <br />
+ <hr />
<h2 id="clj-hector.serialize/serializer">serializer</h2>
<span id="var-type">function</span><br />
<pre id="var-usage">Usage: (serializer x)
View
@@ -1,6 +1,6 @@
<html>
<head>
- <title>clj-hector.time - clj-hector nil API documentation</title>
+ <title>clj-hector.time - clj-hector API documentation</title>
<link href="static/favicon.png" rel="icon" />
<link href="static/favicon.png" rel="shortcut icon" />
<link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
@@ -67,7 +67,7 @@ <h1 class="nopad">Table of Contents</h1>
</div>
</div>
<div id="content-tag"><h1 id="overview">API for <span id="namespace-name">clj-hector.time</span>
- - <span id="header-project">clj-hector</span> <span id="header-version"></span> (<span id="header-status"></span>)
+ - <span id="header-project">clj-hector</span> <span id="header-version"></span>
</h1>
<span id="author-line">by <span id="author-name">Paul Ingles</span><br /></span>
<br />Full namespace name: <span id="long-name">clj-hector.time</span>
@@ -105,7 +105,7 @@ <h2 id="clj-hector.time/from-bytes">from-bytes</h2>
<br />
<hr />
<h2 id="clj-hector.time/get-date">get-date</h2>
- <span id="var-type">multimethod</span><br />
+ <span id="var-type">function</span><br />
<pre id="var-usage">Usage: (get-date object)
</pre>
<pre id="var-docstr">Retrieves the date from a TimeUUID object. TimeUUID can be provided as either
Oops, something went wrong.

0 comments on commit d0924ab

Please sign in to comment.