incubator-blur-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From amccu...@apache.org
Subject git commit: Added documenation for the blur query status object.
Date Mon, 03 Jun 2013 17:34:26 GMT
Updated Branches:
  refs/heads/0.1.5 7307508e0 -> bfd388773


Added documenation for the blur query status object.


Project: http://git-wip-us.apache.org/repos/asf/incubator-blur/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-blur/commit/bfd38877
Tree: http://git-wip-us.apache.org/repos/asf/incubator-blur/tree/bfd38877
Diff: http://git-wip-us.apache.org/repos/asf/incubator-blur/diff/bfd38877

Branch: refs/heads/0.1.5
Commit: bfd388773d3f8d7a14064525097b7e170ec728ea
Parents: 7307508
Author: Aaron McCurry <amccurry@gmail.com>
Authored: Mon Jun 3 13:34:00 2013 -0400
Committer: Aaron McCurry <amccurry@gmail.com>
Committed: Mon Jun 3 13:34:00 2013 -0400

----------------------------------------------------------------------
 .../blur/thrift/generated/BlurQueryStatus.java     |   68 +++++++++------
 .../org/apache/blur/thrift/generated/CpuTime.java  |   18 ++--
 .../src/main/scripts/interface/Blur.thrift         |   26 ++++--
 .../src/main/scripts/interface/gen-html/Blur.html  |   26 ++++--
 .../blur/thrift/generated/BlurQueryStatus.java     |   68 +++++++++------
 .../org/apache/blur/thrift/generated/CpuTime.java  |   18 ++--
 .../main/scripts/interface/gen-rb/blur_types.rb    |   26 ++++--
 7 files changed, 152 insertions(+), 98 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/bfd38877/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/BlurQueryStatus.java
----------------------------------------------------------------------
diff --git a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/BlurQueryStatus.java
b/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/BlurQueryStatus.java
index 9c881db..d7ade13 100644
--- a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/BlurQueryStatus.java
+++ b/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/BlurQueryStatus.java
@@ -50,7 +50,9 @@ import java.util.Arrays;
 //import org.slf4j.LoggerFactory;
 
 /**
- * 
+ * The BlurQueryStatus object hold the status of BlurQueries.  The state of the query
+ * (QueryState), the number of shards the query is executing against, the number of
+ * shards that are complete, etc.
  */
 public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.TBase<BlurQueryStatus,
BlurQueryStatus._Fields>, java.io.Serializable, Cloneable {
   private static final org.apache.blur.thirdparty.thrift_0_9_0.protocol.TStruct STRUCT_DESC
= new org.apache.blur.thirdparty.thrift_0_9_0.protocol.TStruct("BlurQueryStatus");
@@ -69,58 +71,66 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The original query.
    */
   public BlurQuery query; // required
   /**
-   * 
+   * A map of shard names to CpuTime, one for each shard in the table.
    */
   public Map<String,CpuTime> cpuTimes; // required
   /**
-   * 
+   * The number of completed shards.  The shard server will respond with
+   * how many are complete on that server, while the controller will aggregate
+   * all the shard server completed totals together.
    */
   public int completeShards; // required
   /**
-   * 
+   * The total number of shards that the query is executing against.  The shard
+   * server will respond with how many shards are being queried on that server, while
+   * the controller will aggregate all the shard server totals together.
    */
   public int totalShards; // required
   /**
-   * 
+   * The state of the query.  e.g. RUNNING, INTERRUPTED, COMPLETE
    * 
    * @see QueryState
    */
   public QueryState state; // required
   /**
-   * 
+   * The uuid of the query.
    */
   public long uuid; // required
 
   /** The set of fields this struct contains, along with convenience methods for finding
and manipulating them. */
   public enum _Fields implements org.apache.blur.thirdparty.thrift_0_9_0.TFieldIdEnum {
     /**
-     * 
+     * The original query.
      */
     QUERY((short)1, "query"),
     /**
-     * 
+     * A map of shard names to CpuTime, one for each shard in the table.
      */
     CPU_TIMES((short)2, "cpuTimes"),
     /**
-     * 
+     * The number of completed shards.  The shard server will respond with
+     * how many are complete on that server, while the controller will aggregate
+     * all the shard server completed totals together.
      */
     COMPLETE_SHARDS((short)3, "completeShards"),
     /**
-     * 
+     * The total number of shards that the query is executing against.  The shard
+     * server will respond with how many shards are being queried on that server, while
+     * the controller will aggregate all the shard server totals together.
      */
     TOTAL_SHARDS((short)4, "totalShards"),
     /**
-     * 
+     * The state of the query.  e.g. RUNNING, INTERRUPTED, COMPLETE
      * 
      * @see QueryState
      */
     STATE((short)5, "state"),
     /**
-     * 
+     * The uuid of the query.
      */
     UUID((short)6, "uuid");
 
@@ -286,14 +296,14 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The original query.
    */
   public BlurQuery getQuery() {
     return this.query;
   }
 
   /**
-   * 
+   * The original query.
    */
   public BlurQueryStatus setQuery(BlurQuery query) {
     this.query = query;
@@ -327,14 +337,14 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * A map of shard names to CpuTime, one for each shard in the table.
    */
   public Map<String,CpuTime> getCpuTimes() {
     return this.cpuTimes;
   }
 
   /**
-   * 
+   * A map of shard names to CpuTime, one for each shard in the table.
    */
   public BlurQueryStatus setCpuTimes(Map<String,CpuTime> cpuTimes) {
     this.cpuTimes = cpuTimes;
@@ -357,14 +367,18 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The number of completed shards.  The shard server will respond with
+   * how many are complete on that server, while the controller will aggregate
+   * all the shard server completed totals together.
    */
   public int getCompleteShards() {
     return this.completeShards;
   }
 
   /**
-   * 
+   * The number of completed shards.  The shard server will respond with
+   * how many are complete on that server, while the controller will aggregate
+   * all the shard server completed totals together.
    */
   public BlurQueryStatus setCompleteShards(int completeShards) {
     this.completeShards = completeShards;
@@ -386,14 +400,18 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The total number of shards that the query is executing against.  The shard
+   * server will respond with how many shards are being queried on that server, while
+   * the controller will aggregate all the shard server totals together.
    */
   public int getTotalShards() {
     return this.totalShards;
   }
 
   /**
-   * 
+   * The total number of shards that the query is executing against.  The shard
+   * server will respond with how many shards are being queried on that server, while
+   * the controller will aggregate all the shard server totals together.
    */
   public BlurQueryStatus setTotalShards(int totalShards) {
     this.totalShards = totalShards;
@@ -415,7 +433,7 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The state of the query.  e.g. RUNNING, INTERRUPTED, COMPLETE
    * 
    * @see QueryState
    */
@@ -424,7 +442,7 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The state of the query.  e.g. RUNNING, INTERRUPTED, COMPLETE
    * 
    * @see QueryState
    */
@@ -449,14 +467,14 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The uuid of the query.
    */
   public long getUuid() {
     return this.uuid;
   }
 
   /**
-   * 
+   * The uuid of the query.
    */
   public BlurQueryStatus setUuid(long uuid) {
     this.uuid = uuid;

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/bfd38877/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/CpuTime.java
----------------------------------------------------------------------
diff --git a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/CpuTime.java b/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/CpuTime.java
index 297882b..bbc1ab9 100644
--- a/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/CpuTime.java
+++ b/src/blur-thrift/src/main/java/org/apache/blur/thrift/generated/CpuTime.java
@@ -50,7 +50,7 @@ import java.util.Arrays;
 //import org.slf4j.LoggerFactory;
 
 /**
- * 
+ * Holds the cpu time for a query executing on a single shard in a table.
  */
 public class CpuTime implements org.apache.blur.thirdparty.thrift_0_9_0.TBase<CpuTime,
CpuTime._Fields>, java.io.Serializable, Cloneable {
   private static final org.apache.blur.thirdparty.thrift_0_9_0.protocol.TStruct STRUCT_DESC
= new org.apache.blur.thirdparty.thrift_0_9_0.protocol.TStruct("CpuTime");
@@ -65,22 +65,22 @@ public class CpuTime implements org.apache.blur.thirdparty.thrift_0_9_0.TBase<Cp
   }
 
   /**
-   * 
+   * The total cpu time for the query on the given shard.
    */
   public long cpuTime; // required
   /**
-   * 
+   * The real time of the query execution for a given shard.
    */
   public long realTime; // required
 
   /** The set of fields this struct contains, along with convenience methods for finding
and manipulating them. */
   public enum _Fields implements org.apache.blur.thirdparty.thrift_0_9_0.TFieldIdEnum {
     /**
-     * 
+     * The total cpu time for the query on the given shard.
      */
     CPU_TIME((short)1, "cpuTime"),
     /**
-     * 
+     * The real time of the query execution for a given shard.
      */
     REAL_TIME((short)2, "realTime");
 
@@ -191,14 +191,14 @@ public class CpuTime implements org.apache.blur.thirdparty.thrift_0_9_0.TBase<Cp
   }
 
   /**
-   * 
+   * The total cpu time for the query on the given shard.
    */
   public long getCpuTime() {
     return this.cpuTime;
   }
 
   /**
-   * 
+   * The total cpu time for the query on the given shard.
    */
   public CpuTime setCpuTime(long cpuTime) {
     this.cpuTime = cpuTime;
@@ -220,14 +220,14 @@ public class CpuTime implements org.apache.blur.thirdparty.thrift_0_9_0.TBase<Cp
   }
 
   /**
-   * 
+   * The real time of the query execution for a given shard.
    */
   public long getRealTime() {
     return this.realTime;
   }
 
   /**
-   * 
+   * The real time of the query execution for a given shard.
    */
   public CpuTime setRealTime(long realTime) {
     this.realTime = realTime;

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/bfd38877/src/distribution/src/main/scripts/interface/Blur.thrift
----------------------------------------------------------------------
diff --git a/src/distribution/src/main/scripts/interface/Blur.thrift b/src/distribution/src/main/scripts/interface/Blur.thrift
index 1936287..163c440 100644
--- a/src/distribution/src/main/scripts/interface/Blur.thrift
+++ b/src/distribution/src/main/scripts/interface/Blur.thrift
@@ -458,45 +458,51 @@ struct RowMutation {
 }
 
 /**
- *
+ * Holds the cpu time for a query executing on a single shard in a table.
  */
 struct CpuTime {
   /**
-   *
+   * The total cpu time for the query on the given shard.
    */
   1:i64 cpuTime,
   /**
-   *
+   * The real time of the query execution for a given shard.
    */
   2:i64 realTime
 }
 
 /**
- *
+ * The BlurQueryStatus object hold the status of BlurQueries.  The state of the query
+ * (QueryState), the number of shards the query is executing against, the number of 
+ * shards that are complete, etc.
  */
 struct BlurQueryStatus {
   /**
-   *
+   * The original query.
    */
   1:BlurQuery query,
   /**
-   *
+   * A map of shard names to CpuTime, one for each shard in the table.
    */
   2:map<string,CpuTime> cpuTimes,
   /**
-   *
+   * The number of completed shards.  The shard server will respond with 
+   * how many are complete on that server, while the controller will aggregate 
+   * all the shard server completed totals together.
    */
   3:i32 completeShards,
   /**
-   *
+   * The total number of shards that the query is executing against.  The shard 
+   * server will respond with how many shards are being queried on that server, while 
+   * the controller will aggregate all the shard server totals together.
    */
   4:i32 totalShards,
   /**
-   *
+   * The state of the query.  e.g. RUNNING, INTERRUPTED, COMPLETE
    */
   5:QueryState state,
   /**
-   *
+   * The uuid of the query.
    */
   6:i64 uuid
 }

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/bfd38877/src/distribution/src/main/scripts/interface/gen-html/Blur.html
----------------------------------------------------------------------
diff --git a/src/distribution/src/main/scripts/interface/gen-html/Blur.html b/src/distribution/src/main/scripts/interface/gen-html/Blur.html
index 05d04ec..c945b1c 100644
--- a/src/distribution/src/main/scripts/interface/gen-html/Blur.html
+++ b/src/distribution/src/main/scripts/interface/gen-html/Blur.html
@@ -323,26 +323,32 @@ records in the row, be careful.
 </table><br/><p/>
 <br/></div><div class="definition"><h3 id="Struct_CpuTime">Struct:
CpuTime</h3>
 <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default
value</th></thead>
-<tr><td>1</td><td>cpuTime</td><td><code>i64</code></td><td>
+<tr><td>1</td><td>cpuTime</td><td><code>i64</code></td><td>The
total cpu time for the query on the given shard.
 </td><td>default</td><td></td></tr>
-<tr><td>2</td><td>realTime</td><td><code>i64</code></td><td>
+<tr><td>2</td><td>realTime</td><td><code>i64</code></td><td>The
real time of the query execution for a given shard.
 </td><td>default</td><td></td></tr>
-</table><br/><p/>
+</table><br/>Holds the cpu time for a query executing on a single shard in a
table.
 <br/></div><div class="definition"><h3 id="Struct_BlurQueryStatus">Struct:
BlurQueryStatus</h3>
 <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default
value</th></thead>
-<tr><td>1</td><td>query</td><td><code><a href="Blur.html#Struct_BlurQuery">BlurQuery</a></code></td><td>
+<tr><td>1</td><td>query</td><td><code><a href="Blur.html#Struct_BlurQuery">BlurQuery</a></code></td><td>The
original query.
 </td><td>default</td><td></td></tr>
-<tr><td>2</td><td>cpuTimes</td><td><code>map&lt;<code>string</code>,
<code><a href="Blur.html#Struct_CpuTime">CpuTime</a></code>&gt;</code></td><td>
+<tr><td>2</td><td>cpuTimes</td><td><code>map&lt;<code>string</code>,
<code><a href="Blur.html#Struct_CpuTime">CpuTime</a></code>&gt;</code></td><td>A
map of shard names to CpuTime, one for each shard in the table.
 </td><td>default</td><td></td></tr>
-<tr><td>3</td><td>completeShards</td><td><code>i32</code></td><td>
+<tr><td>3</td><td>completeShards</td><td><code>i32</code></td><td>The
number of completed shards.  The shard server will respond with
+how many are complete on that server, while the controller will aggregate
+all the shard server completed totals together.
 </td><td>default</td><td></td></tr>
-<tr><td>4</td><td>totalShards</td><td><code>i32</code></td><td>
+<tr><td>4</td><td>totalShards</td><td><code>i32</code></td><td>The
total number of shards that the query is executing against.  The shard
+server will respond with how many shards are being queried on that server, while
+the controller will aggregate all the shard server totals together.
 </td><td>default</td><td></td></tr>
-<tr><td>5</td><td>state</td><td><code><a href="Blur.html#Enum_QueryState">QueryState</a></code></td><td>
+<tr><td>5</td><td>state</td><td><code><a href="Blur.html#Enum_QueryState">QueryState</a></code></td><td>The
state of the query.  e.g. RUNNING, INTERRUPTED, COMPLETE
 </td><td>default</td><td></td></tr>
-<tr><td>6</td><td>uuid</td><td><code>i64</code></td><td>
+<tr><td>6</td><td>uuid</td><td><code>i64</code></td><td>The
uuid of the query.
 </td><td>default</td><td></td></tr>
-</table><br/><p/>
+</table><br/>The BlurQueryStatus object hold the status of BlurQueries.  The
state of the query
+(QueryState), the number of shards the query is executing against, the number of
+shards that are complete, etc.
 <br/></div><div class="definition"><h3 id="Struct_TableStats">Struct:
TableStats</h3>
 <table class="table-bordered table-striped table-condensed"><thead><th>Key</th><th>Field</th><th>Type</th><th>Description</th><th>Requiredness</th><th>Default
value</th></thead>
 <tr><td>1</td><td>tableName</td><td><code>string</code></td><td>

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/bfd38877/src/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/BlurQueryStatus.java
----------------------------------------------------------------------
diff --git a/src/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/BlurQueryStatus.java
b/src/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/BlurQueryStatus.java
index 9c881db..d7ade13 100644
--- a/src/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/BlurQueryStatus.java
+++ b/src/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/BlurQueryStatus.java
@@ -50,7 +50,9 @@ import java.util.Arrays;
 //import org.slf4j.LoggerFactory;
 
 /**
- * 
+ * The BlurQueryStatus object hold the status of BlurQueries.  The state of the query
+ * (QueryState), the number of shards the query is executing against, the number of
+ * shards that are complete, etc.
  */
 public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.TBase<BlurQueryStatus,
BlurQueryStatus._Fields>, java.io.Serializable, Cloneable {
   private static final org.apache.blur.thirdparty.thrift_0_9_0.protocol.TStruct STRUCT_DESC
= new org.apache.blur.thirdparty.thrift_0_9_0.protocol.TStruct("BlurQueryStatus");
@@ -69,58 +71,66 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The original query.
    */
   public BlurQuery query; // required
   /**
-   * 
+   * A map of shard names to CpuTime, one for each shard in the table.
    */
   public Map<String,CpuTime> cpuTimes; // required
   /**
-   * 
+   * The number of completed shards.  The shard server will respond with
+   * how many are complete on that server, while the controller will aggregate
+   * all the shard server completed totals together.
    */
   public int completeShards; // required
   /**
-   * 
+   * The total number of shards that the query is executing against.  The shard
+   * server will respond with how many shards are being queried on that server, while
+   * the controller will aggregate all the shard server totals together.
    */
   public int totalShards; // required
   /**
-   * 
+   * The state of the query.  e.g. RUNNING, INTERRUPTED, COMPLETE
    * 
    * @see QueryState
    */
   public QueryState state; // required
   /**
-   * 
+   * The uuid of the query.
    */
   public long uuid; // required
 
   /** The set of fields this struct contains, along with convenience methods for finding
and manipulating them. */
   public enum _Fields implements org.apache.blur.thirdparty.thrift_0_9_0.TFieldIdEnum {
     /**
-     * 
+     * The original query.
      */
     QUERY((short)1, "query"),
     /**
-     * 
+     * A map of shard names to CpuTime, one for each shard in the table.
      */
     CPU_TIMES((short)2, "cpuTimes"),
     /**
-     * 
+     * The number of completed shards.  The shard server will respond with
+     * how many are complete on that server, while the controller will aggregate
+     * all the shard server completed totals together.
      */
     COMPLETE_SHARDS((short)3, "completeShards"),
     /**
-     * 
+     * The total number of shards that the query is executing against.  The shard
+     * server will respond with how many shards are being queried on that server, while
+     * the controller will aggregate all the shard server totals together.
      */
     TOTAL_SHARDS((short)4, "totalShards"),
     /**
-     * 
+     * The state of the query.  e.g. RUNNING, INTERRUPTED, COMPLETE
      * 
      * @see QueryState
      */
     STATE((short)5, "state"),
     /**
-     * 
+     * The uuid of the query.
      */
     UUID((short)6, "uuid");
 
@@ -286,14 +296,14 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The original query.
    */
   public BlurQuery getQuery() {
     return this.query;
   }
 
   /**
-   * 
+   * The original query.
    */
   public BlurQueryStatus setQuery(BlurQuery query) {
     this.query = query;
@@ -327,14 +337,14 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * A map of shard names to CpuTime, one for each shard in the table.
    */
   public Map<String,CpuTime> getCpuTimes() {
     return this.cpuTimes;
   }
 
   /**
-   * 
+   * A map of shard names to CpuTime, one for each shard in the table.
    */
   public BlurQueryStatus setCpuTimes(Map<String,CpuTime> cpuTimes) {
     this.cpuTimes = cpuTimes;
@@ -357,14 +367,18 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The number of completed shards.  The shard server will respond with
+   * how many are complete on that server, while the controller will aggregate
+   * all the shard server completed totals together.
    */
   public int getCompleteShards() {
     return this.completeShards;
   }
 
   /**
-   * 
+   * The number of completed shards.  The shard server will respond with
+   * how many are complete on that server, while the controller will aggregate
+   * all the shard server completed totals together.
    */
   public BlurQueryStatus setCompleteShards(int completeShards) {
     this.completeShards = completeShards;
@@ -386,14 +400,18 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The total number of shards that the query is executing against.  The shard
+   * server will respond with how many shards are being queried on that server, while
+   * the controller will aggregate all the shard server totals together.
    */
   public int getTotalShards() {
     return this.totalShards;
   }
 
   /**
-   * 
+   * The total number of shards that the query is executing against.  The shard
+   * server will respond with how many shards are being queried on that server, while
+   * the controller will aggregate all the shard server totals together.
    */
   public BlurQueryStatus setTotalShards(int totalShards) {
     this.totalShards = totalShards;
@@ -415,7 +433,7 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The state of the query.  e.g. RUNNING, INTERRUPTED, COMPLETE
    * 
    * @see QueryState
    */
@@ -424,7 +442,7 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The state of the query.  e.g. RUNNING, INTERRUPTED, COMPLETE
    * 
    * @see QueryState
    */
@@ -449,14 +467,14 @@ public class BlurQueryStatus implements org.apache.blur.thirdparty.thrift_0_9_0.
   }
 
   /**
-   * 
+   * The uuid of the query.
    */
   public long getUuid() {
     return this.uuid;
   }
 
   /**
-   * 
+   * The uuid of the query.
    */
   public BlurQueryStatus setUuid(long uuid) {
     this.uuid = uuid;

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/bfd38877/src/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/CpuTime.java
----------------------------------------------------------------------
diff --git a/src/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/CpuTime.java
b/src/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/CpuTime.java
index 297882b..bbc1ab9 100644
--- a/src/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/CpuTime.java
+++ b/src/distribution/src/main/scripts/interface/gen-java/org/apache/blur/thrift/generated/CpuTime.java
@@ -50,7 +50,7 @@ import java.util.Arrays;
 //import org.slf4j.LoggerFactory;
 
 /**
- * 
+ * Holds the cpu time for a query executing on a single shard in a table.
  */
 public class CpuTime implements org.apache.blur.thirdparty.thrift_0_9_0.TBase<CpuTime,
CpuTime._Fields>, java.io.Serializable, Cloneable {
   private static final org.apache.blur.thirdparty.thrift_0_9_0.protocol.TStruct STRUCT_DESC
= new org.apache.blur.thirdparty.thrift_0_9_0.protocol.TStruct("CpuTime");
@@ -65,22 +65,22 @@ public class CpuTime implements org.apache.blur.thirdparty.thrift_0_9_0.TBase<Cp
   }
 
   /**
-   * 
+   * The total cpu time for the query on the given shard.
    */
   public long cpuTime; // required
   /**
-   * 
+   * The real time of the query execution for a given shard.
    */
   public long realTime; // required
 
   /** The set of fields this struct contains, along with convenience methods for finding
and manipulating them. */
   public enum _Fields implements org.apache.blur.thirdparty.thrift_0_9_0.TFieldIdEnum {
     /**
-     * 
+     * The total cpu time for the query on the given shard.
      */
     CPU_TIME((short)1, "cpuTime"),
     /**
-     * 
+     * The real time of the query execution for a given shard.
      */
     REAL_TIME((short)2, "realTime");
 
@@ -191,14 +191,14 @@ public class CpuTime implements org.apache.blur.thirdparty.thrift_0_9_0.TBase<Cp
   }
 
   /**
-   * 
+   * The total cpu time for the query on the given shard.
    */
   public long getCpuTime() {
     return this.cpuTime;
   }
 
   /**
-   * 
+   * The total cpu time for the query on the given shard.
    */
   public CpuTime setCpuTime(long cpuTime) {
     this.cpuTime = cpuTime;
@@ -220,14 +220,14 @@ public class CpuTime implements org.apache.blur.thirdparty.thrift_0_9_0.TBase<Cp
   }
 
   /**
-   * 
+   * The real time of the query execution for a given shard.
    */
   public long getRealTime() {
     return this.realTime;
   }
 
   /**
-   * 
+   * The real time of the query execution for a given shard.
    */
   public CpuTime setRealTime(long realTime) {
     this.realTime = realTime;

http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/bfd38877/src/distribution/src/main/scripts/interface/gen-rb/blur_types.rb
----------------------------------------------------------------------
diff --git a/src/distribution/src/main/scripts/interface/gen-rb/blur_types.rb b/src/distribution/src/main/scripts/interface/gen-rb/blur_types.rb
index af1e1a6..8ad7f07 100644
--- a/src/distribution/src/main/scripts/interface/gen-rb/blur_types.rb
+++ b/src/distribution/src/main/scripts/interface/gen-rb/blur_types.rb
@@ -511,16 +511,16 @@ module Blur
     ::Thrift::Struct.generate_accessors self
   end
 
-  # 
+  # Holds the cpu time for a query executing on a single shard in a table.
   class CpuTime
     include ::Thrift::Struct, ::Thrift::Struct_Union
     CPUTIME = 1
     REALTIME = 2
 
     FIELDS = {
-      # 
+      # The total cpu time for the query on the given shard.
       CPUTIME => {:type => ::Thrift::Types::I64, :name => 'cpuTime'},
-      # 
+      # The real time of the query execution for a given shard.
       REALTIME => {:type => ::Thrift::Types::I64, :name => 'realTime'}
     }
 
@@ -532,7 +532,9 @@ module Blur
     ::Thrift::Struct.generate_accessors self
   end
 
-  # 
+  # The BlurQueryStatus object hold the status of BlurQueries.  The state of the query
+# (QueryState), the number of shards the query is executing against, the number of
+# shards that are complete, etc.
   class BlurQueryStatus
     include ::Thrift::Struct, ::Thrift::Struct_Union
     QUERY = 1
@@ -543,17 +545,21 @@ module Blur
     UUID = 6
 
     FIELDS = {
-      # 
+      # The original query.
       QUERY => {:type => ::Thrift::Types::STRUCT, :name => 'query', :class =>
::Blur::BlurQuery},
-      # 
+      # A map of shard names to CpuTime, one for each shard in the table.
       CPUTIMES => {:type => ::Thrift::Types::MAP, :name => 'cpuTimes', :key =>
{:type => ::Thrift::Types::STRING}, :value => {:type => ::Thrift::Types::STRUCT,
:class => ::Blur::CpuTime}},
-      # 
+      # The number of completed shards.  The shard server will respond with
+# how many are complete on that server, while the controller will aggregate
+# all the shard server completed totals together.
       COMPLETESHARDS => {:type => ::Thrift::Types::I32, :name => 'completeShards'},
-      # 
+      # The total number of shards that the query is executing against.  The shard
+# server will respond with how many shards are being queried on that server, while
+# the controller will aggregate all the shard server totals together.
       TOTALSHARDS => {:type => ::Thrift::Types::I32, :name => 'totalShards'},
-      # 
+      # The state of the query.  e.g. RUNNING, INTERRUPTED, COMPLETE
       STATE => {:type => ::Thrift::Types::I32, :name => 'state', :enum_class =>
::Blur::QueryState},
-      # 
+      # The uuid of the query.
       UUID => {:type => ::Thrift::Types::I64, :name => 'uuid'}
     }
 


Mime
View raw message