Update READMEs to have correct installation instructions for each pac…

…kage. Make sure instructions are clear for both the precompiled-binary and built-from-source cases.
konstantin-kornienko · Jul 5, 2013 · 531c88e · 531c88e
1 parent a2b252e
commit 531c88e
Show file tree

Hide file tree

Showing 15 changed files with 246 additions and 160 deletions.
diff --git a/avro_parser/README → avro_parser/README.txt b/avro_parser/README → avro_parser/README.txt
@@ -18,6 +18,19 @@ the 'tparty' directory.  Building the parser also builds those libraries.
 * Installation steps
 ***************************************
 
+To install the pre-compiled binary:
+
+- Copy `lib/AvroParser.so' to a machine in your Vertica cluster
+
+- Connect to that machine with vsql and run the following SQL statements:
+CREATE LIBRARY AvroParserLib AS '/path/to/AvroParser.so';
+CREATE PARSER AvroParser AS LANGUAGE 'C++' NAME 'AvroParserFactory' LIBRARY AvroParserLib;
+
+(That's it!)
+
+
+To install from source code:
+
 - Change to the downloaded directory (if you aren't there already ;) )
     cd Avro
 

diff --git a/compatlib_functions/README.txt b/compatlib_functions/README.txt
@@ -16,37 +16,34 @@ TRANSPOSE  (http://www.orafaq.com/node/1871)
 GROUP_GENERATOR - use to build ROLLUP, CUBE, GROUPING_SETS, MULTIPLE DISTINCT AGGREGATES in the NEW EE.
 
 -------------------------------
-BUILDING
+INSTALLING / UNINSTALLING
 -------------------------------
 
-To build:
+You can install this package by running the SQL commands in:
+ src/ddl/install.sql 
+or, to uninstall,
+ src/ddl/uninstall.sql
+Note that the SQL statements assume that you have copied this package to a 
+node in	your cluster and are running them from there.
 
-$ make
+Alternatively, assuming vsql is in your path, just do:
 
+$ make install
+$ make uninstall
 
 -------------------------------
-INSTALLING / UNINSTALLING
+BUILDING
 -------------------------------
 
-Assuming vsql is in your path, just do:
+To build from source:
 
-$ make install
-$ make uninstall
-
-Alternately, you can find the DDL that 'make install' uses in:
- src/ddl/install.sql 
-and
- src/ddl/uninstall.sql
+$ make
 
 -------------------------------
 USAGE
 -------------------------------
 
-See examples
-
--------------------------------
-PERFORMANCE
--------------------------------
+See examples (in the examples/ directory)
 
 -------------------------------
 LICENSE

diff --git a/email_package/README → email_package/README.txt b/email_package/README → email_package/README.txt
@@ -7,24 +7,30 @@ addresses. You can include a subject line and provide an inline message as the
 body, or a text file whose content is printed into the body. 
 
 -------------------------------
-BUILDING
+INSTALLING / UNINSTALLING
 -------------------------------
 
-To build:
+You can install by copying `build/myudx.so' to your Vertica cluster, then 
+running the following SQL statements:
 
-$ make
+CREATE LIBRARY EMAILLib as '/path/to/myudx.so';"
+CREATE FUNCTION EMAIL as language 'C++' name 'EMAILFactory' library EMAILLib;
+
+Alternatively, assuming vsql is in your path, just do:
+
+$ make install
+$ make uninstall
 
+Or, if vsql not in your standard path, edit the makefile.
 
 -------------------------------
-INSTALLING / UNINSTALLING
+BUILDING
 -------------------------------
 
-Assuming vsql is in your path, just do:
+To build from source:
 
-$ make install
-$ make uninstall
+$ make
 
-Or, if vsql not in your standard path, edit the makefile.
 
 -------------------------------
 USAGE

diff --git a/encryption_package/README.txt b/encryption_package/README.txt
@@ -59,11 +59,27 @@ view without compromising the key itself. You can obviously do
 this today, but the key would be exposed with a simple
 'select ..from views'.
 
+-------------------------------
+INSTALLING / UNINSTALLING
+-------------------------------
+
+You can install by running the SQL statements in
+ src/ddl/install.sql 
+or, to uninstall,
+ src/ddl/uninstall.sql
+Note that the SQL statements assume that you have copied this package to a 
+node in	your cluster and are running them from there.
+
+Alternatively, assuming you can run vsql, just do:
+
+$ make install
+$ make uninstall
+
 -------------------------------
 BUILDING
 -------------------------------
 
-To build:
+To build from source:
 
 $ make
 
@@ -74,19 +90,6 @@ in src/third-party/include/my_aes.h to 192 or 256 bits if you're
 inclined. I kept the 128 bit default to be the same as MySQL for
 compatibility.
 
--------------------------------
-INSTALLING / UNINSTALLING
--------------------------------
-
-Assuming you can run vsql, 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

diff --git a/geocode_package/README.txt b/geocode_package/README.txt
@@ -9,6 +9,32 @@ The code hardcodes a free license key obtained after registration with
 limitations.  Please obtain your own key and make the code modifications
 necessary.
 
+-------------------------------
+INSTALLING / UNINSTALLING
+-------------------------------
+
+This package requires that you have the "curl" program and library 
+installed on all machines in your cluster.  For example, on RedHat, as 
+root, do
+
+yum install curl
+
+on all machines in your cluster.
+
+
+You can then install this library by running the SQL statements in
+ src/ddl/install.sql 
+or, to uninstall,
+ src/ddl/uninstall.sql
+Note that the SQL statements assume that you have copied this package to a 
+node in	your cluster and are running them from there.
+
+Alternatively, assuming vsql is in your path, just do:
+
+$ make install
+$ make uninstall
+
+
 -------------------------------
 BUILDING
 -------------------------------
@@ -27,20 +53,6 @@ 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
 -------------------------------

diff --git a/heatmap_package/README → heatmap_package/README.txt b/heatmap_package/README → heatmap_package/README.txt
@@ -17,26 +17,28 @@ image file.
 3. A demonstration python program that takes heat map output and overlays your data over Google maps.
 
 -------------------------------
-BUILDING
+INSTALLING / UNINSTALLING
 -------------------------------
 
-To build:
+You can install by running the SQL statements in
+ src/ddl/install.sql 
+or, to uninstall,
+ src/ddl/uninstall.sql
+Note that the SQL statements assume that you have copied this package to a 
+node in	your cluster and are running them from there.
+
+Alternatively, assuming vsql is in your path, just do:
 
-$ make
+$ make install
+$ make uninstall
 
 -------------------------------
-INSTALLING / UNINSTALLING
+BUILDING
 -------------------------------
 
-Assuming vsql is in your path, just do:
-
-$ make install
-$ make uninstall
+To build from source code:
 
-Alternately, you can find the DDL that 'make install' uses in:
- src/ddl/install.sql 
-and
- src/ddl/uninstall.sql
+$ make
 
 -------------------------------
 USAGE

diff --git a/odbc_loader_package/README → odbc_loader_package/README.txt b/odbc_loader_package/README → odbc_loader_package/README.txt
@@ -8,11 +8,31 @@ This package contains a pair of User-Defined Load functions, ODBCSource() and OD
 
 These Load functions connect to a remote database and load data directly from that database into Vertica.  Data is not converted into an intermediate file format; the data is fetched over the network via ODBC and each record is copied directly into Vertica as it is received.
 
+-------------------------------
+INSTALLING / UNINSTALLING
+-------------------------------
+
+You can install by running the SQL statements in
+ ddl/install.sql 
+or, to uninstall,
+ ddl/uninstall.sql
+Note that the SQL statements assume that you have copied this package to a 
+node in your cluster and are running them from there.
+
+Alternatively, assuming vsql is in your path, just do:
+
+$ make install
+$ make uninstall
+
+As mentioned under 'BUILDING', to install the ODBC Loader you will need to have an ODBC driver manager installed on your cluster.
+
+In order for the ODBC Loader to be useful, you will also need to install one or more ODBC drivers.  These must be installed on ALL COMPUTERS IN YOUR VERTICA CLUSTER!  The drivers are what enable the ODBC Loader to talk to other non-Vertica databases.  Each database product typically has its own driver; you'll need to install the driver per their documentation and packages.
+
 -------------------------------
 BUILDING
 -------------------------------
 
-To build:
+To build this library from source code:
 
 $ make
 
@@ -29,24 +49,6 @@ In order to compile the ODBC Loader, you will need the unixODBC development head
 Please make sure that you are compiling on your Vertica cluster (or at least on a machine that is running the same version and build of unixODBC as your Vertica cluster).  UnixODBC's ABI, particularly prior to version 2.3.0, is not 100% stable; you need to compile for the particular version that you are using.
 
 
--------------------------------
-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:
- ddl/install.sql 
-and
- ddl/uninstall.sql
-
-As mentioned under 'BUILDING', to install the ODBC Loader you will need to have an ODBC driver manager installed on your cluster.
-
-In order for the ODBC Loader to be useful, you will also need to install one or more ODBC drivers.  These must be installed on ALL COMPUTERS IN YOUR VERTICA CLUSTER!  The drivers are what enable the ODBC Loader to talk to other non-Vertica databases.  Each database product typically has its own driver; you'll need to install the driver per their documentation and packages.
-
 -------------------------------
 USAGE
 -------------------------------

diff --git a/sentiment_analysis/README.txt b/sentiment_analysis/README.txt
@@ -18,30 +18,32 @@ the URL.
 returns tweet texts
 
 -------------------------------
-BUILDING
+INSTALLING / UNINSTALLING
 -------------------------------
 
-To build:
-
-$ make
+You can install this library by running the SQL statements in
+ src/ddl/install.sql 
+or, to uninstall,
+ src/ddl/uninstall.sql
+Note that the SQL statements assume that you have copied this package to a 
+node in	your cluster and are running them from there.
 
-For non-standard SDK locations, use
+Alternatively, assuming vsql is in your path, just do:
 
-$ make SDK=/path/to/sdk
+$ make install
+$ make uninstall
 
 -------------------------------
-INSTALLING / UNINSTALLING
+BUILDING
 -------------------------------
 
-Assuming vsql is in your path, just do:
+To build:
 
-$ make install
-$ make uninstall
+$ make
 
-Alternately, you can find the DDL that 'make install' uses in:
- src/ddl/install.sql 
-and
- src/ddl/uninstall.sql
+For non-standard SDK locations, use
+
+$ make SDK=/path/to/sdk
 
 -------------------------------
 USAGE