http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/09afbad7/docs/client_install/index.html ---------------------------------------------------------------------- diff --git a/docs/client_install/index.html b/docs/client_install/index.html index ff0921f..bca6761 100644 --- a/docs/client_install/index.html +++ b/docs/client_install/index.html @@ -558,135 +558,151 @@ table.CodeRay td.code>pre{padding:0} <li><a href="#_odbc_based_clients">2.1.2. ODBC-Based Clients</a></li> </ul> </li> -<li><a href="#introduction-download">2.2. Download Installation Package</a> -<ul class="sectlevel3"> -<li><a href="#introduction-windows-download">2.2.1. Windows Download</a></li> -<li><a href="#introduction-linux-download">2.2.2. Linux Download</a></li> -</ul> -</li> </ul> </li> -<li><a href="#jdbct4">3. Install JDBC Type-4 Driver</a> +<li><a href="#_preparation">3. Preparation</a> <ul class="sectlevel2"> -<li><a href="#jdbct4-installation-requirements">3.1. Installation Requirements</a> +<li><a href="#java-setup">3.1. Java Setup</a> <ul class="sectlevel3"> -<li><a href="#jdbct4-java-environment">3.1.1. Java Environment</a></li> +<li><a href="#java-validation">3.1.1. Verify Java Version</a></li> +<li><a href="#java-install">3.1.2. Install Java</a></li> </ul> </li> -<li><a href="#jdbct4-install-instructions">3.2. Installation Instructions</a> +<li><a href="#download-client-software">3.2. Download Client Software</a> <ul class="sectlevel3"> -<li><a href="#jdbct4-install-driver">3.2.1. Install JDBC Type-4 Driver</a></li> +<li><a href="#download-windows">3.2.1. Windows Download</a></li> +<li><a href="#download-linux">3.2.2. Linux Download</a></li> </ul> </li> -<li><a href="#jdbct4-setup-env">3.3. Set Up Client Environment</a> +<li><a href="#unpack-client-software">3.3. Unpack Client Software</a> <ul class="sectlevel3"> -<li><a href="#_java_development">3.3.1. Java Development</a></li> -<li><a href="#_configure_applications">3.3.2. Configure Applications</a></li> +<li><a href="#_unpack_jdbc_based_client_software">3.3.1. Unpack JDBC-Based Client Software</a></li> +<li><a href="#_unpack_odbc_based_client_software">3.3.2. Unpack ODBC-Based Client Software</a></li> </ul> </li> -<li><a href="#jdbct4-test-programs">3.4. Test Programs</a></li> -<li><a href="#_uninstall_jdbc_type_4_driver">3.5. Uninstall JDBC Type-4 Driver</a></li> -<li><a href="#_reinstall_jdbc_type_4_driver">3.6. Reinstall JDBC Type-4 Driver</a></li> </ul> </li> -<li><a href="#trafci">4. Install trafci</a> +<li><a href="#jdbct4">4. Install JDBC Type-4 Driver</a> <ul class="sectlevel2"> -<li><a href="#trafci-installation-requirements">4.1. Installation Requirements</a> +<li><a href="#_prerequisites">4.1. Prerequisites</a></li> +<li><a href="#jdbct4-validate-install">4.2. Validate Install Directory</a></li> +<li><a href="#jdbct4-setup-env">4.3. Set Up Client Environment</a> <ul class="sectlevel3"> -<li><a href="#trafci_perl_python">4.1.1. Install Perl or Python</a></li> +<li><a href="#jdbct4-java-development">4.3.1. Java Development</a></li> +<li><a href="#_configure_applications">4.3.2. Configure Applications</a></li> +</ul> +</li> +<li><a href="#jdbct4-test-programs">4.4. Test Programs</a></li> +<li><a href="#_uninstall_jdbc_type_4_driver">4.5. Uninstall JDBC Type-4 Driver</a></li> </ul> </li> -<li><a href="#trafci-installation-instructions">4.2. Installation Instructions</a> +<li><a href="#trafci">5. Install trafci</a> +<ul class="sectlevel2"> +<li><a href="#_prerequisites_2">5.1. Prerequisites</a></li> +<li><a href="#trafci_perl_python">5.2. Install Perl or Python</a></li> +<li><a href="#trafci-verify-install">5.3. Verify Installation</a></li> +<li><a href="#trafci-run-installer">5.4. Run trafci Installer</a> <ul class="sectlevel3"> -<li><a href="#trafci-run-installer">4.2.1. Run Executable JAR Installer</a></li> +<li><a href="#trafci-wizard-install">5.4.1. GUI Wizard Install</a></li> +<li><a href="#trafci-cmd-install">5.4.2. Command-Line Installation Steps</a></li> </ul> </li> -<li><a href="#trafci-post-installation-instructions">4.3. Post-Installation Instructions</a> +<li><a href="#_verify_installed_software_files">5.5. Verify Installed Software Files</a></li> +<li><a href="#_modify_path_variable">5.6. Modify PATH variable</a></li> +<li><a href="#_test_launching_trafci">5.7. Test Launching trafci</a> <ul class="sectlevel3"> -<li><a href="#_verify_installed_software_files">4.3.1. Verify Installed Software Files</a></li> +<li><a href="#_windows_example">5.7.1. Windows Example</a></li> +<li><a href="#_linux_example">5.7.2. Linux Example</a></li> +</ul> +</li> +<li><a href="#trafci-uninstall">5.8. Uninstall trafci</a></li> </ul> </li> -<li><a href="#_test_launching_trafci">4.4. Test Launching trafci</a> +<li><a href="#_configure_dbvisualizer">6. Configure DBVisualizer</a> +<ul class="sectlevel2"> +<li><a href="#_prerequisites_3">6.1. Prerequisites</a></li> +<li><a href="#_configuration_instructions">6.2. Configuration Instructions</a> <ul class="sectlevel3"> -<li><a href="#_windows_example">4.4.1. Windows Example</a></li> -<li><a href="#_linux_example">4.4.2. Linux Example</a></li> +<li><a href="#_register_jdbc_type_4_driver">6.2.1. Register JDBC Type-4 Driver</a></li> +<li><a href="#_create_database_connection">6.2.2. Create Database Connection</a></li> +<li><a href="#_disable_connection_validation_select_option">6.2.3. Disable Connection Validation Select Option</a></li> +<li><a href="#_connect_to_trafodion">6.2.4. Connect to Trafodion</a></li> </ul> </li> -<li><a href="#trafci-uninstall">4.5. Uninstall trafci</a></li> </ul> </li> -<li><a href="#_configure_dbvisualizer">5. Configure DbVisualizer</a> +<li><a href="#_configure_squirrel_client">7. Configure SQuirreL Client</a> <ul class="sectlevel2"> -<li><a href="#_prerequisite_software">5.1. Prerequisite Software</a></li> -<li><a href="#_configuration_instructions">5.2. Configuration Instructions</a> +<li><a href="#_prerequisites_4">7.1. Prerequisites</a></li> +<li><a href="#_configuration_instructions_2">7.2. Configuration Instructions</a> <ul class="sectlevel3"> -<li><a href="#_disable_connection_validation_select_option">5.2.1. Disable Connection Validation Select Option</a></li> -<li><a href="#_register_jdbc_type_4_driver">5.2.2. Register JDBC Type-4 Driver</a></li> -<li><a href="#_connect_to_trafodion">5.2.3. Connect to Trafodion</a></li> +<li><a href="#_register_jdbc_type_4_driver_2">7.2.1. Register JDBC Type-4 Driver</a></li> +<li><a href="#_connect_to_trafodion_2">7.2.2. Connect to Trafodion</a></li> </ul> </li> </ul> </li> -<li><a href="#_configure_squirrel_client">6. Configure SQuirreL Client</a> +<li><a href="#odbc-linux-install">8. Install Linux ODBC Driver</a> <ul class="sectlevel2"> -<li><a href="#_prerequisite_software_2">6.1. Prerequisite Software</a></li> -<li><a href="#_configuration_instructions_2">6.2. Configuration Instructions</a> +<li><a href="#_installation_requirements">8.1. Installation Requirements</a></li> +<li><a href="#_validate_install_directory">8.2. Validate Install Directory</a></li> +<li><a href="#_install_reinstall_linux_odbc_driver">8.3. Install/Reinstall Linux ODBC Driver</a> <ul class="sectlevel3"> -<li><a href="#_register_jdbc_type_4_driver_2">6.2.1. Register JDBC Type-4 Driver</a></li> -<li><a href="#_connect_to_trafodion_2">6.2.2. Connect to Trafodion</a></li> +<li><a href="#linux_odbc_client_env">8.3.1. Set Up Client Environment</a></li> +<li><a href="#_enable_compression">8.3.2. Enable Compression</a></li> </ul> </li> +<li><a href="#_use_third_party_driver_manager">8.4. Use Third-Party Driver Manager</a></li> +<li><a href="#_run_sample_program_code_connect_test_code">8.5. Run Sample Program (<code>connect_test</code>)</a></li> +<li><a href="#linux_odbc_run_basicsql">8.6. Run Sample Program (<code>basicsql</code>)</a></li> </ul> </li> -<li><a href="#_install_linux_odbc_driver">7. Install Linux ODBC Driver</a> +<li><a href="#odb-install">9. Install odb</a> <ul class="sectlevel2"> -<li><a href="#_installation_requirements">7.1. Installation Requirements</a></li> -<li><a href="#_installation_instructions">7.2. Installation Instructions</a> +<li><a href="#_odb_requirements">9.1. odb Requirements</a></li> +<li><a href="#odb-install-unixodbc">9.2. Install and Configure unixODBC</a> <ul class="sectlevel3"> -<li><a href="#_install_reinstall_linux_odbc_driver">7.2.1. Install/Reinstall Linux ODBC Driver</a></li> -<li><a href="#_set_up_client_environment">7.2.2. Set Up Client Environment</a></li> -<li><a href="#_enable_compression">7.2.3. Enable Compression</a></li> -<li><a href="#_use_third_party_driver_manager">7.2.4. Use Third-Party Driver Manager</a></li> -<li><a href="#_run_sample_program_code_connect_test_code">7.2.5. Run Sample Program (<code>connect_test</code>)</a></li> -<li><a href="#linux_odbc_run_basicsql">7.2.6. Run Sample Program (<code>basicsql</code>)</a></li> +<li><a href="#_configure_unixodbc">9.2.1. Configure unixODBC</a></li> +<li><a href="#_configure_data_sources">9.2.2. Configure Data Sources</a></li> </ul> </li> +<li><a href="#odb-verify-install">9.3. Verify odb Installation</a></li> +<li><a href="#odb-uninstall">9.4. Uninstall odb</a></li> </ul> </li> -<li><a href="#install-odb">8. Install odb</a> +<li><a href="#install-windows-odbc-driver">10. Install Windows ODBC Driver</a> <ul class="sectlevel2"> -<li><a href="#installation-requirements">8.1. Installation Requirements</a></li> -<li><a href="#installation-instructions">8.2. Installation Instructions</a> +<li><a href="#_installation_requirements_2">10.1. Installation Requirements</a></li> +<li><a href="#win_odbc_install">10.2. Installation Instructions</a></li> +<li><a href="#win_odbc_setup_data_source">10.3. Set Up ODBC Data Source</a> <ul class="sectlevel3"> -<li><a href="#odb-install">8.2.1. Install odb</a></li> +<li><a href="#_enable_compression_2">10.3.1. Enable Compression</a></li> </ul> </li> -<li><a href="#odb-uninstall">8.3. Uninstall odb</a></li> +<li><a href="#win_odbc_run_basicsql">10.4. Run Sample Program (<code>basicsql</code>)</a></li> +<li><a href="#_reinstall_windows_odbc_driver">10.5. Reinstall Windows ODBC Driver</a></li> +<li><a href="#win_odbc_uninstall">10.6. Uninstalling Windows ODBC Driver</a></li> </ul> </li> -<li><a href="#install-windows-odbc-driver">9. Install Windows ODBC Driver</a> +<li><a href="#_configure_tableau_client">11. Configure Tableau Client</a> <ul class="sectlevel2"> -<li><a href="#_installation_requirements_2">9.1. Installation Requirements</a></li> -<li><a href="#_installation_instructions_2">9.2. Installation Instructions</a> +<li><a href="#_prerequisite_software">11.1. Prerequisite Software</a></li> +<li><a href="#_tableau_datasource_configuration_tdc_file">11.2. Tableau Datasource Configuration (.tdc) File</a> <ul class="sectlevel3"> -<li><a href="#win_odbc_install">9.2.1. Install Windows ODBC Driver</a></li> -<li><a href="#_start_the_installshield_wizard">9.2.2. Start the InstallShield wizard</a></li> -<li><a href="#_add_a_client_data_source">9.2.3. Add a client data source</a></li> -<li><a href="#win_odbc_client_env">9.2.4. Set Up Client Environment</a></li> -<li><a href="#_enable_compression_2">9.2.5. Enable Compression</a></li> -<li><a href="#win_odbc_run_basicsql">9.2.6. Run Sample Program (<code>basicsql</code>)</a></li> +<li><a href="#_create_tdc_file">11.2.1. Create .tdc File</a></li> +<li><a href="#_install_tdc_file">11.2.2. Install .tdc File</a></li> </ul> </li> -<li><a href="#_reinstall_windows_odbc_driver">9.3. Reinstall Windows ODBC Driver</a></li> -<li><a href="#win_odbc_uninstall">9.4. Uninstalling Windows ODBC Driver</a></li> +<li><a href="#_connnect_to_trafodion">11.3. Connnect to Trafodion</a></li> </ul> </li> -<li><a href="#_appendix">10. Appendix</a> +<li><a href="#_how_to">12. How To</a> <ul class="sectlevel2"> -<li><a href="#odbc_sample_program">10.1. <code>basicsql</code> (Sample ODBC Program)</a> +<li><a href="#howto-setup-path">12.1. Set Up Path Variable</a> <ul class="sectlevel3"> -<li><a href="#__code_basicsql_cpp_code_source_code">10.1.1. <code>basicsql.cpp</code> Source Code</a></li> -<li><a href="#basicsql_build">10.1.2. Windows Build and Run Files for <code>basicsql</code></a></li> +<li><a href="#howto-setup-path-windows">12.1.1. Set PATH Variable on Windows</a></li> +<li><a href="#howto-setup-path-linux">12.1.2. Set PATH Variable on Linux</a></li> +<li><a href="#howto-setup-path-verify">12.1.3. Verify PATH Variable</a></li> </ul> </li> </ul> @@ -814,8 +830,7 @@ with the furnishing, performance, or use of this material.</p> <div class="sect2"> <h3 id="_new_and_changed_information">1.2. New and Changed Information</h3> <div class="paragraph"> -<p>This manual shows updated versions for Trafodion Release 2.1.0. It also provides instructions on how to download and install <a href="#odb">Trafodion odb</a>, a -new multi-threaded, ODBC-based command-line tool for parallel data loading and extracting.</p> +<p>This manual shows updated versions for Trafodion Release 2.1.0.</p> </div> </div> <div class="sect2"> @@ -1051,16 +1066,16 @@ database.</p> <td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Trafodion JDBC Type 4 Driver</strong></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">A driver that enables Java applications that run on a client workstation to connect to a Trafodion database.<br> <br> -<strong>NOTE:</strong> The Trafodion Command Interface (TrafCI), DbVisualizer, and SQuirreL SQL Client require this driver to be installed on the client +<strong>NOTE:</strong> The Trafodion Command Interface (trafci), DBVisualizer, and SQuirreL SQL Client require this driver to be installed on the client workstation.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Trafodion Command Interface (TrafCI)</strong></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Trafodion Command Interface (trafci)</strong></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">A command-line interface that allows you to connect to a Trafodion database and run SQL statements and other commands interactively or from script files. For more information, see the <a href="http://trafodion.incubator.apache.org/docs/command_interface/index.html";>Trafodion Command Interface Guide</a>.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>DbVisualizer</strong></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>DBVisualizer</strong></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">A third-party database tool that allows you to connect to a Trafodion database. For more information, see the <a href="http://www.dbvis.com/";>DbVisualizer website</a>.</p></td> </tr> <tr> @@ -1105,24 +1120,120 @@ interface (API) and which run on a Windows workstation, to connect to a Trafodio <td class="tableblock halign-left valign-top"><p class="tableblock">A multi-threaded, ODBC-based command-line tool for parallel data loading and extracting. For more information, see the <a href="http://trafodion.incubator.apache.org/docs/odb/index.html";>Trafodion odb User Guide</a>.</p></td> </tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Tableau</strong></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">An interactive data visualization products focused on business intelligence +For more information, see the <a href="http://www.tableau.com/";>Tableau Software website</a>.</p></td> +</tr> </tbody> </table> <div class="paragraph"> <p><sup>1</sup> License issues prevent us from including the ODBC Driver for Windows in this release. Contact <a href="mailto:[email protected]";>[email protected]</a> for help obtaining the driver.</p> </div> -<div style="page-break-after: always;"></div> +</div> +</div> +</div> +</div> +<div class="sect1"> +<h2 id="_preparation">3. Preparation</h2> +<div class="sectionbody"> +<div class="paragraph"> +<p>Trafodion provides JDBC and ODBC drivers plus clients that use those drivers. +In addition, you can configure third-party JDBC- and ODBC-based tools to work +with Trafodion.</p> +</div> +<div class="paragraph"> +<p>Typically, you install and configure the client software in the following order:</p> +</div> +<div class="olist arabic"> +<ol class="arabic"> +<li> +<p>JDBC and/or ODBC drivers. (Depending on what clients you plan to use.)</p> +</li> +<li> +<p>Trafodion clients. For example, trafci and odb.</p> +</li> +<li> +<p>Third-party clients. For example, DBVisualizer, SQuirell, and/or Tableau.</p> +</li> +</ol> +</div> +<div class="paragraph"> +<p>If you don’t plan to use JDBC-based clients, then please skip ahead to +<a href="#download-client-software">Download Client Software</a>.</p> +</div> +<div class="sect2"> +<h3 id="java-setup">3.1. Java Setup</h3> +<div class="paragraph"> +<p>The Trafodion JDBC Type 4 Driver requires Java 1.7 or higher. You need to set +the Java path to the correct location.</p> +</div> +<div class="paragraph"> +<p>Depending on your planned usage, you install +the Java Development Kit (JDK, if you plan to develop Java-based applications) +or the Java Runtime Environment (JRE, if you plan to use packaged JDBC-based +products only).</p> +</div> +<div class="sect3"> +<h4 id="java-validation">3.1.1. Verify Java Version</h4> +<div class="paragraph"> +<p>To display the Java version of the client workstation on the screen, enter:</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="text">java -version</code></pre> +</div> +</div> +<div class="listingblock"> +<div class="title">Example 1: Java Installed and PATH Variable Set Correctly</div> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="text">C:\> java -version + +java version "1.7.0_45" # This is the version you need to check +Java(TM) SE Runtime Environment (build 1.7.0_45-b18) +Java HotSpot(TM) Client VM (build 24.45-b08, mixed mode, sharing) +C:\></code></pre> +</div> +</div> +<div class="paragraph"> +<p>If the version is not 1.7 or higher, then please upgrade you Java installation +See <a href="#java-install">Install Java</a>.</p> +</div> +<div class="paragraph"> +<p>If the version is 1.7 or higher, then skip ahead to <a href="#download-client-software">Download Client Software</a>.</p> +</div> +<div class="listingblock"> +<div class="title">Example 2: Path Not Set</div> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="text">'java' is not recognized as an internal or external command, operable program or batch file.`</code></pre> +</div> +</div> +<div class="paragraph"> +<p>If you have installed Java, then this message indicates that you’ve not included +the Java directory in your search path. See <a href="#howto-setup-path">Set Up PATH Variable</a>.</p> +</div> +</div> +<div class="sect3"> +<h4 id="java-install">3.1.2. Install Java</h4> +<div class="paragraph"> +<p>Refer to: <a href="http://www.java.com/en/download"; class="bare">http://www.java.com/en/download</a>.</p> +</div> +<div class="paragraph"> +<p>Once installed, follow the instruction in <a href="#howto-setup-path">Set Up PATH Variable</a> +to ensure that your Java environment has been set up properly.</p> +</div> </div> </div> <div class="sect2"> -<h3 id="introduction-download">2.2. Download Installation Package</h3> +<h3 id="download-client-software">3.2. Download Client Software</h3> <div class="paragraph"> -<p>The Trafodion client software is available from the <a href="http://http://trafodion.incubator.apache.org/download.html";>Trafodion Download</a> page. There is one +<p>The Trafodion client software is available from the <a href="http://trafodion.incubator.apache.org/download.html";>Trafodion Download</a> page. There is one <code>Trafodion Clients</code> package per release listed under <strong><version> Binaries</strong>.</p> </div> <div class="paragraph"> -<p>The <code>Trafodion Clients</code> package consists of a zipped tar file that contains the Trafodion Clients tar file. The Trafodion Client -binaries are located in the Clients folder, which contains the following files:</p> +<p>The <code>Trafodion Clients</code> package consists of a zipped tar file that contains the Trafodion Clients tar file. +The Trafodion Client binaries are in the <code>clients</code> folder, which contains the following files:</p> </div> <table class="tableblock frame-all grid-all spread"> <colgroup> @@ -1137,24 +1248,36 @@ binaries are located in the Clients folder, which contains the following files:< </thead> <tbody> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>odbc64_linux.tar.gz</pre></div></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Trafodion odb tool.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>DISCLAIMER</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Trafodion Apache incubation disclaimer.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>TFODBC64-*.exe</pre></div></td> -<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>[Not included in this release]</strong><sup>1</sup> Trafodion ODBC Driver for Windows.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>JDBCT4.zip</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Trafodion JDBC Type 4 Driver.</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>LICENCE</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Apache license.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>TRAF_ODBC_Linux_Driver_64.tar.gz</pre></div></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>NOTICE</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Apache notice.</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>odbc64_linux.tar.gz</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Trafodion odb tool.</p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>TRAF_ODBC_Linux_Driver_64.tar.gz</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Trafodion ODBC driver for Linux.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>trafci.zip</pre></div></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>trafci.zip</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">The Trafodion command interpreter <code>trafci</code>.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>JDBCT4.zip</pre></div></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Trafodion JDBC Type 4 Driver.</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>TFODBC64-*.exe</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>[Not included in this release]</strong><sup>1</sup> Trafodion ODBC Driver for Windows.</p></td> </tr> </tbody> </table> @@ -1162,18 +1285,19 @@ binaries are located in the Clients folder, which contains the following files:< <p><sup>1</sup> License issues prevent us from including the ODBC Driver for Windows in this release. Contact <a href="mailto:[email protected]";>[email protected]</a> for help obtaining the driver.</p> </div> +<div style="page-break-after: always;"></div> <div class="sect3"> -<h4 id="introduction-windows-download">2.2.1. Windows Download</h4> +<h4 id="download-windows">3.2.1. Windows Download</h4> <div class="paragraph"> <p>Do the following:</p> </div> <div class="olist arabic"> <ol class="arabic"> <li> -<p>Create a download folder on the client workstation. For example, <code>Trafodion Downloads</code>.</p> +<p>Create a download folder on the client workstation. For example, <code>c:\trafodion</code>.</p> </li> <li> -<p>Open a Web browser and navigate to the Trafodion downloads site <a href="http://http://trafodion.incubator.apache.org/download.html"; class="bare">http://http://trafodion.incubator.apache.org/download.html</a>.</p> +<p>Open a Web browser and navigate to the Trafodion downloads site <a href="http://trafodion.incubator.apache.org/download.html"; class="bare">http://trafodion.incubator.apache.org/download.html</a>.</p> </li> <li> <p>Orient yourself to the binaries for the release you’re installing. @@ -1181,17 +1305,23 @@ Click on the <code>Trafodion Clients</code> link to start downloading the Trafod </li> <li> <p>Place the <code>apache-trafodion-clients-*.tar.gz</code> file into the download folder.</p> -</li> +<div class="ulist"> +<ul> <li> <p>Unpack the <code>apache-trafodion-clients-*.tar.gz</code> file using an unzip program of your choice. This creates an <code>apache-trafodion-clients-*.tar</code> file.</p> </li> <li> -<p>Unpack the <code>apache-trafodion-clients-*.tar</code> file using an unzip program of your choice. This creates -the <code>clients</code> folder, which has the following content:</p> +<p>Unpack the <code>apache-trafodion-clients-*.tar</code> file using an unzip program of your choice.</p> +</li> +</ul> +</div> +</li> +<li> +<p>Verify content of the <code>clients</code> directory:</p> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">JDBCT4.zip odb64_linux.tar.gz trafci.zip TRAF_ODBC_Linux_Driver_64.tar.gz</code></pre> +<pre class="CodeRay highlight"><code data-lang="text">DISCLAIMER JDBCT4.zip LICENSE NOTICE odb64_linux.tar.gz trafci.zip TRAF_ODBC_Linux_Driver_64.tar.gz</code></pre> </div> </div> <div class="paragraph"> @@ -1200,19 +1330,20 @@ the <code>clients</code> folder, which has the following content:</p> </li> </ol> </div> +<div style="page-break-after: always;"></div> </div> <div class="sect3"> -<h4 id="introduction-linux-download">2.2.2. Linux Download</h4> +<h4 id="download-linux">3.2.2. Linux Download</h4> <div class="paragraph"> <p>Do the following:</p> </div> <div class="olist arabic"> <ol class="arabic"> <li> -<p>Create a download directory on the client workstation. For example, <code>$HOME/trafodion-downloads</code>.</p> +<p>Create a download directory on the client workstation. For example, <code>$HOME/trafodion</code>.</p> </li> <li> -<p>Open a Web browser and navigate to the Trafodion downloads site <a href="http://http://trafodion.incubator.apache.org/download.html"; class="bare">http://http://trafodion.incubator.apache.org/download.html</a>.</p> +<p>Open a Web browser and navigate to the Trafodion downloads site <a href="http://trafodion.incubator.apache.org/download.html"; class="bare">http://trafodion.incubator.apache.org/download.html</a>.</p> </li> <li> <p>Orient yourself to the binaries for the release you’re installing. @@ -1220,7 +1351,7 @@ Right-click on the <code>Trafodion Clients</code> link and select <strong>Copy l </li> <li> <p>Go to the download directory on the client workstation and use <code>wget</code> to download the client package -using the link address you copied in step 3 above.</p> +using the URL you copied in step 3 above.</p> </li> <li> <p>Unpack the <code>apache-trafodion-clients-*.tar.gz</code> using <code>tar</code>.</p> @@ -1229,13 +1360,14 @@ using the link address you copied in step 3 above.</p> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">$ mkdir $HOME/trafodion-downloads -$ cd $HOME/trafodion-downloads +<pre class="CodeRay highlight"><code data-lang="text">$ mkdir $HOME/trafodion +$ cd $HOME/trafodion $ wget <link to package> -$ tar -xzf apache-trafodion-clients-1.3.0-incubating-bin.tar.gz +$ tar -xzvf apache-trafodion_clients-*-incubating.tar.gz $ cd clients $ ls -JDBCT4.zip odb64_linux.tar.gz trafci.zip TRAF_ODBC_Linux_Driver_64.tar.gz +DISCLAIMER LICENSE odb64_linux.tar.gz TRAF_ODBC_Linux_Driver_64.tar.gz +JDBCT4.zip NOTICE trafci.zip $</code></pre> </div> </div> @@ -1245,283 +1377,204 @@ $</code></pre> </li> </ol> </div> +<div style="page-break-after: always;"></div> </div> </div> -</div> -</div> -<div class="sect1"> -<h2 id="jdbct4">3. Install JDBC Type-4 Driver</h2> -<div class="sectionbody"> <div class="sect2"> -<h3 id="jdbct4-installation-requirements">3.1. Installation Requirements</h3> +<h3 id="unpack-client-software">3.3. Unpack Client Software</h3> <div class="paragraph"> -<p>The Trafodion JDBC Type 4 Driver requires a Java-enabled platform that supports the Java Development Kit (JDK) 1.7 or higher.</p> +<p>The client packages are located on the <code>client</code> subdirectory where you unpacked +the Trafodion distribution file. For example, <code>c:\trafodion\clients</code> (Windows) +or <code>$HOME/trafodion/clients</code> (Linux).</p> </div> -<div class="sect3"> -<h4 id="jdbct4-java-environment">3.1.1. Java Environment</h4> <div class="paragraph"> -<p>The Trafodion JDBC Type 4 Driver requires that a compatible Java version be installed on the client workstation and that the Java path be set to -the correct location. The supported Java version is 1.7 or higher.</p> +<p>Unpack the client software and its dependencies you intend to use as follows.</p> </div> -<div class="admonitionblock note"> -<table> +<div class="sect3"> +<h4 id="_unpack_jdbc_based_client_software">3.3.1. Unpack JDBC-Based Client Software</h4> +<table class="tableblock frame-all grid-all spread"> +<colgroup> +<col style="width: 30%;"> +<col style="width: 30%;"> +<col style="width: 40%;"> +</colgroup> +<thead> <tr> -<td class="icon"> -<i class="fa icon-note" title="Note"></i> -</td> -<td class="content"> -If you plan to do Java-based development, install the Java Development Kit (JDK) rather than the Java Runtime Environment (JRE). -These examples use JRE. -</td> +<th class="tableblock halign-left valign-top">File</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Recommended Target Directory</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>JDBCT4.zip</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">JDBC Type 4 Driver</p></td> +<td class="tableblock halign-left valign-top"><div><div class="ulist"> +<ul> +<li> +<p><strong>Windows:</strong> <code>c:\trafodion\jdbct4</code></p> +</li> +<li> +<p><strong>Linux:</strong> <code>$HOME/trafodion/jdbct4</code></p> +</li> +</ul> +</div></div></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>trafci.zip</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Command Interface</p></td> +<td class="tableblock halign-left valign-top"><div><div class="ulist"> +<ul> +<li> +<p><strong>Windows:</strong> <code>c:\trafodion\trafci</code></p> +</li> +<li> +<p><strong>Linux:</strong> <code>$HOME/trafodion/trafci</code></p> +</li> +</ul> +</div></div></td> </tr> +</tbody> </table> -</div> -<div class="sect4"> -<h5 id="jdbct4-verify-java-version">Verify Java Version</h5> <div class="paragraph"> -<p>To display the Java version of the client workstation on the screen, enter:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">java -version</code></pre> -</div> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">C:\> java -version - -java version "1.7.0_45" # This is the version you need to check -Java(TM) SE Runtime Environment (build 1.7.0_45-b18) -Java HotSpot(TM) Client VM (build 24.45-b08, mixed mode, sharing) -C:\></code></pre> +<p><strong>Windows</strong></p> </div> +<div class="paragraph"> +<p>Use your favorite compress/uncompress utility to unpack the file to the target directory +defined in the table above.</p> </div> <div class="paragraph"> -<p>The Java version should be <strong>1.7</strong> or higher. If the returned version is not supported, please refer to -<a href="#jdbct4-install-java">Installing a Supported Java Version</a> below.</p> +<p><strong>Linux</strong></p> </div> -<div style="page-break-after: always;"></div> <div class="paragraph"> -<p>If you see this message:</p> +<p>Unpack the <code>.zip</code> file using the <code>unzip <file> -d <target-directory></code> command:</p> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">'java' is not recognized as an internal or external command, operable program or batch file.`</code></pre> +<pre class="CodeRay highlight"><code data-lang="text">$ cd $HOME/trafodion/clients +$ unzip JDBCT4.zip -d $HOME/trafodion/jdbct4 +. +. +. +$ unzip trafci.zip -d $HOME/trafodion/trafci +. +. +. +$ cd .. +$ ls +apache-trafodion_clients-2.0.1-incubating.tar.gz clients jdbct4 trafci +$</code></pre> </div> </div> <div class="paragraph"> -<p>It indicates that the Java PATH is not set. Follow one of these sets of instructions, depending on the operating system of your client -workstation:</p> +<p>Once complete, a fully-installed <code>c:\trafodion</code> (Windows) or +<code>$HOME/trafodion</code> directory should contain the following directories:</p> </div> <div class="ulist"> <ul> <li> -<p><a href="#jdbct4-path-windows">Setting the PATH to a Supported Java Version on Windows</a></p> +<p><code>clients</code>: The compressed client software.</p> +</li> +<li> +<p><code>jdbct4</code>: The Trafodion JDBC Type 4 driver installation directory.</p> </li> <li> -<p><a href="#jdbct4-path-linux">Setting the PATH to a Supported Java Version on Linux</a></p> +<p><code>trafci</code>: The Trafodion Command Interpreter installation directory.</p> </li> </ul> </div> </div> -<div class="sect4"> -<h5 id="jdbct4-install-java">Install Supported Java Version</h5> +<div class="sect3"> +<h4 id="_unpack_odbc_based_client_software">3.3.2. Unpack ODBC-Based Client Software</h4> +<table class="tableblock frame-all grid-all spread"> +<colgroup> +<col style="width: 30%;"> +<col style="width: 30%;"> +<col style="width: 40%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">File</th> +<th class="tableblock halign-left valign-top">Description</th> +<th class="tableblock halign-left valign-top">Recommended Target Directory</th> +</tr> +</thead> +<tbody> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>TRAF_ODBC_Linux_Driver_64.tar.gz</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Linux ODBC Driver</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>$HOME/trafodion/odbc</code></p></td> +</tr> +<tr> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>odb64_linux.tar.gz</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">Linux odb Utility</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>$HOME/trafodion/odb</code></p></td> +</tr> +</tbody> +</table> <div class="paragraph"> -<p>The supported Java version is 1.7 or higher. To install one of the supported Java versions on the client workstation, -go to this link: <a href="http://www.java.com/en/download"; class="bare">http://www.java.com/en/download</a></p> +<p><strong>Linux</strong></p> </div> <div class="paragraph"> -<p>After installing the Java version, proceed with setting the Java path. Follow one of these sets of instructions, depending on the operating -system of your client workstation:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p><a href="#jdbct4-path-windows">Setting the PATH to a Supported Java Version on Windows</a></p> -</li> -<li> -<p><a href="#jdbct4-path-linux">Setting the PATH to a Supported Java Version on Linux</a></p> -</li> -</ul> +<p>Unpack the <code>.tar.gz</code> file using the <code>tar -xzvf <file> -C <target-directory></code> command.</p> </div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="text">$ cd $HOME/trafodion/clients +$ mkdir $HOME/trafodion/odbc +$ tar -xzvf TRAF_ODBC_Linux_Driver_64.tar.gz -C $HOME/trafodion/odbc +. +. +. +$ mkdir $HOME/trafodion/odb +$ tar -xzvf odb64_linux.tar.gz -C $HOME/trafodion/odb +. +. +. +$ cd .. +$ ls +apache-trafodion_clients-2.0.1-incubating.tar.gz clients odb odbc</code></pre> </div> -<div class="sect4"> -<h5 id="jdbct4-path-windows">Set Windows PATH Variable</h5> -<div class="sect5"> -<h6 id="_windows_10">Windows 10</h6> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Right-click on the Windows icon on the menu bar. Select <strong>System</strong>.</p> -</li> -<li> -<p>Click on <strong>Advanced System Settings</strong>.</p> -</li> -<li> -<p>In the <strong>System Properties</strong> dialog box, click the <strong>Advanced</strong> tab.</p> -</li> -<li> -<p>Click the <strong>Environment Variables</strong> button.</p> -</li> -<li> -<p>Under <strong>System</strong> variables, select the variable named <strong>Path</strong>, and then click <strong>Edit. . .</strong>:</p> -<div class="paragraph"> -<p><span class="image"><img src="images/win10_edit_path.jpg" alt="Windows 10 Edit Path Variable"></span></p> </div> -</li> -<li> -<p>Click <strong>Browse. . .</strong>. Find the directory where you installed Java and select it.</p> <div class="paragraph"> -<p><span class="image"><img src="images/win10_select_java.jpg" alt="image"></span></p> +<p>Once complete, a fully-installed <code>c:\trafodion</code> (Windows) or +<code>$HOME/trafodion</code> directory should contain:</p> </div> -</li> +<div class="ulist"> +<ul> <li> -<p>Click <strong>OK</strong> to close the browse window. Click <strong>OK</strong> to close the edit window.</p> +<p><code>clients</code>: The compressed client software.</p> </li> <li> -<p>Verify that the updated <strong>Path</strong> appears under <strong>System</strong> variables, and click <strong>OK</strong>.</p> +<p><code>odb</code>: The Trafodion odb utility installation directory.</p> </li> <li> -<p>In the <strong>System Properties</strong> dialog box, click <strong>OK</strong> to accept the changes.</p> +<p><code>odbc</code>: The Trafodion ODBC driver installation directory.</p> </li> -</ol> +</ul> </div> </div> -<div class="sect5"> -<h6 id="_windows_8">Windows 8</h6> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Open system Right-click the <strong>Computer</strong> icon on your desktop, and then select <strong>Properties</strong>. The <strong>Control Panel > System and Security > System</strong> window -appears.</p> -</li> -<li> -<p>In the left navigation bar, click the <strong>Advanced</strong> system settings link.</p> -</li> -<li> -<p>In the <strong>System Properties</strong> dialog box, click the <strong>Environment Variables</strong> button.</p> -</li> -<li> -<p>Under <strong>System</strong> variables, select the variable named <strong>Path</strong>, and then click <strong>Edit</strong>:</p> -<div class="paragraph"> -<p><span class="image"><img src="images/path2.jpg" alt="image"></span></p> </div> -</li> -<li> -<p>Place the cursor at the start of the <strong>Variable</strong> value field and enter the path of the Java bin directory, ending with a semicolon (;):</p> +</div> +</div> +<div class="sect1"> +<h2 id="jdbct4">4. Install JDBC Type-4 Driver</h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="_prerequisites">4.1. Prerequisites</h3> <div class="paragraph"> -<p><span class="image"><img src="images/varval2.jpg" alt="image"></span></p> +<p>If you have not done so already, please ensure that you have <a href="#java-setup">setup your Java environment</a> +and <a href="#download-software">unpackaged the Trafodion client software</a>.</p> </div> <div class="paragraph"> -<p><strong>Example</strong></p> +<p>The examples in this chapter assumes that you have unpackaged the JDBC Type 4 driver installation files +to <code>c:\trafodion\jdbct4</code> (Windows) or <code>$HOME/trafodion/jdbct4</code> (Linux).</p> </div> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">"C:\Program Files (x86)\Java\jre7\bin";</code></pre> </div> -</div> -<div class="admonitionblock note"> -<table> -<tr> -<td class="icon"> -<i class="fa icon-note" title="Note"></i> -</td> -<td class="content"> -Check that no space exists after the semicolon (;) in the path. If there are spaces in the directory name, delimit the entire directory -path in double quotes (") before the semicolon. -</td> -</tr> -</table> -</div> -</li> -<li> -<p>Click <strong>OK</strong>.</p> -</li> -<li> -<p>Verify that the updated <strong>Path</strong> appears under <strong>System</strong> variables, and click <strong>OK</strong>.</p> -</li> -<li> -<p>In the <strong>System Properties</strong> dialog box, click <strong>OK</strong> to accept the changes.</p> -</li> -</ol> -</div> -</div> -</div> -<div class="sect4"> -<h5 id="jdbct4-path_linux">Set Linux PATH Variable</h5> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Open the user profile (<code>.profile</code> or <code>.bash_profile</code> for the Bash shell) in the <code>$HOME</code> directory.</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">cd $HOME -vi .profile</code></pre> -</div> -</div> -</li> -<li> -<p>In the user profile, set the <code>PATH</code> environment variable to include the path of the Java bin -directory.</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">export PATH=/opt/java1.7/jre/bin:$PATH</code></pre> -</div> -</div> -<div class="admonitionblock note"> -<table> -<tr> -<td class="icon"> -<i class="fa icon-note" title="Note"></i> -</td> -<td class="content"> -Place the path of the Java bin directory before <code>$PATH</code>, and check that no space exists after the colon (:) in the path. In the C shell, -use the setenv command instead of export. -</td> -</tr> -</table> -</div> -</li> -<li> -<p>To activate the changes, either log out and log in again or execute the user profile.</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">. .profile</code></pre> -</div> -</div> -</li> -</ol> -</div> -</div> -</div> -</div> -<div class="sect2"> -<h3 id="jdbct4-install-instructions">3.2. Installation Instructions</h3> -<div class="paragraph"> -<p>You download and extract the Trafodion client package using the instructions in <a href="#introduction-download">Download Installation Package</a> above.</p> -</div> -<div class="sect3"> -<h4 id="jdbct4-install-driver">3.2.1. Install JDBC Type-4 Driver</h4> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Change the directory to the <code>clients</code> subdirectory.</p> -</li> -<li> -<p>Extract the contents of the <code>JDBCT4.zip</code> file by using the unzip command (or the extract function of your compression software):</p> -<div class="paragraph"> -<p><strong>Example</strong></p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">unzip JDBCT4.zip -d $HOME/jdbc</code></pre> -</div> -</div> -</li> -</ol> -</div> -<div class="paragraph"> -<p>The content of the target directory is as follows:</p> +<div class="sect2"> +<h3 id="jdbct4-validate-install">4.2. Validate Install Directory</h3> +<div class="paragraph"> +<p>The content of the <code>jdbct4</code> installation directory is as follows:</p> </div> <table class="tableblock frame-all grid-all spread"> <colgroup> @@ -1538,73 +1591,73 @@ use the setenv command instead of export. </thead> <tbody> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>/lib</pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>jdbcT4.jar</pre></div></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/lib</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>jdbcT4.jar</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Product JAR file.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>/samples</pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>t4jdbc.properties</pre></div></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/samples</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>t4jdbc.properties</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Properties file that you can configure for your application environment.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre></pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>README</pre></div></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>README</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Readme file that explains how to use the common sample set.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>/samples/common</pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>sampleUtils.java</pre></div></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/samples/common</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>sampleUtils.java</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Sample source code for creating, populating, and dropping sample tables.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>/samples/DBMetaSample</pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>DBMetaSample.java</pre></div></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/samples/DBMetaSample</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>DBMetaSample.java</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Sample source code for getting metadata about the sample tables.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre></pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>README</pre></div></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>README</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Readme file that explains how to use this sample set.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>/samples/PreparedStatementSample</pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>PreparedStatementSample.java</pre></div></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/samples/PreparedStatementSample</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>PreparedStatementSample.java</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Sample code for simple or parameterized SELECT statements that are prepared.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre></pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>README</pre></div></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>README</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Readme file that explains how to use this sample set.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>/samples/ResultSetSample</pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>README</pre></div></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/samples/ResultSetSample</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>README</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Readme file that explains how to use this sample set.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre></pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>ResultSetSample.java</pre></div></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>ResultSetSample.java</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Sample source code for fetching rows from a result set.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>/samples/StatementSample</pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>README</pre></div></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>/samples/StatementSample</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>README</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Readme file that explains how to use this sample set.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre></pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>StatementSample.java</pre></div></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>StatementSample.java</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Sample source code for fetching rows from a simple SELECT statement.</p></td> </tr> </tbody> </table> -</div> +<div style="page-break-after: always;"></div> </div> <div class="sect2"> -<h3 id="jdbct4-setup-env">3.3. Set Up Client Environment</h3> +<h3 id="jdbct4-setup-env">4.3. Set Up Client Environment</h3> <div class="sect3"> -<h4 id="_java_development">3.3.1. Java Development</h4> +<h4 id="jdbct4-java-development">4.3.1. Java Development</h4> <div class="paragraph"> <p>If you plan to write and run Java applications that use the Trafodion JDBC Type 4 Driver to connect to a Trafodion database, then set these environment variables on the client workstation, replacing <code><em>jdk-directory</em></code> with the location of your Java Development Kit and @@ -1625,19 +1678,19 @@ replacing <code><em>jdbc-installation-directory</em></code> with the name of the </thead> <tbody> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>JAVA_HOME</pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>set JAVA_HOME="<em>jdk-directory</em>"<sup>1</sup></pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>export JAVA_HOME=<em>jdk-directory</em></pre></div></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>JAVA_HOME</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>set JAVA_HOME="<em>jdk-directory</em>"</code><sup>1</sup></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>export JAVA_HOME=<em>jdk-directory</em></code></p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>PATH</pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>set PATH=%PATH%;%JAVA_HOME%\bin</pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>export PATH=$PATH:$JAVA_HOME/bin</pre></div></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>PATH</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>set PATH=%PATH%;%JAVA_HOME%\bin</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>export PATH=$PATH:$JAVA_HOME/bin</code></p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>CLASSPATH</pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>set CLASSPATH=%CLASSPATH%;_jdbc-installation-directory_\lib\jdbcT4.jar;</pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>export CLASSPATH=$CLASSPATH:_jdbc-installation-directory_/lib/jdbcT4.jar:</pre></div></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>CLASSPATH</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>set CLASSPATH=%CLASSPATH%;_jdbc-installation-directory_\lib\jdbcT4.jar;</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>export CLASSPATH=$CLASSPATH:_jdbc-installation-directory_/lib/jdbcT4.jar:</code></p></td> </tr> </tbody> </table> @@ -1647,7 +1700,7 @@ replacing <code><em>jdbc-installation-directory</em></code> with the name of the <div style="page-break-after: always;"></div> </div> <div class="sect3"> -<h4 id="_configure_applications">3.3.2. Configure Applications</h4> +<h4 id="_configure_applications">4.3.2. Configure Applications</h4> <div class="paragraph"> <p>Edit the <code>t4jdbc.properties</code> file in the <code>samples</code> folder. Refer to the <code>README</code> file in the <code>samples</code> folder for instructions.</p> </div> @@ -1657,26 +1710,31 @@ replacing <code><em>jdbc-installation-directory</em></code> with the name of the <div class="ulist"> <ul> <li> -<p><em>catalog</em>: Specify a catalog that exists in the database.</p> +<p><code>catalog</code>: Specify a catalog that exists in the database.</p> </li> <li> -<p><em>schema</em>: Specify a schema that exists in the database.</p> +<p><code>schema</code>: Specify a schema that exists in the database.</p> </li> <li> -<p><em>user</em>: Specify the name of a user who will be accessing the database.</p> +<p><code>user</code>: Specify the name of a user who will be accessing the database.</p> </li> <li> -<p><em>password</em>: Specify the password of a user who will be accessing the database.</p> +<p><code>password</code>: Specify the password of a user who will be accessing the database.</p> </li> <li> -<p><em>url</em>: Specify this string: <em>jdbc:t4jdbc://_host-name</em>:_port-number_/:_</p> +<p><code>url</code>: Specify this string: <code>jdbc:t4jdbc://<host-name>:<port-number>/:</code></p> </li> </ul> </div> <div class="paragraph"> -<p><em>host-name</em> is the IP address or host name of the database platform, and <em>port-number</em> is the location where the -Trafodion Database Connectivity Service (DCS) is running, which is <strong>23400</strong> by default. See the -<a href="http://trafodion.incubator.apache.org/docs/dcs_reference/index.html";>Trafodion Database Connectivity Services Reference Guide</a> +<p><code><host-name></code> is the IP address or host name of the database platform.</p> +</div> +<div class="paragraph"> +<p><code><port-number></code> is the location where the +Trafodion Database Connectivity Service (DCS) is running. (Default: <strong>23400</strong>).</p> +</div> +<div class="paragraph"> +<p>See the <a href="http://trafodion.incubator.apache.org/docs/dcs_reference/index.html";>Trafodion Database Connectivity Services Reference Guide</a> for information about how to configure the DCS port.</p> </div> <div class="paragraph"> @@ -1712,27 +1770,134 @@ The driverâs class name is <code>org.trafodion.jdbc.t4.T4Driver</code>. </div> </div> <div class="sect2"> -<h3 id="jdbct4-test-programs">3.4. Test Programs</h3> +<h3 id="jdbct4-test-programs">4.4. Test Programs</h3> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +You must use JDK and set up the environmental variables as documented in +<a href="#jdbct4-java-development">Java Development</a> to build the test programs. +</td> +</tr> +</table> +</div> <div class="paragraph"> <p>The <code>README</code> file in the <code>samples</code> folder provide information for how you build and run sample Java programs. -You can use these programs to verify the setup of the Trafodion JDBC Type-4 driver. -See the <a href="#jdbct4-install-driver">Install JDBC Type-4 Driver</a> section above for information on the different +You can use these programs to verify the setup of the Trafodion JDBC Type-4 driver.</p> +</div> +<div class="paragraph"> +<p>See the <a href="#jdbct4-validate-install">Validate Install Directory</a> section above for information on the different sample programs that are included with the Trafodion JDBC Type-4 driver.</p> </div> <div class="paragraph"> -<p><strong>Example</strong></p> +<p><strong>Windows Example</strong></p> +</div> +<div class="paragraph"> +<p>Build and run the StatementSample test program to verify the JDBC Type-4 driver installation.</p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="text">C:\trafodion\jdbct4\samples> cd StatementSample + +C:\trafodion\jdbct4\samples\StatementSample> %JAVA_HOME%\bin\javac -classpath ..\..\lib\jdbcT4.jar *.java ..\common\*.java + +Note: ..\common\sampleUtils.java uses or overrides a deprecated API. +Note: Recompile with -Xlint:deprecation for details. + +C:\trafodion\jdbct4\samples\StatementSample> %JAVA_HOME%\bin\java -classpath ..\..\lib\jdbcT4.jar;..;. -Dt4jdbc.properties=..\t4jdbc.properties StatementSample + +Mar 16, 2016 9:36:54 PM common.sampleUtils getPropertiesConnection +INFO: DriverManager.getConnection(url, props) passed + +Inserting TimeStamp + +Simple Select + +Printing ResultSetMetaData ... +No. of Columns 12 +Column 1 Data Type: CHAR Name: C1 +Column 2 Data Type: SMALLINT Name: C2 +Column 3 Data Type: INTEGER Name: C3 +Column 4 Data Type: BIGINT Name: C4 +Column 5 Data Type: VARCHAR Name: C5 +Column 6 Data Type: NUMERIC Name: C6 +Column 7 Data Type: DECIMAL Name: C7 +Column 8 Data Type: DATE Name: C8 +Column 9 Data Type: TIME Name: C9 +Column 10 Data Type: TIMESTAMP Name: C10 +Column 11 Data Type: REAL Name: C11 +Column 12 Data Type: DOUBLE PRECISION Name: C12 + +Fetching rows... + +Printing Row 1 using getString(), getObject() +Column 1 - Row1 ,Row1 +Column 2 - 100,100 +Column 3 - 12345678,12345678 +Column 4 - 123456789012,123456789012 +Column 5 - Selva,Selva +Column 6 - 100.12,100.12 +Column 7 - 100.12,100.12 +Column 8 - 2000-05-06,2000-05-06 +Column 9 - 10:11:12,10:11:12 +Column 10 - 2000-05-06 10:11:12.000000,2000-05-06 10:11:12.0 +Column 11 - 100.12,100.12 +Column 12 - 100.12,100.12 + +Printing Row 2 using getString(), getObject() +Column 1 - Row2 ,Row2 +Column 2 - -100,-100 +Column 3 - -12345678,-12345678 +Column 4 - -123456789012,-123456789012 +Column 5 - Selva,Selva +Column 6 - -100.12,-100.12 +Column 7 - -100.12,-100.12 +Column 8 - 2000-05-16,2000-05-16 +Column 9 - 10:11:12,10:11:12 +Column 10 - 2000-05-06 10:11:12.000000,2000-05-06 10:11:12.0 +Column 11 - -100.12,-100.12 +Column 12 - -100.12,-100.12 + +Printing Row 3 using getString(), getObject() +Column 1 - TimeStamp ,TimeStamp +Column 2 - -100,-100 +Column 3 - -12345678,-12345678 +Column 4 - -123456789012,-123456789012 +Column 5 - Selva,Selva +Column 6 - -100.12,-100.12 +Column 7 - -100.12,-100.12 +Column 8 - 2016-03-16,2016-03-16 +Column 9 - 21:37:03,21:37:03 +Column 10 - 2016-03-16 21:37:03.053,2016-03-16 21:37:03.053 +Column 11 - -100.12,-100.12 +Column 12 - -100.12,-100.12 + +End of Data + +C:\trafodion\jdbct4\samples\StatementSample></code></pre> +</div> +</div> +<div style="page-break-after: always;"></div> +<div class="paragraph"> +<p><strong>Linux Example</strong></p> </div> <div class="paragraph"> <p>Build and run the StatementSample test program to verify the JDBC Type-4 driver installation.</p> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">C:\Development Tools\Trafodion JDBCT4\samples>cd StatementSample +<pre class="CodeRay highlight"><code data-lang="text">$ cd $HOME/trafodion/jdbct4/samples/StatementSample + +$ $JAVA_HOME/bin/javac -classpath ../../lib/jdbcT4.jar *.java ../common/*.java -C:\Development Tools\Trafodion JDBCT4\samples\StatementSample>%JAVA_HOME%\bin\javac -classpath ..\..\lib\jdbcT4.jar *.java ..\common\*.java Note: ..\common\sampleUtils.java uses or overrides a deprecated API. Note: Recompile with -Xlint:deprecation for details. -C:\Development Tools\Trafodion JDBCT4\samples\StatementSample>%JAVA_HOME%\bin\java -classpath ..\..\lib\jdbcT4.jar -Dt4jdbc.properties=..\t4jdbc.properties StatementSample + +$ $JAVA_HOME/bin/java -classpath ../../lib/jdbcT4.jar:..:. -Dt4jdbc.properties=../t4jdbc.properties StatementSample + Mar 16, 2016 9:36:54 PM common.sampleUtils getPropertiesConnection INFO: DriverManager.getConnection(url, props) passed @@ -1801,23 +1966,23 @@ Column 12 - -100.12,-100.12 End of Data -C:\Development Tools\Trafodion JDBCT4\samples\StatementSample></code></pre> +$</code></pre> </div> </div> <div style="page-break-after: always;"></div> </div> <div class="sect2"> -<h3 id="_uninstall_jdbc_type_4_driver">3.5. Uninstall JDBC Type-4 Driver</h3> +<h3 id="_uninstall_jdbc_type_4_driver">4.5. Uninstall JDBC Type-4 Driver</h3> <div class="paragraph"> <p>Run one of these sets of commands to remove the Trafodion JDBC Type 4 Driver:</p> </div> <div class="ulist"> <ul> <li> -<p>On Linux:</p> +<p>On Windows:</p> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">rm -rf <jdbc-installation-directory></code></pre> +<pre class="CodeRay highlight"><code data-lang="text">rmdir /s /q <jdbc-installation-directory></code></pre> </div> </div> <div class="paragraph"> @@ -1825,94 +1990,61 @@ C:\Development Tools\Trafodion JDBCT4\samples\StatementSample></code></pre> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">rm -rf ~/jdbc</code></pre> +<pre class="CodeRay highlight"><code data-lang="text">rmdir /s /q c:\trafodion\jdbct4</code></pre> </div> </div> </li> <li> -<p>On Windows:</p> +<p>On Linux:</p> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">del <jdbc-installation-directory> -rmdir <jdbc-installation-directory></code></pre> +<pre class="CodeRay highlight"><code data-lang="text">rm -rf <jdbc-installation-directory></code></pre> </div> </div> -<div style="page-break-after: always;"></div> <div class="paragraph"> <p><strong>Example</strong></p> </div> -<div class="paragraph"> -<p>Windows uninstall</p> -</div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">C:\>del /s JDBC -C:\JDBC\, Are you sure (Y/N)? Y -C:\JDBC\install\*, Are you sure (Y/N)? Y -Deleted file - C:\JDBC\install\t4jdbcSanityCheck.class -Deleted file - C:\JDBC\install\t4jdbcUninstall.class -Deleted file - C:\JDBC\install\product.contents -C:\JDBC\lib\*, Are you sure (Y/N)? Y -Deleted file - C:\JDBC\lib\jdbcT4.jar -C:\JDBC\samples\*, Are you sure (Y/N)? Y -Deleted file - C:\JDBC\samples\t4jdbc.properties -Deleted file - C:\JDBC\samples\README -C:\JDBC\samples\common\*, Are you sure (Y/N)? Y -Deleted file - C:\JDBC\samples\common\sampleUtils.java -C:\JDBC\samples\DBMetaSample\*, Are you sure (Y/N)? Y -Deleted file - C:\JDBC\samples\DBMetaSample\DBMetaSample.java -Deleted file - C:\JDBC\samples\DBMetaSample\README -C:\JDBC\samples\PreparedStatementSample\*, Are you sure (Y/N)? Y -Deleted file - C:\JDBC\samples\PreparedStatementSample\PreparedStatementSample.java -Deleted file - C:\JDBC\samples\PreparedStatementSample\README -C:\JDBC\samples\ResultSetSample\*, Are you sure (Y/N)? Y -Deleted file - C:\JDBC\samples\ResultSetSample\README -Deleted file - C:\JDBC\samples\ResultSetSample\ResultSetSample.java -C:\JDBC\samples\StatementSample\*, Are you sure (Y/N)? Y -Deleted file - C:\JDBC\samples\StatementSample\README -Deleted file - C:\JDBC\samples\StatementSample\StatementSample.java -C:\>rmdir /s JDBC -JDBC, Are you sure (Y/N)? Y -C:\></code></pre> +<pre class="CodeRay highlight"><code data-lang="text">rm -rf $HOME/trafodion/jdbct4</code></pre> </div> </div> </li> </ul> </div> -<div style="page-break-after: always;"></div> -</div> -<div class="sect2"> -<h3 id="_reinstall_jdbc_type_4_driver">3.6. Reinstall JDBC Type-4 Driver</h3> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Close all applications running on the workstation, except the Web browser.</p> -</li> -<li> -<p>Download and extract the Trafodion client package using the instructions in <a href="#introduction-download">Download Installation Package</a> above.</p> -</li> -<li> -<p>Install the new Trafodion JDBC Type-4 driver. See <a href="#jdbct4-install-driver">Install JDBC Type-4 Driver</a>.</p> -</li> -<li> -<p>Set up the client environment. Please refer to: <a href="#jdbct4-setup-env">Set Up Client Environment</a>.</p> -</li> -</ol> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +Remember to update/remove environmental variables if you’ve created them in th +<a href="#jdbct4-java-development">Java Development</a>. +</td> +</tr> +</table> </div> </div> </div> </div> <div class="sect1"> -<h2 id="trafci">4. Install trafci</h2> +<h2 id="trafci">5. Install trafci</h2> <div class="sectionbody"> <div class="sect2"> -<h3 id="trafci-installation-requirements">4.1. Installation Requirements</h3> +<h3 id="_prerequisites_2">5.1. Prerequisites</h3> <div class="paragraph"> -<p>The Trafodion Command Interface (trafci) runs on Windows and Linux. Before installing trafci on the client workstation, -ensure that you’ve installed the JDBC Type-4 driver. See the <a href="#jdbct4">Install JDBC Type-4 Driver</a> chapter above.</p> +<p>If you have not done so already, please ensure that you have <a href="#java-setup">setup your Java environment</a>, +<a href="#download-software">unpackaged the Trafodion client software</a>, and <a href="#jdbct4">installed the JDBC Type-4 Driver</a>. +.</p> </div> -<div class="sect3"> -<h4 id="trafci_perl_python">4.1.1. Install Perl or Python</h4> +<div class="paragraph"> +<p>The examples in this chapter assumes that you have unpackaged the trafci installation file +to <code>c:\trafodion\trafci</code> (Windows) or <code>$HOME/trafodion/trafci</code> (Linux).</p> +</div> +</div> +<div class="sect2"> +<h3 id="trafci_perl_python">5.2. Install Perl or Python</h3> <div class="paragraph"> <p>If you plan to use Perl or Python scripts with trafci, verify that you have Perl or Python installed on the client workstation. trafci supports these versions of Perl and Python:</p> @@ -1938,29 +2070,10 @@ Jython open source extensions. To download them manually, see the <code>README</ </div> <div style="page-break-after: always;"></div> </div> -</div> <div class="sect2"> -<h3 id="trafci-installation-instructions">4.2. Installation Instructions</h3> -<div class="paragraph"> -<p>You download and extract the Trafodion client package using the instructions in <a href="#introduction-download">Download Installation Package</a> above.</p> -</div> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Change the directory to the <code>clients</code> subdirectory.</p> -</li> -<li> -<p>Extract the contents of the <code>trafci.zip</code> file to a location on your client workstation (for example, a folder named <code>trafci</code>) by -using the unzip command (or the extract function of your compression software):</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">cd $HOME/trafodion-download/clients -unzip trafci.zip -d trafci -cd trafci</code></pre> -</div> -</div> +<h3 id="trafci-verify-install">5.3. Verify Installation</h3> <div class="paragraph"> -<p>The command extracts these files:</p> +<p>Verify that <code>c:\trafodion\trafci</code> (Windows) or <code>$HOME/trafodion/trafci</code> (Linux) contains the following files:</p> </div> <div class="ulist"> <ul> @@ -1972,27 +2085,27 @@ cd trafci</code></pre> </li> </ul> </div> -</li> -</ol> </div> -<div class="sect3"> -<h4 id="trafci-run-installer">4.2.1. Run Executable JAR Installer</h4> +<div class="sect2"> +<h3 id="trafci-run-installer">5.4. Run trafci Installer</h3> +<div class="paragraph"> +<p><code>trafciInstaller.jar</code> is used to install trafci.</p> +</div> <div class="paragraph"> -<p>When using the executable JAR file, <code>trafciInstaller.jar</code>, to install trafci, you have a choice of running the installer from the Installer -Wizard Graphical User Interface (GUI) or from the command line:</p> +<p>Two modes are supported:</p> </div> <div class="ulist"> <ul> <li> -<p><a href="#trafci-wizard-install">Installer Wizard Steps</a></p> +<p><a href="#trafci-wizard-install">GUI Wizard Install</a></p> </li> <li> -<p><a href="#trafci-cmd-install">Command-Line Installation Steps</a></p> +<p><a href="#trafci-cmd-install">Command-Line Install</a></p> </li> </ul> </div> -<div class="sect4"> -<h5 id="trafci-wizard-install">Installer Wizard Steps</h5> +<div class="sect3"> +<h4 id="trafci-wizard-install">5.4.1. GUI Wizard Install</h4> <div class="admonitionblock note"> <table> <tr> @@ -2000,56 +2113,59 @@ Wizard Graphical User Interface (GUI) or from the command line:</p> <i class="fa icon-note" title="Note"></i> </td> <td class="content"> -On Linux, to run the Installer Wizard, you must have the X Window system installed on the client workstation. If the client workstation -does not have the X Window system, see <a href="#trafci-cmd-install">Command-Line Installation Steps</a>. +You must have the X Window system installed on your Linux client workstation to run the trafci Installer Wizard. +If you do not, then use the <a href="#trafci-cmd-install">Command-Line Install</a> instructions below. +<<< +==== Launch the Installer Wizard </td> </tr> </table> </div> -<div style="page-break-after: always;"></div> -<div class="sect5"> -<h6 id="_launching_the_installer_wizard">Launching the Installer Wizard</h6> <div class="olist arabic"> <ol class="arabic"> <li> -<p>Locate the <code>trafciInstaller.jar</code> file in the folder where you extracted the contents of the distribution (<code>.zip</code>) file.</p> -</li> +<p>Move to the trafci install directory.</p> +<div class="ulist"> +<ul> <li> -<p>Verify that the <code>trafciInstaller.jar</code> file appears as an executable JAR File. If not, skip the next two steps and go to Step 5.</p> +<p><strong>Windows:</strong> <code>c:\trafodion\trafci</code></p> </li> <li> -<p>Double-click the <code>trafciInstaller.jar</code> file to launch the Installer Wizard.</p> +<p><strong>Linux:</strong> <code>$HOME/trafodion/trafci</code></p> </li> -<li> -<p>Proceed to <a href="#trafci-using-wizard">Using the Installer Wizard</a>.</p> +</ul> +</div> </li> <li> -<p>At a command prompt, change to the directory where you extracted the installer files:</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">cd installer-directory</code></pre> -</div> +<p>Double-click on <code>trafciInstaller.jar</code></p> +</li> +</ol> </div> <div class="paragraph"> -<p><code><em>installer-directory</em></code> is the directory where you extracted the installer file, <code>trafciInstaller.jar</code>.</p> +<p>If the trafci Installer Wizard does not start, then do the following from a command prompt:</p> </div> +<div class="olist arabic"> +<ol class="arabic"> +<li> +<p>Change director to the trafci install directory.</p> +<div class="ulist"> +<ul> +<li> +<p><strong>Windows:</strong> <code>cd c:\trafodion\trafci</code></p> </li> <li> -<p>Launch the Installer Wizard by entering:</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">java -jar trafciInstaller.jar</code></pre> -</div> +<p><strong>Linux:</strong> <code>cd $HOME/trafodion/trafci</code></p> +</li> +</ul> </div> </li> <li> -<p>Proceed to <a href="#trafci-using-wizard">Using the Installer Wizard</a>.</p> +<p>Launch the trafci Installer Wizard: <code>java -jar trafciInstaller.jar</code></p> </li> </ol> </div> -</div> -<div class="sect5"> -<h6 id="trafci-using-wizard">Using the Installer Wizard</h6> +<div class="sect4"> +<h5 id="trafci-using-wizard">Using the Installer Wizard</h5> <div class="paragraph"> <p>When you execute <code>trafciInstaller.jar</code>, the Installer Wizard appears:</p> </div> @@ -2059,18 +2175,18 @@ does not have the X Window system, see <a href="#trafci-cmd-install">Command-Lin <div class="olist arabic"> <ol class="arabic"> <li> -<p>Click one of these buttons for the type of installation that you would like to perform:</p> +<p>Click one of the buttons for the type of installation that you would like to perform:</p> <div class="ulist"> <ul> <li> -<p><strong>Standard Installation</strong> to start the Installer Wizard, which guides you through installing both the core trafci components and the optional open -source extensions</p> +<p><strong>Standard Installation</strong> to start the Installer Wizard. Guides you through installing both the core trafci components and the optional open +source extensions.</p> </li> <li> -<p><strong>Core Components</strong> for a quick installation of the core trafci files</p> +<p><strong>Core Components</strong> for a quick installation of the core trafci files.</p> </li> <li> -<p><strong>Optional Components</strong> if you have already installed the core trafci files but want to install only the optional open source extensions</p> +<p><strong>Optional Components</strong> if you have already installed the core trafci files but want to install only the optional open source extensions.</p> </li> </ul> </div> @@ -2083,31 +2199,25 @@ where you will install trafci.</p> </div> </li> <li> -<p>To locate the JDBC driver JAR file, click <strong>Browse</strong> next to the <strong>JDBC Type 4 Driver JAR File</strong>.</p> -</li> -<li> -<p>In the <strong>Select JDBC Type 4 Driver JAR File</strong> dialog box, navigate to and select the lib folder of the Trafodion JDBC driver, and then click <strong>Open</strong>.</p> -</li> -<li> -<p>Select <code>jdbcT4.jar</code> so that it appears in the <strong>File Name</strong> box, and then click <strong>Select</strong>.</p> +<p>To locate the <strong>JDBC Type 4 Driver JAR file</strong>, click <strong>Browse</strong> next to the <strong>JDBC Type 4 Driver JAR File</strong>.</p> <div class="paragraph"> -<p>The Installer Wizard now displays the path of the JDBC driver JAR file.</p> +<p>Navigate to the lib folder of the Trafodion JDBC driver and select the <code>jdbcT4.jar</code> file +(<code>c:\trafodion\jdbct4\lib\jdbcT4.jar</code> on Windows, <code>$HOME/trafodion/jdbct4/lib/jdbcT4.jar</code> on Linux), and then click <strong>Select</strong>.</p> </div> <div class="paragraph"> -<p><span class="image"><img src="images/JDBC_JAR_Path.jpg" alt="trafci path to JDBC driver JAR file"></span></p> +<p>The Installer Wizard now displays the path of the JDBC driver JAR file for <strong>JDBC Type 4 Driver JAR File</strong>.</p> </div> </li> <li> -<p>To install in the default location, proceed to Step 9. To install in your own preferred location, proceed to Step 7.</p> -</li> -<li> -<p>To find an installation location for trafci, click <strong>Browse</strong> next to the <strong>Trafodion Command Interface</strong> installation directory.</p> -</li> -<li> -<p>In the <strong>Select Trafodion Command Interface Installation Directory</strong> dialog box, select the folder where you want to install trafci so that -the directory path appears in the <strong>File Name</strong> box, and then click <strong>Select</strong>.</p> +<p>To select the <strong>Trafodion Command Interface installation directory</strong>, click <strong>Browse</strong> next to the <strong>Trafodion Command Interface installation directory</strong></p> <div class="paragraph"> -<p>The Installer Wizard displays the directory where trafci is installed.</p> +<p>Navicate to <code>c:\trafodion</code> (Windows) or <code>$HOME/trafodion</code> (Linux)and click on <strong>Select</strong>.</p> +</div> +<div class="paragraph"> +<p>The Installer Wizard now displays the path of the installation directory for <strong>Trafodion Command Interface installation directory</strong>.</p> +</div> +<div class="paragraph"> +<p><span class="image"><img src="images/trafci_Installation_Choices.jpg" alt="trafci installation choices"></span></p> </div> </li> <li> @@ -2147,7 +2257,7 @@ Perl and Python must be installed for the respective extensions to work. </div> </li> <li> -<p>If you do not require a proxy server, proceed to Step 15.</p> +<p>If you do not require a proxy server, proceed to Step 12.</p> </li> <li> <p>If you require a proxy server, select <strong>Use the following proxy settings</strong> and enter the proxy server and port for downloading the open @@ -2167,7 +2277,7 @@ them in a drop-down menu next to the <strong>Detect Proxy Server(s)</strong> but <p>After the core trafci files are installed, the <strong>Installation Status</strong> dialog box appears indicating how many files were extracted to the installation directory:</p> <div class="paragraph"> -<p><span class="image"><img src="images/Extracted_Files.jpg" alt="trafci extracted files"></span></p> +<p><span class="image"><img src="images/Extracted_Files.jpg" alt="trafci extracted files" width="600" height="600"></span></p> </div> <div class="paragraph"> <p>Click <strong>OK</strong> to continue the installation.</p> @@ -2192,26 +2302,28 @@ the components.</p> <div style="page-break-after: always;"></div> </div> </div> -<div class="sect4"> -<h5 id="trafci-cmd-install">Command-Line Installation Steps</h5> +<div class="sect3"> +<h4 id="trafci-cmd-install">5.4.2. Command-Line Installation Steps</h4> <div class="olist arabic"> <ol class="arabic"> <li> <p>At a command prompt, change to the directory where you extracted the contents of the distribution (.zip) file:</p> +<div class="paragraph"> +<p><strong>Windows</strong></p> +</div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">cd installer-directory</code></pre> -</div> +<pre class="CodeRay highlight"><code data-lang="text">c:\> cd c:\trafodion\trafci +c:\trafodion\trafci> dir +README trafciInstaller.jar</code></pre> </div> -<div class="paragraph"> -<p><code><em>installer-directory</em></code> is the directory where you extracted the installer files.</p> </div> <div class="paragraph"> -<p><strong>Example</strong></p> +<p><strong>Linux</strong></p> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">$ cd $HOME/trafodion-download/clients/trafci +<pre class="CodeRay highlight"><code data-lang="text">$ cd $HOME/trafodion/trafci $ ls README trafciInstaller.jar</code></pre> </div> @@ -2229,29 +2341,64 @@ Usage: java -jar <installer jar> [ -help] | <-cm|-silent> <div class="paragraph"> <p>The <code>-silent</code> option installs the client without prompting you for options.</p> </div> +<div class="paragraph"> +<p><strong>Windows</strong></p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="text">java -jar trafciInstaller.jar -silent -jdbcFile "C:\trafodion\jdbct4\lib\jdbcT4.jar" -installDir C:\trafodion\trafci</code></pre> +</div> +</div> +<div class="paragraph"> +<p><strong>Linux</strong></p> +</div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">java -jar trafciInstaller.jar -silent -jdbcFile "C:\JDBC\lib\jdbcT4.jar" -installDir C:\TRAFCI</code></pre> +<pre class="CodeRay highlight"><code data-lang="text">java -jar trafciInstaller.jar -silent -jdbcFile "$HOME/jdbct4/lib/jdbcT4.jar" -installDir $HOME/trafodion/trafci</code></pre> </div> </div> <div class="paragraph"> <p><em>-jdbcFile</em> and <em>-installDir</em> are optional parameters. If you do not specify those parameters, you will be prompted to enter them during installation.</p> </div> +<div style="page-break-after: always;"></div> </li> <li> <p>Launch the command-line installer by entering this command:</p> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">java -jar trafciInstaller.jar cm</code></pre> +<pre class="CodeRay highlight"><code data-lang="text">java -jar trafciInstaller.jar -cm</code></pre> </div> </div> <div class="paragraph"> <p>The command-line installer starts and prompts you to enter the type of installation:</p> </div> +<div class="paragraph"> +<p><strong>Windows</strong></p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="text">c:\> cd c:\trafodion\trafci +c:\trafodion\trafci> java -jar trafciInstaller.jar -cm +******************************************************************** +**** ** +**** Welcome to Trafodion Command Interface Installer ** +**** ** +**** NOTE: The installer requires a the JDBC Type 4 ** +**** Driver to be installed a on your workstation. ** +******************************************************************** +Type Y for a standard installation, or N for optional components only. + +Standard Installation [Y]:</code></pre> +</div> +</div> +<div class="paragraph"> +<p><strong>Linux</strong></p> +</div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">/home/myname/trafcitemp>java -jar trafciInstaller.jar cm +<pre class="CodeRay highlight"><code data-lang="text">$ cd $HOME/trafodion/trafci +$ java -jar trafciInstaller.jar -cm ******************************************************************** **** ** **** Welcome to Trafodion Command Interface Installer ** @@ -2283,6 +2430,7 @@ All items in square brackets are default values. Press Enter to accept the defau </tr> </table> </div> +<div style="page-break-after: always;"></div> </li> </ul> </div> @@ -2296,6 +2444,29 @@ All items in square brackets are default values. Press Enter to accept the defau Enter the location and file name:</code></pre> </div> </div> +<div class="ulist"> +<ul> +<li> +<p><strong>Windows</strong>: <code>c:\trafodion\jdbct4\lib\jdbcT4.jar</code></p> +</li> +<li> +<p><strong>Linux</strong>: <code>/opt/user/trafodion/lib/jdbcT4.jar</code></p> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +Don’t use environmental variables on Linux (such as <code>$HOME</code>). Instead, specify the full path to the +<code>jdbcT4.jar</code> file. +</td> +</tr> +</table> +</div> +</li> +</ul> +</div> </li> <li> <p>Enter an existing directory where you would like to install trafci:</p> @@ -2306,18 +2477,41 @@ Enter the location and file name:</code></pre> Enter the installation directory:</code></pre> </div> </div> +<div class="ulist"> +<ul> +<li> +<p><strong>Windows</strong>: <code>c:\trafodion\trafci</code></p> +</li> +<li> +<p><strong>Linux</strong>: <code>/opt/user/trafodion/trafci</code></p> <div class="paragraph"> <p>The installation status appears, indicating how many files are installed in the installation directory:</p> </div> <div class="listingblock"> <div class="content"> <pre class="CodeRay highlight"><code data-lang="text">Extracted 18 files from the -/home/myname/trafcitemp/trafciInstaller.jar archive into the -/usr/local/trafci directory. +/opt/user/trafodion/trafci/trafciInstaller.jar archive into the +/opt/user/trafodion/trafci directory. Core TRAFCI files installed. Do you want to install the optional components? [Y]:</code></pre> </div> </div> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +Don’t use environmental variables on Linux (such as <code>$HOME</code>). Instead, specify the full path to the +<code>jdbcT4.jar</code> file. +</td> +</tr> +</table> +</div> +</li> +</ul> +</div> </li> <li> <p>If you do not wish to download and install the optional components, type <strong>N</strong> at the prompt and press Enter, and your installation @@ -2374,6 +2568,7 @@ Install Jython, a Java implementation of Python? [Y]: Y Jython URL (jython_installer-2.2.jar)</code></pre> </div> </div> +<div style="page-break-after: always;"></div> </li> <li> <p>The setup proceeds to download and install the optional open-source components. As each component is retrieved, dots (.) are printed to @@ -2393,7 +2588,7 @@ Downloading Jython [1 of 1] - jython_installer-2.2.jar ......................... 100% Successfully Installed Jython. Successfully added settings.py Trafodion Command Interface Installation Complete. -/home/myname/trafcitemp></code></pre> +$</code></pre> </div> </div> </li> @@ -2402,13 +2597,11 @@ Trafodion Command Interface Installation Complete. <div style="page-break-after: always;"></div> </div> </div> -</div> <div class="sect2"> -<h3 id="trafci-post-installation-instructions">4.3. Post-Installation Instructions</h3> -<div class="sect3"> -<h4 id="_verify_installed_software_files">4.3.1. Verify Installed Software Files</h4> +<h3 id="_verify_installed_software_files">5.5. Verify Installed Software Files</h3> <div class="paragraph"> -<p>After downloading and running the installer file, verify that the trafci software files are installed in the correct locations:</p> +<p>After downloading and running the installer file, verify that the trafci software files are installed in the correct locations. +<code>c:\trafodion\trafci</code> (Windows) or <code>$HOME/trafodion/trafci</code> (Linux).</p> </div> <table class="tableblock frame-all grid-all spread"> <colgroup> @@ -2425,140 +2618,144 @@ Trafodion Command Interface Installation Complete. </thead> <tbody> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>bin</pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>trafci</pre></div></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>bin</code></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>trafci</code></p></td> <td class="tableblock halign-left valign-top"></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre></pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>trafci.cmd</pre></div></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>trafci.cmd</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Windows launch file.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre></pre></div></td> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>trafci.pl</pre></div></td> +<td class="tableblock halign-left valign-top"></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><code>trafci.pl</code></p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">Perl wrapper script. <em>trafci-perl.pl</em> is renamed <em>trafci.pl</em>. To run this script, see the <a href="http://trafodion.incubator.apache.org/docs/command
<TRUNCATED>
