incubator-blur-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From amccu...@apache.org
Subject svn commit: r1517509 - in /incubator/blur/site/trunk/content/blur/docs/0.2.0: Blur.html cluster-setup.html data-model.html getting-started.html using-blur.base.html using-blur.html
Date Mon, 26 Aug 2013 11:51:19 GMT
Author: amccurry
Date: Mon Aug 26 11:51:18 2013
New Revision: 1517509

URL: http://svn.apache.org/r1517509
Log:
More documentation updates.

Modified:
    incubator/blur/site/trunk/content/blur/docs/0.2.0/Blur.html
    incubator/blur/site/trunk/content/blur/docs/0.2.0/cluster-setup.html
    incubator/blur/site/trunk/content/blur/docs/0.2.0/data-model.html
    incubator/blur/site/trunk/content/blur/docs/0.2.0/getting-started.html
    incubator/blur/site/trunk/content/blur/docs/0.2.0/using-blur.base.html
    incubator/blur/site/trunk/content/blur/docs/0.2.0/using-blur.html

Modified: incubator/blur/site/trunk/content/blur/docs/0.2.0/Blur.html
URL: http://svn.apache.org/viewvc/incubator/blur/site/trunk/content/blur/docs/0.2.0/Blur.html?rev=1517509&r1=1517508&r2=1517509&view=diff
==============================================================================
--- incubator/blur/site/trunk/content/blur/docs/0.2.0/Blur.html (original)
+++ incubator/blur/site/trunk/content/blur/docs/0.2.0/Blur.html Mon Aug 26 11:51:18 2013
@@ -314,8 +314,6 @@ The location id of the Record or Row to 
 </td><td>default</td><td></td></tr>
 <tr><td>6</td><td>columnsToFetch</td><td><code>map&lt;<code>string</code>,
<code>set&lt;<code>string</code>&gt;</code>&gt;</code></td><td>The
columns in the families to fetch.  If null, fetch all.  If empty, fetch none.
 </td><td>default</td><td></td></tr>
-<tr><td>7</td><td>allowStaleData</td><td><code>bool</code></td><td>@deprecated
This value is no longer used.  This allows the fetch to see the most current data that has
been added to the table.
-</td><td>default</td><td></td></tr>
 <tr><td>8</td><td>startRecord</td><td><code>i32</code></td><td>Only
valid for Row fetches, the record in the row to start fetching.  If the row contains 1000
 records and you want the first 100, then this value is 0.  If you want records 300-400 then
this
 value would be 300.  If startRecord is beyond the end of the row, the row will be null in
the
@@ -430,7 +428,7 @@ with the query options.
 </table><br/>The RowMutation defines how the given Record is to be mutated.
 <br/></p></section><section><div class="page-header"><h3
id="Struct_RowMutation">Struct: RowMutation</h3></div><p class="lead">
 <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>table</td><td><code>string</code></td><td>The
that that the row mutation is to act upon.
+<tr><td>1</td><td>table</td><td><code>string</code></td><td>The
table that the row mutation is to act upon.
 </td><td>default</td><td></td></tr>
 <tr><td>2</td><td>rowId</td><td><code>string</code></td><td>The
row id that the row mutation is to act upon.
 </td><td>default</td><td></td></tr>
@@ -486,7 +484,7 @@ shards that are complete, etc.
 </table><br/>TableStats holds the statistics for a given table.
 <br/></p></section><section><div class="page-header"><h3
id="Struct_ColumnDefinition">Struct: ColumnDefinition</h3></div><p class="lead">
 <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>family</td><td><code>string</code></td><td>Required.
The family the this column existing within.
+<tr><td>1</td><td>family</td><td><code>string</code></td><td>Required.
The family that this column exists within.
 </td><td>default</td><td></td></tr>
 <tr><td>2</td><td>columnName</td><td><code>string</code></td><td>Required.
The column name.
 </td><td>default</td><td></td></tr>
@@ -532,7 +530,7 @@ NOTE: This will index the column as a fu
 </td><td>default</td><td></td></tr>
 <tr><td>10</td><td>blockCaching</td><td><code>bool</code></td><td>Should
block cache be enable or disabled for this table.
 </td><td>default</td><td>1</td></tr>
-<tr><td>11</td><td>blockCachingFileTypes</td><td><code>set&lt;<code>string</code>&gt;</code></td><td>The
files extensions that you would like to allow block cache to to cache.  If null (default)
everything is cached.
+<tr><td>11</td><td>blockCachingFileTypes</td><td><code>set&lt;<code>string</code>&gt;</code></td><td>The
files extensions that you would like to allow block cache to cache.  If null (default) everything
is cached.
 </td><td>default</td><td></td></tr>
 <tr><td>12</td><td>readOnly</td><td><code>bool</code></td><td>If
a table is set to be readonly, that means that mutates through Thrift are NOT allowed.  However
 updates through MapReduce are allowed and in fact they are only allowed if the table is in
readOnly mode.
@@ -640,7 +638,7 @@ throws <code><a href="Blur.html#Struct_B
 <pre><code>string</code> parseQuery(<code>string</code> table,
 <code><a href="Blur.html#Struct_Query">Query</a></code> query)
 throws <code><a href="Blur.html#Struct_BlurException">BlurException</a></code>
-</pre>Parses the given query and return the string represents the query.
+</pre>Parses the given query and returns the string that 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.
@@ -708,7 +706,7 @@ throws <code><a href="Blur.html#Struct_B
 </table></p></section><section><div class="page-header"><h4
id="Fn_Blur_mutate">Function: Blur.mutate</h4></div><p class="lead">
 <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.
+</pre>Mutates a Row given the RowMutation that 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>
@@ -767,7 +765,7 @@ string and text field types.
 </td></tr>
 <tr><td>columnName</td><td>the column name.
 </td></tr>
-<tr><td>startWith</td><td>the term to start with assuming that you
paging through the term list.
+<tr><td>startWith</td><td>the term to start with assuming that you
are paging through the term list.
 </td></tr>
 <tr><td>size</td><td>the number to fetch at once.
 </td></tr>

Modified: incubator/blur/site/trunk/content/blur/docs/0.2.0/cluster-setup.html
URL: http://svn.apache.org/viewvc/incubator/blur/site/trunk/content/blur/docs/0.2.0/cluster-setup.html?rev=1517509&r1=1517508&r2=1517509&view=diff
==============================================================================
--- incubator/blur/site/trunk/content/blur/docs/0.2.0/cluster-setup.html (original)
+++ incubator/blur/site/trunk/content/blur/docs/0.2.0/cluster-setup.html Mon Aug 26 11:51:18
2013
@@ -103,7 +103,7 @@ file:
             <p>
 
 <pre>
-<code class="bash"># The ZooKeeper connection string, consider adding a root path to
the string it
+<code class="bash"># The ZooKeeper connection string, consider adding a root path to
the string, it
 # can help when upgrading Blur.
 # Example: zknode1:2181,zknode2:2181,zknode3:2181/blur-0.2.0
 #
@@ -140,7 +140,7 @@ export HADOOP_HOME=&lt;path to your Hado
             </div>
             <h3 id="controller-blur-site">blur-site.properties</h3>
             <p>
-              These are the default settings for the shard server that can be overridden
in the blur-site.properties file. Consider increasing the various thread pool counts (*.thread.count).
The blur.controller.server.remote.thread.count is very important to increase for larger clusters,
basically one thread is used per shard server per query. Some production cluster have used
set this thread pool to 2000 or more threads.
+              These are the default settings for the shard server that can be overridden
in the blur-site.properties file. Consider increasing the various thread pool counts (*.thread.count).
The blur.controller.server.remote.thread.count is very important to increase for larger clusters,
basically one thread is used per shard server per query. Some production clusters have set
this thread pool to 2000 or more threads.
             </p>
 <pre>
 <code class="bash"># Sets the hostname for the controller, if blank the hostname is
automatically detected

Modified: incubator/blur/site/trunk/content/blur/docs/0.2.0/data-model.html
URL: http://svn.apache.org/viewvc/incubator/blur/site/trunk/content/blur/docs/0.2.0/data-model.html?rev=1517509&r1=1517508&r2=1517509&view=diff
==============================================================================
--- incubator/blur/site/trunk/content/blur/docs/0.2.0/data-model.html (original)
+++ incubator/blur/site/trunk/content/blur/docs/0.2.0/data-model.html Mon Aug 26 11:51:18
2013
@@ -177,7 +177,7 @@ Let's say you want to find all the Rows 
 
               <h3 id="text_query">Text</h3>
 <p>Text fields are analyzed with Lucene's standard analyzers, which mean that the string
is broken down into terms
-and the terms capitalization is removed and well as any special punctuation.  See Lucene's
documentation for further explanation.
+and the terms capitalization is removed as well as any special punctuation.  See Lucene's
documentation for further explanation.
 </p>
 <h4>Examples:</h4>
 <p>
@@ -241,14 +241,14 @@ To run a query to find all the rows that
               <h3 id="spatial_query">Spatial</h3>
 <p>
 Spatial queries are supported through the Lucene spatial module.  There are currently three

-different types of stragies:
+different types of strategies:
 <ul>
 <li>Point Vector</li>
 <li>Term Query Prefix Tree</li>
 <li>Recursive Prefix Tree</li>
 </ul>
 Currently all of the built in spatial types are using a GEO spatial context, meaning the
assumed
-cooridates are on the planet Earth.  Each of these strategies support different indexing
features
+coordinates are on the planet Earth.  Each of these strategies support different indexing
features
 such as the shapes they can index, the shapes they can query with, and the operations they

 support during the query.  See the type section below to get a list of supported operations
and
 shapes per strategy. 

Modified: incubator/blur/site/trunk/content/blur/docs/0.2.0/getting-started.html
URL: http://svn.apache.org/viewvc/incubator/blur/site/trunk/content/blur/docs/0.2.0/getting-started.html?rev=1517509&r1=1517508&r2=1517509&view=diff
==============================================================================
--- incubator/blur/site/trunk/content/blur/docs/0.2.0/getting-started.html (original)
+++ incubator/blur/site/trunk/content/blur/docs/0.2.0/getting-started.html Mon Aug 26 11:51:18
2013
@@ -178,7 +178,7 @@ localhost: Stopping ZooKeeper with pid [
             <pre><code class="bash">$BLUR_HOME/bin/blur shell</code></pre>
             <p>You can also explicitly call out the controller servers.</p>
             <pre><code class="bash">$BLUR_HOME/bin/blur shell controller1:40010,controller2:40010</code></pre>
-            <p>Once in the shell, tables and be created, enabled, disabled, and removed.
Type help to get a list of the commands.</p>
+            <p>Once in the shell, tables can be created, enabled, disabled, and removed.
Type help to get a list of the commands.</p>
           </section>
           <section>
             <div class="page-header">

Modified: incubator/blur/site/trunk/content/blur/docs/0.2.0/using-blur.base.html
URL: http://svn.apache.org/viewvc/incubator/blur/site/trunk/content/blur/docs/0.2.0/using-blur.base.html?rev=1517509&r1=1517508&r2=1517509&view=diff
==============================================================================
--- incubator/blur/site/trunk/content/blur/docs/0.2.0/using-blur.base.html (original)
+++ incubator/blur/site/trunk/content/blur/docs/0.2.0/using-blur.base.html Mon Aug 26 11:51:18
2013
@@ -75,6 +75,20 @@
             <div class="page-header">
               <h1 id="thrift-client">Thrift Client</h1>
             </div>
+<p>
+The following examples are of using the Thrift API directly.  You will need to following
libraries at a minimum:
+<ul>
+	<li>blur-thrift-*.jar</li>
+	<li>blur-util-*.jar</li>
+	<li>slf4j-api-1.6.1.jar</li>
+	<li>slf4j-log4j12-1.6.1.jar</li>
+	<li>commons-logging-1.1.1.jar</li>
+	<li>log4j-1.2.15.jar</li>
+</ul>
+
+<div class="bs-callout bs-callout-info"><h4>Note</h4>Other versions of
these libraries could work, but these are the versions that Blur currently uses.</div>
+
+</p>
 <h3 id="simple_query_example">Query Example</h3>
 <p>
 This is a simple example of how to run a query via the Thrift API and get back search results.
 By default

Modified: incubator/blur/site/trunk/content/blur/docs/0.2.0/using-blur.html
URL: http://svn.apache.org/viewvc/incubator/blur/site/trunk/content/blur/docs/0.2.0/using-blur.html?rev=1517509&r1=1517508&r2=1517509&view=diff
==============================================================================
--- incubator/blur/site/trunk/content/blur/docs/0.2.0/using-blur.html (original)
+++ incubator/blur/site/trunk/content/blur/docs/0.2.0/using-blur.html Mon Aug 26 11:51:18
2013
@@ -116,6 +116,20 @@
             <div class="page-header">
               <h1 id="thrift-client">Thrift Client</h1>
             </div>
+<p>
+The following examples are of using the Thrift API directly.  You will need to following
libraries at a minimum:
+<ul>
+	<li>blur-thrift-*.jar</li>
+	<li>blur-util-*.jar</li>
+	<li>slf4j-api-1.6.1.jar</li>
+	<li>slf4j-log4j12-1.6.1.jar</li>
+	<li>commons-logging-1.1.1.jar</li>
+	<li>log4j-1.2.15.jar</li>
+</ul>
+
+<div class="bs-callout bs-callout-info"><h4>Note</h4>Other versions of
these libraries could work, but these are the versions that Blur currently uses.</div>
+
+</p>
 <h3 id="simple_query_example">Query Example</h3>
 <p>
 This is a simple example of how to run a query via the Thrift API and get back search results.
 By default
@@ -260,8 +274,8 @@ The following rules are used when intera
 </p>
 <h3 id="shell_table_commands">Table Commands</h3>
 <h4 id="shell_command_create">create</h4>
-<p>Description: Create the named table.<br/>
-<pre><code class="bash">create &lt;tablename&gt; &lt;tableuri&gt;
&lt;shardcount&gt;</code></pre></p>
+<p>Description: Create the named table.  Run -h for full argument list.<br/>
+<pre><code class="bash">create -t &lt;tablename&gt; -c &lt;shardcount&gt;</code></pre></p>
 <h4 id="shell_command_enable">enable</h4>
 <p>Description: Enable the named table.<br/>
 <pre><code class="bash">enable &lt;tablename&gt;</code></pre></p>



Mime
View raw message