http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/asciidoc/_chapters/preparation.adoc ---------------------------------------------------------------------- diff --git a/docs/client_install/src/asciidoc/_chapters/preparation.adoc b/docs/client_install/src/asciidoc/_chapters/preparation.adoc new file mode 100644 index 0000000..90b9ebb --- /dev/null +++ b/docs/client_install/src/asciidoc/_chapters/preparation.adoc @@ -0,0 +1,273 @@ +//// +/** +* @@@ START COPYRIGHT @@@ +* +* Licensed to the Apache Software Foundation (ASF) under one +* or more contributor license agreements. See the NOTICE file +* distributed with this work for additional information +* regarding copyright ownership. The ASF licenses this file +* to you under the Apache License, Version 2.0 (the +* "License"); you may not use this file except in compliance +* with the License. You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, +* software distributed under the License is distributed on an +* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +* KIND, either express or implied. See the License for the +* specific language governing permissions and limitations +* under the License. +* +* @@@ END COPYRIGHT @@@ +*/ +//// + += Preparation + +{project-name} 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 {project-name}. + +Typically, you install and configure the client software in the following order: + +. JDBC and/or ODBC drivers. (Depending on what clients you plan to use.) +. {project-name} clients. For example, trafci and odb. +. Third-party clients. For example, DBVisualizer, SQuirell, and/or Tableau. + +If you don't plan to use JDBC-based clients, then please skip ahead to +<<download-client-software, Download Client Software>>. + +[[java-setup]] +== Java Setup + +The {project-name} JDBC Type 4 Driver requires Java 1.7 or higher. You need to set +the Java path to the correct location. + +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). + +[[java-validation]] +=== Verify Java Version + +To display the Java version of the client workstation on the screen, enter: + +``` +java -version +``` + +.Example 1: Java Installed and PATH Variable Set Correctly + +``` +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:\> +``` + +If the version is not 1.7 or higher, then please upgrade you Java installation +See <<java-install, Install Java>>. + +If the version is 1.7 or higher, then skip ahead to <<download-client-software, Download Client Software>>. + +.Example 2: Path Not Set + +``` +'java' is not recognized as an internal or external command, operable program or batch file.` +``` + +If you have installed Java, then this message indicates that you've not included +the Java directory in your search path. See <<howto-setup-path, Set Up PATH Variable>>. + +[[java-install]] +=== Install Java + +Refer to: http://www.java.com/en/download. + +Once installed, follow the instruction in <<howto-setup-path, Set Up PATH Variable>> +to ensure that your Java environment has been set up properly. + +[[download-client-software]] +== Download Client Software + +The {project-name} client software is available from the {download-url}[{project-name} Download] page. There is one +`{project-name} Clients` package per release listed under *<version> Binaries*. + +The `{project-name} Clients` package consists of a zipped tar file that contains the {project-name} Clients tar file. +The {project-name} Client binaries are in the `clients` folder, which contains the following files: + +[cols="30%,70%", options="header"] +|=== +| File | Usage +| `DISCLAIMER` | {project-name} Apache incubation disclaimer. +| `JDBCT4.zip` | {project-name} JDBC Type 4 Driver. +| `LICENCE` | Apache license. +| `NOTICE` | Apache notice. +| `odbc64_linux.tar.gz` | {project-name} odb tool. +| `TRAF_ODBC_Linux_Driver_64.tar.gz` | {project-name} ODBC driver for Linux. +| `trafci.zip` | The {project-name} command interpreter `trafci`. +| `TFODBC64-*.exe` | *[Not included in this release]*^1^ {project-name} ODBC Driver for Windows. +|=== + +^1^ License issues prevent us from including the ODBC Driver for Windows in this release. Contact +{project-support} for help obtaining the driver. + +<<< +[[download-windows]] +=== Windows Download + +Do the following: + +. Create a download folder on the client workstation. For example, `c:\trafodion`. + +. Open a Web browser and navigate to the {project-name} downloads site {download-url}. + +. Orient yourself to the binaries for the release you're installing. +Click on the `{project-name} Clients` link to start downloading the {project-name} clients tar file to your workstation. + +. Place the `apache-trafodion-clients-*.tar.gz` file into the download folder. +* Unpack the `apache-trafodion-clients-\*.tar.gz` file using an unzip program of your choice. This creates +an `apache-trafodion-clients-*.tar` file. +* Unpack the `apache-trafodion-clients-*.tar` file using an unzip program of your choice. + +. Verify content of the `clients` directory: ++ +``` +DISCLAIMER JDBCT4.zip LICENSE NOTICE odb64_linux.tar.gz trafci.zip TRAF_ODBC_Linux_Driver_64.tar.gz +``` ++ +You use these files to install the different {project-name} clients. + +<<< +[[download-linux]] +=== Linux Download + +Do the following: + +. Create a download directory on the client workstation. For example, `$HOME/trafodion`. + +. Open a Web browser and navigate to the {project-name} downloads site {download-url}. + +. Orient yourself to the binaries for the release you're installing. +Right-click on the `{project-name} Clients` link and select *Copy link address*. + +. Go to the download directory on the client workstation and use `wget` to download the client package +using the URL you copied in step 3 above. + +. Unpack the `apache-trafodion-clients-*.tar.gz` using `tar`. ++ +*Example* ++ +``` +$ mkdir $HOME/trafodion +$ cd $HOME/trafodion +$ wget <link to package> +$ tar -xzvf apache-trafodion_clients-*-incubating.tar.gz +$ cd clients +$ ls +DISCLAIMER LICENSE odb64_linux.tar.gz TRAF_ODBC_Linux_Driver_64.tar.gz +JDBCT4.zip NOTICE trafci.zip +$ +``` ++ +You use these files to install the different {project-name} clients. + +<<< +[[unpack-client-software]] +== Unpack Client Software + +The client packages are located on the `client` subdirectory where you unpacked +the {project-name} distribution file. For example, `c:\trafodion\clients` (Windows) +or `$HOME/trafodion/clients` (Linux). + +Unpack the client software and its dependencies you intend to use as follows. + +=== Unpack JDBC-Based Client Software + +[cols="30%,30%,40%a", options="header"] +|=== +| File | Description | Recommended Target Directory +| `JDBCT4.zip` | JDBC Type 4 Driver | * *Windows:* `c:\trafodion\jdbct4` ++ +* *Linux:* `$HOME/trafodion/jdbct4` +| `trafci.zip` | Command Interface | * *Windows:* `c:\trafodion\trafci` ++ +* *Linux:* `$HOME/trafodion/trafci` +|=== + +*Windows* + +Use your favorite compress/uncompress utility to unpack the file to the target directory +defined in the table above. + +*Linux* + +Unpack the `.zip` file using the `unzip <file> -d <target-directory>` command: + +``` +$ 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 +$ +``` + +Once complete, a fully-installed `c:\trafodion` (Windows) or +`$HOME/trafodion` directory should contain the following directories: + +* `clients`: The compressed client software. +* `jdbct4`: The {project-name} JDBC Type 4 driver installation directory. +* `trafci`: The {project-name} Command Interpreter installation directory. + +=== Unpack ODBC-Based Client Software + +[cols="30%,30%,40%",options="header"] +|=== +| File | Description | Recommended Target Directory +| `TRAF_ODBC_Linux_Driver_64.tar.gz` | Linux ODBC Driver | `$HOME/trafodion/odbc` +| `odb64_linux.tar.gz` | Linux odb Utility | `$HOME/trafodion/odb` +|=== + +*Linux* + +Unpack the `.tar.gz` file using the `tar -xzvf <file> -C <target-directory>` command. + +``` +$ 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 +``` + + +Once complete, a fully-installed `c:\trafodion` (Windows) or +`$HOME/trafodion` directory should contain: + +* `clients`: The compressed client software. +* `odb`: The {project-name} odb utility installation directory. +* `odbc`: The {project-name} ODBC driver installation directory. + + +
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/asciidoc/_chapters/sample_prog.adoc ---------------------------------------------------------------------- diff --git a/docs/client_install/src/asciidoc/_chapters/sample_prog.adoc b/docs/client_install/src/asciidoc/_chapters/sample_prog.adoc index 138322c..2562319 100644 --- a/docs/client_install/src/asciidoc/_chapters/sample_prog.adoc +++ b/docs/client_install/src/asciidoc/_chapters/sample_prog.adoc @@ -1,75 +1,75 @@ -//// -/** - *@@@ START COPYRIGHT @@@ - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * @@@ END COPYRIGHT @@@ - */ -//// - -[[odbc_sample_program]] -== `basicsql` (Sample ODBC Program) -This appendix provides the source code for the ODBC sample program, `basicsql,` which is not currently bundled with the ODBC drivers. - -This appendix also provides the code for the script files that are needed to build and run the sample program on Windows. See -<<basicsql_build, Windows Build and Run Files for 'basicsql'>>. - -Copy and paste the code from this appendix into the recommended files. To build and run the sample program, see these instructions: - -* On Windows: <<win_odbc_run_basicsql, Run Sample Program (`basicsql`)>>. -* On Linux: <<linux_odbc_run_basicsql, Run Sample Program (`basicsql`)>>. - -=== `basicsql.cpp` Source Code -You can download the `basicsql.cpp` example from -http://trafodion.incubator.apache.org/docs/client_install/resources/source/basicsql.cpp. - -Alternatively, copy and paste the following code into a file named `basicsql.cpp`: - -[source, cplusplus] ----- -include::{sourcedir}/basicsql.cpp[] ----- - -[[basicsql_build]] -=== Windows Build and Run Files for `basicsql` - -The script files that are needed to build and run the sample program on Windows are not currently bundled with the ODBC driver. -Copy and paste the code from this appendix into the recommended files. To build and run the sample program on Windows, -see the instructions in <<win_odbc_run_basicsql, Run Sample Program (`basicsql`)>>. - -==== `build.bat` (Build Script) -You can download the `build.bat` example from -http://trafodion.incubator.apache.org/docs/client_install/resources/source/build.bat. - -Alternatively, copy and paste the following code into a file named `build.bat`, which is used to build the sample program on Windows: - ----- -include::{sourcedir}/build.bat[] ----- - -To build the sample program on Windows, see the instructions in <<win_odbc_run_basicsql, Run Sample Program (`basicsql`)>>. - -==== Run `run.bat` -You can download the `run.bat` example from -http://trafodion.incubator.apache.org/docs/client_install/resources/source/run.bat. - -Alternatively, copy and paste the following code into a file named `run.bat`, which is used to run the sample program on Windows: - ----- -include::{sourcedir}/run.bat[] ----- - -To run the sample program on Windows, see the instructions in <<win_odbc_run_basicsql, Run Sample Program (`basicsql`)>>. +//// +/** + *@@@ START COPYRIGHT @@@ + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * @@@ END COPYRIGHT @@@ + */ +//// + +[[odbc_sample_program]] +== `basicsql` (Sample ODBC Program) +This appendix provides the source code for the ODBC sample program, `basicsql,` which is not currently bundled with the ODBC drivers. + +This appendix also provides the code for the script files that are needed to build and run the sample program on Windows. See +<<basicsql_build, Windows Build and Run Files for 'basicsql'>>. + +Copy and paste the code from this appendix into the recommended files. To build and run the sample program, see these instructions: + +* On Windows: <<win_odbc_run_basicsql, Run Sample Program (`basicsql`)>>. +* On Linux: <<linux_odbc_run_basicsql, Run Sample Program (`basicsql`)>>. + +=== `basicsql.cpp` Source Code +You can download the `basicsql.cpp` example from +http://trafodion.incubator.apache.org/docs/client_install/resources/source/basicsql.cpp. + +Alternatively, copy and paste the following code into a file named `basicsql.cpp`: + +[source, cplusplus] +---- +include::{sourcedir}/basicsql.cpp[] +---- + +[[basicsql_build]] +=== Windows Build and Run Files for `basicsql` + +The script files that are needed to build and run the sample program on Windows are not currently bundled with the ODBC driver. +Copy and paste the code from this appendix into the recommended files. To build and run the sample program on Windows, +see the instructions in <<win_odbc_run_basicsql, Run Sample Program (`basicsql`)>>. + +==== `build.bat` (Build Script) +You can download the `build.bat` example from +http://trafodion.incubator.apache.org/docs/client_install/resources/source/build.bat. + +Alternatively, copy and paste the following code into a file named `build.bat`, which is used to build the sample program on Windows: + +---- +include::{sourcedir}/build.bat[] +---- + +To build the sample program on Windows, see the instructions in <<win_odbc_run_basicsql, Run Sample Program (`basicsql`)>>. + +==== Run `run.bat` +You can download the `run.bat` example from +http://trafodion.incubator.apache.org/docs/client_install/resources/source/run.bat. + +Alternatively, copy and paste the following code into a file named `run.bat`, which is used to run the sample program on Windows: + +---- +include::{sourcedir}/run.bat[] +---- + +To run the sample program on Windows, see the instructions in <<win_odbc_run_basicsql, Run Sample Program (`basicsql`)>>. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/asciidoc/_chapters/tableau.adoc ---------------------------------------------------------------------- diff --git a/docs/client_install/src/asciidoc/_chapters/tableau.adoc b/docs/client_install/src/asciidoc/_chapters/tableau.adoc new file mode 100644 index 0000000..9a9e615 --- /dev/null +++ b/docs/client_install/src/asciidoc/_chapters/tableau.adoc @@ -0,0 +1,83 @@ +//// +/** + *@@@ START COPYRIGHT @@@ + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * @@@ END COPYRIGHT @@@ + */ +//// + += Configure Tableau Client + +== Prerequisite Software + +Make sure that you have this software installed on your workstation: + +* {project-name} Windows ODBC Driver. See <<install-windows-odbc-driver,Install Windows ODBC Driver>>. +* Tableau Software. See the http://www.tableau.com/trial/download-tableau[_Tableau website_]. + +== Tableau Datasource Configuration (.tdc) File + +=== Create .tdc File + +The Tableau Datasource Configuration (`.tdc`) file is used to customize and tune ODBC connections. + +NOTE: You can download each sample documented herein by clicking the link provided with the +sample name. For example, click on link:{tableau}/trafodion.tdc[trafodion.tdc] +to download a `.tdc` file for Tableau 9.3 using Trafodion ODBC 2.1. + + + +You can access the complete source directory at: {docs-url}/client_install/resources/tableau/ + +The `.tdc` file contains version-specific settings that you need to modify. + +.Template: link:resources/tableau/trafodion.tdc.template[`trafodion.tdc.template`] + +[source, xml] +---- +include::{tableau}/trafodion.tdc.template[Trafodion `.tdc` template file] +---- + +Save this file as `trafodion.tdc` and change the following placeholders: + +* `<tableau-version>` - Change to the version of Tableau you're using. For example: `9.3` +* `<trafodion-driver-name>` - Change to the name of the Trafodion ODBC driver you're using. For example: `TRAF ODBC 2.1` + +Once edited, your `trafodion.tdc` file should look similar to the example below. + +.Example: link:resources/tableau/trafodion.tdc[`trafodion.tdc`] + +[source, xml] +---- +include::{tableau}/trafodion.tdc[`trafodion.tdc`] +---- + +=== Install .tdc File + +Copy the `trafodion.tdc` file to the `C:\Users\%USERNAME%\Documents\My Tableau Repository\Datasources` folder. + +Restart Tableay if it's running to pick up the configuration change. + +== Connnect to {project-name} + +. Configure a ODBC data source using the MS ODBC Administrator. See <<win_odbc_setup_data_source, Set Up ODBC Data Source>>. +. Start Tableau. +. Create a *New Database Connection* by selecting *Other Databases (ODBC)*. +. Select your data source in the *DSN* dropdown. +. Enter *Trafodion* in the *Database:* field. +. Enter your *Username* and *Password*. +. Click *OK* to connect to your {project-name} database. ++ +image:{images}/tableau_connect.jpg[width=400,height=400,alt="Tableau Database Connection Screen"] http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/asciidoc/_chapters/trafci.adoc ---------------------------------------------------------------------- diff --git a/docs/client_install/src/asciidoc/_chapters/trafci.adoc b/docs/client_install/src/asciidoc/_chapters/trafci.adoc index 3ab5f7a..32bdc7b 100644 --- a/docs/client_install/src/asciidoc/_chapters/trafci.adoc +++ b/docs/client_install/src/asciidoc/_chapters/trafci.adoc @@ -1,472 +1,512 @@ -//// -/** - *@@@ START COPYRIGHT @@@ - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * @@@ END COPYRIGHT @@@ - */ -//// - -[[trafci]] -= Install trafci - -[[trafci-installation-requirements]] -== Installation Requirements - -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 <<jdbct4, Install JDBC Type-4 Driver>> chapter above. - -[[trafci_perl_python]] -=== Install Perl or Python - -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: - -* Perl version 5.8.8 -* Python version 2.3.4 - -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. - -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 `README` in the samples directory. - -<<< -[[trafci-installation-instructions]] -== Installation Instructions - -You download and extract the {project-name} client package using the instructions in <<introduction-download, Download Installation Package>> above. - -1. Change the directory to the `clients` subdirectory. - -2. Extract the contents of the `trafci.zip` file to a location on your client workstation (for example, a folder named `trafci`) by -using the unzip command (or the extract function of your compression software): -+ -``` -cd $HOME/trafodion-download/clients -unzip trafci.zip -d trafci -cd trafci -``` -+ -The command extracts these files: -+ -* `README` -* `trafciInstaller.jar` - -[[trafci-run-installer]] -=== Run Executable JAR Installer - -When using the executable JAR file, `trafciInstaller.jar`, to install trafci, you have a choice of running the installer from the Installer -Wizard Graphical User Interface (GUI) or from the command line: - -* <<trafci-wizard-install, Installer Wizard Steps>> -* <<trafci-cmd-install, Command-Line Installation Steps>> - -[[trafci-wizard-install]] -==== Installer Wizard Steps - -NOTE: 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 <<trafci-cmd-install, Command-Line Installation Steps>>. - -<<< -===== Launching the Installer Wizard - -1. Locate the `trafciInstaller.jar` file in the folder where you extracted the contents of the distribution (`.zip`) file. -2. Verify that the `trafciInstaller.jar` file appears as an executable JAR File. If not, skip the next two steps and go to Step 5. -3. Double-click the `trafciInstaller.jar` file to launch the Installer Wizard. -4. Proceed to <<trafci-using-wizard, Using the Installer Wizard>>. -5. At a command prompt, change to the directory where you extracted the installer files: -+ -``` -cd installer-directory -``` -+ -`_installer-directory_` is the directory where you extracted the installer file, `trafciInstaller.jar`. - -6. Launch the Installer Wizard by entering: -+ -``` -java -jar trafciInstaller.jar -``` - -7. Proceed to <<trafci-using-wizard, Using the Installer Wizard>>. - -[[trafci-using-wizard]] -===== Using the Installer Wizard - -When you execute `trafciInstaller.jar`, the Installer Wizard appears: - -image:{images}/InstallerWizardWelcome.jpg[trafci Installer Wizard welcome screen] - -1. Click one of these buttons for the type of installation that you would like to perform: -* *Standard Installation* to start the Installer Wizard, which guides you through installing both the core trafci components and the optional open -source extensions -* *Core Components* for a quick installation of the core trafci files -* *Optional Components* if you have already installed the core trafci files but want to install only the optional open source extensions - -2. After you have selected the components you wish to install, browse and select the JDBC JAR file and then specify an installation directory -where you will install trafci. -+ -image:{images}/InstallerWizardPaths.jpg[trafci select path dialog] - -3. To locate the JDBC driver JAR file, click *Browse* next to the *JDBC Type 4 Driver JAR File*. -4. In the *Select JDBC Type 4 Driver JAR File* dialog box, navigate to and select the lib folder of the {project-name} JDBC driver, and then click *Open*. -5. Select `jdbcT4.jar` so that it appears in the *File Name* box, and then click *Select*. -+ -The Installer Wizard now displays the path of the JDBC driver JAR file. -+ -image:{images}/JDBC_JAR_Path.jpg[trafci path to JDBC driver JAR file] -6. To install in the default location, proceed to Step 9. To install in your own preferred location, proceed to Step 7. - -7. To find an installation location for trafci, click *Browse* next to the *Trafodion Command Interface* installation directory. -8. In the *Select Trafodion Command Interface Installation Directory* dialog box, select the folder where you want to install trafci so that -the directory path appears in the *File Name* box, and then click *Select*. -+ -The Installer Wizard displays the directory where trafci is installed. - -9. Click *Next* to review the open-source legal disclaimer. -10. If you agree to the terms and conditions, select the check box, and click *Next*. -+ -The Installer Wizard dialog box shows which components are available for you to download and install. -+ -image:{images}/OptionalComponents.jpg[trafci component selection] - -11. Select the optional components to be downloaded and installed. Each optional component is installed if the component box is checked. -+ -If you want to change the download URL for the extensions, click *Edit URL*, and this dialog box appears: -+ -image:{images}/PerlJavaServerURL.jpg[trafci edit download URL] -+ -Type a new path, and click *OK*. -+ -NOTE: Perl and Python must be installed for the respective extensions to work. - -12. If you do not require a proxy server, proceed to Step 15. -13. If you require a proxy server, select *Use the following proxy settings* and enter the proxy server and port for downloading the open -source extensions. -+ -image:{images}/ProxySettings.jpg[trafci proxy settings] -14. Click *Detect Proxy Server(s)* to try to auto-detect your proxy settings. If trafci detects one or more proxy servers, it displays -them in a drop-down menu next to the *Detect Proxy Server(s)* button. -15. Click *Install* to start the installation. - -16. After the core trafci files are installed, the *Installation Status* dialog box appears indicating how many files were extracted to the -installation directory: -+ -image:{images}/Extracted_Files.jpg[trafci extracted files] -+ -Click *OK* to continue the installation. -17. If you chose to install the optional components, the installer attempts to download and install them. The progress bar indicates the -download progress of each file. In addition, an installation log provides details about the status of the download and installation of -the components. -+ -image:{images}/InstallComplete.jpg[trafci installation complete] -18. After all trafci files are installed, the Installer Wizard completes. -19. Click *Exit*. - -<<< -[[trafci-cmd-install]] -==== Command-Line Installation Steps - -1. At a command prompt, change to the directory where you extracted the contents of the distribution (.zip) file: -+ -``` -cd installer-directory -``` -+ -`_installer-directory_` is the directory where you extracted the installer files. -+ -*Example* -+ -``` -$ cd $HOME/trafodion-download/clients/trafci -$ ls -README trafciInstaller.jar -``` - -2. Before launching the command-line installer, see the command options below: -+ -``` -java -jar trafciInstaller.jar -help -Usage: java -jar <installer jar> [ -help] | <-cm|-silent> - [-jdbcFile <jdbc filename>] [-installDir <install dir>] ] -``` -+ -The `-silent` option installs the client without prompting you for options. -+ -``` -java -jar trafciInstaller.jar -silent -jdbcFile "C:\JDBC\lib\jdbcT4.jar" -installDir C:\TRAFCI -``` -+ -_-jdbcFile_ and _-installDir_ are optional parameters. If you do not specify those parameters, you will be prompted to enter them during -installation. - -3. Launch the command-line installer by entering this command: -+ -``` -java -jar trafciInstaller.jar cm -``` -+ -The command-line installer starts and prompts you to enter the type of installation: -+ -``` -/home/myname/trafcitemp>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]: -``` -+ -* For a standard installation, type *Y* and press *Enter*. -* To install the optional components only, type *N*, press *Enter*, and proceed to Step 7. -+ -NOTE: All items in square brackets are default values. Press Enter to accept the default value. - -4. Enter the full directory path and file name of the JDBC driver JAR file, `jdbcT4.jar`, which is located in the JDBC driver lib directory: -+ -``` -JDBC Type 4 Driver JAR File --------------------------------- -Enter the location and file name: -``` -5. Enter an existing directory where you would like to install trafci: -+ -``` -Trafodion Command Interface --------------------------------- -Enter the installation directory: -``` -+ -The installation status appears, indicating how many files are installed in the installation directory: -+ -``` -Extracted 18 files from the -/home/myname/trafcitemp/trafciInstaller.jar archive into the -/usr/local/trafci directory. -Core TRAFCI files installed. -Do you want to install the optional components? [Y]: -``` - -6. If you do not wish to download and install the optional components, type *N* at the prompt and press Enter, and your installation -is complete. Otherwise, type *Y*, press *Enter*, and proceed through the remainder of the installation. -+ -<<< - -7. Type *Y* and press *Enter* if you agree to the terms. If you are doing an optional install only, you are prompted to enter a valid trafci -installation directory: -+ -``` -Do you agree to these terms? (Y or N): Y - -Enter your installation directory: -``` - -8. If you do not require a proxy server, type *N*, press *Enter*, and proceed to Step 10. Otherwise, type *Y*, press *Enter*, -and proceed to Step 9. -+ -``` -Use a proxy server? [N]: -``` - -9. When prompted to auto-detect proxy servers, type *Y* and press *Enter* to direct trafci to detect your proxy settings. -If trafci finds proxy servers, it displays them. If you type *N* and press *Enter*, trafci prompts you to enter the proxy server and port: -+ -``` -Use a proxy server? [Y]: Y -Attempt to auto-detect proxy server(s)? [Y]: N -Enter the proxy server (do not include the port): myproxyserver.com -Enter the proxy port: 8080 -``` - -10. You are prompted to select which optional components you wish to download and install. You can also change the download URL. -+ -``` -Install Perl JavaServer extensions? [Y]: Y - -Perl JavaServer requires 3 files: Java.pm, JavaArray.pm, and JavaServer.jar -http://search.cpan.org/src/METZZO/Java-4.7/[URL of the folder which contains these files [http://search.cpan.org/src/METZZO/Java-4.7/]:] - -Install Perl XML SAX Module? [Y]: Y - -Perl SAX XML Module URL (PerlSAX.pm) - -Install Jython, a Java implementation of Python? [Y]: Y - -Jython URL (jython_installer-2.2.jar) -``` - -11. The setup proceeds to download and install the optional open-source components. As each component is retrieved, dots (.) are printed to -indicate the progress of the download. -+ -``` -Downloading Perl JavaServer [1 of 3] - Java.pm -......................... 100% -Downloading Perl JavaServer [2 of 3] - JavaArray.pm1 -......................... 100% -Downloading Perl JavaServer [3 of 3] - JavaServer.jar -......................... 100% -Successfully added settings.pl -Downloading Perl XML SAX Module [1 of 1] - PerlSAX.pm -......................... 100% -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> -``` - -<<< -[[trafci-post-installation-instructions]] -== Post-Installation Instructions - -=== Verify Installed Software Files - -After downloading and running the installer file, verify that the trafci software files are installed in the correct locations: - -[cols="15%l,20%l,65%",options="header"] -|=== -| Folder | Files | Description -| bin | trafci | -| | trafci.cmd | Windows launch file. -| | trafci.pl | Perl wrapper script. _trafci-perl.pl_ is renamed _trafci.pl_. To run this script, see the -{docs-url}/command_interface/index.html[_Trafodion Command Interface Guide_]. -| | trafci.py | Python wrapper script. trafci-python.py is renamed as trafci.py. To run this script, see the -{docs-url}/command_interface/index.html[_Trafodion Command Interface Guide_]. -| | trafci.sh | Linux launch file. -| | trafci-perl.pl | Perl wrapper script. This script has been modified to invoke trafci.pl. This script is retained for backward compatibility. -| | trafci-python.py | Python wrapper script. This script has been modified to invoke trafci.py. This script is retained for backward compatibility. -| lib | trafci.jar | Product JAR file. -| lib/perl | Session.pm | Product file. -| lib/python | Session.py | Product file. -| samples | README | Readme file that describes how to use the sample scripts. -| | arrayDML.pl | Sample Perl program that executes DML statements and returns results in an array format. -| | sample.pl | Sample Perl program that supports multiple sessions in one script. -| | sample.sql | Sample SQL script. -| | sampleDDL.py | Sample Python file that uses Jython to execute DDL statements. -| | sampleDML.py | Sample Python file that uses Jython to execute DML statements. -| | sampleTables.pl | Sample Perl file that lists all tables and respective row counts. The file accepts a wild-card argument on the command line. -| | sampleTables.py | Sample Python file that lists all tables and respective row counts. The file accepts a wild-card argument on the command line. -|=== - -<<< -== Test Launching trafci - -Before launching trafci, make sure that you have set the Java path to the correct location. For more information, see: - -* <<jdbct4-path-windows, Setting the PATH to a Supported Java Version on Windows>> -* <<jdbct4-path-linux, Setting the PATH to a Supported Java Version on Linux>> - -If you did not set the Java path on your client workstation and you try to launch trafci, you might see the following error message appear -momentarily in the trafci window before the trafci window disappears: - -``` -'java' is not recognized as an internal or external command, operable program or batch file. -``` - -For information about setting up and using trafci, such as choosing the look and feel of the interface or presetting launch parameters, see the -{docs-url}/command_interface/index.html[Trafodion Command Interface Guide]. - -<<< -=== Windows Example - -On Windows, do the following: - -1. Go to the directory where you installed trafci. For example, `c:\Trafodion\Trafodion Command Interface` -2. Go to the `bin` directory -3. Invoke the `trafci.cmd` file. -4. Answer prompts. - -``` -cd "c:\Trafodion\Trafodion Command Interface" -cd bin -trafci.cmd -<screen is cleared> - -Welcome to Apache Trafodion Command Interface -Copyright (c) 2015 Apache Software Foundation - -Host Name/IP Address: trafodion.host.com:23400 -User Name: usr -Password: - - -Connected to Trafodion - -SQL> show schemas ; - -Welcome to Apache Trafodion Command Interface -Copyright (c) 2015 Apache Software Foundation - -Host Name/IP Address: 10.1.30.28:23400 -User Name: usr -Password: - - -Connected to Trafodion - -SQL>show schemas; - -SCHEMA NAMES --------------------------------------------------------------------------------- -SEABASE _MD_ _REPOS_ _LIBMGR_ - -SQL> -``` - -<<< -=== Linux Example - -On Linux, do the following: - -1. Go to the directory where you installed trafci. For example, `$HOME/trafci` -2. Go to the `bin` directory -3. Invoke the `trafci.sh` file. -4. Answer prompts. - -``` -$ cd $HOME/trafci/bin -$ . ./trafci.sh -h trafodion.home.com:23400 -u usr -p pwd - -Welcome to Apache Trafodion Command Interface -Copyright (c) 2015 Apache Software Foundation - -Connected to Trafodion - -SQL>show schemas; - -SCHEMA NAMES --------------------------------------------------------------------------------- -SEABASE _MD_ _REPOS_ _LIBMGR_ - -SQL> -``` - -<<< -[[trafci-uninstall]] -== Uninstall trafci - -If you used the executable JAR file, `trafciInstaller.jar`, to install trafci, delete the entire -folder/directory when you installed trafci. - - - +//// +/** + *@@@ START COPYRIGHT @@@ + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * @@@ END COPYRIGHT @@@ + */ +//// + +[[trafci]] += Install trafci + +== Prerequisites + +If you have not done so already, please ensure that you have <<java-setup, setup your Java environment>>, +<<download-software, unpackaged the {project-name} client software>>, and <<jdbct4, installed the JDBC Type-4 Driver>>. +. + +The examples in this chapter assumes that you have unpackaged the trafci installation file +to `c:\trafodion\trafci` (Windows) or `$HOME/trafodion/trafci` (Linux). + +[[trafci_perl_python]] +== Install Perl or Python + +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: + +* Perl version 5.8.8 +* Python version 2.3.4 + +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. + +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 `README` in the samples directory. + +<<< +[[trafci-verify-install]] +== Verify Installation + +Verify that `c:\trafodion\trafci` (Windows) or `$HOME/trafodion/trafci` (Linux) contains the following files: + +* `README` +* `trafciInstaller.jar` + +[[trafci-run-installer]] +== Run trafci Installer + +`trafciInstaller.jar` is used to install trafci. + +Two modes are supported: + +* <<trafci-wizard-install, GUI Wizard Install>> +* <<trafci-cmd-install, Command-Line Install>> + +[[trafci-wizard-install]] +=== GUI Wizard Install + +NOTE: 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 <<trafci-cmd-install, Command-Line Install>> instructions below. +<<< +==== Launch the Installer Wizard + +. Move to the trafci install directory. +** *Windows:* `c:\trafodion\trafci` +** *Linux:* `$HOME/trafodion/trafci` +. Double-click on `trafciInstaller.jar` + +If the trafci Installer Wizard does not start, then do the following from a command prompt: + +. Change director to the trafci install directory. +** *Windows:* `cd c:\trafodion\trafci` +** *Linux:* `cd $HOME/trafodion/trafci` +. Launch the trafci Installer Wizard: `java -jar trafciInstaller.jar` + +[[trafci-using-wizard]] +==== Using the Installer Wizard + +When you execute `trafciInstaller.jar`, the Installer Wizard appears: + +image:{images}/InstallerWizardWelcome.jpg[trafci Installer Wizard welcome screen] + +1. Click one of the buttons for the type of installation that you would like to perform: +* *Standard Installation* to start the Installer Wizard. Guides you through installing both the core trafci components and the optional open +source extensions. +* *Core Components* for a quick installation of the core trafci files. +* *Optional Components* if you have already installed the core trafci files but want to install only the optional open source extensions. + +2. After you have selected the components you wish to install, browse and select the JDBC JAR file and then specify an installation directory +where you will install trafci. ++ +image:{images}/InstallerWizardPaths.jpg[trafci select path dialog] + +3. To locate the *JDBC Type 4 Driver JAR file*, click *Browse* next to the *JDBC Type 4 Driver JAR File*. ++ +Navigate to the lib folder of the {project-name} JDBC driver and select the `jdbcT4.jar` file +(`c:\trafodion\jdbct4\lib\jdbcT4.jar` on Windows, `$HOME/trafodion/jdbct4/lib/jdbcT4.jar` on Linux), and then click *Select*. ++ +The Installer Wizard now displays the path of the JDBC driver JAR file for *JDBC Type 4 Driver JAR File*. + +4. To select the *Trafodion Command Interface installation directory*, click *Browse* next to the *Trafodion Command Interface installation directory* ++ +Navicate to `c:\trafodion` (Windows) or `$HOME/trafodion` (Linux)and click on *Select*. ++ +The Installer Wizard now displays the path of the installation directory for *Trafodion Command Interface installation directory*. ++ +image:{images}/trafci_Installation_Choices.jpg[trafci installation choices] + +5. Click *Next* to review the open-source legal disclaimer. +6. If you agree to the terms and conditions, select the check box, and click *Next*. ++ +The Installer Wizard dialog box shows which components are available for you to download and install. ++ +image:{images}/OptionalComponents.jpg[trafci component selection] + +7. Select the optional components to be downloaded and installed. Each optional component is installed if the component box is checked. ++ +If you want to change the download URL for the extensions, click *Edit URL*, and this dialog box appears: ++ +image:{images}/PerlJavaServerURL.jpg[trafci edit download URL] ++ +Type a new path, and click *OK*. ++ +NOTE: Perl and Python must be installed for the respective extensions to work. + +8. If you do not require a proxy server, proceed to Step 12. +9. If you require a proxy server, select *Use the following proxy settings* and enter the proxy server and port for downloading the open +source extensions. ++ +image:{images}/ProxySettings.jpg[trafci proxy settings] + +10. Click *Detect Proxy Server(s)* to try to auto-detect your proxy settings. If trafci detects one or more proxy servers, it displays +them in a drop-down menu next to the *Detect Proxy Server(s)* button. +11. Click *Install* to start the installation. + +12. After the core trafci files are installed, the *Installation Status* dialog box appears indicating how many files were extracted to the +installation directory: ++ +image:{images}/Extracted_Files.jpg[height=600,width=600,alt="trafci extracted files"] ++ +Click *OK* to continue the installation. + +13. If you chose to install the optional components, the installer attempts to download and install them. The progress bar indicates the +download progress of each file. In addition, an installation log provides details about the status of the download and installation of +the components. ++ +image:{images}/InstallComplete.jpg[trafci installation complete] + +14. After all trafci files are installed, the Installer Wizard completes. +15. Click *Exit*. + +<<< +[[trafci-cmd-install]] +=== Command-Line Installation Steps + +1. At a command prompt, change to the directory where you extracted the contents of the distribution (.zip) file: ++ +*Windows* ++ +``` +c:\> cd c:\trafodion\trafci +c:\trafodion\trafci> dir +README trafciInstaller.jar +``` ++ +*Linux* ++ +``` +$ cd $HOME/trafodion/trafci +$ ls +README trafciInstaller.jar +``` + +2. Before launching the command-line installer, see the command options below: ++ +``` +java -jar trafciInstaller.jar -help +Usage: java -jar <installer jar> [ -help] | <-cm|-silent> + [-jdbcFile <jdbc filename>] [-installDir <install dir>] ] +``` ++ +The `-silent` option installs the client without prompting you for options. ++ +*Windows* ++ +``` +java -jar trafciInstaller.jar -silent -jdbcFile "C:\trafodion\jdbct4\lib\jdbcT4.jar" -installDir C:\trafodion\trafci +``` ++ +*Linux* ++ +``` +java -jar trafciInstaller.jar -silent -jdbcFile "$HOME/jdbct4/lib/jdbcT4.jar" -installDir $HOME/trafodion/trafci +``` ++ +_-jdbcFile_ and _-installDir_ are optional parameters. If you do not specify those parameters, you will be prompted to enter them during +installation. ++ +<<< +3. Launch the command-line installer by entering this command: ++ +``` +java -jar trafciInstaller.jar -cm +``` ++ +The command-line installer starts and prompts you to enter the type of installation: ++ +*Windows* ++ +``` +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]: +``` ++ +*Linux* ++ +``` +$ cd $HOME/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]: +``` ++ +* For a standard installation, type *Y* and press *Enter*. +* To install the optional components only, type *N*, press *Enter*, and proceed to Step 7. ++ +NOTE: All items in square brackets are default values. Press Enter to accept the default value. ++ +<<< +4. Enter the full directory path and file name of the JDBC driver JAR file, `jdbcT4.jar`, which is located in the JDBC driver lib directory: ++ +``` +JDBC Type 4 Driver JAR File +-------------------------------- +Enter the location and file name: +``` ++ +* *Windows*: `c:\trafodion\jdbct4\lib\jdbcT4.jar` +* *Linux*: `/opt/user/trafodion/lib/jdbcT4.jar` ++ +NOTE: Don't use environmental variables on Linux (such as `$HOME`). Instead, specify the full path to the +`jdbcT4.jar` file. + +5. Enter an existing directory where you would like to install trafci: ++ +``` +Trafodion Command Interface +-------------------------------- +Enter the installation directory: +``` ++ +* *Windows*: `c:\trafodion\trafci` +* *Linux*: `/opt/user/trafodion/trafci` ++ +The installation status appears, indicating how many files are installed in the installation directory: ++ +``` +Extracted 18 files from the +/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]: +``` ++ +NOTE: Don't use environmental variables on Linux (such as `$HOME`). Instead, specify the full path to the +`jdbcT4.jar` file. + +6. If you do not wish to download and install the optional components, type *N* at the prompt and press Enter, and your installation +is complete. Otherwise, type *Y*, press *Enter*, and proceed through the remainder of the installation. ++ +<<< + +7. Type *Y* and press *Enter* if you agree to the terms. If you are doing an optional install only, you are prompted to enter a valid trafci +installation directory: ++ +``` +Do you agree to these terms? (Y or N): Y + +Enter your installation directory: +``` + +8. If you do not require a proxy server, type *N*, press *Enter*, and proceed to Step 10. Otherwise, type *Y*, press *Enter*, +and proceed to Step 9. ++ +``` +Use a proxy server? [N]: +``` + +9. When prompted to auto-detect proxy servers, type *Y* and press *Enter* to direct trafci to detect your proxy settings. +If trafci finds proxy servers, it displays them. If you type *N* and press *Enter*, trafci prompts you to enter the proxy server and port: ++ +``` +Use a proxy server? [Y]: Y +Attempt to auto-detect proxy server(s)? [Y]: N +Enter the proxy server (do not include the port): myproxyserver.com +Enter the proxy port: 8080 +``` + +10. You are prompted to select which optional components you wish to download and install. You can also change the download URL. ++ +``` +Install Perl JavaServer extensions? [Y]: Y + +Perl JavaServer requires 3 files: Java.pm, JavaArray.pm, and JavaServer.jar +http://search.cpan.org/src/METZZO/Java-4.7/[URL of the folder which contains these files [http://search.cpan.org/src/METZZO/Java-4.7/]:] + +Install Perl XML SAX Module? [Y]: Y + +Perl SAX XML Module URL (PerlSAX.pm) + +Install Jython, a Java implementation of Python? [Y]: Y + +Jython URL (jython_installer-2.2.jar) +``` ++ +<<< +11. The setup proceeds to download and install the optional open-source components. As each component is retrieved, dots (.) are printed to +indicate the progress of the download. ++ +``` +Downloading Perl JavaServer [1 of 3] - Java.pm +......................... 100% +Downloading Perl JavaServer [2 of 3] - JavaArray.pm1 +......................... 100% +Downloading Perl JavaServer [3 of 3] - JavaServer.jar +......................... 100% +Successfully added settings.pl +Downloading Perl XML SAX Module [1 of 1] - PerlSAX.pm +......................... 100% +Downloading Jython [1 of 1] - jython_installer-2.2.jar +......................... 100% +Successfully Installed Jython. Successfully added settings.py +Trafodion Command Interface Installation Complete. +$ +``` + +<<< +== Verify Installed Software Files + +After downloading and running the installer file, verify that the trafci software files are installed in the correct locations. +`c:\trafodion\trafci` (Windows) or `$HOME/trafodion/trafci` (Linux). + +[cols="15%,20%,65%",options="header"] +|=== +| Folder | Files | Description +| `bin` | `trafci` | +| | `trafci.cmd` | Windows launch file. +| | `trafci.pl` | Perl wrapper script. _trafci-perl.pl_ is renamed _trafci.pl_. To run this script, see the +{docs-url}/command_interface/index.html[_Trafodion Command Interface Guide_]. +| | `trafci.py` | Python wrapper script. trafci-python.py is renamed as trafci.py. To run this script, see the +{docs-url}/command_interface/index.html[_Trafodion Command Interface Guide_]. +| | `trafci.sh` | Linux launch file. +| | `trafci-perl.pl` | Perl wrapper script. This script has been modified to invoke trafci.pl. This script is retained for backward compatibility. +| | `trafci-python.py` | Python wrapper script. This script has been modified to invoke trafci.py. This script is retained for backward compatibility. +| `lib` | `trafci.jar` | Product JAR file. +| `lib/perl` | `Session.pm` | Product file. +| `lib/python` | `Session.py` | Product file. +| `samples` | `README` | Readme file that describes how to use the sample scripts. +| | `arrayDML.pl` | Sample Perl program that executes DML statements and returns results in an array format. +| | `sample.pl` | Sample Perl program that supports multiple sessions in one script. +| | `sample.sql` | Sample SQL script. +| | `sampleDDL.py` | Sample Python file that uses Jython to execute DDL statements. +| | `sampleDML.py` | Sample Python file that uses Jython to execute DML statements. +| | `sampleTables.pl` | Sample Perl file that lists all tables and respective row counts. The file accepts a wild-card argument on the command line. +| | `sampleTables.py` | Sample Python file that lists all tables and respective row counts. The file accepts a wild-card argument on the command line. +|=== + +== Modify PATH variable + +Modify the PATH variable: + +* *Windows:* `c:\trafodion\trafci\bin\` +* *Linux:* `$HOME/trafodion/trafci/bin` + +See <<howto-setup-path, Set Up Path Variable>> for further instructions. + +<<< +== Test Launching trafci + +NOTE: For information about setting up and using trafci, such as choosing the look and feel of the interface or presetting launch parameters, see the +{docs-url}/command_interface/index.html[Trafodion Command Interface Guide]. + +=== Windows Example + +On Windows, do the following: + +1. Go to the directory where you installed trafci. For example, `c:\trafodion\trafci` +2. Go to the `bin` directory +3. Invoke the `trafci.cmd` file. +4. Answer prompts. + +``` +cd "c:\trafodion\trafci\bin" +trafci.cmd +<screen is cleared> + +Welcome to Apache Trafodion Command Interface +Copyright (c) 2015 Apache Software Foundation + +Host Name/IP Address: trafodion.host.com:23400 +User Name: usr +Password: + + +Connected to Trafodion + +SQL> show schemas ; + +SCHEMA NAMES +-------------------------------------------------------------------------------- +SEABASE _MD_ _REPOS_ _LIBMGR_ + +SQL> +``` + +<<< +=== Linux Example + +On Linux, do the following: + +1. Go to the directory where you installed trafci. For example, `$HOME/trafodion/trafci` +2. Go to the `bin` directory +3. Invoke the `trafci.sh` file. +4. Answer prompts. + +``` +$ cd $HOME/trafodion/trafci/bin +$ . ./trafci.sh -h trafodion.home.com:23400 -u usr -p pwd + +Welcome to Apache Trafodion Command Interface +Copyright (c) 2015 Apache Software Foundation + +Connected to Trafodion + +SQL>show schemas; + +SCHEMA NAMES +-------------------------------------------------------------------------------- +SEABASE _MD_ _REPOS_ _LIBMGR_ + +SQL> +``` + +<<< +[[trafci-uninstall]] +== Uninstall trafci + +If you used the executable JAR file, `trafciInstaller.jar`, to install trafci, delete the entire +folder/directory when you installed trafci. + +* On Windows: ++ +``` +rmdir /s /q <trafci-installation-directory> +``` ++ +*Example* ++ +``` +rmdir /s /q c:\trafodion\trafci +``` + +* On Linux: ++ +``` +rm -rf <jdbc-installation-directory> +``` ++ +*Example* ++ +``` +rm -rf $HOME/trafodion/trafci +``` + +NOTE: Remember to remove the trafci reference in the PATH variable. + + + + + http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/asciidoc/index.adoc ---------------------------------------------------------------------- diff --git a/docs/client_install/src/asciidoc/index.adoc b/docs/client_install/src/asciidoc/index.adoc index f8ae3b8..c6aa394 100644 --- a/docs/client_install/src/asciidoc/index.adoc +++ b/docs/client_install/src/asciidoc/index.adoc @@ -1,68 +1,70 @@ -//// -* @@@ START COPYRIGHT @@@ -* -* Licensed to the Apache Software Foundation (ASF) under one -* or more contributor license agreements. See the NOTICE file -* distributed with this work for additional information -* regarding copyright ownership. The ASF licenses this file -* to you under the Apache License, Version 2.0 (the -* "License"); you may not use this file except in compliance -* with the License. You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, -* software distributed under the License is distributed on an -* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -* KIND, either express or implied. See the License for the -* specific language governing permissions and limitations -* under the License. -* -* @@@ END COPYRIGHT @@@ -//// - -= Client Installation Guide -:doctype: book -:numbered: -:toc: left -:toclevels: 3 -:toc-title: Table of Contents -:icons: font -:iconsdir: icons -:experimental: -:source-language: text -:revnumber: {project-version} -:title-logo-image: {project-logo} -:project-name: {project-name} - -:images: ../images -:sourcedir: ../../resources/source - -:leveloffset: 1 - -// The directory is called _chapters because asciidoctor skips direct -// processing of files found in directories starting with an _. This -// prevents each chapter being built as its own book. - -include::../../shared/license.txt[] - -<<< - -include::../../shared/acknowledgements.txt[] - -<<< -include::../../shared/revisions.txt[] - -include::asciidoc/_chapters/about.adoc[] -include::asciidoc/_chapters/introduction.adoc[] -include::asciidoc/_chapters/jdbct4.adoc[] -include::asciidoc/_chapters/trafci.adoc[] -include::asciidoc/_chapters/dbviz.adoc[] -include::asciidoc/_chapters/SQuirrel.adoc[] -include::asciidoc/_chapters/odbc_linux.adoc[] -include::asciidoc/_chapters/odb.adoc[] -include::asciidoc/_chapters/odbc_windows.adoc[] - -= Appendix -include::asciidoc/_chapters/sample_prog.adoc[] - +//// +* @@@ START COPYRIGHT @@@ +* +* Licensed to the Apache Software Foundation (ASF) under one +* or more contributor license agreements. See the NOTICE file +* distributed with this work for additional information +* regarding copyright ownership. The ASF licenses this file +* to you under the Apache License, Version 2.0 (the +* "License"); you may not use this file except in compliance +* with the License. You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, +* software distributed under the License is distributed on an +* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +* KIND, either express or implied. See the License for the +* specific language governing permissions and limitations +* under the License. +* +* @@@ END COPYRIGHT @@@ +//// + += Client Installation Guide +:doctype: book +:numbered: +:toc: left +:toclevels: 3 +:toc-title: Table of Contents +:icons: font +:iconsdir: icons +:experimental: +:source-language: text +:revnumber: {project-version} +:title-logo-image: {project-logo} +:project-name: {project-name} + +:images: ../images +:sourcedir: ../../resources/source +:tableau: ../../resources/tableau +:leveloffset: 1 + +// The directory is called _chapters because asciidoctor skips direct +// processing of files found in directories starting with an _. This +// prevents each chapter being built as its own book. + +include::../../shared/license.txt[] + +<<< +include::../../shared/acknowledgements.txt[] + +<<< +include::../../shared/revisions.txt[] + +include::asciidoc/_chapters/about.adoc[] +include::asciidoc/_chapters/introduction.adoc[] +include::asciidoc/_chapters/preparation.adoc[] +include::asciidoc/_chapters/jdbct4.adoc[] +include::asciidoc/_chapters/trafci.adoc[] +include::asciidoc/_chapters/dbviz.adoc[] +include::asciidoc/_chapters/SQuirrel.adoc[] +include::asciidoc/_chapters/odbc_linux.adoc[] +include::asciidoc/_chapters/odb.adoc[] +include::asciidoc/_chapters/odbc_windows.adoc[] +include::asciidoc/_chapters/tableau.adoc[] +include::asciidoc/_chapters/howto.adoc[] + + + + http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/Database_Connection_in_DbVisualizer.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/Database_Connection_in_DbVisualizer.jpg b/docs/client_install/src/images/Database_Connection_in_DbVisualizer.jpg index 5cd345c..4dc5931 100644 Binary files a/docs/client_install/src/images/Database_Connection_in_DbVisualizer.jpg and b/docs/client_install/src/images/Database_Connection_in_DbVisualizer.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/DbVisualizer_Driver_Manager.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/DbVisualizer_Driver_Manager.jpg b/docs/client_install/src/images/DbVisualizer_Driver_Manager.jpg index 535d96f..617bbad 100644 Binary files a/docs/client_install/src/images/DbVisualizer_Driver_Manager.jpg and b/docs/client_install/src/images/DbVisualizer_Driver_Manager.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/Extracted_Files.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/Extracted_Files.jpg b/docs/client_install/src/images/Extracted_Files.jpg index b272015..f905b30 100644 Binary files a/docs/client_install/src/images/Extracted_Files.jpg and b/docs/client_install/src/images/Extracted_Files.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/InstallComplete.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/InstallComplete.jpg b/docs/client_install/src/images/InstallComplete.jpg index a565be3..20d88c6 100644 Binary files a/docs/client_install/src/images/InstallComplete.jpg and b/docs/client_install/src/images/InstallComplete.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/Physical_Connection.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/Physical_Connection.jpg b/docs/client_install/src/images/Physical_Connection.jpg index b5d3475..257c44b 100644 Binary files a/docs/client_install/src/images/Physical_Connection.jpg and b/docs/client_install/src/images/Physical_Connection.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/SQuirrel_Add_Alias.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/SQuirrel_Add_Alias.jpg b/docs/client_install/src/images/SQuirrel_Add_Alias.jpg new file mode 100644 index 0000000..35fd141 Binary files /dev/null and b/docs/client_install/src/images/SQuirrel_Add_Alias.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/SQuirrel_Extra_Class_Path.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/SQuirrel_Extra_Class_Path.jpg b/docs/client_install/src/images/SQuirrel_Extra_Class_Path.jpg new file mode 100644 index 0000000..ccdbf27 Binary files /dev/null and b/docs/client_install/src/images/SQuirrel_Extra_Class_Path.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/SQuirrel_New_Driver.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/SQuirrel_New_Driver.jpg b/docs/client_install/src/images/SQuirrel_New_Driver.jpg new file mode 100644 index 0000000..a881bd8 Binary files /dev/null and b/docs/client_install/src/images/SQuirrel_New_Driver.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/tableau_connect.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/tableau_connect.jpg b/docs/client_install/src/images/tableau_connect.jpg new file mode 100644 index 0000000..dcc7062 Binary files /dev/null and b/docs/client_install/src/images/tableau_connect.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/trafci_Installation_Choices.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/trafci_Installation_Choices.jpg b/docs/client_install/src/images/trafci_Installation_Choices.jpg new file mode 100644 index 0000000..4a98b6b Binary files /dev/null and b/docs/client_install/src/images/trafci_Installation_Choices.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_admin_add.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_admin_add.jpg b/docs/client_install/src/images/winodbc_admin_add.jpg new file mode 100644 index 0000000..da4413f Binary files /dev/null and b/docs/client_install/src/images/winodbc_admin_add.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_admin_add_general.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_admin_add_general.jpg b/docs/client_install/src/images/winodbc_admin_add_general.jpg new file mode 100644 index 0000000..ab90336 Binary files /dev/null and b/docs/client_install/src/images/winodbc_admin_add_general.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_admin_add_general_edited.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_admin_add_general_edited.jpg b/docs/client_install/src/images/winodbc_admin_add_general_edited.jpg new file mode 100644 index 0000000..7e1bd93 Binary files /dev/null and b/docs/client_install/src/images/winodbc_admin_add_general_edited.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_admin_add_network.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_admin_add_network.jpg b/docs/client_install/src/images/winodbc_admin_add_network.jpg new file mode 100644 index 0000000..a540734 Binary files /dev/null and b/docs/client_install/src/images/winodbc_admin_add_network.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_admin_add_schema.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_admin_add_schema.jpg b/docs/client_install/src/images/winodbc_admin_add_schema.jpg new file mode 100644 index 0000000..fbdfa7a Binary files /dev/null and b/docs/client_install/src/images/winodbc_admin_add_schema.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_admin_add_test_connection.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_admin_add_test_connection.jpg b/docs/client_install/src/images/winodbc_admin_add_test_connection.jpg new file mode 100644 index 0000000..93a4f9f Binary files /dev/null and b/docs/client_install/src/images/winodbc_admin_add_test_connection.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_admin_add_tested_connection.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_admin_add_tested_connection.jpg b/docs/client_install/src/images/winodbc_admin_add_tested_connection.jpg new file mode 100644 index 0000000..b9dbf65 Binary files /dev/null and b/docs/client_install/src/images/winodbc_admin_add_tested_connection.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_admin_add_translate_dll.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_admin_add_translate_dll.jpg b/docs/client_install/src/images/winodbc_admin_add_translate_dll.jpg new file mode 100644 index 0000000..8af9875 Binary files /dev/null and b/docs/client_install/src/images/winodbc_admin_add_translate_dll.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_admin_intro.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_admin_intro.jpg b/docs/client_install/src/images/winodbc_admin_intro.jpg new file mode 100644 index 0000000..e1c206f Binary files /dev/null and b/docs/client_install/src/images/winodbc_admin_intro.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_destination.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_destination.jpg b/docs/client_install/src/images/winodbc_destination.jpg new file mode 100644 index 0000000..e31e275 Binary files /dev/null and b/docs/client_install/src/images/winodbc_destination.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_install_finished.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_install_finished.jpg b/docs/client_install/src/images/winodbc_install_finished.jpg new file mode 100644 index 0000000..5260f3d Binary files /dev/null and b/docs/client_install/src/images/winodbc_install_finished.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_license.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_license.jpg b/docs/client_install/src/images/winodbc_license.jpg new file mode 100644 index 0000000..3ca6bb6 Binary files /dev/null and b/docs/client_install/src/images/winodbc_license.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_ready_to_install.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_ready_to_install.jpg b/docs/client_install/src/images/winodbc_ready_to_install.jpg new file mode 100644 index 0000000..7f672f1 Binary files /dev/null and b/docs/client_install/src/images/winodbc_ready_to_install.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/images/winodbc_welcome.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/winodbc_welcome.jpg b/docs/client_install/src/images/winodbc_welcome.jpg new file mode 100644 index 0000000..9b6d2fd Binary files /dev/null and b/docs/client_install/src/images/winodbc_welcome.jpg differ
