Repository: incubator-blur Updated Branches: refs/heads/master 20ef55430 -> dc96edb67
Added a new page for console docs Project: http://git-wip-us.apache.org/repos/asf/incubator-blur/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-blur/commit/ab026265 Tree: http://git-wip-us.apache.org/repos/asf/incubator-blur/tree/ab026265 Diff: http://git-wip-us.apache.org/repos/asf/incubator-blur/diff/ab026265 Branch: refs/heads/master Commit: ab026265280a2dc8cdfd7d20d18d93e10b0e43e4 Parents: 20ef554 Author: Chris Rohr <[email protected]> Authored: Wed Aug 13 04:52:59 2014 -0400 Committer: Chris Rohr <[email protected]> Committed: Fri Aug 22 20:59:55 2014 -0400 ---------------------------------------------------------------------- blur-console/pom.xml | 15 +++++ docs/cluster-setup.base.html | 23 +++---- docs/cluster-setup.html | 23 +++---- docs/console.html | 115 ++++++++++++++++++++++++++++++++++ docs/data-model.html | 53 ++++++++-------- docs/getting-started.html | 15 ++--- docs/index.html | 9 +-- docs/release-notes.html | 15 ++--- docs/release-notes.template.html | 7 ++- docs/using-blur.base.html | 35 ++++++----- docs/using-blur.html | 35 ++++++----- 11 files changed, 242 insertions(+), 103 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/ab026265/blur-console/pom.xml ---------------------------------------------------------------------- diff --git a/blur-console/pom.xml b/blur-console/pom.xml index 5098742..88a6fa1 100644 --- a/blur-console/pom.xml +++ b/blur-console/pom.xml @@ -48,6 +48,11 @@ <artifactId>blur-core</artifactId> <version>${project.version}</version> </dependency> + <dependency> + <groupId>org.apache.blur</groupId> + <artifactId>blur-util</artifactId> + <version>${project.version}</version> + </dependency> <!-- Development and Runtime Libraries --> <dependency> @@ -331,6 +336,11 @@ <version>${hadoop.version}</version> <scope>test</scope> </dependency> + <dependency> + <groupId>org.mortbay.jetty</groupId> + <artifactId>jetty</artifactId> + <version>6.1.26</version> + </dependency> </dependencies> </profile> <profile> @@ -355,6 +365,11 @@ <version>${hadoop.version}</version> <scope>test</scope> </dependency> + <dependency> + <groupId>org.mortbay.jetty</groupId> + <artifactId>jetty</artifactId> + <version>6.1.26</version> + </dependency> </dependencies> </profile> <profile> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/ab026265/docs/cluster-setup.base.html ---------------------------------------------------------------------- diff --git a/docs/cluster-setup.base.html b/docs/cluster-setup.base.html index f31e82c..5f38d8b 100644 --- a/docs/cluster-setup.base.html +++ b/docs/cluster-setup.base.html @@ -1,14 +1,14 @@ <!DOCTYPE html> -<!-- +<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 - + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -42,6 +42,7 @@ <li class="active"><a href="cluster-setup.html">Cluster Setup</a></li> <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> + <li><a href="console.html">Console</a></li> <li><a href="site/index.html" target="_blank">Maven Site</a></li> <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> @@ -96,8 +97,8 @@ <h1 id="general">General Configuration</h1> </div> <p> -The basic cluster setup involves editing the blur-site.properties and the blur-env.sh -files in the $BLUR_HOME/conf directory. It is recommended that a standalone ZooKeeper +The basic cluster setup involves editing the blur-site.properties and the blur-env.sh +files in the $BLUR_HOME/conf directory. It is recommended that a standalone ZooKeeper be setup. Also a modern version of Hadoop with append support is required for proper data management (the write ahead log requires the sync operation). @@ -124,7 +125,7 @@ blur.zookeeper.connection=127.0.0.1 blur.cluster.name=default -# Sets the default table location in hdfs. If left null or omitted the table uri property in +# Sets the default table location in hdfs. If left null or omitted the table uri property in # the table descriptor will be required for all tables. blur.cluster.default.table.uri=hdfs://namenode/blur/tables</code> @@ -136,9 +137,9 @@ blur.cluster.default.table.uri=hdfs://namenode/blur/tables</code> </table> <h3 id="general-hadoop">Hadoop</h3> <p> -The current version of Blur has Hadoop 1.2.1 embedded in the "apache-blur-*/lib/hadoop-1.2.1" path. However if -you are using a different version of Hadoop or want Blur to use the Hadoop configuration in your installed -version you will need to set the "HADOOP_HOME" environment variable in the +The current version of Blur has Hadoop 1.2.1 embedded in the "apache-blur-*/lib/hadoop-1.2.1" path. However if +you are using a different version of Hadoop or want Blur to use the Hadoop configuration in your installed +version you will need to set the "HADOOP_HOME" environment variable in the "blur-env.sh" script found in "apache-blur-*/conf/". <pre> <code class="bash"># Edit the blur-env.sh @@ -189,7 +190,7 @@ In Hadoop the dfs.datanode.max.xcievers should be increased to at least 4096 if <value>4096</value> </property></code></pre> <br/> -In blur-env.sh set the cache memory for the shard processes. DO NOT over allocate this will +In blur-env.sh set the cache memory for the shard processes. DO NOT over allocate this will likely crash your server. <pre><code class="bash">-XX:MaxDirectMemorySize=13g</code></pre> <div class="bs-callout bs-callout-warning"><h4>Caution</h4> @@ -342,7 +343,7 @@ blur.metrics.reporter.graphite.prefix=[""]</code></pre> </div> </div> </div> - + <!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> <script src="resources/js/jquery-2.0.3.min.js"></script> <!-- Include all compiled plugins (below), or include individual files as needed --> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/ab026265/docs/cluster-setup.html ---------------------------------------------------------------------- diff --git a/docs/cluster-setup.html b/docs/cluster-setup.html index 5d26f62..71a2636 100644 --- a/docs/cluster-setup.html +++ b/docs/cluster-setup.html @@ -1,14 +1,14 @@ <!DOCTYPE html> -<!-- +<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 - + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -42,6 +42,7 @@ <li class="active"><a href="cluster-setup.html">Cluster Setup</a></li> <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> + <li><a href="console.html">Console</a></li> <li><a href="site/index.html" target="_blank">Maven Site</a></li> <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> @@ -96,8 +97,8 @@ <h1 id="general">General Configuration</h1> </div> <p> -The basic cluster setup involves editing the blur-site.properties and the blur-env.sh -files in the $BLUR_HOME/conf directory. It is recommended that a standalone ZooKeeper +The basic cluster setup involves editing the blur-site.properties and the blur-env.sh +files in the $BLUR_HOME/conf directory. It is recommended that a standalone ZooKeeper be setup. Also a modern version of Hadoop with append support is required for proper data management (the write ahead log requires the sync operation). @@ -124,7 +125,7 @@ blur.zookeeper.connection=127.0.0.1 blur.cluster.name=default -# Sets the default table location in hdfs. If left null or omitted the table uri property in +# Sets the default table location in hdfs. If left null or omitted the table uri property in # the table descriptor will be required for all tables. blur.cluster.default.table.uri=hdfs://namenode/blur/tables</code> @@ -136,9 +137,9 @@ blur.cluster.default.table.uri=hdfs://namenode/blur/tables</code> </table> <h3 id="general-hadoop">Hadoop</h3> <p> -The current version of Blur has Hadoop 1.2.1 embedded in the "apache-blur-*/lib/hadoop-1.2.1" path. However if -you are using a different version of Hadoop or want Blur to use the Hadoop configuration in your installed -version you will need to set the "HADOOP_HOME" environment variable in the +The current version of Blur has Hadoop 1.2.1 embedded in the "apache-blur-*/lib/hadoop-1.2.1" path. However if +you are using a different version of Hadoop or want Blur to use the Hadoop configuration in your installed +version you will need to set the "HADOOP_HOME" environment variable in the "blur-env.sh" script found in "apache-blur-*/conf/". <pre> <code class="bash"># Edit the blur-env.sh @@ -189,7 +190,7 @@ In Hadoop the dfs.datanode.max.xcievers should be increased to at least 4096 if <value>4096</value> </property></code></pre> <br/> -In blur-env.sh set the cache memory for the shard processes. DO NOT over allocate this will +In blur-env.sh set the cache memory for the shard processes. DO NOT over allocate this will likely crash your server. <pre><code class="bash">-XX:MaxDirectMemorySize=13g</code></pre> <div class="bs-callout bs-callout-warning"><h4>Caution</h4> @@ -342,7 +343,7 @@ blur.metrics.reporter.graphite.prefix=[""]</code></pre> </div> </div> </div> - + <!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> <script src="resources/js/jquery-2.0.3.min.js"></script> <!-- Include all compiled plugins (below), or include individual files as needed --> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/ab026265/docs/console.html ---------------------------------------------------------------------- diff --git a/docs/console.html b/docs/console.html new file mode 100644 index 0000000..40b05c7 --- /dev/null +++ b/docs/console.html @@ -0,0 +1,115 @@ +<!DOCTYPE html> +<!-- + Licensed to the Apache Software Foundation (ASF) under one or more + contributor license agreements. See the NOTICE file distributed with + this work for additional information regarding copyright ownership. + The ASF licenses this file to You under the Apache License, Version 2.0 + (the "License"); you may not use this file except in compliance with + the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +--> +<html> + <head> + <title>Apache Blur (Incubator) Documentation</title> + <meta name="viewport" content="width=device-width, initial-scale=1.0"> + <!-- Bootstrap --> + <link href="resources/css/bootstrap.min.css" rel="stylesheet" media="screen"> + <link href="resources/css/bs-docs.css" rel="stylesheet" media="screen"> + </head> + <body> + <div class="navbar navbar-inverse navbar-fixed-top"> + <div class="container"> + <div class="navbar-header"> + <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + <span class="icon-bar"></span> + </button> + <a class="navbar-brand" href="http://incubator.apache.org/blur";>Apache Blur (Incubator)</a> + </div> + <div class="collapse navbar-collapse"> + <ul class="nav navbar-nav"> + <li class="active"><a href="index.html">Main</a></li> + <li><a href="getting-started.html">Getting Started</a></li> + <li><a href="data-model.html">Data Model</a></li> + <li><a href="cluster-setup.html">Cluster Setup</a></li> + <li><a href="using-blur.html">Using Blur</a></li> + <li><a href="Blur.html">Blur API</a></li> + <li><a href="console.html">Console</a></li> + <li><a href="site/index.html" target="_blank">Maven Site</a></li> + <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> + </ul> + </div> + </div> + </div> + <div class="container bs-docs-container"> + <div class="row"> + <div class="col-md-3"> + <div class="bs-sidebar hidden-print affix" role="complementary"> + <ul class="nav bs-sidenav"> + <li><a href="#configuration">Configuration</a></li> + <li><a href="#security">Security</a></li> + </ul> + </div> + </div> + <div class="col-md-9" role="main"> + <section> + <div class="page-header"> + <h1 id="configuration">Configuration</h1> + </div> + <p class="lead"> + Below you will find a list of available options and their appropriate defaults for the Blur Console component. All options can be set in the blur-site.properties file. + </p> + <table class="table table-bordered table-striped table-condensed"> + <thead> + <tr> + <th>Property</th> + <th>Default</th> + <th>Description</th> + </tr> + </thead> + <tbody> + <tr> + <td></td> + </tr> + </tbody> + </table> + </section> + <section> + <div class="page-header"> + <h1 id="security">Security</h1> + </div> + <p class="lead"> + Blur Console itself provides some hooks and default implementations to allow for authentication and authorization to both the tool as well as the data. + </p> + <h3>Authentication Provider</h3> + <p> + + </p> + <h3>Authorization Provider</h3> + <p> + + </p> + <h3>Available Implementations</h3> + <p> + + </p> + </section> + </div> + </div> + + <!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> + <script src="resources/js/jquery-2.0.3.min.js"></script> + <!-- Include all compiled plugins (below), or include individual files as needed --> + <script src="resources/js/bootstrap.min.js"></script> + <!-- Enable responsive features in IE8 with Respond.js (https://github.com/scottjehl/Respond) --> + <script src="resources/js/respond.min.js"></script> + </body> +</html> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/ab026265/docs/data-model.html ---------------------------------------------------------------------- diff --git a/docs/data-model.html b/docs/data-model.html index 4eecbe1..1fe95f8 100644 --- a/docs/data-model.html +++ b/docs/data-model.html @@ -1,14 +1,14 @@ <!DOCTYPE html> -<!-- +<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 - + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -42,6 +42,7 @@ <li><a href="cluster-setup.html">Cluster Setup</a></li> <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> + <li><a href="console.html">Console</a></li> <li><a href="site/index.html" target="_blank">Maven Site</a></li> <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> @@ -100,7 +101,7 @@ <li><a href="#custom_types_using">Using</a> <ul class="nav"> <li><a href="#custom_types_using_cluster"> Cluster Wide</a></li> - <li><a href="#custom_types_using_table"> Single Table</a></li> + <li><a href="#custom_types_using_table"> Single Table</a></li> </ul> </li> </ul> @@ -220,9 +221,9 @@ To run a query to find all the rows that contain a column with a word that match </p> <h3 id="string_query">String</h3> -<p>String fields are indexed Columns that are not analyzed they are indexed as is. Do not use String fields for -large amount of text, this will increase the size of your index and probably not give you the desired behavior. -So given the string "Hadoop" and "hadoop", these will be indexed as two different term because the String field +<p>String fields are indexed Columns that are not analyzed they are indexed as is. Do not use String fields for +large amount of text, this will increase the size of your index and probably not give you the desired behavior. +So given the string "Hadoop" and "hadoop", these will be indexed as two different term because the String field is case sensitive. Also if the string contains "The cow jumps over the moon." the single term that will be placed into the index is "The cow jumps over the moon." as a single string. This field type is normally used for id or type lookups. @@ -299,7 +300,7 @@ To run a query to find all the rows that contain a column with a starting value <h3 id="spatial_query">Spatial</h3> <p> -Spatial queries are supported through the Lucene spatial module. There are currently three +Spatial queries are supported through the Lucene spatial module. There are currently three different types of strategies: <ul> <li>Point Vector</li> @@ -308,9 +309,9 @@ different types of strategies: </ul> Currently all of the built in spatial types are using a GEO spatial context, meaning the assumed 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 +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. +shapes per strategy. </p> <h4>Examples:</h4> <p> @@ -338,7 +339,7 @@ To run a query to find all the rows that contain a location within 10 miles of g <ul> <li>"stopWordPath" -Optional- default value is no stop words. This should be a HDFS path. <br/>This will load stop words into the StandardAnalyzer for this field, one term per line.</li> - + <li>"analyzerClass" -Optional- default value is a standard analyzer with no stop words.<br/>This could be any Analyzer class that has a default constructor or one that takes a Lucene Version enum.</li> </ul> </p> @@ -398,7 +399,7 @@ To run a query to find all the rows that contain a location within 10 miles of g <li>"numericPrecisionStep" -Optional- default value is "4"</li> </ul> </p> - + <h3 id="stored_type">Stored</h3> <p> The Stored Type has the type name of: @@ -492,7 +493,7 @@ To run a query to find all the rows that contain a location within 10 miles of g <p class="lead">Custom types in Blur allow you to create your own types in Lucene as well as plugging into the query parser so that you can use your custom type.</p> <h3 id="custom_types_creating">Creating</h3> - <p> + <p> You will need to extend the "org.apache.blur.analysis.FieldTypeDefinition" class found in the blur-query module. If you need to use a different Analyzer than the StandardAnalyzer used in the "text" type just extend the "org.apache.blur.analysis.type.TextFieldTypeDefinition" and make the appropriate changes. </p> <p> @@ -507,7 +508,7 @@ Below is a simple type that is basically the same as a "string" type, however it /** * Get the name of the type. - * + * * @return the name. */ @Override @@ -517,7 +518,7 @@ Below is a simple type that is basically the same as a "string" type, however it /** * Configures this instance for the type. - * + * * @param fieldNameForThisInstance * the field name for this instance. * @param properties @@ -526,7 +527,7 @@ Below is a simple type that is basically the same as a "string" type, however it * method. */ @Override - public void configure(String fieldNameForThisInstance, Map<String, String> properties, + public void configure(String fieldNameForThisInstance, Map<String, String> properties, Configuration configuration) { _fieldNameForThisInstance = fieldNameForThisInstance; } @@ -534,12 +535,12 @@ Below is a simple type that is basically the same as a "string" type, however it /** * Create {@link Field}s for the index as well as for storing the original * data for retrieval. - * + * * @param family * the family name. * @param column * the column that holds the name and value. - * + * * @return the {@link Iterable} of {@link Field}s. */ @Override @@ -552,18 +553,18 @@ Below is a simple type that is basically the same as a "string" type, however it /** * Create {@link Field}s for the index do NOT store the data because the is a * sub column. - * + * * @param family * the family name. * @param column * the column that holds the name and value. * @param subName * the sub column name. - * + * * @return the {@link Iterable} of {@link Field}s. */ @Override - public Iterable<? extends Field> getFieldsForSubColumn(String family, Column column, + public Iterable<? extends Field> getFieldsForSubColumn(String family, Column column, String subName) { String name = family + "." + column.getName() + "." + subName; String value = column.getValue(); @@ -572,7 +573,7 @@ Below is a simple type that is basically the same as a "string" type, however it /** * Gets the query from the text provided by the query parser. - * + * * @param text * the text provided by the query parser. * @return the {@link Query}. @@ -584,7 +585,7 @@ Below is a simple type that is basically the same as a "string" type, however it } </code></pre> - + </p> <h3 id="custom_types_distributing">Distributing</h3> @@ -601,9 +602,9 @@ Please note that the prefix of "blur.fieldtype." is all that is used from the pr </p> <h4 id="custom_types_using_table">Single Table</h4> <p>For a single table configuration you will need to add the new field types into the tableProperties map in the TableDescriptor as you define the table. -<pre><code class="java">tableDescriptor.putToTableProperties("blur.fieldtype.customtype1", +<pre><code class="java">tableDescriptor.putToTableProperties("blur.fieldtype.customtype1", "org.apache.blur.analysis.type.ExampleType1"); -tableDescriptor.putToTableProperties("blur.fieldtype.customtype2", +tableDescriptor.putToTableProperties("blur.fieldtype.customtype2", "org.apache.blur.analysis.type.ExampleType2"); ...</code></pre> @@ -614,7 +615,7 @@ Please note that the prefix of "blur.fieldtype." is all that is used from the pr </div> <br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/> - + <!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> <script src="resources/js/jquery-2.0.3.min.js"></script> <!-- Include all compiled plugins (below), or include individual files as needed --> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/ab026265/docs/getting-started.html ---------------------------------------------------------------------- diff --git a/docs/getting-started.html b/docs/getting-started.html index 1d66946..6b215ed 100644 --- a/docs/getting-started.html +++ b/docs/getting-started.html @@ -1,14 +1,14 @@ <!DOCTYPE html> -<!-- +<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 - + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -42,6 +42,7 @@ <li><a href="cluster-setup.html">Cluster Setup</a></li> <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> + <li><a href="console.html">Console</a></li> <li><a href="site/index.html" target="_blank">Maven Site</a></li> <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> @@ -164,12 +165,12 @@ mvn install -DskipTests -Dhadoop2</code></pre> <p> You should see: </p> - <pre><code class="bash">blur@blurvm:~$ apache-blur-0.2.4-incubating-SNAPSHOT/bin/start-all.sh + <pre><code class="bash">blur@blurvm:~$ apache-blur-0.2.4-incubating-SNAPSHOT/bin/start-all.sh localhost: ZooKeeper starting as process 6650. localhost: Shard [0] starting as process 6783. localhost: Controller [0] starting as process 6933.</code></pre> <p>If you run the start command again you should see:</p> - <pre><code class="bash">blur@blurvm:~$ apache-blur-0.2.4-incubating-SNAPSHOT/bin/stop-all.sh + <pre><code class="bash">blur@blurvm:~$ apache-blur-0.2.4-incubating-SNAPSHOT/bin/stop-all.sh localhost: Stopping Controller [0] server with pid [6933]. localhost: Stopping Shard [0] server with pid [6783]. localhost: Stopping ZooKeeper with pid [6650].</code></pre> @@ -241,7 +242,7 @@ highlight of query command is now on </p> <h3 id="shell-query-highlight">Query with Highlights</h3> <p> -<pre><code class="bash">blur> #Runs a query on testtable with highlighting on, notice <<<value1>>> is highlighted +<pre><code class="bash">blur> #Runs a query on testtable with highlighting on, notice <<<value1>>> is highlighted blur> query testtable2 fam0.col1:value1 - Results Summary - total : 1 @@ -264,7 +265,7 @@ blur></code></pre> </div> <br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/><br/> - + <!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> <script src="resources/js/jquery-2.0.3.min.js"></script> <!-- Include all compiled plugins (below), or include individual files as needed --> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/ab026265/docs/index.html ---------------------------------------------------------------------- diff --git a/docs/index.html b/docs/index.html index b39efbc..4539587 100644 --- a/docs/index.html +++ b/docs/index.html @@ -1,14 +1,14 @@ <!DOCTYPE html> -<!-- +<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 - + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -42,6 +42,7 @@ <li><a href="cluster-setup.html">Cluster Setup</a></li> <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> + <li><a href="console.html">Console</a></li> <li><a href="site/index.html" target="_blank">Maven Site</a></li> <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> @@ -58,7 +59,7 @@ <a href="release-notes.html" class="btn btn-primary btn-large">View Release Notes »</a> </div> </div> - + <!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> <script src="resources/js/jquery-2.0.3.min.js"></script> <!-- Include all compiled plugins (below), or include individual files as needed --> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/ab026265/docs/release-notes.html ---------------------------------------------------------------------- diff --git a/docs/release-notes.html b/docs/release-notes.html index 2faffd6..8bc8517 100644 --- a/docs/release-notes.html +++ b/docs/release-notes.html @@ -1,14 +1,14 @@ <!DOCTYPE html> -<!-- +<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 - + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -43,6 +43,7 @@ <li><a href="cluster-setup.html">Cluster Setup</a></li> <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> + <li><a href="console.html">Console</a></li> <li><a href="site/index.html" target="_blank">Maven Site</a></li> <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> @@ -63,7 +64,7 @@ Release Notes - Apache Blur - Version 0.2.2 - + <h2> Bug </h2> <ul> @@ -114,11 +115,11 @@ <li>[<a href='https://issues.apache.org/jira/browse/BLUR-337'>BLUR-337</a>] - Shard server should fail hard on a bad misconfiguration </li> </ul> - + <h2> Improvement </h2> <ul> -<li>[<a href='https://issues.apache.org/jira/browse/BLUR-302'>BLUR-302</a>] - start-all script sometimes causes errors +<li>[<a href='https://issues.apache.org/jira/browse/BLUR-302'>BLUR-302</a>] - start-all script sometimes causes errors </li> <li>[<a href='https://issues.apache.org/jira/browse/BLUR-317'>BLUR-317</a>] - Enable Changing of Compression alg and chunk size in Codec </li> @@ -133,7 +134,7 @@ <li>[<a href='https://issues.apache.org/jira/browse/BLUR-335'>BLUR-335</a>] - Field existence query </li> </ul> - + <h2> New Feature </h2> <ul> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/ab026265/docs/release-notes.template.html ---------------------------------------------------------------------- diff --git a/docs/release-notes.template.html b/docs/release-notes.template.html index 249d0f5..f685318 100644 --- a/docs/release-notes.template.html +++ b/docs/release-notes.template.html @@ -1,14 +1,14 @@ <!DOCTYPE html> -<!-- +<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 - + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -43,6 +43,7 @@ <li><a href="cluster-setup.html">Cluster Setup</a></li> <li><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> + <li><a href="console.html">Console</a></li> <li><a href="site/index.html" target="_blank">Maven Site</a></li> <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/ab026265/docs/using-blur.base.html ---------------------------------------------------------------------- diff --git a/docs/using-blur.base.html b/docs/using-blur.base.html index d70e443..40aa598 100644 --- a/docs/using-blur.base.html +++ b/docs/using-blur.base.html @@ -1,14 +1,14 @@ <!DOCTYPE html> -<!-- +<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 - + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -42,6 +42,7 @@ <li><a href="cluster-setup.html">Cluster Setup</a></li> <li class="active"><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> + <li><a href="console.html">Console</a></li> <li><a href="site/index.html" target="_blank">Maven Site</a></li> <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> @@ -107,7 +108,7 @@ The following examples are of using the Thrift API directly. You will need to f <p> <br/> <h4 id="simple_connection_example_constr">Connection String</h4> -The connection string can be parsed or constructed through "Connection" object. If you are using the +The connection string can be parsed or constructed through "Connection" object. If you are using the parsed version there are some options. At a minimum you will have to provide hostname and port: <pre><code class="bash">host1:40010</code></pre> @@ -174,7 +175,7 @@ for (BlurResult result : results.getResults()) { <h3 id="simple_query_example_data">Query Example with Data</h3> <p> This is an example of how to run a query via the Thrift API and get back search results with data. All -the columns in the "fam0" family are returned for each Record in the Row. +the columns in the "fam0" family are returned for each Record in the Row. </p> <pre><code class="java">Iface client = BlurClient.getClient("controller1:40010,controller2:40010"); @@ -209,7 +210,7 @@ for (BlurResult result : results.getResults()) { <h3 id="simple_query_sorting">Query Example with Sorting</h3> <p> This is an example of how to run a query via the Thrift API and get back search results with - data being sorted by the "docs.timestamp" column. All the columns in the records + data being sorted by the "docs.timestamp" column. All the columns in the records will be returned. <div class="bs-callout bs-callout-info"><h4>Note</h4>Sorting is only allowed on Record queries at this point.</div> </p> @@ -247,7 +248,7 @@ query.setQuery("+docs.body:\"Hadoop is awesome\""); final BlurQuery blurQuery = new BlurQuery(); blurQuery.setQuery(query); -// This facet will stop counting once the count has reached 10000. However this is only counted +// This facet will stop counting once the count has reached 10000. However this is only counted // on each server, so it is likely you will receive a count larger than your max. blurQuery.addToFacets(new Facet("fam1.col1:value1 OR fam1.col1:value2", 10000)); blurQuery.addToFacets(new Facet("fam1.col1:value100 AND fam1.col1:value200", Long.MAX_VALUE)); @@ -296,25 +297,25 @@ record1.setRecordId("recordid1"); record1.setFamily("fam0"); record1.addToColumns(new Column("col0", "val0")); record1.addToColumns(new Column("col1", "val1")); - + Record record2 = new Record(); record2.setRecordId("recordid2"); record2.setFamily("fam1"); record2.addToColumns(new Column("col4", "val4")); record2.addToColumns(new Column("col5", "val5")); - + List<RecordMutation> recordMutations = new ArrayList<RecordMutation>(); - + recordMutations.add(new RecordMutation(RecordMutationType.REPLACE_ENTIRE_RECORD, record1)); recordMutations.add(new RecordMutation(RecordMutationType.REPLACE_ENTIRE_RECORD, record2)); // This will replace the exiting Row of "rowid1" (if one exists) in table "table1". It will -// write the mutate to the write ahead log (WAL) and it will not block waiting for the -// mutate to become visible. +// write the mutate to the write ahead log (WAL) and it will not block waiting for the +// mutate to become visible. RowMutation mutation = new RowMutation("table1", "rowid1", true, RowMutationType.REPLACE_ROW, recordMutations, false); mutation.setRecordMutations(recordMutations); - + client.mutate(mutation); </code></pre> @@ -327,8 +328,8 @@ This is the same example as above but is shorted with a help class. Iface client = BlurClient.getClient("controller1:40010,controller2:40010"); // This will replace the exiting Row of "rowid1" (if one exists) in table "table1". It will -// write the mutate to the write ahead log (WAL) and it will not block waiting for the -// mutate to become visible. +// write the mutate to the write ahead log (WAL) and it will not block waiting for the +// mutate to become visible. RowMutation mutation = newRowMutation("table1", "rowid1", newRecordMutation("fam0", "recordid1", newColumn("col0", "val0"), newColumn("col1", "val2")), newRecordMutation("fam1", "recordid2", newColumn("col4", "val4"), newColumn("col5", "val4"))); @@ -417,7 +418,7 @@ job.waitForCompletion(true);</code></pre> </div> <p> The CSV Loader program can be invoked by running:<pre><code class="bash">$BLUR_HOME/bin/blur csvloader</code></pre> -<div class="bs-callout bs-callout-warning"><h4>Caution</h4>Also the machine that will execute this command will need to have Hadoop installed and configured locally, +<div class="bs-callout bs-callout-warning"><h4>Caution</h4>Also the machine that will execute this command will need to have Hadoop installed and configured locally, otherwise the scripts will not work correctly.</div> <pre><code class="bash">usage: csvloader The "csvloader" command is used to load delimited into a Blur table. @@ -487,7 +488,7 @@ Here is a screenshot of the JDBC driver in SQuirrel: </div> </div> </div> - + <!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> <script src="resources/js/jquery-2.0.3.min.js"></script> <!-- Include all compiled plugins (below), or include individual files as needed --> http://git-wip-us.apache.org/repos/asf/incubator-blur/blob/ab026265/docs/using-blur.html ---------------------------------------------------------------------- diff --git a/docs/using-blur.html b/docs/using-blur.html index 717c462..8cb3613 100644 --- a/docs/using-blur.html +++ b/docs/using-blur.html @@ -1,14 +1,14 @@ <!DOCTYPE html> -<!-- +<!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at - + http://www.apache.org/licenses/LICENSE-2.0 - + Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -42,6 +42,7 @@ <li><a href="cluster-setup.html">Cluster Setup</a></li> <li class="active"><a href="using-blur.html">Using Blur</a></li> <li><a href="Blur.html">Blur API</a></li> + <li><a href="console.html">Console</a></li> <li><a href="site/index.html" target="_blank">Maven Site</a></li> <li><a href="site/apidocs/index.html" target="_blank">Javadocs</a></li> </ul> @@ -158,7 +159,7 @@ The following examples are of using the Thrift API directly. You will need to f <p> <br/> <h4 id="simple_connection_example_constr">Connection String</h4> -The connection string can be parsed or constructed through "Connection" object. If you are using the +The connection string can be parsed or constructed through "Connection" object. If you are using the parsed version there are some options. At a minimum you will have to provide hostname and port: <pre><code class="bash">host1:40010</code></pre> @@ -225,7 +226,7 @@ for (BlurResult result : results.getResults()) { <h3 id="simple_query_example_data">Query Example with Data</h3> <p> This is an example of how to run a query via the Thrift API and get back search results with data. All -the columns in the "fam0" family are returned for each Record in the Row. +the columns in the "fam0" family are returned for each Record in the Row. </p> <pre><code class="java">Iface client = BlurClient.getClient("controller1:40010,controller2:40010"); @@ -260,7 +261,7 @@ for (BlurResult result : results.getResults()) { <h3 id="simple_query_sorting">Query Example with Sorting</h3> <p> This is an example of how to run a query via the Thrift API and get back search results with - data being sorted by the "docs.timestamp" column. All the columns in the records + data being sorted by the "docs.timestamp" column. All the columns in the records will be returned. <div class="bs-callout bs-callout-info"><h4>Note</h4>Sorting is only allowed on Record queries at this point.</div> </p> @@ -298,7 +299,7 @@ query.setQuery("+docs.body:\"Hadoop is awesome\""); final BlurQuery blurQuery = new BlurQuery(); blurQuery.setQuery(query); -// This facet will stop counting once the count has reached 10000. However this is only counted +// This facet will stop counting once the count has reached 10000. However this is only counted // on each server, so it is likely you will receive a count larger than your max. blurQuery.addToFacets(new Facet("fam1.col1:value1 OR fam1.col1:value2", 10000)); blurQuery.addToFacets(new Facet("fam1.col1:value100 AND fam1.col1:value200", Long.MAX_VALUE)); @@ -347,25 +348,25 @@ record1.setRecordId("recordid1"); record1.setFamily("fam0"); record1.addToColumns(new Column("col0", "val0")); record1.addToColumns(new Column("col1", "val1")); - + Record record2 = new Record(); record2.setRecordId("recordid2"); record2.setFamily("fam1"); record2.addToColumns(new Column("col4", "val4")); record2.addToColumns(new Column("col5", "val5")); - + List<RecordMutation> recordMutations = new ArrayList<RecordMutation>(); - + recordMutations.add(new RecordMutation(RecordMutationType.REPLACE_ENTIRE_RECORD, record1)); recordMutations.add(new RecordMutation(RecordMutationType.REPLACE_ENTIRE_RECORD, record2)); // This will replace the exiting Row of "rowid1" (if one exists) in table "table1". It will -// write the mutate to the write ahead log (WAL) and it will not block waiting for the -// mutate to become visible. +// write the mutate to the write ahead log (WAL) and it will not block waiting for the +// mutate to become visible. RowMutation mutation = new RowMutation("table1", "rowid1", true, RowMutationType.REPLACE_ROW, recordMutations, false); mutation.setRecordMutations(recordMutations); - + client.mutate(mutation); </code></pre> @@ -378,8 +379,8 @@ This is the same example as above but is shorted with a help class. Iface client = BlurClient.getClient("controller1:40010,controller2:40010"); // This will replace the exiting Row of "rowid1" (if one exists) in table "table1". It will -// write the mutate to the write ahead log (WAL) and it will not block waiting for the -// mutate to become visible. +// write the mutate to the write ahead log (WAL) and it will not block waiting for the +// mutate to become visible. RowMutation mutation = newRowMutation("table1", "rowid1", newRecordMutation("fam0", "recordid1", newColumn("col0", "val0"), newColumn("col1", "val2")), newRecordMutation("fam1", "recordid2", newColumn("col4", "val4"), newColumn("col5", "val4"))); @@ -589,7 +590,7 @@ job.waitForCompletion(true);</code></pre> </div> <p> The CSV Loader program can be invoked by running:<pre><code class="bash">$BLUR_HOME/bin/blur csvloader</code></pre> -<div class="bs-callout bs-callout-warning"><h4>Caution</h4>Also the machine that will execute this command will need to have Hadoop installed and configured locally, +<div class="bs-callout bs-callout-warning"><h4>Caution</h4>Also the machine that will execute this command will need to have Hadoop installed and configured locally, otherwise the scripts will not work correctly.</div> <pre><code class="bash">usage: csvloader The "csvloader" command is used to load delimited into a Blur table. @@ -659,7 +660,7 @@ Here is a screenshot of the JDBC driver in SQuirrel: </div> </div> </div> - + <!-- jQuery (necessary for Bootstrap's JavaScript plugins) --> <script src="resources/js/jquery-2.0.3.min.js"></script> <!-- Include all compiled plugins (below), or include individual files as needed -->
