Update READMEs and LICENSE files

README.txt

@@ -7,6 +7,8 @@ processing capabilities of the Vertica Analytic Database.
 You need the Vertica SDK to compile these programs and you need the
 Vertica Analytic Database to run them.
 
+All code is provided under the license found in LICENSE.txt
+
 *******************
 Submission guidelines:
 *******************

compatlib_functions/LICENSE.txt

@@ -0,0 +1,28 @@
+
+Portions of this software Copyright (c) 2011 by Vertica, an HP
+Company.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+- Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

compatlib_functions/README.txt

@@ -1,24 +1,57 @@
-**************
-* Oracle Compatibility Functions
-*
-* These implementations might be incomplete. Please help by updating them!
-*
-* CONNECT_BY (http://psoug.org/reference/connectby.html)
-* TRANSPOSE  (http://www.orafaq.com/node/1871)
-**************
+-------------------------------
+INTRODUCTION
+-------------------------------
 
-1) To build, run:
+Compatibility Functions
 
-  cd build
-  make
+This package contains a set of functions that are found in other
+databases (such as Oracle) but not natively in the Vertica Analytic
+Database.
 
-1) To install, run:
+These implementations might be incomplete. Please help by updating them!
 
-./install.sh
+CONNECT_BY (http://psoug.org/reference/connectby.html)
+TRANSPOSE  (http://www.orafaq.com/node/1871)
 
-2) To uninstall, execute the following sql:
+-------------------------------
+BUILDING
+-------------------------------
+
+To build:
+
+$ make
+
+
+-------------------------------
+INSTALLING / UNINSTALLING
+-------------------------------
+
+Assuming vsql is in your path, just do:
+
+$ make install
+$ make uninstall
+
+Alternately, you can find the DDL that 'make install' uses in:
+ src/ddl/install.sql 
+and
+ src/ddl/uninstall.sql
+
+-------------------------------
+USAGE
+-------------------------------
+
+See examples
+
+-------------------------------
+PERFORMANCE
+-------------------------------
+
+-------------------------------
+LICENSE
+-------------------------------
+
+Please see LICENSE.txt
 
-./remove.sh
 
 
 

strings_package/LICENSE.txt

@@ -0,0 +1,28 @@
+
+Portions of this software Copyright (c) 2011 by Vertica, an HP
+Company.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+- Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

strings_package/README.txt

@@ -1,35 +1,62 @@
-***************
-* Vertica UDF Strings package
-*
-* This library contains commonly used string manipulation functions
-* for use in text search and natural language processing applications
-*
-* StringTokenizer: Tokenizes strings on spaces into single words
-*
-* EditDistance: How many characters words differ by (http://en.wikipedia.org/wiki/Levenshtein_distance)
-*   Contributed by UbiSoft who says: "On a 4-node cluster, it achieved
-*   an impressive performance of 100M rows a second (about 15 seconds
-*   to go through 1.5B rows)."
-*
-*
-* Stemmer: the famous Porter Stemmer (http://en.wikipedia.org/wiki/Stemming)
-*
-* NGrams:  find all 2,3,4 and 5 word sequences in sentences
-*          (http://en.wikipedia.org/wiki/N-gram).
-* 
-* WordCount: Counts the number of words that appear in a sentence
-*
-***************
-
-1) To build, run:
-
-  cd build
-  make
-
-2) to install, run:
-
-./install.sh
-
-3) to uninstall, execute the following sql:
-
-./uninstall.sh
+-------------------------------
+INTRODUCTION
+-------------------------------
+
+This library contains commonly used string manipulation functions for
+use in text search and natural language processing applications
+
+StringTokenizer: Tokenizes strings on spaces into single words
+
+EditDistance: How many characters words differ by
+(http://en.wikipedia.org/wiki/Levenshtein_distance)
+
+Stemmer: the famous Porter Stemmer
+(http://en.wikipedia.org/wiki/Stemming)
+
+NGrams: find all 2,3,4 and 5 word sequences in sentences
+(http://en.wikipedia.org/wiki/N-gram).
+
+WordCount: Counts the number of words that appear in a sentence
+
+-------------------------------
+BUILDING
+-------------------------------
+
+To build:
+
+$ make
+
+
+-------------------------------
+INSTALLING / UNINSTALLING
+-------------------------------
+
+Assuming vsql is in your path, just do:
+
+$ make install
+$ make uninstall
+
+Alternately, you can find the DDL that 'make install' uses in:
+ src/ddl/install.sql 
+and
+ src/ddl/uninstall.sql
+
+-------------------------------
+USAGE
+-------------------------------
+
+Please see examples
+
+-------------------------------
+PERFORMANCE
+-------------------------------
+
+EditDistance: Contributed by UbiSoft who says: "On a 4-node cluster,
+it achieved an impressive performance of 100M rows a second (about 15
+seconds to go through 1.5B rows)."
+
+-------------------------------
+LICENSE
+-------------------------------
+
+Please see LICENSE.txt

web_package/LICENSE.txt

@@ -0,0 +1,28 @@
+
+Portions of this software Copyright (c) 2011 by Vertica, an HP
+Company.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are
+met:
+
+- Redistributions of source code must retain the above copyright
+  notice, this list of conditions and the following disclaimer.
+
+- Redistributions in binary form must reproduce the above copyright
+  notice, this list of conditions and the following disclaimer in the
+  documentation and/or other materials provided with the distribution.
+
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

web_package/README.txt

@@ -1,29 +1,44 @@
-***************
-** Vertica Web Analysis Package. 
-**
-** Functions included (more details below):
-** 
-** Apache Log Parser: Parse Apache Web Server log files
-**
-** URI decoder
-** 
-** IIS / W3C Parser: Parse Microsoft IIS Web Server log files
-** 
-***************
+-------------------------------
+INTRODUCTION
+-------------------------------
 
+The Web Analysis Package includes functions that are commonly used
+for analysis of weblogs.
 
-1) To build, run:
+Apache Log Parser: Parse Apache Web Server log files
 
-  cd build
-  make
+IIS / W3C Parser: Parse Microsoft IIS Web Server log files
 
-2) to install, run:
+URI decoder: Decodes the name=value pairs in URLs
+http://en.wikipedia.org/wiki/Percent-encoding
 
-./install.sh
+-------------------------------
+BUILDING
+-------------------------------
 
-3) to uninstall, execute the following sql:
+To build:
+
+$ make
+
+
+-------------------------------
+INSTALLING / UNINSTALLING
+-------------------------------
+
+Assuming vsql is in your path, just do:
+
+$ make install
+$ make uninstall
+
+Alternately, you can find the DDL that 'make install' uses in:
+ src/ddl/install.sql 
+and
+ src/ddl/uninstall.sql
+
+-------------------------------
+USAGE
+-------------------------------
 
-./uninstall.sh
 
 *********************
 * W3C Log Parser
@@ -55,8 +70,14 @@ the filename in the table holding the log data).
 Please see the w3cLogParser.sql script for an example of how to stage
 the data and call the function.
 
+-------------------------------
+PERFORMANCE
+-------------------------------
 
 
 
+-------------------------------
+LICENSE
+-------------------------------
 
-
+Please see LICENSE.txt