http://git-wip-us.apache.org/repos/asf/incubator-trafodion-site/blob/11567d60/docs/2.0.0/client_install/index.html ---------------------------------------------------------------------- diff --git a/docs/2.0.0/client_install/index.html b/docs/2.0.0/client_install/index.html index fa5e07b..ff1b1cb 100644 --- a/docs/2.0.0/client_install/index.html +++ b/docs/2.0.0/client_install/index.html @@ -547,130 +547,138 @@ table.CodeRay td.code>pre{padding:0} <li><a href="#_intended_audience">1.1. Intended Audience</a></li> <li><a href="#_new_and_changed_information">1.2. New and Changed Information</a></li> <li><a href="#_notation_conventions">1.3. Notation Conventions</a></li> -<li><a href="#_publishing_history">1.4. Publishing History</a></li> -<li><a href="#_comments_encouraged">1.5. Comments Encouraged</a></li> +<li><a href="#_comments_encouraged">1.4. Comments Encouraged</a></li> </ul> </li> -<li><a href="#_trafodion_client_products">2. Trafodion Client Products</a> +<li><a href="#introduction">2. Introduction</a> <ul class="sectlevel2"> -<li><a href="#_client_summary">2.1. Client Summary</a></li> +<li><a href="#_client_summary">2.1. Client Summary</a> +<ul class="sectlevel3"> +<li><a href="#_jdbc_based_clients">2.1.1. JDBC-Based Clients</a></li> +<li><a href="#_odbc_based_clients">2.1.2. ODBC-Based Clients</a></li> </ul> </li> -<li><a href="#_install_windows_odbc_driver">3. Install Windows ODBC Driver</a> -<ul class="sectlevel2"> -<li><a href="#_installation_package">3.1. Installation Package</a></li> -<li><a href="#_installation_requirements">3.2. Installation Requirements</a></li> -<li><a href="#_installation_instructions">3.3. Installation Instructions</a> +<li><a href="#introduction-download">2.2. Download Installation Package</a> <ul class="sectlevel3"> -<li><a href="#win_odbc_install">3.3.1. Install Windows ODBC Driver</a></li> -<li><a href="#_reinstall_windows_odbc_driver">3.3.2. Reinstall Windows ODBC Driver</a></li> -<li><a href="#win_odbc_uninstall">3.3.3. Uninstalling Windows ODBC Driver</a></li> -<li><a href="#win_odbc_client_env">3.3.4. Set Up Client Environment</a></li> -<li><a href="#_enable_compression">3.3.5. Enable Compression</a></li> -<li><a href="#win_odbc_run_basicsql">3.3.6. Run Sample Program (<code>basicsql</code>)</a></li> +<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="#_install_linux_odbc_driver">4. Install Linux ODBC Driver</a> +<li><a href="#jdbct4">3. Install JDBC Type-4 Driver</a> <ul class="sectlevel2"> -<li><a href="#_installation_packaged">4.1. Installation Packaged</a></li> -<li><a href="#_installation_requirements_2">4.2. Installation Requirements</a></li> -<li><a href="#_installation_instructions_2">4.3. Installation Instructions</a> +<li><a href="#jdbct4-installation-requirements">3.1. Installation Requirements</a> +<ul class="sectlevel3"> +<li><a href="#jdbct4-java-environment">3.1.1. Java Environment</a></li> +</ul> +</li> +<li><a href="#jdbct4-install-instructions">3.2. Installation Instructions</a> +<ul class="sectlevel3"> +<li><a href="#jdbct4-install-driver">3.2.1. Install JDBC Type-4 Driver</a></li> +</ul> +</li> +<li><a href="#jdbct4-setup-env">3.3. Set Up Client Environment</a> <ul class="sectlevel3"> -<li><a href="#_download_linux_odbc_driver">4.3.1. Download Linux ODBC Driver</a></li> -<li><a href="#_install_reinstall_linux_odbc_driver">4.3.2. Install/Reinstall Linux ODBC Driver</a></li> -<li><a href="#_set_up_client_environment">4.3.3. Set Up Client Environment</a></li> -<li><a href="#_enable_compression_2">4.3.4. Enable Compression</a></li> -<li><a href="#_use_third_party_driver_manager">4.3.5. Use Third-Party Driver Manager</a></li> -<li><a href="#_run_sample_program_code_connect_test_code">4.3.6. Run Sample Program (<code>connect_test</code>)</a></li> -<li><a href="#linux_odbc_run_basicsql">4.3.7. Run Sample Program (<code>basicsql</code>)</a></li> +<li><a href="#_java_development">3.3.1. Java Development</a></li> +<li><a href="#_configure_applications">3.3.2. Configure Applications</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="#_install_jdbc_type_4_driver">5. Install JDBC Type-4 Driver</a> +<li><a href="#trafci">4. Install trafci</a> <ul class="sectlevel2"> -<li><a href="#_installation_package_2">5.1. Installation Package</a></li> -<li><a href="#_installation_requirements_3">5.2. Installation Requirements</a> +<li><a href="#trafci-installation-requirements">4.1. Installation Requirements</a> <ul class="sectlevel3"> -<li><a href="#jdbct4_JRE">5.2.1. Install Java Runtime Environment (JRE)</a></li> +<li><a href="#trafci_perl_python">4.1.1. Install Perl or Python</a></li> </ul> </li> -<li><a href="#jdbct4_install">5.3. Installation Instructions</a> +<li><a href="#trafci-installation-instructions">4.2. Installation Instructions</a> <ul class="sectlevel3"> -<li><a href="#jdbct4_download">5.3.1. Download JDBC Type-4 Driver</a></li> -<li><a href="#jdbct4_install_zip">5.3.2. Install JDBC Type-4 Driver</a></li> -<li><a href="#_uninstall_jdbc_type_4_driver">5.3.3. Uninstall JDBC Type-4 Driver</a></li> -<li><a href="#_reinstall_jdbc_type_4_driver">5.3.4. Reinstall JDBC Type-4 Driver</a></li> +<li><a href="#trafci-run-installer">4.2.1. Run Executable JAR Installer</a></li> </ul> </li> -<li><a href="#jdbct4_setup_env">5.4. Set Up Client Environment</a> +<li><a href="#trafci-post-installation-instructions">4.3. Post-Installation Instructions</a> <ul class="sectlevel3"> -<li><a href="#_configure_applications">5.4.1. Configure Applications</a></li> +<li><a href="#_verify_installed_software_files">4.3.1. Verify Installed Software Files</a></li> </ul> </li> +<li><a href="#_test_launching_trafci">4.4. Test Launching trafci</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> +</ul> +</li> +<li><a href="#trafci-uninstall">4.5. Uninstall trafci</a></li> </ul> </li> -<li><a href="#_install_trafci">6. Install TrafCI</a> +<li><a href="#_configure_dbvisualizer">5. Configure DbVisualizer</a> <ul class="sectlevel2"> -<li><a href="#_installation_package_3">6.1. Installation Package</a></li> -<li><a href="#_installation_requirements_4">6.2. Installation Requirements</a> +<li><a href="#_prerequisite_software">5.1. Prerequisite Software</a></li> +<li><a href="#_configuration_instructions">5.2. Configuration Instructions</a> <ul class="sectlevel3"> -<li><a href="#trafci_JRE">6.2.1. Install/Verify Java Runtime Environment</a></li> -<li><a href="#trafci_install_jdbct4">6.2.2. Install/Verify JDBC Type-4 Driver</a></li> -<li><a href="#trafci_perl_python">6.2.3. Install Perl or Python</a></li> +<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> </ul> </li> -<li><a href="#_installation_instructions_3">6.3. Installation Instructions</a> -<ul class="sectlevel3"> -<li><a href="#trafci_download_installer">6.3.1. Download Installer</a></li> -<li><a href="#trafci_run_installer">6.3.2. Run Executable JAR Installer</a></li> -<li><a href="#trafci_uninstall">6.3.3. Uninstall TrafCI</a></li> </ul> </li> -<li><a href="#_post_installation_instructions">6.4. Post-Installation Instructions</a> +<li><a href="#_configure_squirrel_client">6. Configure SQuirreL Client</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> <ul class="sectlevel3"> -<li><a href="#_verify_installed_software_files">6.4.1. Verify Installed Software Files</a></li> -<li><a href="#_test_launching_trafci">6.4.2. Test Launching TrafCI</a></li> +<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> </ul> </li> </ul> </li> -<li><a href="#install-odb">7. Install odb</a> +<li><a href="#_install_linux_odbc_driver">7. Install Linux ODBC Driver</a> <ul class="sectlevel2"> -<li><a href="#installation-package">7.1. Installation Package</a></li> -<li><a href="#installation-requirements">7.2. Installation Requirements</a></li> -<li><a href="#installation-instructions">7.3. Installation Instructions</a> +<li><a href="#_installation_requirements">7.1. Installation Requirements</a></li> +<li><a href="#_installation_instructions">7.2. Installation Instructions</a> <ul class="sectlevel3"> -<li><a href="#odb-download">7.3.1. Download odb</a></li> -<li><a href="#odb-install">7.3.2. Install odb</a></li> -<li><a href="#odb-uninstall">7.3.3. Uninstall odb</a></li> +<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> </ul> </li> </ul> </li> -<li><a href="#_configure_dbvisualizer">8. Configure DbVisualizer</a> +<li><a href="#install-odb">8. Install odb</a> <ul class="sectlevel2"> -<li><a href="#_prerequisite_software">8.1. Prerequisite Software</a></li> -<li><a href="#_configuration_instructions">8.2. Configuration Instructions</a> +<li><a href="#installation-requirements">8.1. Installation Requirements</a></li> +<li><a href="#installation-instructions">8.2. Installation Instructions</a> <ul class="sectlevel3"> -<li><a href="#_disable_connection_validation_select_option">8.2.1. Disable Connection Validation Select Option</a></li> -<li><a href="#_register_jdbc_type_4_driver">8.2.2. Register JDBC Type-4 Driver</a></li> -<li><a href="#_connect_to_trafodion">8.2.3. Connect to Trafodion</a></li> +<li><a href="#odb-install">8.2.1. Install odb</a></li> </ul> </li> +<li><a href="#odb-uninstall">8.3. Uninstall odb</a></li> </ul> </li> -<li><a href="#_configure_squirrel_client">9. Configure SQuirreL Client</a> +<li><a href="#install-windows-odbc-driver">9. Install Windows ODBC Driver</a> <ul class="sectlevel2"> -<li><a href="#_prerequisite_software_2">9.1. Prerequisite Software</a></li> -<li><a href="#_configuration_instructions_2">9.2. Configuration Instructions</a> +<li><a href="#_installation_requirements_2">9.1. Installation Requirements</a></li> +<li><a href="#_installation_instructions_2">9.2. Installation Instructions</a> <ul class="sectlevel3"> -<li><a href="#_register_jdbc_type_4_driver_2">9.2.1. Register JDBC Type-4 Driver</a></li> -<li><a href="#_connect_to_trafodion_2">9.2.2. Connect to Trafodion</a></li> +<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> </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> </ul> </li> <li><a href="#_appendix">10. Appendix</a> @@ -707,7 +715,10 @@ specific language governing permissions and limitations under the License.</p> <p><strong>Acknowledgements</strong></p> </div> <div class="paragraph"> -<p>Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation. Java® is a registered trademark of Oracle and/or its affiliates. DbVisualizer⢠is a trademark of DbVis Software AB.</p> +<p>Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation. Java® is a registered trademark of Oracle and/or its affiliates. DbVisualizer⢠is a trademark of DbVis Software AB.</p> +</div> +<div class="paragraph"> +<p><strong>Revision History</strong></p> </div> <table class="tableblock frame-all grid-all spread"> <colgroup> @@ -722,6 +733,10 @@ specific language governing permissions and limitations under the License.</p> </thead> <tbody> <tr> +<td class="tableblock halign-left valign-top"><p class="tableblock">2.0.0</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">To be announced.</p></td> +</tr> +<tr> <td class="tableblock halign-left valign-top"><p class="tableblock">1.3.0</p></td> <td class="tableblock halign-left valign-top"><p class="tableblock">January, 2016</p></td> </tr> @@ -744,7 +759,7 @@ specific language governing permissions and limitations under the License.</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 1.3.0. It also provides instructions on how to download and install <a href="#odb">Trafodion odb</a>, a +<p>This manual shows updated versions for Trafodion Release 2.0.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> </div> </div> @@ -897,6 +912,11 @@ INTERVAL { start-field TO end-field | single-field }</code></pre> </div> </div> </li> +</ul> +</div> +<div style="page-break-after: always;"></div> +<div class="ulist"> +<ul> <li> <p>Item Spacing</p> <div class="paragraph"> @@ -916,11 +936,6 @@ INTERVAL { start-field TO end-field | single-field }</code></pre> </div> </div> </li> -</ul> -</div> -<div style="page-break-after: always;"></div> -<div class="ulist"> -<ul> <li> <p>Line Spacing</p> <div class="paragraph"> @@ -940,28 +955,7 @@ INTERVAL { start-field TO end-field | single-field }</code></pre> </div> </div> <div class="sect2"> -<h3 id="_publishing_history">1.4. Publishing History</h3> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 50%;"> -<col style="width: 50%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-top">Product Version</th> -<th class="tableblock halign-left valign-top">Publication Date</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock">Trafodion Release 1.3.0</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">To be announced.</p></td> -</tr> -</tbody> -</table> -</div> -<div class="sect2"> -<h3 id="_comments_encouraged">1.5. Comments Encouraged</h3> +<h3 id="_comments_encouraged">1.4. Comments Encouraged</h3> <div class="paragraph"> <p>The Trafodion community encourages your comments concerning this document. We are committed to providing documentation that meets your needs. Send any errors found, suggestions for improvement, or compliments to:</p> @@ -978,7 +972,7 @@ Or, even better, join our community and help us improve our documentation. Pleas </div> </div> <div class="sect1"> -<h2 id="_trafodion_client_products">2. Trafodion Client Products</h2> +<h2 id="introduction">2. Introduction</h2> <div class="sectionbody"> <div class="paragraph"> <p>This manual describes how to install and configure the following client applications, which enable you to connect to and use a Trafodion @@ -986,8 +980,10 @@ database.</p> </div> <div class="sect2"> <h3 id="_client_summary">2.1. Client Summary</h3> +<div class="sect3"> +<h4 id="_jdbc_based_clients">2.1.1. JDBC-Based Clients</h4> <div class="paragraph"> -<p>The following table lists the clients supported by Trafodion.</p> +<p>The following table lists JDBC-based clients supported by Trafodion.</p> </div> <table class="tableblock frame-all grid-all spread"> <colgroup> @@ -1002,344 +998,220 @@ database.</p> </thead> <tbody> <tr> -<th class="tableblock halign-left valign-top"><p class="tableblock">Trafodion ODBC Driver for Windows</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">A driver that enables applications, which were developed for the Microsoft Open Database Connectivity (ODBC) application programming -interface (API) and which run on a Windows workstation, to connect to a Trafodion database.</p></td> -</tr> -<tr> -<th class="tableblock halign-left valign-top"><p class="tableblock">Trafodion ODBC Driver for Linux</p></th> -<td class="tableblock halign-left valign-top"><p class="tableblock">A driver that enables applications, which were developed for the Microsoft ODBC API and run on a Linux workstation, to connect to a -Trafodion database.</p></td> -</tr> -<tr> -<th class="tableblock halign-left valign-top"><p class="tableblock">Trafodion JDBC Type 4 Driver</p></th> -<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. -</p><p class="tableblock">NOTE: The Trafodion Command Interface (TrafCI), DbVisualizer, and SQuirreL SQL Client require this driver to be installed on the client +<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 workstation.</p></td> </tr> <tr> -<th class="tableblock halign-left valign-top"><p class="tableblock">Trafodion Command Interface (TrafCI)</p></th> +<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";><em>Trafodion Command Interface Guide</em></a>.</p></td> -</tr> -<tr> -<th class="tableblock halign-left valign-top"><p class="tableblock">Trafodion odb tool</p></th> -<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_user/index.html";><em>Trafodion odb User Guide</em></a>.</p></td> +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> -<th class="tableblock halign-left valign-top"><p class="tableblock">DbVisualizer</p></th> -<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/";><em>DbVisualizer website</em></a>.</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> -<th class="tableblock halign-left valign-top"><p class="tableblock">SQuirreL SQL Client</p></th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>SQuirreL SQL Client</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://squirrel-sql.sourceforge.net/";><em>SQuirreL SQL Client website</em></a>.</p></td> +<a href="http://squirrel-sql.sourceforge.net/";>SQuirreL SQL Client website</a>.</p></td> </tr> </tbody> </table> </div> -</div> -</div> -<div class="sect1"> -<h2 id="_install_windows_odbc_driver">3. Install Windows ODBC Driver</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>These installation instructions apply to Trafodion Release 1.3.<strong><em>n</em></strong> and subsequent updates of the product until otherwise indicated.</p> -</div> -<div class="sect2"> -<h3 id="_installation_package">3.1. Installation Package</h3> +<div class="sect3"> +<h4 id="_odbc_based_clients">2.1.2. ODBC-Based Clients</h4> <div class="paragraph"> -<p>The installer file for the Trafodion ODBC Driver for Windows is packaged within the Trafodion clients tar file, <code>Trafodion Clients</code>, on the -Trafodion downloads site <a href="http://trafodion.incubator.apache.org/download.html"; class="bare">http://trafodion.incubator.apache.org/download.html</a>. Use this installer file to install the Trafodion ODBC Driver for Windows:</p> +<p>The following table lists ODBC-based clients supported by Trafodion.</p> </div> <table class="tableblock frame-all grid-all spread"> <colgroup> -<col style="width: 25%;"> -<col style="width: 25%;"> -<col style="width: 50%;"> +<col style="width: 30%;"> +<col style="width: 70%;"> </colgroup> <thead> <tr> -<th class="tableblock halign-left valign-top">Installer File</th> +<th class="tableblock halign-left valign-top">Client Name</th> <th class="tableblock halign-left valign-top">Description</th> -<th class="tableblock halign-left valign-top">Client Operating System</th> </tr> </thead> <tbody> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>TFODBC64-1.3.<strong><em>n</em></strong>.msi</pre></div></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Windows MSI installer file</p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Windows 64-bit</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Trafodion ODBC Driver for Linux</strong></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock">A driver that enables applications, which were developed for the Microsoft ODBC API and run on a Linux workstation, to connect to a +Trafodion database.</p></td> </tr> -</tbody> -</table> -<div class="paragraph"> -<p>By default, a new version of the ODBC driver will be installed in this directory and its folders unless you specify a different directory -during installation:</p> -</div> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 40%;"> -<col style="width: 60%;"> -</colgroup> -<thead> <tr> -<th class="tableblock halign-left valign-top">Default Installation Directory</th> -<th class="tableblock halign-left valign-top">Client Operating System</th> +<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Trafodion ODBC Driver for Windows</strong></p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>[Not included in this release]</strong><sup>1</sup><br> +<br> +A driver that enables applications, which were developed for the Microsoft Open Database Connectivity (ODBC) application programming +interface (API) and which run on a Windows workstation, to connect to a Trafodion database.</p></td> </tr> -</thead> -<tbody> <tr> -<td class="tableblock halign-left valign-top"><div class="literal"><pre>C:\Program Files\Trafodion\TRAF</pre></div></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">ODBC 1.0 Windows 64-bit</p></td> +<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Trafodion odb tool</strong></p></td> +<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> </tbody> </table> <div class="paragraph"> -<p>The ODBC client installation file installs or links to multiple client components:</p> +<p><sup>1</sup> License issues prevent us from including the ODBC Driver for Windows in this release. Contact the +Trafodion user e-mail list (<a href="mailto:[email protected]";>[email protected]</a>) for help obtaining the driver.</p> </div> -<table class="tableblock frame-all grid-all spread"> -<colgroup> -<col style="width: 40%;"> -<col style="width: 60%;"> -</colgroup> -<thead> -<tr> -<th class="tableblock halign-left valign-top">This client component…</th> -<th class="tableblock halign-left valign-top">Does this…</th> -</tr> -</thead> -<tbody> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Microsoft ODBC Driver Manager</strong></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Manages access to ODBC drivers for applications. The driver manager loads and unloads drivers and passes calls for ODBC functions to the -correct driver.</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Trafodion ODBC driver</strong></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Implements ODBC function calls to enable an ODBC client application to access the Trafodion database.</p></td> -</tr> -<tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Microsoft ODBC Administrator</strong></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Adds, configures, and removes ODBC data sources on client workstations.</p></td> -</tr> -</tbody> -</table> <div style="page-break-after: always;"></div> </div> +</div> <div class="sect2"> -<h3 id="_installation_requirements">3.2. Installation Requirements</h3> +<h3 id="introduction-download">2.2. Download Installation Package</h3> +<div class="paragraph"> +<p>The Trafodion client software is available from the <a href="http://http://trafodion.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> +</div> <table class="tableblock frame-all grid-all spread"> <colgroup> -<col style="width: 40%;"> -<col style="width: 60%;"> +<col style="width: 30%;"> +<col style="width: 70%;"> </colgroup> <thead> <tr> -<th class="tableblock halign-left valign-top">Item</th> -<th class="tableblock halign-left valign-top">Requirement</th> +<th class="tableblock halign-left valign-top">File</th> +<th class="tableblock halign-left valign-top">Usage</th> </tr> </thead> <tbody> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Computer</strong></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Windows compatible PC workstation</p></td> +<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> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Memory</strong></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Recommended minimum 32 MB</p></td> +<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> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Disk Space</strong></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">Minimum 30 MB additional free space</p></td> +<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">Trafodion ODBC driver for Linux.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Operating System</strong></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">x64 Edition of Microsoft Windows 7, Windows 8, or Windows Server 2008</p></td> +<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">The Trafodion command interpreter <code>trafci</code>.</p></td> </tr> <tr> -<td class="tableblock halign-left valign-top"><p class="tableblock"><strong>Network Software</strong></p></td> -<td class="tableblock halign-left valign-top"><p class="tableblock">TCP/IP</p></td> +<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> </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 the +Trafodion user e-mail list (<a href="mailto:[email protected]";>[email protected]</a>) for help obtaining the driver.</p> </div> -<div class="sect2"> -<h3 id="_installation_instructions">3.3. Installation Instructions</h3> <div class="sect3"> -<h4 id="win_odbc_install">3.3.1. Install Windows ODBC Driver</h4> -<div class="admonitionblock note"> -<table> -<tr> -<td class="icon"> -<i class="fa icon-note" title="Note"></i> -</td> -<td class="content"> -To install the driver on your PC, you must be logged on with a user ID that has administrator privileges. -</td> -</tr> -</table> +<h4 id="introduction-windows-download">2.2.1. Windows Download</h4> +<div class="paragraph"> +<p>Do the following:</p> </div> -<div class="sect4"> -<h5 id="_task_1_download_the_odbc_client_installation_file">Task 1: Download the ODBC client installation file</h5> <div class="olist arabic"> <ol class="arabic"> <li> -<p>Create a download folder on the client workstation.</p> +<p>Create a download folder on the client workstation. For example, <code>Trafodion Downloads</code>.</p> </li> <li> -<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> +<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>Click on the <code>Trafodion Clients</code> link to start downloading the Trafodion clients tar file to your workstation.</p> +<p>Orient yourself to the binaries for the release you’re installing. +Click on the <code>Trafodion Clients</code> link to start downloading the Trafodion clients tar file to your workstation.</p> </li> <li> -<p>Place the <code>*.tar.gz file</code> into the download folder.</p> +<p>Place the <code>apache-trafodion-clients-*.tar.gz</code> file into the download folder.</p> </li> <li> -<p>Extract the contents of the <code><strong>.tar.gz</code> file by using an extract tool like WinZip. The package file contains the -<code>TFODBC64-1.3.*<em>n</em></strong>.msi</code> installer file, which is extracted to the clients sub-directory.</p> +<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> -</ol> -</div> +<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> +<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> </div> -<div class="sect4"> -<h5 id="_task_2_start_the_installshield_wizard">Task 2: Start the InstallShield wizard</h5> -<div class="paragraph"> -<p>The InstallShield wizard walks you through the steps to install the client components (Trafodion ODBC 1.0) on your workstation. You can -perform the installation in <em>interactive mode</em>, in which you provide input or accept defaults when prompted as ODBC is installed. -Please refer to <a href="#win_odbc_interactive_mode">Interactive Mode Installation</a> below.</p> </div> -<div style="page-break-after: always;"></div> -<div class="sect5"> -<h6 id="win_odbc_interactive_mode">Interactive Mode Installation</h6> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Double-click the <code>.msi</code> distribution file to start the InstallShield wizard.</p> -</li> -<li> -<p>On the <strong>Welcome</strong> page, click <strong>Next</strong>.</p> -</li> -<li> -<p>On the <strong>Destination Folder</strong> page, click <strong>Next</strong> to select the default location: <code>C:\Program Files\Trafodion\TRAF ODBC 1.0\</code></p> <div class="paragraph"> -<p>This location is the installation directory for ODBC header and help files. All other ODBC files are installed in <code>%SYSTEMROOT%\system32</code>.</p> +<p>You use these files to install the different Trafodion clients.</p> </div> </li> -<li> -<p>On the <strong>Set Certificate Directory</strong> page, click <strong>Next</strong> to accept the default location for the security certificate (<code>SYSTEM_DEFAULT</code>).</p> -</li> -<li> -<p>On the <strong>Ready to Install the Program</strong> page, click <strong>Install</strong>. The installation begins. The <strong>Installing Trafodion ODBC64 1.0</strong> page displays a -progress bar.</p> -</li> -<li> -<p>On the <strong>InstallShield Wizard Completed</strong> page, click <strong>Finish</strong> to exit the wizard. Do not add a new <code>Trafodion ODBC</code> data source to the MS ODBC -Administrator until you have restarted your system.</p> -</li> </ol> </div> </div> +<div class="sect3"> +<h4 id="introduction-linux-download">2.2.2. Linux Download</h4> +<div class="paragraph"> +<p>Do the following:</p> </div> -<div class="sect4"> -<h5 id="_task_3_add_a_client_data_source">Task 3: Add a client data source</h5> <div class="olist arabic"> <ol class="arabic"> <li> -<p>Start the Microsoft ODBC Administrator:</p> -<div class="ulist"> -<ul> -<li> -<p>On Windows 7: <strong>Start>All Programs>Trafodion ODBC 1.0>MS ODBC Administrator</strong></p> -</li> -<li> -<p>On Windows 8: Right-click the <strong>Trafodion ODBC 1.0</strong> icon on the desktop and select MS ODBC Administrator.</p> -</li> -</ul> -</div> -</li> -<li> -<p>In the <strong>ODBC Data Source Administrator</strong> dialog box, click <strong>Add</strong>.</p> -</li> -<li> -<p>Select <strong>TRAF ODBC 1.0</strong>, and then click <strong>Finish</strong> to start the <strong>Create a New Trafodion ODBC Data Source</strong> wizard.</p> +<p>Create a download directory on the client workstation. For example, <code>$HOME/trafodion-downloads</code>.</p> </li> <li> -<p>Enter the data source name (for example, <code>Default_DataSource_Schema1</code>) and an optional description, and click <strong>Next</strong>.</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>Enter the <code>IP address</code> or <code>host name</code> for the database platform. Enter the port number as <strong>37800</strong>. Leave the defaults as is, and click <strong>Next</strong>.</p> +<p>Orient yourself to the binaries for the release you’re installing. +Right-click on the <code>Trafodion Clients</code> link and select <strong>Copy link address</strong>.</p> </li> <li> -<p>Enter the schema name. The default schema name is <code>SEABASE</code>. Click <strong>Next</strong>.</p> +<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> </li> <li> -<p>Enter the translate DLL name and its option, if you have one. If not, leave it blank. Leave the localization defaults as is.</p> -<div style="page-break-after: always;"></div> +<p>Unpack the <code>apache-trafodion-clients-*.tar.gz</code> using <code>tar</code>.</p> <div class="paragraph"> -<p>The Replacement Character replaces any character that is incompatible for translation when retrieving data. It is one character (one or two -bytes long). The Replacement Character is assumed to be in the character set specified in the Client/Server Character Set Interaction. If it is not specified, <code>?</code> is used as the default.</p> +<p><strong>Example</strong></p> +</div> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="text">$ mkdir $HOME/trafodion-downloads +$ cd $HOME/trafodion-downloads +$ wget <link to package> +$ tar -xzf apache-trafodion-clients-1.3.0-incubating-bin.tar.gz +$ cd clients +$ ls +JDBCT4.zip odb64_linux.tar.gz trafci.zip TRAF_ODBC_Linux_Driver_64.tar.gz +$</code></pre> </div> -<div class="paragraph"> -<p>Click <strong>Next</strong>.</p> </div> -</li> -<li> -<p>Select the trace options, if desired. Change the <strong>Log File Path</strong> to the location you want, or leave the default as is, and click <strong>Finish</strong>.</p> -</li> -<li> -<p>The wizard gives you an opportunity to test the connection. Click <strong>Test Connection</strong> and click <strong>OK</strong>.</p> -</li> -<li> -<p>The server ID and schema are filled in for you. Enter a valid user name and password, and click <strong>OK</strong>.</p> <div class="paragraph"> -<p>The wizard attempts to connect to the data source and displays a message stating whether it was successful or not.</p> +<p>You use these files to install the different Trafodion clients.</p> </div> </li> -<li> -<p>Click <strong>OK</strong> to save the data source, or click <strong>Cancel</strong> <em>twice</em> to quit the <strong>Create Data Source</strong> wizard.</p> -</li> </ol> </div> </div> </div> -<div class="sect3"> -<h4 id="_reinstall_windows_odbc_driver">3.3.2. Reinstall Windows ODBC Driver</h4> -<div class="paragraph"> -<p>To reinstall the driver, we recommend that you fully remove your ODBC driver and then install the new version. Please refer to -<a href="#win_odbc_uninstall">Uninstalling the Trafodion ODBC Driver for Windows</a> and then <a href="#win_odbc_install">Installing the Trafodion ODBC Driver for Windows</a>.</p> -</div> </div> -<div class="sect3"> -<h4 id="win_odbc_uninstall">3.3.3. Uninstalling Windows ODBC Driver</h4> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Start to remove the ODBC driver:</p> -<div class="ulist"> -<ul> -<li> -<p>On Windows 7: <strong>Start>All Programs>Trafodion ODBC 1.0>Remove TRAF ODBC 1.0</strong></p> -</li> -<li> -<p>On Windows 8: Right-click the <strong>Trafodion ODBC 1.0</strong> icon on the desktop and select <strong>Remove TRAF ODBC 1.0</strong>.</p> -</li> -</ul> </div> -</li> -<li> -<p>When the <strong>Windows Installer</strong> dialog box asks you if you want to uninstall this product, click <strong>Yes</strong>.</p> -</li> -<li> -<p>The <strong>Trafodion ODBC 1.0</strong> dialog box displays the status and asks you to wait while <code>Windows configures Trafodion ODBC 1.0</code> (that is, removes -the Trafodion ODBC Driver from your Windows workstation).</p> +<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> <div class="paragraph"> -<p>After this dialog box disappears, Trafodion ODBC 1.0 is no longer on your workstation.</p> +<p>The Trafodion JDBC Type 4 Driver requires a Java-enabled platform that supports the Java Development Kit (JDK) 1.7 or higher.</p> </div> -</li> -</ol> +<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> </div> <div class="admonitionblock note"> <table> @@ -1348,143 +1220,156 @@ the Trafodion ODBC Driver from your Windows workstation).</p> <i class="fa icon-note" title="Note"></i> </td> <td class="content"> -Uninstalling the ODBC driver does not remove pre-existing data source definitions from the Windows registry. +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> </tr> </table> </div> -<div style="page-break-after: always;"></div> -</div> -<div class="sect3"> -<h4 id="win_odbc_client_env">3.3.4. Set Up Client Environment</h4> +<div class="sect4"> +<h5 id="jdbct4-verify-java-version">Verify Java Version</h5> <div class="paragraph"> -<p>All client data sources connect to the pre-configured server data source on the database platform, which is <code>Default_DataSource</code>.</p> +<p>To display the Java version of the client workstation on the screen, enter:</p> </div> -<div class="paragraph"> -<p>You can configure one data source only, <code>Default_DataSource</code>, on the database platform, but you can create other data source -definitions on the workstation.</p> +<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> </div> -<div class="paragraph"> -<p>For example, if you have more than one schema on the database platform and you want to connect -to each of those schemas on the database platform, you can create a client data source for each of those schemas.</p> </div> <div class="paragraph"> -<p>Instead of changing the schema definition in the data source definition on the workstation, you can create multiple data source -definitions with different schemas on the workstation. The client data source will use the specified schema but will connect to -<code>Default_DataSource</code> on the database platform.</p> +<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> </div> +<div style="page-break-after: always;"></div> <div class="paragraph"> -<p>To create a data source on the client workstation, follow these steps:</p> +<p>If you see this message:</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> +</div> </div> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Launch the <strong>MS ODBC Administrator</strong>.</p> <div class="paragraph"> -<p>For example, on Windows 7, select <strong>Start>All Programs>Trafodion ODBC 1.0>MS ODBC Administrator</strong>.</p> +<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> </div> -</li> +<div class="ulist"> +<ul> <li> -<p>In the <strong>ODBC Data Source Administrator</strong> dialog box, select the <strong>User DSN</strong> tab, and click <strong>Add</strong>.</p> +<p><a href="#jdbct4-path-windows">Setting the PATH to a Supported Java Version on Windows</a></p> </li> <li> -<p>Select the <strong>TRAF ODBC 1.0</strong> driver, and then click <strong>Finish</strong>.</p> +<p><a href="#jdbct4-path-linux">Setting the PATH to a Supported Java Version on Linux</a></p> +</li> +</ul> +</div> +</div> +<div class="sect4"> +<h5 id="jdbct4-install-java">Install Supported Java Version</h5> <div class="paragraph"> -<p>A new dialog box appears, prompting you to create a new data source.</p> +<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> </div> -</li> +<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>Enter the name of the data source, <code>Default_DataSource</code>, and click <strong>Next</strong> to continue.</p> +<p><a href="#jdbct4-path-windows">Setting the PATH to a Supported Java Version on Windows</a></p> </li> <li> -<p>Enter the IP address and port number of the Trafodion system to which will be connecting. The port number must be <strong>37800</strong>. -Click <strong>Next</strong> to continue.</p> +<p><a href="#jdbct4-path-linux">Setting the PATH to a Supported Java Version on Linux</a></p> </li> +</ul> +</div> +</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>Select the default schema. If you do not select a schema, the default is <code>USR</code>. Click Next to continue.</p> +<p>Right-click on the Windows icon on the menu bar. Select <strong>System</strong>.</p> </li> <li> -<p>If desired, configure the <strong>translate dll</strong>, which translates data from one character set to another, and configure the localization. By -default, the client error message language is English, and the clientâs local character set is used. Click <strong>Next</strong> to continue.</p> +<p>Click on <strong>Advanced System Settings</strong>.</p> </li> <li> -<p>If desired, set the trace options and the file path of the trace log. Click <strong>Finish</strong>.</p> -<div class="paragraph"> -<p>The <strong>Test Trafodion ODBC Connection</strong> dialog box appears, allowing you to test the connection using the data source that you created.</p> -</div> +<p>In the <strong>System Properties</strong> dialog box, click the <strong>Advanced</strong> tab.</p> </li> <li> -<p>Click <strong>Test Connection</strong>.</p> +<p>Click the <strong>Environment Variables</strong> button.</p> </li> <li> -<p>When prompted, enter your user name and password, and click <strong>OK</strong>.</p> -<div class="paragraph"> -<p>If the connection is successful, you will see <code>Connected Successfully</code> in the <strong>Test Trafodion ODBC Connection</strong> dialog box.</p> -</div> -</li> -</ol> -</div> -</div> -<div class="sect3"> -<h4 id="_enable_compression">3.3.5. Enable Compression</h4> -<div class="paragraph"> -<p>When compression is enabled in the ODBC driver, the ODBC driver can send and receive large volumes of data quickly and efficiently to and from -the Trafodion Database Connectivity Services (DCS) server over a TCP/IP network. By default, compression is disabled.</p> -</div> +<p>Under <strong>System</strong> variables, select the variable named <strong>Path</strong>, and then click <strong>Edit. . .</strong>:</p> <div class="paragraph"> -<p>To enable compression in the ODBC driver or to change the compression setting, follow these steps:</p> +<p><span class="image"><img src="images/win10_edit_path.jpg" alt="Windows 10 Edit Path Variable"></span></p> </div> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Launch the MS ODBC Administrator. For example, on Windows 7, select <strong>Start>All Programs>Trafodion ODBC 1.0>MS ODBC Administrator</strong>.</p> </li> <li> -<p>In the <strong>ODBC Data Source Administrator</strong> dialog box, select the <strong>User DSN</strong> tab, select the name of your data source under -<strong>User Data Sources</strong>, and click <strong>Configure</strong>. If you did not create a data source, please refer to -<a href="#win_odbc_client_env">Setting Up the Client Environment</a>.</p> +<p>Click <strong>Browse. . .</strong>. Find the directory where you installed Java and select it.</p> <div class="paragraph"> -<p>A new dialog box appears, showing the configuration of your data source.</p> +<p><span class="image"><img src="images/win10_select_java.jpg" alt="image"></span></p> </div> </li> <li> -<p>Select the <strong>Network</strong> tab, and then select one of these values for <strong>Compression</strong>:</p> -<div class="ulist"> -<ul> -<li> -<p><code>SYSTEM_DEFAULT</code>, which is the same as no compression</p> +<p>Click <strong>OK</strong> to close the browse window. Click <strong>OK</strong> to close the edit window.</p> </li> <li> -<p><code>no compression</code></p> +<p>Verify that the updated <strong>Path</strong> appears under <strong>System</strong> variables, and click <strong>OK</strong>.</p> </li> <li> -<p><code>best speed</code></p> +<p>In the <strong>System Properties</strong> dialog box, click <strong>OK</strong> to accept the changes.</p> </li> +</ol> +</div> +</div> +<div class="sect5"> +<h6 id="_windows_8">Windows 8</h6> +<div class="olist arabic"> +<ol class="arabic"> <li> -<p><code>best compression</code></p> +<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><code>balance</code></p> +<p>In the left navigation bar, click the <strong>Advanced</strong> system settings link.</p> </li> <li> -<p>An integer from 0 to 9, with 0 being no compression and 9 being the -maximum available compression</p> -</li> -</ul> -</div> +<p>In the <strong>System Properties</strong> dialog box, click the <strong>Environment Variables</strong> button.</p> </li> <li> -<p>Click <strong>OK</strong> to accept the change.</p> +<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>Click <strong>OK</strong> to exit the <strong>ODBC Data Source Administrator</strong> dialog box.</p> -</li> -</ol> +<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 class="paragraph"> +<p><span class="image"><img src="images/varval2.jpg" alt="image"></span></p> +</div> +<div class="paragraph"> +<p><strong>Example</strong></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 style="page-break-after: always;"></div> </div> -<div class="sect3"> -<h4 id="win_odbc_run_basicsql">3.3.6. Run Sample Program (<code>basicsql</code>)</h4> <div class="admonitionblock note"> <table> <tr> @@ -1492,107 +1377,46 @@ maximum available compression</p> <i class="fa icon-note" title="Note"></i> </td> <td class="content"> -The Basic SQL sample program is not currently bundled with the ODBC Windows driver. To obtain the source code and the build and run -files for this program, please refer to <a href="#odbc_sample_program">ODBC Sample Program</a>. +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> -<div class="paragraph"> -<p>To build and run the executable file, follow these steps:</p> -</div> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Open a Visual Studio x64 Win64 Command Prompt. Make sure to select the x64 version of the command prompt. For example, on Windows 7, select -<strong>Start>All Programs>Microsoft Visual Studio 2010>Visual Studio Tools>Visual Studio x64 Win64 Command Prompt</strong>.</p> </li> <li> -<p>At the command prompt, move to the directory where you put the <code>basicsql.cpp</code> and build files.</p> +<p>Click <strong>OK</strong>.</p> </li> <li> -<p>Run build at the command prompt. You will see <code>basicsql.exe</code> created in the same directory as the source file.</p> +<p>Verify that the updated <strong>Path</strong> appears under <strong>System</strong> variables, and click <strong>OK</strong>.</p> </li> <li> -<p>Before running the sample program, create a Trafodion data source named <code>Default_DataSource</code> on the client workstation using MS ODBC -Administrator. For instructions, please refer to <a href="#win_odbc_client_env">Set Up Client Environment</a>.</p> +<p>In the <strong>System Properties</strong> dialog box, click <strong>OK</strong> to accept the changes.</p> </li> -<li> -<p>From the command prompt, run the sample program by entering either run or this command:</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">basicsql DefaultDataSource <username> <password></code></pre> -</div> +</ol> </div> -<div class="paragraph"> -<p>If the sample program executes successfully, you should see this output:</p> </div> -<div class="paragraph"> -<p><strong>Example</strong></p> </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">Using Connect String: DSN=Default_DataSource;UID=user1;PWD=pwd1; -Successfully connected using SQLDriverConnect. -Drop sample table if it exists... -Creating sample table TASKS... -Table TASKS created using SQLExecDirect. -Inserting data using SQLBindParameter, SQLPrepare, SQLExecute -Data inserted. -Fetching data using SQLExecDirect, SQLFetch, SQLGetData -Data selected: 1000 CREATE REPORTS 2014-3-22 -Basic SQL ODBC Test Passed!</code></pre> +<pre class="CodeRay highlight"><code data-lang="text">cd $HOME +vi .profile</code></pre> </div> </div> </li> -</ol> -</div> -</div> -</div> -</div> -</div> -<div class="sect1"> -<h2 id="_install_linux_odbc_driver">4. Install Linux ODBC Driver</h2> -<div class="sectionbody"> -<div class="paragraph"> -<p>These installation instructions apply to Trafodion Release 1.3.<strong><em>n</em></strong> and subsequent updates of the product until otherwise indicated.</p> -</div> -<div class="sect2"> -<h3 id="_installation_packaged">4.1. Installation Packaged</h3> -<div class="paragraph"> -<p>The distribution file for the Trafodion ODBC Driver for Linux is packaged within the Trafodion clients tar file, -<code>clients-1.3.<strong><em>n</em></strong>.tar.gz</code>, on the Trafodion downloads site <a href="http://trafodion.incubator.apache.org/download.html"; class="bare">http://trafodion.incubator.apache.org/download.html</a>.</p> -</div> -<div class="paragraph"> -<p><code>TRAF_ODBC_Linux_Driver_64.tar.gz</code> is used to install the Trafodion ODBC Driver for Linux. It contains the following files:</p> -</div> +<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">connect_test.cpp -install.sh -libicudataNv44.so.44 -libicuucNv44.so.44 -libtrafodbc_l64.so -libtrafodbc_l64_drvr.so -LICENSE -license.txt -MD5SUM -TRAFDSN</code></pre> -</div> -</div> -<div class="paragraph"> -<p>By default, a new version of the Trafodion ODBC driver will be installed in the following directories unless you specify a different directory -during installation:</p> +<pre class="CodeRay highlight"><code data-lang="text">export PATH=/opt/java1.7/jre/bin:$PATH</code></pre> </div> -<div class="ulist"> -<ul> -<li> -<p><code>/usr/lib64</code></p> -</li> -<li> -<p><code>/etc/odbc</code></p> -</li> -</ul> </div> <div class="admonitionblock note"> <table> @@ -1601,379 +1425,525 @@ during installation:</p> <i class="fa icon-note" title="Note"></i> </td> <td class="content"> -The following header files are not packaged with the Trafodion ODBC driver: +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> -<div class="ulist"> -<ul> -<li> -<p><code>sql.h</code></p> -</li> -<li> -<p><code>sqlext.h</code></p> -</li> -<li> -<p><code>sqltypes.h</code></p> </li> <li> -<p><code>sqlucode.h</code></p> +<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> -</ul> +</ol> +</div> </div> -<div class="paragraph"> -<p>To install those header files, <a href="#win_odbc_client_env">Setting Up the Client Environment</a>..</p> </div> -<div style="page-break-after: always;"></div> </div> <div class="sect2"> -<h3 id="_installation_requirements_2">4.2. Installation Requirements</h3> +<h3 id="jdbct4-install-instructions">3.2. Installation Instructions</h3> <div class="paragraph"> -<p>The driver for Linux requires <code>libgcc 3.4.3</code> and <code>libstd++ 6.0</code>.</p> +<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="paragraph"> -<p>If you are building ODBC applications, please use the preferred build platform, RedHat 6.4 or CentOS 6.4.</p> -</div> -</div> -<div class="sect2"> -<h3 id="_installation_instructions_2">4.3. Installation Instructions</h3> <div class="sect3"> -<h4 id="_download_linux_odbc_driver">4.3.1. Download Linux ODBC Driver</h4> +<h4 id="jdbct4-install-driver">3.2.1. Install JDBC Type-4 Driver</h4> <div class="olist arabic"> <ol class="arabic"> <li> -<p>Create a download folder on the client workstation.</p> -</li> -<li> -<p>Open a Web browser and navigate to <a href="http://trafodion.incubator.apache.org/download.html"; class="bare">http://trafodion.incubator.apache.org/download.html</a>.</p> -</li> -<li> -<p>Click on the <code>clients-1.3.<strong><em>n</em></strong>.tar.gz</code> link to start downloading the Trafodion clients tar file to your workstation.</p> -</li> -<li> -<p>Place the <code>clients-1.3.<strong><em>n</em></strong>.tar.gz</code> file into the download folder.</p> +<p>Change the directory to the <code>clients</code> subdirectory.</p> </li> <li> -<p>Unpack the <code>clients-1.3.<strong><em>n</em></strong>.tar.gz</code> file.</p> +<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">tar -xzf clients-1.3.0.tar.gz</code></pre> +<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 package file contains the Trafodion ODBC distribution file, <code>TRAF_ODBC_Linux_Driver_64.tar.gz</code>, which is extracted to the clients subdirectory.</p> +<p>The content of the target directory is as follows:</p> </div> -</div> -<div class="sect3"> -<h4 id="_install_reinstall_linux_odbc_driver">4.3.2. Install/Reinstall Linux ODBC Driver</h4> -<div class="admonitionblock note"> -<table> +<table class="tableblock frame-all grid-all spread"> +<colgroup> +<col style="width: 33%;"> +<col style="width: 30%;"> +<col style="width: 37%;"> +</colgroup> +<thead> <tr> -<td class="icon"> -<i class="fa icon-note" title="Note"></i> -</td> -<td class="content"> -You must have root access to install the Trafodion ODBC Driver for Linux at the default system location. -</td> +<th class="tableblock halign-left valign-top">Installation Folder</th> +<th class="tableblock halign-left valign-top">Files</th> +<th class="tableblock halign-left valign-top">Description</th> +</tr> +</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">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">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"><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">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">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"><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">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"><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">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"><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">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"><p class="tableblock">Sample source code for fetching rows from a simple SELECT statement.</p></td> </tr> +</tbody> </table> </div> -<div class="olist arabic"> -<ol class="arabic"> -<li> -<p>Change the directory to the clients subdirectory, and decompress the <code>.tar.gz</code> distribution file:</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">gunzip TRAF_ODBC_Linux_Driver_64.tar.gz</code></pre> -</div> </div> -</li> -<li> -<p>Extract the contents of the <code>.tar</code> file. A directory called <code>PkgTmp</code> is created.</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">tar âxvf TRAF_ODBC_Linux_Driver_64.tar</code></pre> +<div class="sect2"> +<h3 id="jdbct4-setup-env">3.3. Set Up Client Environment</h3> +<div class="sect3"> +<h4 id="_java_development">3.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 +replacing <code><em>jdbc-installation-directory</em></code> with the name of the directory where you downloaded the JDBC Type 4 driver:</p> </div> +<table class="tableblock frame-all grid-all spread"> +<colgroup> +<col style="width: 20%;"> +<col style="width: 40%;"> +<col style="width: 40%;"> +</colgroup> +<thead> +<tr> +<th class="tableblock halign-left valign-top">Environment Variable</th> +<th class="tableblock halign-left valign-top">On Windows</th> +<th class="tableblock halign-left valign-top">On Linux</th> +</tr> +</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> +</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> +</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> +</tr> +</tbody> +</table> +<div class="paragraph"> +<p><sup>1</sup> Enclose the <em>jdk-directory</em> in quotes to ensure that Windows can find the directory correctly. You can use the <code>set <variable></code> command to verify the setting.</p> </div> -</li> -<li> -<p>Install the product by entering these commands:</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">cd PkgTmp -./install.sh</code></pre> +<div style="page-break-after: always;"></div> </div> +<div class="sect3"> +<h4 id="_configure_applications">3.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> <div class="paragraph"> -<p>Except for the sample file, the <code>install.sh</code> script saves a copy (<code>.SAV</code>) of your previous installation files if they exist.</p> +<p>Set these values for your environment:</p> </div> -</li> -<li> -<p>Accept the terms of the license agreement by entering <strong>yes</strong>.</p> -</li> +<div class="ulist"> +<ul> <li> -<p>Enter a directory for the library files, or press Enter to use the default directory (<code>/usr/lib64</code>).</p> +<p><em>catalog</em>: Specify a catalog that exists in the database.</p> </li> <li> -<p>Enter a directory for the data-source template file, or press <strong>Enter</strong> to use the default directory (<code>/etc/odbc</code>).</p> +<p><em>schema</em>: Specify a schema that exists in the database.</p> </li> <li> -<p>Enter a directory for the sample program, or press <strong>Enter</strong> to use the default directory (<code>/etc/odbc</code>).</p> +<p><em>user</em>: Specify the name of a user who will be accessing the database.</p> </li> -</ol> -</div> -</div> -<div class="sect3"> -<h4 id="_set_up_client_environment">4.3.3. Set Up Client Environment</h4> -<div class="paragraph"> -<p>If you selected default options during installation, ensure that:</p> -</div> -<div class="ulist"> -<ul> <li> -<p>The libraries are located in the <code>/usr/lib64</code> directory.</p> +<p><em>password</em>: Specify the password of a user who will be accessing the database.</p> </li> <li> -<p>A <code>TRAFDSN</code> file is in the <code>/etc/odbc</code> directory.</p> +<p><em>url</em>: Specify this string: <em>jdbc:t4jdbc://_host-name</em>:_port-number_/:_</p> </li> </ul> </div> <div class="paragraph"> -<p>If you select non-default locations during installation, ensure that the files are installed in the directories that you specified during -installation.</p> -</div> -<div class="paragraph"> -<p>The driver expects the <code>TRAFDSN</code> file to be present in either the default location (<code>/etc/odbc</code>) or the current working directory (<code>CWD</code>) of the -application.</p> +<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> +for information about how to configure the DCS port.</p> </div> <div class="paragraph"> -<p>If you are building ODBC applications, you will need to install these header files in your build environment:</p> -</div> -<div class="ulist"> -<ul> -<li> -<p><code>sql.h</code></p> -</li> -<li> -<p><code>sqlext.h</code></p> -</li> -<li> -<p><code>sqltypes.h</code></p> -</li> -<li> -<p><code>sqlucode.h</code></p> -</li> -</ul> +<p><strong>Example</strong></p> </div> <div class="paragraph"> -<p>To install those header files from the latest packages, run this <code>yum</code> command:</p> +<p>In this example, Trafodion authentication has not been enabled. Therefore, you can use a dummy +user and password. If authentication is enabled, then use your user and password information.</p> </div> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">yum install libiodbc libiodbc-devel</code></pre> +<pre class="CodeRay highlight"><code data-lang="text">catalog = TRAFODION +schema = SEABASE +user = usr +password = pwd + +url = jdbc:t4jdbc://trafodion.host.com:23400/:</code></pre> </div> </div> -<div class="paragraph"> -<p>The <code>yum</code> command automatically installs the header files in the <code>/usr/include</code> and <code>/usr/include/libiodbc</code> directories.</p> +<div class="admonitionblock note"> +<table> +<tr> +<td class="icon"> +<i class="fa icon-note" title="Note"></i> +</td> +<td class="content"> +The driverâs class name is <code>org.trafodion.jdbc.t4.T4Driver</code>. +</td> +</tr> +</table> </div> <div style="page-break-after: always;"></div> </div> -<div class="sect3"> -<h4 id="_enable_compression_2">4.3.4. Enable Compression</h4> +</div> +<div class="sect2"> +<h3 id="jdbct4-test-programs">3.4. Test Programs</h3> <div class="paragraph"> -<p>When compression is enabled in the ODBC driver, the ODBC driver can send and receive large volumes of data quickly and efficiently to and from -the Trafodion Database Connectivity Services (DCS) server over a TCP/IP network. By default, compression is disabled.</p> +<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 +sample programs that are included with the Trafodion JDBC Type-4 driver.</p> </div> <div class="paragraph"> -<p>To enable compression in the ODBC driver or to change the compression setting, follow these steps:</p> +<p><strong>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="ulist"> -<ul> -<li> -<p>If you are using the Trafodion ODBC driver manager, add</p> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">Compression = compression-level</code></pre> +<pre class="CodeRay highlight"><code data-lang="text">C:\Development Tools\Trafodion JDBCT4\samples>cd StatementSample + +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. +v +C:\Development Tools\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:\Development Tools\Trafodion JDBCT4\samples\StatementSample></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> <div class="paragraph"> -<p>to the <code>DSN</code> section of <code>TRAFDSN</code> file.</p> +<p>Run one of these sets of commands to remove the Trafodion JDBC Type 4 Driver:</p> </div> -</li> +<div class="ulist"> +<ul> <li> -<p>If you are using a third-party driver manager, such as unixODBC, add</p> +<p>On Linux:</p> <div class="listingblock"> <div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">Compression = compression-level</code></pre> +<pre class="CodeRay highlight"><code data-lang="text">rm -rf <jdbc-installation-directory></code></pre> </div> </div> <div class="paragraph"> -<p>to the <code>DSN</code> section of the <code>odbc.ini</code> file.</p> +<p><strong>Example</strong></p> </div> -</li> -</ul> +<div class="listingblock"> +<div class="content"> +<pre class="CodeRay highlight"><code data-lang="text">rm -rf ~/jdbc</code></pre> </div> -<div class="paragraph"> -<p>The <code><em>compression-level</em></code> is one of these values:</p> </div> -<div class="ulist"> -<ul> -<li> -<p><code>SYSTEM_DEFAULT</code>, which is the same as no compression</p> </li> <li> -<p><code>no compression</code></p> +<p>On Windows:</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> +</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> +</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><code>best speed</code></p> +<p>Close all applications running on the workstation, except the Web browser.</p> </li> <li> -<p><code>best compression</code></p> +<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><code>balance</code></p> +<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>An integer from <code>0</code> to <code>9</code>, with <code>0</code> being <code>no compression</code> and <code>9</code> being the <code>maximum available compression</code></p> +<p>Set up the client environment. Please refer to: <a href="#jdbct4-setup-env">Set Up Client Environment</a>.</p> </li> -</ul> +</ol> +</div> </div> -<div style="page-break-after: always;"></div> +</div> +</div> +<div class="sect1"> +<h2 id="trafci">4. Install trafci</h2> +<div class="sectionbody"> +<div class="sect2"> +<h3 id="trafci-installation-requirements">4.1. Installation Requirements</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> </div> <div class="sect3"> -<h4 id="_use_third_party_driver_manager">4.3.5. Use Third-Party Driver Manager</h4> -<div class="admonitionblock note"> -<table> -<tr> -<td class="icon"> -<i class="fa icon-note" title="Note"></i> -</td> -<td class="content"> -For better performance, we recommend that you use at least version <code>2.3.<em>x</em></code> of unixODBC. -</td> -</tr> -</table> +<h4 id="trafci_perl_python">4.1.1. Install Perl or Python</h4> +<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> </div> <div class="ulist"> <ul> <li> -<p>If you are using an external driver manager, you must point to <code>libtrafodbc_drvr64.so</code> and not to <code>libtrafodbc64.so</code>.</p> -</li> -<li> -<p>The driver, <code>libtrafodbc_l64_drvr.so</code>, has been verified with iODBC and unixODBC driver managers.</p> -</li> -<li> -<p>These driver managers, as well as documentation, can be found at these Web sites:</p> -</li> -<li> -<p><a href="http://www.iodbc.org/"; class="bare">http://www.iodbc.org/</a></p> -</li> -<li> -<p><a href="http://www.unixodbc.org/"; class="bare">http://www.unixodbc.org/</a></p> +<p>Perl version 5.8.8</p> </li> <li> -<p>For information on the necessary data-source configuration options, you will need to add to the respective configuration files (for example, -to <code>odbc.ini</code>).</p> +<p>Python version 2.3.4</p> </li> </ul> </div> -</div> -<div class="sect3"> -<h4 id="_run_sample_program_code_connect_test_code">4.3.6. Run Sample Program (<code>connect_test</code>)</h4> -<div class="admonitionblock note"> -<table> -<tr> -<td class="icon"> -<i class="fa icon-note" title="Note"></i> -</td> -<td class="content"> -The examples after each step assume that you have default installation directories. -</td> -</tr> -</table> +<div class="paragraph"> +<p>If you do not have Perl or Python, download it from any open-source software provider. You can perform this installation procedure anytime +before or after installing trafci.</p> </div> <div class="paragraph"> -<p>If you have a previous version of the Trafodion ODBC driver installed, you need to re-link your existing application to ensure that you pick up -the correct version of the driver. If you are unsure of the version, check the version of your application with this command:</p> +<p>If you plan to run the sample scripts provided with trafci, verify that you have the Perl JavaServer and Jython (Java implementation of Python) +installed on your client workstation. Use the trafci Installation Wizard to automatically download and install both the Perl JavaServer and +Jython open source extensions. To download them manually, see the <code>README</code> in the samples directory.</p> </div> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">ldd object-file</code></pre> +<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>Move to the directory where you installed the sample program:</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">cd /etc/odbc</code></pre> -</div> -</div> +<p>Change the directory to the <code>clients</code> subdirectory.</p> </li> <li> -<p>Set the environment variable <code>LD_LIBRARY_PATH</code>:</p> +<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">export LD_LIBRARY_PATH=<path-to-odbc-library-files or /usr/lib64></code></pre> +<pre class="CodeRay highlight"><code data-lang="text">cd $HOME/trafodion-download/clients +unzip trafci.zip -d trafci +cd trafci</code></pre> </div> </div> -</li> -<li> -<p>In the <code>/etc/odbc/TRAFDSN</code> file, add the correct IP address to the <code>Server</code> parameter for the <code>Default_DataSource</code>.</p> <div class="paragraph"> -<p><strong>Example</strong></p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">[Default_DataSource] -Description = Default Data Source -Catalog = TRAFODION -Schema = SEABASE -DataLang = 0 -FetchBufferSize = SYSTEM_DEFAULT -Server = TCP:1.2.3.4:37800 <- _Set IP Address_ -SQL_ATTR_CONNECTION_TIMEOUT = SYSTEM_DEFAULT -SQL_LOGIN_TIMEOUT = SYSTEM_DEFAULT -SQL_QUERY_TIMEOUT = NO_TIMEOUT</code></pre> -</div> +<p>The command extracts these files:</p> </div> -</li> +<div class="ulist"> +<ul> <li> -<p>Compile the sample program.</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">g++ -g connect_test.cpp -L/usr/lib64 -I/usr/include/odbc -ltrafodbc64 -o connect_test</code></pre> -</div> -</div> +<p><code>README</code></p> </li> <li> -<p>Run the sample program:</p> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">./connect_test -d Default_DataSource -u username -p password</code></pre> -</div> +<p><code>trafciInstaller.jar</code></p> +</li> +</ul> </div> </li> </ol> </div> +<div class="sect3"> +<h4 id="trafci-run-installer">4.2.1. Run Executable JAR Installer</h4> <div class="paragraph"> -<p>If the sample program runs successfully, you should see output similar to the following:</p> -</div> -<div class="listingblock"> -<div class="content"> -<pre class="CodeRay highlight"><code data-lang="text">Using Connect String: DSN=Default_DataSource;UID=username;PWD=****; -Connect Test Passed...</code></
<TRUNCATED>
