incubator-blur-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From amccu...@apache.org
Subject [07/10] More documentation.
Date Sun, 18 Aug 2013 00:15:13 GMT
http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/d05d4ba2/distribution/src/main/scripts/interface/gen-html/Blur.html
----------------------------------------------------------------------
diff --git a/distribution/src/main/scripts/interface/gen-html/Blur.html b/distribution/src/main/scripts/interface/gen-html/Blur.html
index 2c48747..5efb7d9 100644
--- a/distribution/src/main/scripts/interface/gen-html/Blur.html
+++ b/distribution/src/main/scripts/interface/gen-html/Blur.html
@@ -80,12 +80,14 @@
 </tr></table>
 <hr/><h2 id="Enumerations">Enumerations</h2>
 <div class="definition"><h3 id="Enum_ErrorType">Enumeration: ErrorType</h3>
-The error type of a BlurException.<br/><br/>
-UNKNOWN - Unknown error.<br/><br/>
-QUERY_CANCEL - Query has been cancel.<br/><br/>
-QUERY_TIMEOUT - Query has timed out.<br/><br/>
-BACK_PRESSURE - Server has run out of memory and is trying to prevent a failure.<br/><br/>
-REQUEST_TIMEOUT - The TCP connection has timed out.<br/>
+<table class="table-bordered table-striped table-condensed">
+<tr><td colspan="2">The error type of a BlurException.</td></tr>
+<tr><td>UNKNOWN</td><td>Unknown error.</td></tr>
+<tr><td>QUERY_CANCEL</td><td>Query has been cancel.</td></tr>
+<tr><td>QUERY_TIMEOUT</td><td>Query has timed out.</td></tr>
+<tr><td>BACK_PRESSURE</td><td>Server has run out of memory and is
trying to prevent a failure.</td></tr>
+<tr><td>REQUEST_TIMEOUT</td><td>The TCP connection has timed out.</td></tr>
+</table>
 <br/><br/><table class="table-bordered table-striped table-condensed">
 <tr><td><code>UNKNOWN</code></td><td><code>0</code></td></tr>
 <tr><td><code>QUERY_CANCEL</code></td><td><code>1</code></td></tr>
@@ -94,11 +96,13 @@ REQUEST_TIMEOUT - The TCP connection has timed out.<br/>
 <tr><td><code>REQUEST_TIMEOUT</code></td><td><code>4</code></td></tr>
 </table></div>
 <div class="definition"><h3 id="Enum_ScoreType">Enumeration: ScoreType</h3>
-The scoring type used during a SuperQuery to score multi Record hits within a ColumnFamily.<br/><br/>
-SUPER - During a multi Record match, a calculation of the best match Record plus how often
it occurs within the match Row produces the score that is used in the scoring of the SuperQuery.<br/><br/>
-AGGREGATE - During a multi Record match, the aggregate score of all the Records within a
ColumnFamily is used in the scoring of the SuperQuery.<br/><br/>
-BEST - During a multi Record match, the best score of all the Records within a ColumnFamily
is used in the scoring of the SuperQuery.<br/><br/>
-CONSTANT - A constant score of 1 is used in the scoring of the SuperQuery.<br/>
+<table class="table-bordered table-striped table-condensed">
+<tr><td colspan="2">The scoring type used during a SuperQuery to score multi
Record hits within a ColumnFamily.</td></tr>
+<tr><td>SUPER</td><td>During a multi Record match, a calculation
of the best match Record plus how often it occurs within the match Row produces the score
that is used in the scoring of the SuperQuery.</td></tr>
+<tr><td>AGGREGATE</td><td>During a multi Record match, the aggregate
score of all the Records within a ColumnFamily is used in the scoring of the SuperQuery.</td></tr>
+<tr><td>BEST</td><td>During a multi Record match, the best score
of all the Records within a ColumnFamily is used in the scoring of the SuperQuery.</td></tr>
+<tr><td>CONSTANT</td><td>A constant score of 1 is used in the scoring
of the SuperQuery.</td></tr>
+</table>
 <br/><br/><table class="table-bordered table-striped table-condensed">
 <tr><td><code>SUPER</code></td><td><code>0</code></td></tr>
 <tr><td><code>AGGREGATE</code></td><td><code>1</code></td></tr>
@@ -106,10 +110,12 @@ CONSTANT - A constant score of 1 is used in the scoring of the SuperQuery.<br/>
 <tr><td><code>CONSTANT</code></td><td><code>3</code></td></tr>
 </table></div>
 <div class="definition"><h3 id="Enum_QueryState">Enumeration: QueryState</h3>
-The state of a query.<br/><br/>
-RUNNING - Query is running.<br/><br/>
-INTERRUPTED - Query has been interrupted.<br/><br/>
-COMPLETE - Query is complete.<br/>
+<table class="table-bordered table-striped table-condensed">
+<tr><td colspan="2">The state of a query.</td></tr>
+<tr><td>RUNNING</td><td>Query is running.</td></tr>
+<tr><td>INTERRUPTED</td><td>Query has been interrupted.</td></tr>
+<tr><td>COMPLETE</td><td>Query is complete.</td></tr>
+</table>
 <br/><br/><table class="table-bordered table-striped table-condensed">
 <tr><td><code>RUNNING</code></td><td><code>0</code></td></tr>
 <tr><td><code>INTERRUPTED</code></td><td><code>1</code></td></tr>
@@ -117,28 +123,34 @@ COMPLETE - Query is complete.<br/>
 <tr><td><code>BACK_PRESSURE_INTERRUPTED</code></td><td><code>3</code></td></tr>
 </table></div>
 <div class="definition"><h3 id="Enum_Status">Enumeration: Status</h3>
-NOT_FOUND - when UUID is not found<br/><br/>
-FOUND - when UUID is present<br/>
+<table class="table-bordered table-striped table-condensed">
+<tr><td>NOT_FOUND</td><td>Blur status UUID is not found.</td></tr>
+<tr><td>FOUND</td><td>Blur status UUID is present.</td></tr>
+</table>
 <br/><br/><table class="table-bordered table-striped table-condensed">
 <tr><td><code>NOT_FOUND</code></td><td><code>0</code></td></tr>
 <tr><td><code>FOUND</code></td><td><code>1</code></td></tr>
 </table></div>
 <div class="definition"><h3 id="Enum_RowMutationType">Enumeration: RowMutationType</h3>
-Specifies the type of Row mutation that should occur during a mutation of a given Row.<br/><br/>
-DELETE_ROW - Indicates that the entire Row is to be deleted.  No changes are made if the
specified row does not exist.<br/><br/>
-REPLACE_ROW - Indicates that the entire Row is to be deleted, and then a new Row with the
same id is to be added.  If the specified row does not exist, the new row will still be created.<br/><br/>
-UPDATE_ROW - Indicates that mutations of the underlying Records will be processed individually.
 Mutation will result in a BlurException if the specified row does not exist.<br/>
+<table class="table-bordered table-striped table-condensed">
+<tr><td colspan="2">Specifies the type of Row mutation that should occur during
a mutation of a given Row.</td></tr>
+<tr><td>DELETE_ROW</td><td>Indicates that the entire Row is to be
deleted.  No changes are made if the specified row does not exist.</td></tr>
+<tr><td>REPLACE_ROW</td><td>Indicates that the entire Row is to be
deleted, and then a new Row with the same id is to be added.  If the specified row does not
exist, the new row will still be created.</td></tr>
+<tr><td>UPDATE_ROW</td><td>Indicates that mutations of the underlying
Records will be processed individually.  Mutation will result in a BlurException if the specified
row does not exist.</td></tr>
+</table>
 <br/><br/><table class="table-bordered table-striped table-condensed">
 <tr><td><code>DELETE_ROW</code></td><td><code>0</code></td></tr>
 <tr><td><code>REPLACE_ROW</code></td><td><code>1</code></td></tr>
 <tr><td><code>UPDATE_ROW</code></td><td><code>2</code></td></tr>
 </table></div>
 <div class="definition"><h3 id="Enum_RecordMutationType">Enumeration: RecordMutationType</h3>
-Specifies the type of Record mutation that should occur during a mutation of a given Record.<br/><br/>
-DELETE_ENTIRE_RECORD -  Indicates the Record with the given recordId in the given Row is
to be deleted.  If the target record does not exist, then no changes are made.<br/><br/>
-REPLACE_ENTIRE_RECORD - Indicates the Record with the given recordId in the given Row is
to be deleted, and a new Record with the same id is to be added. If the specified record does
not exist the new record is still added.<br/><br/>
-REPLACE_COLUMNS - Replace the columns that are specified in the Record mutation.  If the
target record does not exist then this mutation will result in a BlurException.<br/><br/>
-APPEND_COLUMN_VALUES - Append the columns in the Record mutation to the Record that could
already exist.  If the target record does not exist then this mutation will result in a BlurException.<br/>
+<table class="table-bordered table-striped table-condensed">
+<tr><td colspan="2">Specifies the type of Record mutation that should occur during
a mutation of a given Record.</td></tr>
+<tr><td>DELETE_ENTIRE_RECORD</td><td>Indicates the Record with the
given recordId in the given Row is to be deleted.  If the target record does not exist, then
no changes are made.</td></tr>
+<tr><td>REPLACE_ENTIRE_RECORD</td><td>Indicates the Record with the
given recordId in the given Row is to be deleted, and a new Record with the same id is to
be added. If the specified record does not exist the new record is still added.</td></tr>
+<tr><td>REPLACE_COLUMNS</td><td>Replace the columns that are specified
in the Record mutation.  If the target record does not exist then this mutation will result
in a BlurException.</td></tr>
+<tr><td>APPEND_COLUMN_VALUES</td><td>Append the columns in the Record
mutation to the Record that could already exist.  If the target record does not exist then
this mutation will result in a BlurException.</td></tr>
+</table>
 <br/><br/><table class="table-bordered table-striped table-condensed">
 <tr><td><code>DELETE_ENTIRE_RECORD</code></td><td><code>0</code></td></tr>
 <tr><td><code>REPLACE_ENTIRE_RECORD</code></td><td><code>1</code></td></tr>
@@ -146,7 +158,15 @@ APPEND_COLUMN_VALUES - Append the columns in the Record mutation to the
Record t
 <tr><td><code>APPEND_COLUMN_VALUES</code></td><td><code>3</code></td></tr>
 </table></div>
 <div class="definition"><h3 id="Enum_ShardState">Enumeration: ShardState</h3>
-See shardServerLayoutOptions method in the Blur service for details.
+<table class="table-bordered table-striped table-condensed">
+<tr><td colspan="2">The shard state, see shardServerLayoutOptions method in the
Blur service for details.</td></tr>
+<tr><td>OPENING</td><td>The shard is opening.</td></tr>
+<tr><td>OPEN</td><td>The shard is open.</td></tr>
+<tr><td>OPENING_ERROR</td><td>An error during the opening of the
shard.</td></tr>
+<tr><td>CLOSING</td><td>In the process of closing.</td></tr>
+<tr><td>CLOSED</td><td>The shard is closed.</td></tr>
+<tr><td>CLOSING_ERROR</td><td>An error during the closing of the
shard.</td></tr>
+</table>
 <br/><br/><table class="table-bordered table-striped table-condensed">
 <tr><td><code>OPENING</code></td><td><code>0</code></td></tr>
 <tr><td><code>OPEN</code></td><td><code>1</code></td></tr>
@@ -484,56 +504,48 @@ updates through MapReduce are allowed and in fact they are only allowed
if the t
 <h3 id="Svc_Blur">Service: Blur</h3>
 The Blur service API.  This API is the same for both controller servers as well as
 shards servers.  Each of the methods are documented.
-<br/><div class="definition"><h4 id="Fn_Blur_shardClusterList">Function:
Blur.shardClusterList</h4>
-<pre><code>list&lt;<code>string</code>&gt;</code> shardClusterList()
-    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Returns a list of all the shard clusters.
-@return list of all the shard clusters.
-<br/></div><div class="definition"><h4 id="Fn_Blur_shardServerList">Function:
Blur.shardServerList</h4>
-<pre><code>list&lt;<code>string</code>&gt;</code> shardServerList(<code>string</code>
cluster)
+<br/><div class="definition"><h4 id="Fn_Blur_createTable">Function: Blur.createTable</h4>
+<pre><code>void</code> createTable(<code><a href="Blur.html#Struct_TableDescriptor">TableDescriptor</a></code>
tableDescriptor)
     throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Returns a list of all the shard servers for the given cluster.
-@return list of all the shard servers within the cluster.
-<br/><br/><h4 id="Parameters_Blur_shardServerList">Parameters</h4>
-<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>cluster</td><td>the
cluster name.
+</pre>Creates a table with the given TableDescriptor.
+<br/><br/><h4 id="Parameters_Blur_createTable">Parameters</h4>
+<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>tableDescriptor</td><td>the
TableDescriptor.
 </td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_controllerServerList">Function:
Blur.controllerServerList</h4>
-<pre><code>list&lt;<code>string</code>&gt;</code> controllerServerList()
+</table></div><div class="definition"><h4 id="Fn_Blur_enableTable">Function:
Blur.enableTable</h4>
+<pre><code>void</code> enableTable(<code>string</code> table)
     throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Returns a list of all the controller servers.
-@return list of all the controllers.
-<br/></div><div class="definition"><h4 id="Fn_Blur_shardServerLayout">Function:
Blur.shardServerLayout</h4>
-<pre><code>map&lt;<code>string</code>, <code>string</code>&gt;</code>
shardServerLayout(<code>string</code> table)
+</pre>Enables the given table, blocking until all shards are online.
+<br/><br/><h4 id="Parameters_Blur_enableTable">Parameters</h4>
+<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
+</td></tr>
+</table></div><div class="definition"><h4 id="Fn_Blur_disableTable">Function:
Blur.disableTable</h4>
+<pre><code>void</code> disableTable(<code>string</code> table)
     throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Returns a map of the layout of the given table, where the key is the shard name
-and the value is the shard server.<br><br>
-This method will return the "correct" layout for the given shard, or the
-"correct" layout of cluster if called on a controller.<br><br>
-The meaning of correct:<br>Given the current state of the shard cluster with failures
taken
-into account, the correct layout is what the layout should be given the current state.  In
-other words, what the shard server should be serving.  The act of calling the shard
-server layout method with the NORMAL option will block until the layout shard server
-matches the correct layout.  Meaning it will block until indexes that should be open are
-open and ready for queries.  However indexes are lazily closed, so if a table is being
-disabled then the call will return immediately with an empty map, but the indexes may
-not be close yet.<br><br>
-@return map of shards in a table to the shard servers.
-<br/><br/><h4 id="Parameters_Blur_shardServerLayout">Parameters</h4>
+</pre>Disables the given table, blocking until all shards are offline.
+<br/><br/><h4 id="Parameters_Blur_disableTable">Parameters</h4>
 <table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
 </td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_shardServerLayoutState">Function:
Blur.shardServerLayoutState</h4>
-<pre><code>map&lt;<code>string</code>, <code>map&lt;<code>string</code>,
<code><a href="Blur.html#Enum_ShardState">ShardState</a></code>&gt;</code>&gt;</code>
shardServerLayoutState(<code>string</code> table)
+</table></div><div class="definition"><h4 id="Fn_Blur_removeTable">Function:
Blur.removeTable</h4>
+<pre><code>void</code> removeTable(<code>string</code> table,
+                 <code>bool</code> deleteIndexFiles)
     throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Returns a map of the layout of the given table, where the key is the shard name
and the
-value is the shard server.<br><br>
-This method will return immediately with what shards are currently
-open in the shard server.  So if a shard is being moved to another server and is being
-closed by this server it WILL be returned in the map.  The shardServerLayout method would
not return
-the shard given the same situation.
-@return map of shards to a map of shard servers with the state of the shard.
-<br/><br/><h4 id="Parameters_Blur_shardServerLayoutState">Parameters</h4>
+</pre>Removes the given table, with an optional to delete the underlying index storage
as well.
+<br/><br/><h4 id="Parameters_Blur_removeTable">Parameters</h4>
 <table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
 </td></tr>
+<tr><td>deleteIndexFiles</td><td>true to remove the index storage
and false if to preserve.
+</td></tr>
+</table></div><div class="definition"><h4 id="Fn_Blur_addColumnDefinition">Function:
Blur.addColumnDefinition</h4>
+<pre><code>bool</code> addColumnDefinition(<code>string</code>
table,
+                         <code><a href="Blur.html#Struct_ColumnDefinition">ColumnDefinition</a></code>
columnDefinition)
+    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
+</pre>Attempts to add a column definition to the given table.
+@return true if successfully defined false if not.
+<br/><br/><h4 id="Parameters_Blur_addColumnDefinition">Parameters</h4>
+<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
name of the table.
+</td></tr>
+<tr><td>columnDefinition</td><td>the ColumnDefinition.
+</td></tr>
 </table></div><div class="definition"><h4 id="Fn_Blur_tableList">Function:
Blur.tableList</h4>
 <pre><code>list&lt;<code>string</code>&gt;</code> tableList()
     throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
@@ -555,7 +567,58 @@ the shard given the same situation.
 <br/><br/><h4 id="Parameters_Blur_describe">Parameters</h4>
 <table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
 </td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_query">Function:
Blur.query</h4>
+</table></div><div class="definition"><h4 id="Fn_Blur_schema">Function:
Blur.schema</h4>
+<pre><code><a href="Blur.html#Struct_Schema">Schema</a></code>
schema(<code>string</code> table)
+    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
+</pre>Gets the schema for a given table.
+@return Schema.
+<br/><br/><h4 id="Parameters_Blur_schema">Parameters</h4>
+<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
+</td></tr>
+</table></div><div class="definition"><h4 id="Fn_Blur_parseQuery">Function:
Blur.parseQuery</h4>
+<pre><code>string</code> parseQuery(<code>string</code> table,
+                  <code><a href="Blur.html#Struct_SimpleQuery">SimpleQuery</a></code>
simpleQuery)
+    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
+</pre>Parses the given query and return the string represents the query.
+@return string representation of the parsed query.
+<br/><br/><h4 id="Parameters_Blur_parseQuery">Parameters</h4>
+<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
+</td></tr>
+<tr><td>simpleQuery</td><td>the query to parse.
+</td></tr>
+</table></div><div class="definition"><h4 id="Fn_Blur_tableStats">Function:
Blur.tableStats</h4>
+<pre><code><a href="Blur.html#Struct_TableStats">TableStats</a></code>
tableStats(<code>string</code> table)
+    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
+</pre>Gets the table stats for the given table.
+@return TableStats.
+<br/><br/><h4 id="Parameters_Blur_tableStats">Parameters</h4>
+<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
+</td></tr>
+</table></div><div class="definition"><h4 id="Fn_Blur_optimize">Function:
Blur.optimize</h4>
+<pre><code>void</code> optimize(<code>string</code> table,
+              <code>i32</code> numberOfSegmentsPerShard)
+    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
+</pre>Will perform a forced optimize on the index in the given table.
+<br/><br/><h4 id="Parameters_Blur_optimize">Parameters</h4>
+<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>table
the name of the table.
+</td></tr>
+<tr><td>numberOfSegmentsPerShard</td><td>the maximum of segments
per shard index after the operation is completed.
+</td></tr>
+</table></div><div class="definition"><h4 id="Fn_Blur_createSnapshot">Function:
Blur.createSnapshot</h4>
+<pre><code>void</code> createSnapshot(<code>string</code> table,
+                    <code>string</code> name)
+    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
+</pre>Creates a snapshot for the table with the given name
+<br/></div><div class="definition"><h4 id="Fn_Blur_removeSnapshot">Function:
Blur.removeSnapshot</h4>
+<pre><code>void</code> removeSnapshot(<code>string</code> table,
+                    <code>string</code> name)
+    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
+</pre>Removes a previous snapshot(identified by name) of the table
+<br/></div><div class="definition"><h4 id="Fn_Blur_listSnapshots">Function:
Blur.listSnapshots</h4>
+<pre><code>map&lt;<code>string</code>, <code>list&lt;<code>string</code>&gt;</code>&gt;</code>
listSnapshots(<code>string</code> table)
+    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
+</pre>Returns a map where the key is the shard, and the list is the snapshots within
that shard
+<br/></div><div class="definition"><h4 id="Fn_Blur_query">Function:
Blur.query</h4>
 <pre><code><a href="Blur.html#Struct_BlurResults">BlurResults</a></code>
query(<code>string</code> table,
                   <code><a href="Blur.html#Struct_BlurQuery">BlurQuery</a></code>
blurQuery)
     throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
@@ -570,16 +633,30 @@ the shard server, if any.
 </td></tr>
 <tr><td>blurQuery</td><td>the query to execute.
 </td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_parseQuery">Function:
Blur.parseQuery</h4>
-<pre><code>string</code> parseQuery(<code>string</code> table,
-                  <code><a href="Blur.html#Struct_SimpleQuery">SimpleQuery</a></code>
simpleQuery)
+</table></div><div class="definition"><h4 id="Fn_Blur_fetchRow">Function:
Blur.fetchRow</h4>
+<pre><code><a href="Blur.html#Struct_FetchResult">FetchResult</a></code>
fetchRow(<code>string</code> table,
+                     <code><a href="Blur.html#Struct_Selector">Selector</a></code>
selector)
     throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Parses the given query and return the string represents the query.
-@return string representation of the parsed query.
-<br/><br/><h4 id="Parameters_Blur_parseQuery">Parameters</h4>
+</pre>Fetches a Row or a Record in the given table with the given Selector.
+@return the FetchResult.
+<br/><br/><h4 id="Parameters_Blur_fetchRow">Parameters</h4>
 <table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
 </td></tr>
-<tr><td>simpleQuery</td><td>the query to parse.
+<tr><td>selector</td><td>the Selector to use to fetch the Row or
Record.
+</td></tr>
+</table></div><div class="definition"><h4 id="Fn_Blur_mutate">Function:
Blur.mutate</h4>
+<pre><code>void</code> mutate(<code><a href="Blur.html#Struct_RowMutation">RowMutation</a></code>
mutation)
+    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
+</pre>Mutates a Row given the RowMutation the is provided.
+<br/><br/><h4 id="Parameters_Blur_mutate">Parameters</h4>
+<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>mutation</td><td>the
RowMutation.
+</td></tr>
+</table></div><div class="definition"><h4 id="Fn_Blur_mutateBatch">Function:
Blur.mutateBatch</h4>
+<pre><code>void</code> mutateBatch(<code>list&lt;<code><a
href="Blur.html#Struct_RowMutation">RowMutation</a></code>&gt;</code>
mutations)
+    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
+</pre>Mutates a group of Rows given the list of RowMutations that are provided.  Note:
This is not an atomic operation.
+<br/><br/><h4 id="Parameters_Blur_mutateBatch">Parameters</h4>
+<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>mutations</td><td>the
batch of RowMutations.
 </td></tr>
 </table></div><div class="definition"><h4 id="Fn_Blur_cancelQuery">Function:
Blur.cancelQuery</h4>
 <pre><code>void</code> cancelQuery(<code>string</code> table,
@@ -611,22 +688,6 @@ cancel call maybe take some time for the query actually stops executing.
 </td></tr>
 <tr><td>uuid</td><td>the uuid of the query.
 </td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_schema">Function:
Blur.schema</h4>
-<pre><code><a href="Blur.html#Struct_Schema">Schema</a></code>
schema(<code>string</code> table)
-    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Gets the schema for a given table.
-@return Schema.
-<br/><br/><h4 id="Parameters_Blur_schema">Parameters</h4>
-<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
-</td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_tableStats">Function:
Blur.tableStats</h4>
-<pre><code><a href="Blur.html#Struct_TableStats">TableStats</a></code>
tableStats(<code>string</code> table)
-    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Gets the table stats for the given table.
-@return TableStats.
-<br/><br/><h4 id="Parameters_Blur_tableStats">Parameters</h4>
-<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
-</td></tr>
 </table></div><div class="definition"><h4 id="Fn_Blur_terms">Function:
Blur.terms</h4>
 <pre><code>list&lt;<code>string</code>&gt;</code> terms(<code>string</code>
table,
                    <code>string</code> columnFamily,
@@ -666,83 +727,56 @@ string and text field types.
 </td></tr>
 <tr><td>value</td><td>the value.
 </td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_fetchRow">Function:
Blur.fetchRow</h4>
-<pre><code><a href="Blur.html#Struct_FetchResult">FetchResult</a></code>
fetchRow(<code>string</code> table,
-                     <code><a href="Blur.html#Struct_Selector">Selector</a></code>
selector)
-    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Fetches a Row or a Record in the given table with the given Selector.
-@return the FetchResult.
-<br/><br/><h4 id="Parameters_Blur_fetchRow">Parameters</h4>
-<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
-</td></tr>
-<tr><td>selector</td><td>the Selector to use to fetch the Row or
Record.
-</td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_mutate">Function:
Blur.mutate</h4>
-<pre><code>void</code> mutate(<code><a href="Blur.html#Struct_RowMutation">RowMutation</a></code>
mutation)
-    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Mutates a Row given the RowMutation the is provided.
-<br/><br/><h4 id="Parameters_Blur_mutate">Parameters</h4>
-<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>mutation</td><td>the
RowMutation.
-</td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_mutateBatch">Function:
Blur.mutateBatch</h4>
-<pre><code>void</code> mutateBatch(<code>list&lt;<code><a
href="Blur.html#Struct_RowMutation">RowMutation</a></code>&gt;</code>
mutations)
+</table></div><div class="definition"><h4 id="Fn_Blur_shardClusterList">Function:
Blur.shardClusterList</h4>
+<pre><code>list&lt;<code>string</code>&gt;</code> shardClusterList()
     throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Mutates a group of Rows given the list of RowMutations that are provided.  Note:
This is not an atomic operation.
-<br/><br/><h4 id="Parameters_Blur_mutateBatch">Parameters</h4>
-<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>mutations</td><td>the
batch of RowMutations.
-</td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_createTable">Function:
Blur.createTable</h4>
-<pre><code>void</code> createTable(<code><a href="Blur.html#Struct_TableDescriptor">TableDescriptor</a></code>
tableDescriptor)
+</pre>Returns a list of all the shard clusters.
+@return list of all the shard clusters.
+<br/></div><div class="definition"><h4 id="Fn_Blur_shardServerList">Function:
Blur.shardServerList</h4>
+<pre><code>list&lt;<code>string</code>&gt;</code> shardServerList(<code>string</code>
cluster)
     throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Creates a table with the given TableDescriptor.
-<br/><br/><h4 id="Parameters_Blur_createTable">Parameters</h4>
-<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>tableDescriptor</td><td>the
TableDescriptor.
+</pre>Returns a list of all the shard servers for the given cluster.
+@return list of all the shard servers within the cluster.
+<br/><br/><h4 id="Parameters_Blur_shardServerList">Parameters</h4>
+<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>cluster</td><td>the
cluster name.
 </td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_enableTable">Function:
Blur.enableTable</h4>
-<pre><code>void</code> enableTable(<code>string</code> table)
+</table></div><div class="definition"><h4 id="Fn_Blur_controllerServerList">Function:
Blur.controllerServerList</h4>
+<pre><code>list&lt;<code>string</code>&gt;</code> controllerServerList()
     throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Enables the given table, blocking until all shards are online.
-<br/><br/><h4 id="Parameters_Blur_enableTable">Parameters</h4>
-<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
-</td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_disableTable">Function:
Blur.disableTable</h4>
-<pre><code>void</code> disableTable(<code>string</code> table)
+</pre>Returns a list of all the controller servers.
+@return list of all the controllers.
+<br/></div><div class="definition"><h4 id="Fn_Blur_shardServerLayout">Function:
Blur.shardServerLayout</h4>
+<pre><code>map&lt;<code>string</code>, <code>string</code>&gt;</code>
shardServerLayout(<code>string</code> table)
     throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Disables the given table, blocking until all shards are offline.
-<br/><br/><h4 id="Parameters_Blur_disableTable">Parameters</h4>
+</pre>Returns a map of the layout of the given table, where the key is the shard name
+and the value is the shard server.<br><br>
+This method will return the "correct" layout for the given shard, or the
+"correct" layout of cluster if called on a controller.<br><br>
+The meaning of correct:<br>Given the current state of the shard cluster with failures
taken
+into account, the correct layout is what the layout should be given the current state.  In
+other words, what the shard server should be serving.  The act of calling the shard
+server layout method with the NORMAL option will block until the layout shard server
+matches the correct layout.  Meaning it will block until indexes that should be open are
+open and ready for queries.  However indexes are lazily closed, so if a table is being
+disabled then the call will return immediately with an empty map, but the indexes may
+not be close yet.<br><br>
+@return map of shards in a table to the shard servers.
+<br/><br/><h4 id="Parameters_Blur_shardServerLayout">Parameters</h4>
 <table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
 </td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_removeTable">Function:
Blur.removeTable</h4>
-<pre><code>void</code> removeTable(<code>string</code> table,
-                 <code>bool</code> deleteIndexFiles)
+</table></div><div class="definition"><h4 id="Fn_Blur_shardServerLayoutState">Function:
Blur.shardServerLayoutState</h4>
+<pre><code>map&lt;<code>string</code>, <code>map&lt;<code>string</code>,
<code><a href="Blur.html#Enum_ShardState">ShardState</a></code>&gt;</code>&gt;</code>
shardServerLayoutState(<code>string</code> table)
     throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Removes the given table, with an optional to delete the underlying index storage
as well.
-<br/><br/><h4 id="Parameters_Blur_removeTable">Parameters</h4>
+</pre>Returns a map of the layout of the given table, where the key is the shard name
and the
+value is the shard server.<br><br>
+This method will return immediately with what shards are currently
+open in the shard server.  So if a shard is being moved to another server and is being
+closed by this server it WILL be returned in the map.  The shardServerLayout method would
not return
+the shard given the same situation.
+@return map of shards to a map of shard servers with the state of the shard.
+<br/><br/><h4 id="Parameters_Blur_shardServerLayoutState">Parameters</h4>
 <table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
table name.
 </td></tr>
-<tr><td>deleteIndexFiles</td><td>true to remove the index storage
and false if to preserve.
-</td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_addColumnDefinition">Function:
Blur.addColumnDefinition</h4>
-<pre><code>bool</code> addColumnDefinition(<code>string</code>
table,
-                         <code><a href="Blur.html#Struct_ColumnDefinition">ColumnDefinition</a></code>
columnDefinition)
-    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Attempts to add a column definition to the given table.
-@return true if successfully defined false if not.
-<br/><br/><h4 id="Parameters_Blur_addColumnDefinition">Parameters</h4>
-<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>the
name of the table.
-</td></tr>
-<tr><td>columnDefinition</td><td>the ColumnDefinition.
-</td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_optimize">Function:
Blur.optimize</h4>
-<pre><code>void</code> optimize(<code>string</code> table,
-              <code>i32</code> numberOfSegmentsPerShard)
-    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Will perform a forced optimize on the index in the given table.
-<br/><br/><h4 id="Parameters_Blur_optimize">Parameters</h4>
-<table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>table</td><td>table
the name of the table.
-</td></tr>
-<tr><td>numberOfSegmentsPerShard</td><td>the maximum of segments
per shard index after the operation is completed.
-</td></tr>
 </table></div><div class="definition"><h4 id="Fn_Blur_isInSafeMode">Function:
Blur.isInSafeMode</h4>
 <pre><code>bool</code> isInSafeMode(<code>string</code> cluster)
     throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
@@ -764,18 +798,4 @@ string and text field types.
 <br/><br/><h4 id="Parameters_Blur_metrics">Parameters</h4>
 <table class="table-bordered table-striped table-condensed"><thead><th>Name</th><th>Description</th></thead><tr><td>metrics</td><td>the
names of the metrics to return.  If null all are returned.
 </td></tr>
-</table></div><div class="definition"><h4 id="Fn_Blur_createSnapshot">Function:
Blur.createSnapshot</h4>
-<pre><code>void</code> createSnapshot(<code>string</code> table,
-                    <code>string</code> name)
-    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Creates a snapshot for the table with the given name
-<br/></div><div class="definition"><h4 id="Fn_Blur_removeSnapshot">Function:
Blur.removeSnapshot</h4>
-<pre><code>void</code> removeSnapshot(<code>string</code> table,
-                    <code>string</code> name)
-    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Removes a previous snapshot(identified by name) of the table
-<br/></div><div class="definition"><h4 id="Fn_Blur_listSnapshots">Function:
Blur.listSnapshots</h4>
-<pre><code>map&lt;<code>string</code>, <code>list&lt;<code>string</code>&gt;</code>&gt;</code>
listSnapshots(<code>string</code> table)
-    throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Returns a map where the key is the shard, and the list is the snapshots within
that shard
-<br/></div></div></body></html>
+</table></div></div></body></html>


Mime
View raw message