[jboss-svn-commits] JBL Code SVN: r30175 - labs/jbosstm/workspace/whitingjr/trunk/performance.

[jboss-svn-commits at lists.jboss.org]

Author: whitingjr
Date: 2009-11-16 07:55:15 -0500 (Mon, 16 Nov 2009)
New Revision: 30175

Added:
   labs/jbosstm/workspace/whitingjr/trunk/performance/INSTALL.txt
Log:
Added installation and configuration information for project.

Added: labs/jbosstm/workspace/whitingjr/trunk/performance/INSTALL.txt
===================================================================
--- labs/jbosstm/workspace/whitingjr/trunk/performance/INSTALL.txt	                        (rev 0)
+++ labs/jbosstm/workspace/whitingjr/trunk/performance/INSTALL.txt	2009-11-16 12:55:15 UTC (rev 30175)
@@ -0,0 +1,55 @@
+To run the performance tests you will need to download client database driver
+for each database profiled against. Multiple databases types and installations are 
+supported.
+
+The steps for configuring are:
+
+* Down load database client driver
+* Configure the database installation
+* Add vendor db library package.
+* Select command line options
+* Execute profiling for later comparrison.
+
+
+    Each database driver is installed in a separate directory.
+   Create a directory (without spaces) for each database vendor.
+   ./libs/dbdrivers/<dbvendor>/
+   Place the driver jar file in the. directory.
+   
+   The <dbvendor> directory name is used later in these configuration instructions 
+   and executing the profiling.
+   
+   Now configure the database connection details for the installation type.
+   Create a directory using the same <dbvendor> used in the previous step.
+   ./src/main/resources/properties/database/<dbvendor>/
+   Then copy the contents of the sample directory into the one just created.
+   for example
+   cp src/main/resources/properties/database/sample src/main/resources/properties/database/<dbvendor>/ 
+   
+   For each database vendor three types of installation are supported. Embedded,
+   co-located and remote. Rather than repeat vendor details for each installation
+   a common vendor properties file is used. This is used in addition to the installation 
+   property file.
+   common vendor properties
+   ./src/main/resources/properties/database/<dbvendor>/db-profile.properties
+   and for a remote installation
+   src/main/resources/properties/database/<dbvendor>/database-locations/remote-db/db-installation.properties
+
+   Configuring the profiled classes for each vendor requires identifying the package name 
+   in the driver library. It is recommended you use a generic name to ensure most accurate
+   timings. for example, the MySQL driver package has two package domains
+   com.mysql and org.gjt
+   This package is added to the 'db-vendor-profiling' property in the database 
+   vendor common properties file. Multiple package names are supported using a comma
+   to separate each.
+   
+   Select an appropriate class for controlling the database during setup. Some vendors
+   support sequences whereas others do not. If a class has not been provided then
+   implement one using existing classes as guideline. You will need to
+   extend org.jboss.jbossts.performance.persistence.vendor.AbstractVendorControl
+   
+
+    
+   
+   
+   
\ No newline at end of file