http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c86d2385/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc ---------------------------------------------------------------------- diff --git a/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc b/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc index 09cad34..e0419e3 100644 --- a/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc +++ b/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc @@ -21,14 +21,19 @@ //// = Install Linux ODBC Driver -These installation instructions apply to Trafodion Release 1.3.*_n_* and subsequent updates of the product until otherwise indicated. -== Installation Packaged +== Installation Requirements + +The driver for Linux requires `libgcc 3.4.3` and `libstd++ 6.0`. + +If you are building ODBC applications, please use the preferred build platform, RedHat 6.x or CentOS 6.x. + +== Installation Instructions -The distribution file for the Trafodion ODBC Driver for Linux is packaged within the Trafodion clients tar file, -`clients-1.3.*_n_*.tar.gz`, on the Trafodion downloads site http://trafodion.incubator.apache.org/download.html. +You download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above. -`TRAF_ODBC_Linux_Driver_64.tar.gz` is used to install the Trafodion ODBC Driver for Linux. It contains the following files: +The package file contains the Trafodion ODBC distribution file, `TRAF_ODBC_Linux_Driver_64.tar.gz`, which is extracted to the `clients` subdirectory. +It contains the following files: ``` connect_test.cpp @@ -43,44 +48,21 @@ MD5SUM TRAFDSN ``` -By default, a new version of the Trafodion ODBC driver will be installed in the following directories unless you specify a different directory +By default, a new version of the Trafodion ODBC driver is installed in the following directories unless you specify a different directory during installation: * `/usr/lib64` * `/etc/odbc` -NOTE: The following header files are not packaged with the Trafodion ODBC driver: - -* `sql.h` -* `sqlext.h` -* `sqltypes.h` -* `sqlucode.h` - +NOTE: The following header files are not packaged with the Trafodion ODBC driver: + + + +- `sql.h` + +- `sqlext.h` + +- `sqltypes.h` + +- `sqlucode.h` + + + To install those header files, <<win_odbc_client_env, Setting Up the Client Environment>>.. -<<< -== Installation Requirements - -The driver for Linux requires `libgcc 3.4.3` and `libstd++ 6.0`. - -If you are building ODBC applications, please use the preferred build platform, RedHat 6.4 or CentOS 6.4. - -== Installation Instructions - -=== Download Linux ODBC Driver - -1. Create a download folder on the client workstation. -2. Open a Web browser and navigate to http://trafodion.incubator.apache.org/download.html. -3. Click on the `clients-1.3.*_n_*.tar.gz` link to start downloading the Trafodion clients tar file to your workstation. -4. Place the `clients-1.3.*_n_*.tar.gz` file into the download folder. -5. Unpack the `clients-1.3.*_n_*.tar.gz` file. -+ -``` -tar -xzf clients-1.3.0.tar.gz -``` - -The package file contains the Trafodion ODBC distribution file, `TRAF_ODBC_Linux_Driver_64.tar.gz`, which is extracted to the clients subdirectory. - === Install/Reinstall Linux ODBC Driver NOTE: You must have root access to install the Trafodion ODBC Driver for Linux at the default system location. @@ -100,7 +82,7 @@ tar âxvf TRAF_ODBC_Linux_Driver_64.tar + ``` cd PkgTmp -./install.sh +sudo ./install.sh ``` + Except for the sample file, the `install.sh` script saves a copy (`.SAV`) of your previous installation files if they exist. @@ -109,6 +91,7 @@ Except for the sample file, the `install.sh` script saves a copy (`.SAV`) of you 6. Enter a directory for the data-source template file, or press *Enter* to use the default directory (`/etc/odbc`). 7. Enter a directory for the sample program, or press *Enter* to use the default directory (`/etc/odbc`). +<<< === Set Up Client Environment If you selected default options during installation, ensure that: @@ -122,7 +105,7 @@ installation. The driver expects the `TRAFDSN` file to be present in either the default location (`/etc/odbc`) or the current working directory (`CWD`) of the application. -If you are building ODBC applications, you will need to install these header files in your build environment: +If you are building ODBC applications, you need to install these header files in your build environment: * `sql.h` * `sqlext.h` @@ -132,7 +115,7 @@ If you are building ODBC applications, you will need to install these header fil To install those header files from the latest packages, run this `yum` command: ``` -yum install libiodbc libiodbc-devel +sudo yum -y install libiodbc libiodbc-devel ``` The `yum` command automatically installs the header files in the `/usr/include` and `/usr/include/libiodbc` directories. @@ -175,7 +158,7 @@ The `_compression-level_` is one of these values: NOTE: For better performance, we recommend that you use at least version `2.3._x_` of unixODBC. -* If you are using an external driver manager, you must point to `libtrafodbc_drvr64.so` and not to `libtrafodbc64.so`. +* If you are using an external driver manager, then you must point to `libtrafodbc_drvr64.so` and not to `libtrafodbc64.so`. * The driver, `libtrafodbc_l64_drvr.so`, has been verified with iODBC and unixODBC driver managers. * These driver managers, as well as documentation, can be found at these Web sites: * http://www.iodbc.org/ @@ -183,6 +166,7 @@ NOTE: For better performance, we recommend that you use at least version `2.3._x * For information on the necessary data-source configuration options, you will need to add to the respective configuration files (for example, to `odbc.ini`). +<<< === Run Sample Program (`connect_test`) NOTE: The examples after each step assume that you have default installation directories. @@ -205,6 +189,12 @@ cd /etc/odbc ``` export LD_LIBRARY_PATH=<path-to-odbc-library-files or /usr/lib64> ``` ++ +*Example* ++ +``` +export LD_LIBRARY_PATH=/usr/lib64 +``` 3. In the `/etc/odbc/TRAFDSN` file, add the correct IP address to the `Server` parameter for the `Default_DataSource`. + @@ -217,16 +207,18 @@ Catalog = TRAFODION Schema = SEABASE DataLang = 0 FetchBufferSize = SYSTEM_DEFAULT -Server = TCP:1.2.3.4:37800 <- _Set IP Address_ +Server = TCP:1.2.3.4:23400 <- _Set IP Address_ SQL_ATTR_CONNECTION_TIMEOUT = SYSTEM_DEFAULT SQL_LOGIN_TIMEOUT = SYSTEM_DEFAULT SQL_QUERY_TIMEOUT = NO_TIMEOUT ``` ++ +<<< 4. Compile the sample program. + ``` -g++ -g connect_test.cpp -L/usr/lib64 -I/usr/include/odbc -ltrafodbc64 -o connect_test +sudo g++ -g connect_test.cpp -L/usr/lib64 -I/usr/include/odbc -ltrafodbc64 -o connect_test ``` 5. Run the sample program: @@ -266,8 +258,6 @@ export LD_LIBRARY_PATH=<path-to-odbc-driver-dlls> 3. In the `/etc/odbc/TRAFDSN` file, add the correct IP address to the `Server` parameter for the `Default_DataSource`. For example: + -<<< -+ *Example* + ``` @@ -277,11 +267,13 @@ Catalog = TRAFODION Schema = SEABASE DataLang = 0 FetchBufferSize = SYSTEM_DEFAULT -Server = TCP:1.2.3.4:37800 +Server = TCP:1.2.3.4:23400 SQL_ATTR_CONNECTION_TIMEOUT = SYSTEM_DEFAULT SQL_LOGIN_TIMEOUT = SYSTEM_DEFAULT SQL_QUERY_TIMEOUT = NO_TIMEOUT ``` ++ +<<< 4. Compile the sample program. +
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c86d2385/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc ---------------------------------------------------------------------- diff --git a/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc b/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc index 739d0e6..98995b9 100644 --- a/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc +++ b/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc @@ -20,29 +20,34 @@ */ //// +[[install-windows-odbc-driver]] = Install Windows ODBC Driver -These installation instructions apply to Trafodion Release 1.3.*_n_* and subsequent updates of the product until otherwise indicated. -== Installation Package -The installer file for the Trafodion ODBC Driver for Windows is packaged within the Trafodion clients tar file, `Trafodion Clients`, on the -Trafodion downloads site http://trafodion.incubator.apache.org/download.html. Use this installer file to install the Trafodion ODBC Driver for Windows: +WARNING: License issues prevent us from including the ODBC Driver for Windows in this release. Contact the +Trafodion user e-mail list ([email protected]) for help obtaining the driver. -[cols="25%l,25%,50%",options="header"] +== Installation Requirements + +[cols="40%s,60%",options="header"] |=== -| Installer File | Description | Client Operating System -| TFODBC64-1.3.*_n_*.msi | Windows MSI installer file | Windows 64-bit +| Item | Requirement +| Computer | Windows compatible PC workstation +| Memory | Recommended minimum 32 MB +| Disk Space | Minimum 30 MB additional free space +| Operating System | x64 Edition of Microsoft Windows 7, Windows 8, Windows 10, or Windows Server 2008 +| Network Software | TCP/IP |=== -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: +== Installation Instructions +[[win_odbc_install]] -[cols="40%l,60%",options="header"] -|=== -| Default Installation Directory | Client Operating System -| C:\Program Files\Trafodion\TRAF | ODBC 1.0 Windows 64-bit -|=== +=== Install Windows ODBC Driver + +NOTE: To install the driver on your PC, you must be logged on with a user ID that has administrator privileges. + +You download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above. -The ODBC client installation file installs or links to multiple client components: +The ODBC client installation file, `TFODBC64-*.exe`, which installs or links to multiple client components: [cols="40%s,60%",options="header"] |=== @@ -53,91 +58,59 @@ correct driver. | Microsoft ODBC Administrator | Adds, configures, and removes ODBC data sources on client workstations. |=== -<<< -== Installation Requirements +By default, a new version of the ODBC driver is installed in this directory and its folders unless you specify a different directory +during installation: -[cols="40%s,60%",options="header"] +[cols="40%l,60%",options="header"] |=== -| Item | Requirement -| Computer | Windows compatible PC workstation -| Memory | Recommended minimum 32 MB -| Disk Space | Minimum 30 MB additional free space -| Operating System | x64 Edition of Microsoft Windows 7, Windows 8, or Windows Server 2008 -| Network Software | TCP/IP +| Default Installation Directory | Client Operating System +| C:\Program Files\Trafodion\TRAF | ODBC _version_ Windows 64-bit |=== -== Installation Instructions -[[win_odbc_install]] -=== Install Windows ODBC Driver -NOTE: To install the driver on your PC, you must be logged on with a user ID that has administrator privileges. - -==== Task 1: Download the ODBC client installation file -1. Create a download folder on the client workstation. -2. Open a Web browser and navigate to the Trafodion downloads site http://trafodion.incubator.apache.org/download.html -3. Click on the `Trafodion Clients` link to start downloading the Trafodion clients tar file to your workstation. -4. Place the `*.tar.gz file` into the download folder. -5. Extract the contents of the `*.tar.gz` file by using an extract tool like WinZip. The package file contains the -`TFODBC64-1.3.*_n_*.msi` installer file, which is extracted to the clients sub-directory. - -==== Task 2: Start the InstallShield wizard +=== Start the InstallShield wizard 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 _interactive mode_, in which you provide input or accept defaults when prompted as ODBC is installed. Please refer to <<win_odbc_interactive_mode,Interactive Mode Installation>> below. -<<< [[win_odbc_interactive_mode]] -===== Interactive Mode Installation -1. Double-click the `.msi` distribution file to start the InstallShield wizard. +==== Interactive Mode Installation + +1. Double-click the `TFODBC64-*.exe` distribution file to start the InstallShield wizard. 2. On the *Welcome* page, click *Next*. -3. On the *Destination Folder* page, click *Next* to select the default location: `C:\Program Files\Trafodion\TRAF ODBC 1.0\` +3. Read and select the *I accept the agreement* radio button. Click *Next*. +4. On the *Destination Folder* page, click *Install* to select the default location: `C:\Program Files\Trafodion\TRAF ODBC _version_\` + This location is the installation directory for ODBC header and help files. All other ODBC files are installed in `%SYSTEMROOT%\system32`. -4. On the *Set Certificate Directory* page, click *Next* to accept the default location for the security certificate (`SYSTEM_DEFAULT`). -5. On the *Ready to Install the Program* page, click *Install*. The installation begins. The *Installing Trafodion ODBC64 1.0* page displays a -progress bar. -6. On the *InstallShield Wizard Completed* page, click *Finish* to exit the wizard. Do not add a new `Trafodion ODBC` data source to the MS ODBC -Administrator until you have restarted your system. -==== Task 3: Add a client data source +5. Read and accept the Microsoft C++ license agreement by checking the *I agree to the license terms and conditions*. Click *Install*. +6. Click *Close*. +7. Click *Finish* to exit the installation wizard. + +=== Add a client data source 1. Start the Microsoft ODBC Administrator: -* On Windows 7: *Start>All Programs>Trafodion ODBC 1.0>MS ODBC Administrator* -* On Windows 8: Right-click the *Trafodion ODBC 1.0* icon on the desktop and select MS ODBC Administrator. +* On Windows 7: *Start>All Programs>Trafodion ODBC _version_>MS ODBC Administrator* +* On Windows 8: Right-click the *Trafodion ODBC _version_* icon on the desktop and select MS ODBC Administrator. +* On Windows 10: Right-click the Windows icon in the menu bar. Select *Settings*. Search for *Set up ODBC data sources (64-bit)*. Click on the found item. + 2. In the *ODBC Data Source Administrator* dialog box, click *Add*. -3. Select *TRAF ODBC 1.0*, and then click *Finish* to start the *Create a New Trafodion ODBC Data Source* wizard. +3. Select *TRAF ODBC _version_*, and then click *Finish* to start the *Create a New Trafodion ODBC Data Source* wizard. 4. Enter the data source name (for example, `Default_DataSource_Schema1`) and an optional description, and click *Next*. -5. Enter the `IP address` or `host name` for the database platform. Enter the port number as *37800*. Leave the defaults as is, and click *Next*. +5. Enter the `IP address` or `host name` for the database platform. Enter the default port number as *23400*^1^. Leave the defaults as is, and click *Next*. 6. Enter the schema name. The default schema name is `SEABASE`. Click *Next*. 7. Enter the translate DLL name and its option, if you have one. If not, leave it blank. Leave the localization defaults as is. + -<<< -+ 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, `?` is used as the default. + -Click *Next*. -8. Select the trace options, if desired. Change the *Log File Path* to the location you want, or leave the default as is, and click *Finish*. -9. The wizard gives you an opportunity to test the connection. Click *Test Connection* and click *OK*. -10. The server ID and schema are filled in for you. Enter a valid user name and password, and click *OK*. -+ -The wizard attempts to connect to the data source and displays a message stating whether it was successful or not. -11. Click *OK* to save the data source, or click *Cancel* _twice_ to quit the *Create Data Source* wizard. - -=== Reinstall Windows ODBC Driver -To reinstall the driver, we recommend that you fully remove your ODBC driver and then install the new version. Please refer to -<<win_odbc_uninstall,Uninstalling the Trafodion ODBC Driver for Windows>> and then <<win_odbc_install, Installing the Trafodion ODBC Driver for Windows>>. +Click *Finish*. -[[win_odbc_uninstall]] -=== Uninstalling Windows ODBC Driver -1. Start to remove the ODBC driver: -* On Windows 7: *Start>All Programs>Trafodion ODBC 1.0>Remove TRAF ODBC 1.0* -* On Windows 8: Right-click the *Trafodion ODBC 1.0* icon on the desktop and select *Remove TRAF ODBC 1.0*. -2. When the *Windows Installer* dialog box asks you if you want to uninstall this product, click *Yes*. -3. The *Trafodion ODBC 1.0* dialog box displays the status and asks you to wait while `Windows configures Trafodion ODBC 1.0` (that is, removes -the Trafodion ODBC Driver from your Windows workstation). +8. The wizard gives you an opportunity to test the connection. Click *Test Connection* and click *OK*. +9. The server ID and schema are filled in for you. Enter a valid user name and password, and click *OK*. + -After this dialog box disappears, Trafodion ODBC 1.0 is no longer on your workstation. +The wizard attempts to connect to the data source and displays a message stating whether it was successful or not. +10. Click *OK* to save the data source, or click *Cancel* _twice_ to quit the *Create Data Source* wizard. -NOTE: Uninstalling the ODBC driver does not remove pre-existing data source definitions from the Windows registry. +^1^ Your specific installation may use a different port number. Check with your Trafodion administrator. <<< [[win_odbc_client_env]] @@ -157,25 +130,32 @@ definitions with different schemas on the workstation. The client data source wi To create a data source on the client workstation, follow these steps: 1. Launch the *MS ODBC Administrator*. -+ -For example, on Windows 7, select *Start>All Programs>Trafodion ODBC 1.0>MS ODBC Administrator*. +* On Windows 7: *Start>All Programs>Trafodion ODBC _version_>MS ODBC Administrator* +* On Windows 8: Right-click the *Trafodion ODBC _version_* icon on the desktop and select MS ODBC Administrator. +* On Windows 10: Right-click the Windows icon in the menu bar. Select *Settings*. Search for *Set up ODBC data sources (64-bit)*. Click on the found item. + 2. In the *ODBC Data Source Administrator* dialog box, select the *User DSN* tab, and click *Add*. -3. Select the *TRAF ODBC 1.0* driver, and then click *Finish*. +3. Select the *TRAF ODBC _version_* driver, and then click *Finish*. + A new dialog box appears, prompting you to create a new data source. 4. Enter the name of the data source, `Default_DataSource`, and click *Next* to continue. -5. Enter the IP address and port number of the Trafodion system to which will be connecting. The port number must be *37800*. +5. Enter the IP address and port number of the Trafodion system to which will be connecting. By default, the port number is *23400*^1^. Click *Next* to continue. -6. Select the default schema. If you do not select a schema, the default is `USR`. Click Next to continue. +6. Select the default schema. If you do not select a schema, the default is `SEABASE`. Click *Next* to continue. ++ +<<< 7. If desired, configure the *translate dll*, 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 *Next* to continue. -8. If desired, set the trace options and the file path of the trace log. Click *Finish*. +default, the client error message language is English, and the clientâs local character set is used. Click *Finish* to continue. + The *Test Trafodion ODBC Connection* dialog box appears, allowing you to test the connection using the data source that you created. -9. Click *Test Connection*. -10. When prompted, enter your user name and password, and click *OK*. + +8. Click *Test Connection*. +9. When prompted, enter your user name and password, and, optionally, schema. Click *OK*. + If the connection is successful, you will see `Connected Successfully` in the *Test Trafodion ODBC Connection* dialog box. +10. Click *OK* to save the data source, or click *Cancel* _twice_ to quit the *Create Data Source* wizard. + +^1^ Your specific installation may use a different port number. Check with your Trafodion administrator. === Enable Compression 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 @@ -183,12 +163,18 @@ the Trafodion Database Connectivity Services (DCS) server over a TCP/IP network. To enable compression in the ODBC driver or to change the compression setting, follow these steps: -1. Launch the MS ODBC Administrator. For example, on Windows 7, select *Start>All Programs>Trafodion ODBC 1.0>MS ODBC Administrator*. +1. Launch the MS ODBC Administrator. +* On Windows 7: *Start>All Programs>Trafodion ODBC _version_>MS ODBC Administrator* +* On Windows 8: Right-click the *Trafodion ODBC _version_* icon on the desktop and select MS ODBC Administrator. +* On Windows 10: Right-click the Windows icon in the menu bar. Select *Settings*. Search for *Set up ODBC data sources (64-bit)*. Click on the found item. + 2. In the *ODBC Data Source Administrator* dialog box, select the *User DSN* tab, select the name of your data source under *User Data Sources*, and click *Configure*. If you did not create a data source, please refer to <<win_odbc_client_env, Setting Up the Client Environment>>. + A new dialog box appears, showing the configuration of your data source. ++ +<<< 3. Select the *Network* tab, and then select one of these values for *Compression*: * `SYSTEM_DEFAULT`, which is the same as no compression * `no compression` @@ -237,3 +223,22 @@ Data selected: 1000 CREATE REPORTS 2014-3-22 Basic SQL ODBC Test Passed! ``` +<<< +== Reinstall Windows ODBC Driver +To reinstall the driver, we recommend that you fully remove your ODBC driver and then install the new version. Please refer to +<<win_odbc_uninstall,Uninstalling the Trafodion ODBC Driver for Windows>> and then <<win_odbc_install, Installing the Trafodion ODBC Driver for Windows>>. + +[[win_odbc_uninstall]] +== Uninstalling Windows ODBC Driver +1. Start to remove the ODBC driver: +* On Windows 7: *Start>All Programs>Trafodion ODBC _version_>Remove TRAF ODBC _version_* +* On Windows 8: Right-click the *Trafodion ODBC _version_* icon on the desktop and select *Remove TRAF ODBC _version_*. +* On Windows 10: Right-click the Windows icon in the menu bar. Select *Control Panel*. Click on *Uninstall a program*. Locate *Trafodion ODBC64 _version_* and select it. Click on *Uninstall*. + +2. When the *Windows Installer* dialog box asks you if you want to uninstall this product, click *Yes*. +3. The *Trafodion ODBC _version_* dialog box displays the status and asks you to wait while `Windows configures Trafodion ODBC _version_` (that is, removes +the Trafodion ODBC Driver from your Windows workstation). ++ +After this dialog box disappears, Trafodion ODBC _version_ is no longer on your workstation. + +NOTE: Uninstalling the ODBC driver does not remove pre-existing data source definitions from the Windows registry. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c86d2385/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 dfe7b2e..138322c 100644 --- a/docs/client_install/src/asciidoc/_chapters/sample_prog.adoc +++ b/docs/client_install/src/asciidoc/_chapters/sample_prog.adoc @@ -34,7 +34,7 @@ Copy and paste the code from this appendix into the recommended files. To build === `basicsql.cpp` Source Code You can download the `basicsql.cpp` example from -http://trafodion.incubator.apache.org/docs/latest/client_install/resources/source/basicsql.cpp. +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`: @@ -52,7 +52,7 @@ 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/latest/client_install/resources/source/build.bat. +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: @@ -64,7 +64,7 @@ To build the sample program on Windows, see the instructions in <<win_odbc_run_b ==== Run `run.bat` You can download the `run.bat` example from -http://trafodion.incubator.apache.org/docs/latest/client_install/resources/source/run.bat. +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: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c86d2385/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 f670587..2a21d2a 100644 --- a/docs/client_install/src/asciidoc/_chapters/trafci.adoc +++ b/docs/client_install/src/asciidoc/_chapters/trafci.adoc @@ -20,137 +20,46 @@ */ //// -= Install TrafCI -These installation instructions apply to Trafodion Release 1.3.*_n_* and subsequent updates of the product until otherwise indicated. - -== Installation Package - -The distribution file for the Trafodion Command Interface (TrafCI) is packaged within the Trafodion clients tar file, -`clients-1.3.*_n_*.tar.gz`, on the Trafodion downloads site http://trafodion.incubator.apache.org/download.html. -Use this distribution file to install TrafCI: - -[cols="35%l,35%,30%",options="header"] -|=== -| Distribution File | Description | Client Operating System -| trafci.zip | Zip file | Windows or Linux -|=== - -The distribution zip file contains this installer file: `trafciInstaller.jar`, an executable JAR file. +[[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, follow these -instructions: - -* <<trafci_JRE, Install Java Runtime Environment>> -* <<trafci_install_jdbct4, Install JDBC Type-4 Driver>> -* <<trafci_perl_python, Install Perl or Python>> - -[[trafci_JRE]] -=== Install/Verify Java Runtime Environment - -TrafCI and the Trafodion JDBC Type 4 Driver require 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. - -To determine the Java version that you have installed on your client workstation and to install a supported version, see -<<jdbct4_JRE, Install Java Runtime Environment (JRE)>>. - -[[trafci_install_jdbct4]] -=== Install/Verify JDBC Type-4 Driver -TrafCI requires a compatible version of the Trafodion JDBC Type 4 Driver to be installed on the client workstation before you install TrafCI. - -==== Install JDBC Type-4 Driver -To install and use the JDBC driver, see <<jdbct4_JRE, Install Java Runtime Environment (JRE)>>. - -==== Verify JDBC Type-4 Driver -To display the version of the JDBC driver that is already installed on the client workstation: +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. -1. Change the directory to the lib directory, which contains the JDBC driver JAR file: -* On Windows, enter this command: -+ -``` -cd jdbc-installation-directory\lib -``` -+ -`_jdbc-installation-directory_` is the directory where you installed the JDBC driver. - -* On Linux, enter this command: -+ -``` -cd jdbc-installation-directory/lib -``` -+ -`_jdbc-installation-directory_` is the directory where you installed the JDBC driver. - -2. Enter this command to return version information: -+ -``` -java -jar jdbcT4.jar -``` -+ -``` -C:\> cd "\<user-specified directory>\lib" -C:\<user-specified directory>\lib> java -jar jdbcT4.jar -Traf_JDBC_Type4_Build_40894 - -C:\<user-specified directory>\lib> -``` - -If the JAR file is inaccessible or the returned version is not supported, see <<trafci_install_jdbct4, Install/Verify JDBC Type-4 Driver>>. - -<<< [[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 +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 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 +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 -NOTE: Before following the installation procedures, you must install the Trafodion JDBC Type 4 Driver on the client workstation. For more -information, see <<trafci_install_jdbct4, Install JDBC Type-4 Driver>>. - -Follow these instructions to download and install TrafCI on the client workstation. - -* <<trafci_download_installer, Download Installer>> -* <<trafci_run_installer, Run Executable JAR Installer>> - -To uninstall TrafCI, see <<trafci_uninstall, Uninstall_TrafCI>>. +You download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above. -[[trafci_download_installer]] -=== Download Installer +1. Change the directory to the `clients` subdirectory. -1. Create a download folder on the client workstation. -2. Open a Web browser and navigate to the Trafodion downloads site http://trafodion.incubator.apache.org/download/html -3. Click on the `clients-1.3.*_n_*.tar.gz` link to start downloading the Trafodion clients tar file to your workstation. -4. Place the `clients-1.3.*_n_*.tar.gz` file into the download folder. -+ -<<< -5. Unpack the `clients-1.3.*_n_*.tar.gz` file. -+ -``` -tar -xzf clients-1.3.0.tar.gz -``` -+ -The package file contains the trafci.zip distribution file, which is extracted to the clients subdirectory. - -6. Change the directory to the clients subdirectory. - -7. Extract the contents of the `trafci.zip` file to a location on your client workstation by using the unzip command (or the WinZip extract -tool): +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): + ``` -unzip trafci.zip +cd $HOME/trafodion-download/clients +unzip trafci.zip -d trafci +cd trafci ``` + The command extracts these files: @@ -158,22 +67,20 @@ The command extracts these files: * `README` * `trafciInstaller.jar` -8. Proceed with <<trafci_run_installer, Run Executable JAR Installer>>. - -[[trafci_run_installer]] +[[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 +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>> +* <<trafci-cmd-install, Command-Line Installation Steps>> -[[trafci_wizard_install]] +[[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>>. +does not have the X Window system, see <<trafci-cmd-install, Command-Line Installation Steps>>. <<< ===== Launching the Installer Wizard @@ -181,7 +88,7 @@ does not have the X Window system, see <<trafci_cmd_install, Command-Line Instal 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>>. +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: + ``` @@ -196,25 +103,25 @@ cd installer-directory java -jar trafciInstaller.jar ``` -7. Proceed to <<trafci_using_wizard, Using the Installer Wizard>>. +7. Proceed to <<trafci-using-wizard, Using the Installer Wizard>>. -[[trafci_using_wizard]] +[[trafci-using-wizard]] ===== Using the Installer Wizard When you execute `trafciInstaller.jar`, the Installer Wizard appears: -image:{images}/InstallerWizardWelcome.jpg[image] +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 +* *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 +* *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. +where you will install trafci. + -image:{images}/InstallerWizardPaths.jpg[image] +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 Trafodion JDBC driver, and then click *Open*. @@ -222,63 +129,74 @@ image:{images}/InstallerWizardPaths.jpg[image] + The Installer Wizard now displays the path of the JDBC driver JAR file. + -image:{images}/JDBC_JAR_Path.jpg[image] +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 + +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. +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[image] +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[image] +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[image] -14. Click *Detect Proxy Server(s)* to try to auto-detect your proxy settings. If TrafCI detects one or more proxy servers, it displays +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 +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[image] +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[image] -18. After all TrafCI files are installed, the Installer Wizard completes. +image:{images}/InstallComplete.jpg[trafci installation complete] +18. After all trafci files are installed, the Installer Wizard completes. 19. Click *Exit*. <<< -[[trafci_cmd_install]] +[[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_* -==== +``` +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: + @@ -331,7 +249,7 @@ JDBC Type 4 Driver JAR File -------------------------------- Enter the location and file name: ``` -5. Enter an existing directory where you would like to install TrafCI: +5. Enter an existing directory where you would like to install trafci: + ``` Trafodion Command Interface @@ -351,7 +269,10 @@ 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 ++ +<<< + +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: + ``` @@ -367,8 +288,8 @@ 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: +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 @@ -414,17 +335,13 @@ Trafodion Command Interface Installation Complete. /home/myname/trafcitemp> ``` -[[trafci_uninstall]] -=== Uninstall TrafCI - -If you used the executable JAR file, `trafciInstaller.jar`, to install TrafCI, delete the entire -`Trafodion Command Interface` folder to uninstall TrafCI. - +<<< +[[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: +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"] |=== @@ -452,22 +369,104 @@ http://trafodion.incubator.apache.com/docs/command_interface/index.html[_Trafodi |=== <<< -=== Test Launching TrafCI +== Test Launching trafci -Before launching TrafCI, make sure that you have set the Java path to the correct location. For more information, see: +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 >> -* <<jdbct4_path_linux, Setting the PATH to a Supported Java Version on Linux>> +* <<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: +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 +http://trafodion.incubator.apache.com/docs/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. -For information about setting up the client, such as choosing the look and feel of the interface or presetting launch parameters, see the -http://trafodion.incubator.apache.com/docs/command_interface/index.html[_Trafodion Command Interface Guide_]. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c86d2385/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 f59af1d..9dc187f 100644 --- a/docs/client_install/src/asciidoc/index.adoc +++ b/docs/client_install/src/asciidoc/index.adoc @@ -56,23 +56,26 @@ specific language governing permissions and limitations under the License. **Acknowledgements** -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. +Microsoft(R) 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. + +*Revision History* [cols="2",options="header"] |=== | Version | Date +| 2.0.0 | To be announced. | 1.3.0 | January, 2016 |=== include::asciidoc/_chapters/about.adoc[] include::asciidoc/_chapters/introduction.adoc[] -include::asciidoc/_chapters/odbc_windows.adoc[] -include::asciidoc/_chapters/odbc_linux.adoc[] include::asciidoc/_chapters/jdbct4.adoc[] include::asciidoc/_chapters/trafci.adoc[] -include::asciidoc/_chapters/odb.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[] http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c86d2385/docs/client_install/src/images/win10_edit_path.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/win10_edit_path.jpg b/docs/client_install/src/images/win10_edit_path.jpg new file mode 100644 index 0000000..ec9c8c6 Binary files /dev/null and b/docs/client_install/src/images/win10_edit_path.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c86d2385/docs/client_install/src/images/win10_select_java.jpg ---------------------------------------------------------------------- diff --git a/docs/client_install/src/images/win10_select_java.jpg b/docs/client_install/src/images/win10_select_java.jpg new file mode 100644 index 0000000..a8e498a Binary files /dev/null and b/docs/client_install/src/images/win10_select_java.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c86d2385/docs/command_interface/src/asciidoc/_chapters/about.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/about.adoc b/docs/command_interface/src/asciidoc/_chapters/about.adoc index 6b4f1c6..dccb28f 100644 --- a/docs/command_interface/src/asciidoc/_chapters/about.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/about.adoc @@ -24,8 +24,8 @@ //// = About This Document -This guide describes how to use the Trafodion Command Interface (TrafCI) on a client workstation to connect to and query a Trafodion database. -The TrafCI enables you to run SQL statements interactively or from script files. +This guide describes how to use the Trafodion Command Interface (trafci) on a client workstation to connect to and query a Trafodion database. +The trafci enables you to run SQL statements interactively or from script files. == Intended Audience This guide is intended for database administrators and support personnel who are maintaining and monitoring a Trafodion database. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c86d2385/docs/command_interface/src/asciidoc/_chapters/commands.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/commands.adoc b/docs/command_interface/src/asciidoc/_chapters/commands.adoc index cf568bd..5dbfa7f 100644 --- a/docs/command_interface/src/asciidoc/_chapters/commands.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/commands.adoc @@ -537,7 +537,7 @@ LOG OPTIONS APPEND,CMDTEXT ON MARKUP RAW PROMPT SQL> SCHEMA SEABASE -SERVER sqws135.houston.host.com:37800 +SERVER sqws135.houston.host.com:23400 SQLTERMINATOR ; STATISTICS OFF TIME OFF @@ -561,7 +561,7 @@ LOG OFF MARKUP RAW PROMPT SQL> SCHEMA SEABASE -SERVER sqws135.houston.host.com:37800 +SERVER sqws135.houston.host.com:23400 SQLTERMINATOR ; STATISTICS OFF TIME OFF @@ -3872,7 +3872,7 @@ LOG OPTIONS APPEND,CMDTEXT ON MARKUP RAW PROMPT SQL> SCHEMA SEABASE -SERVER sqws135.houston.host.com:37800 +SERVER sqws135.houston.host.com:23400 SQLTERMINATOR ; STATISTICS OFF TIME OFF @@ -3893,7 +3893,7 @@ LOG OFF MARKUP RAW PROMPT SQL> SCHEMA SEABASE -SERVER sqws135.houston.host.com:37800 +SERVER sqws135.houston.host.com:23400 SQLTERMINATOR ; STATISTICS OFF TIME OFF http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c86d2385/docs/command_interface/src/asciidoc/_chapters/install.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/install.adoc b/docs/command_interface/src/asciidoc/_chapters/install.adoc index f755c90..6251908 100644 --- a/docs/command_interface/src/asciidoc/_chapters/install.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/install.adoc @@ -26,74 +26,24 @@ [[install]] = Install and Configure -== Install TrafCI -To install TrafCI on a client workstation, follow the procedures in the -http://trafodion.incubator.apache.org/docs/client_install/index.html[_Trafodion Client Installation Guide_]. +== Install trafci +To install trafci on a client workstation, follow the procedures in the +http://trafodion.incubator.apache.org/docs/client_install/index.html[Trafodion Client Installation Guide]. +Ensure that you set up the Java Path per the instructions in that guide. -[[install_verify]] -== Verify and Set the Java Path -=== Set PATH on Windows - -1. Right-click the *Computer* icon on your desktop, and then select *Properties*. -The *Control Panel>System and Security>System* window appears. -2. In the left navigation bar, click the *Advanced* system settings link. -3. In the *System Properties* dialog box, click the *Environment Variables* button. -4. Under _System variables_, select the variable named *Path*, and then click *Edit*: -+ -image:{images}/path2.jpg[image] - -5. Place the cursor at the beginning of the _Variable_ value field and enter the path of the Java -`bin` directory, ending with a semicolon (`;`): -+ -image:{images}/varval2.jpg[image] -+ -``` -"C:\Program Files (x86)\Java\jre7\bin"; -``` -+ -NOTE: 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. - -6. Click *OK*. -7. Verify that the updated Path appears under _System variables_, and click OK. -8. In the *System Properties* dialog box, click *OK* to accept the changes. - -=== Set PATH on Linux -1. Open the user profile (`.profile` or `.bash_profile` for the Bash shell) in the `$HOME` directory. -+ -``` -vi .profile -``` - -2. In the user profile, set the `PATH` environment variable to include path of the Java bin -directory. -+ -``` -export PATH=/opt/java1.7/jre/bin:$PATH -``` -+ -NOTE: Place the path of the Java bin directory before `$PATH`, and check that no space exists after the colon (`:`) in the path. -In the C shell, use the `setenv` command instead of export. - -3. To activate the changes, either log out and log in again or execute the user profile. -+ -``` -. .profile -``` - -== Test TrafCI Launch -1. Launch TrafCI and verify that you can connect to the database. For -instructions, see <<launch_trafci, Launch TrafCI>>. +== Test trafci Launch +1. Launch trafci and verify that you can connect to the database. For +instructions, see <<launch_trafci, Launch trafci>>. + This window should appear: + image:{images}/launch02.jpg[image] -2. If you cannot launch TrafCI or connect to the database, verify that: +2. If you cannot launch trafci or connect to the database, verify that: + * The database platform is available and running, and the port number is correct for the database platform. * The Java path is set to the correct location. See <<install_verify, Verify and Set the Java Path>>. -* You installed the TrafCI and JDBC software files correctly. +* You installed the trafci and JDBC software files correctly. -See the http://trafodion.incubator.apache.org/docs/latest/client_install/index.html[_Trafodion Client Installation Guide_]. +See the http://trafodion.incubator.apache.org/docs/latest/client_install/index.html[Trafodion Client Installation Guide]. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c86d2385/docs/command_interface/src/asciidoc/_chapters/interactive.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/interactive.adoc b/docs/command_interface/src/asciidoc/_chapters/interactive.adoc index ac5abcc..9e73208 100644 --- a/docs/command_interface/src/asciidoc/_chapters/interactive.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/interactive.adoc @@ -24,13 +24,13 @@ //// = Run Commands Interactively -After launching TrafCI, you can run SQL statements and interface commands in the command-line interface. +After launching trafci, you can run SQL statements and interface commands in the command-line interface. == User Interface === Product Banner -After you launch TrafCI and connect to the database platform, the product banner appears in the +After you launch trafci and connect to the database platform, the product banner appears in the command-line interface: image:{images}/launch02.jpg[Product banner] @@ -68,7 +68,7 @@ for parts that you enclose in single-quotes (`'`) or double-quotes (`"`). <<< == Interface Commands -The interface commands allow you to customize TrafCI (for example, by using `SET` commands) or +The interface commands allow you to customize trafci (for example, by using `SET` commands) or return information about the interface settings or database objects (for example, by using `SHOW commands`). @@ -79,7 +79,7 @@ command across more than one line, enter the SQL terminator and then reenter the === Show Session Attributes -To display the attributes and settings of the current TrafCI session, use the `ENV`, `SHOW SESSION`, +To display the attributes and settings of the current trafci session, use the `ENV`, `SHOW SESSION`, or `SESSION` command. *Example* @@ -98,7 +98,7 @@ LOG OPTIONS APPEND,CMDTEXT ON MARKUP RAW PROMPT SQL> SCHEMA SEABASE -SERVER sqws135.houston.host.com:37800 +SERVER sqws135.houston.host.com:23400 SQLTERMINATOR ; STATISTICS OFF TIME OFF @@ -233,7 +233,7 @@ the <<cmd_show_sqlterminator, SHOW SQLTERMINATOR Command>>. [[interactive_display_elapsed_time]] === Display the Elapsed Time -By default, TrafCI does not display the elapsed time of an SQL statement after the statement +By default, trafci does not display the elapsed time of an SQL statement after the statement executes. To display the elapsed time after each SQL statement executes, enter the `SET TIMING ON` command: @@ -274,7 +274,7 @@ For more information, see the <<cmd_set_timing, SET TIMING Command>>. === Set and Show the Current Schema By default, the schema of the session is `USR`. The SQL statement, `SET SCHEMA`, -allows you to set the schema for the TrafCI session. +allows you to set the schema for the trafci session. *Example* @@ -352,7 +352,7 @@ For more information, see the <<cmd_set_list_count, SET LIST_COUNT Command>> and [[interactive_history]] === Display Executed Commands -To display commands that were recently executed in the TrafCI session, enter the +To display commands that were recently executed in the trafci session, enter the `HISTORY` command. The `HISTORY` command associates each command with a number that you can use to re-execute or edit the command with the `FC` command. See <<edit_reexecute_command, Edit and Reexecute a Command>>. @@ -376,7 +376,7 @@ To save the session history in a user-specified file, enter the `SAVEHIST` comma *Example* This `SAVEHIST` command saves the session history in a file named `history.txt` in the -local directory where you are running TrafCI: +local directory where you are running trafci: ``` SQL> SAVEHIST history.txt @@ -389,7 +389,7 @@ the <<cmd_savehist, SAVEHIST Command>>. [[edit_reexecute_command]] === Edit and Reexecute a Command -To edit and reexecute a command in the history buffer of an TrafCI session, enter the `FC` command. +To edit and reexecute a command in the history buffer of an trafci session, enter the `FC` command. To display the commands in the history buffer, use the `HISTORY` command. See <<interactive_history, Display Executed Commands>>. @@ -412,7 +412,7 @@ Pressing Enter executes the corrected `SELECT` statement. For more information, <<< === Clear the Interface Window -After entering commands in TrafCI, you can clear the interface window by using the `CLEAR` command. +After entering commands in trafci, you can clear the interface window by using the `CLEAR` command. *Example* @@ -427,7 +427,7 @@ For more information, see the <<cmd_clear, CLEAR Command>>. === Obtain Help -To display help text for an interface command that is supported in TrafCI, enter the `HELP` command. +To display help text for an interface command that is supported in trafci, enter the `HELP` command. *Example* @@ -442,19 +442,19 @@ For more information, see the <<cmd_help, HELP Command>>. <<< == Run SQL Statements -In TrafCI, you can run SQL statements interactively. TrafCI supports all the SQL statements, +In trafci, you can run SQL statements interactively. trafci supports all the SQL statements, SQL utilities, and other SQL-related commands that the Trafodion database engine supports. For more information about those SQL statements, see the http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. -To run SQL statements from script files in TrafCI, see <<run_scripts, Run Scripts>>. +To run SQL statements from script files in trafci, see <<run_scripts, Run Scripts>>. === Execute an SQL Statement *Example* You can query the `EMPLOYEE` table and return an employeeâs salary by executing this `SELECT` statement -in TrafCI: +in trafci: ``` SQL> SELECT salary @@ -480,9 +480,9 @@ SALARY SQL> ``` -If the SQL statement executes successfully, TrafCI returns a message indicating that the SQL +If the SQL statement executes successfully, trafci returns a message indicating that the SQL operation was successful, followed by the standard prompt. If a problem occurs during the -execution of the SQL statement, TrafCI returns an error message. +execution of the SQL statement, trafci returns an error message. <<< === Repeat an SQL Statement @@ -587,7 +587,7 @@ http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion S [[interactive_set_parameters]] ==== Setting Parameters -In an TrafCI session, you can set a parameter of an SQL statement (either prepared or not) +In an trafci session, you can set a parameter of an SQL statement (either prepared or not) by using the SET PARAM command. NOTE: The parameter name is case-sensitive. If you specify it in lowercase in the @@ -793,7 +793,7 @@ http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion S [[interactive_log_output]] == Log Output -To log an TrafCI session, use the `SPOOL` or `LOG` command. The `SPOOL` and `LOG` commands +To log an trafci session, use the `SPOOL` or `LOG` command. The `SPOOL` and `LOG` commands record into a log file the commands that you enter in the command-line interface and the output of those commands. @@ -811,7 +811,7 @@ the <<cmd_spool, SPOOL Command>>. ==== `SPOOL ON` or `LOG ON` Command The `SPOOL ON` or `LOG ON` command logs information about a session in the `sqlspool.lst` -file, which TrafCI stores in the bin directory: +file, which trafci stores in the bin directory: * On Windows: + @@ -820,7 +820,7 @@ file, which TrafCI stores in the bin directory: ``` + `_trafci-installation-directory_` is the directory where you installed the -TrafCI software files. +trafci software files. * On Linux: + @@ -829,7 +829,7 @@ TrafCI software files. ``` + `_trafci-installation-directory_` is the directory where you installed -the TrafCI software files. +the trafci software files. *Example* @@ -844,7 +844,7 @@ SQL> SPOOL ON The `SPOOL _log-file_` and `LOG _log-file_` commands record information about a session in a log file that you specify. If you specify a directory for the log file, the directory must exist as specified. Otherwise, an error occurs when you try to run the -`SPOOL` or `LOG` command. If you do not specify a directory for the log file, TrafCI uses the +`SPOOL` or `LOG` command. If you do not specify a directory for the log file, trafci uses the `bin` directory. *Example* @@ -860,7 +860,7 @@ SQL> SPOOL C:\log\persnl_updates.log ==== Using the `CLEAR` Option The CLEAR option clears the contents of an existing log file before logging new information to -the file. If you omit CLEAR, TrafCI appends new information to existing information in the log file. +the file. If you omit CLEAR, trafci appends new information to existing information in the log file. *Example* @@ -871,9 +871,9 @@ starts logging the session in the log file: SQL> SPOOL C:\log\persnl_updates.log clear ``` -==== Log Concurrent the TrafCI Sessions +==== Log Concurrent the trafci Sessions -If you plan to run two or more TrafCI sessions concurrently on the same workstation, use the +If you plan to run two or more trafci sessions concurrently on the same workstation, use the `SPOOL _log-file_` or `LOG _log-file_` command and specify a unique name for each log file. Otherwise, each session writes information to the same log file, making it difficult to determine which information belongs to each session. @@ -887,7 +887,7 @@ To stop logging, enter one of these commands: *Example* -This SPOOL OFF command stops logging in an TrafCI session: +This SPOOL OFF command stops logging in an trafci session: ``` SQL> SPOOL OFF @@ -896,7 +896,7 @@ SQL> SPOOL OFF <<< === View the Contents of a Log File -The log file is an ASCII text file that contains all the lines in TrafCI from the time you start +The log file is an ASCII text file that contains all the lines in trafci from the time you start logging to the time you stop logging. The logged lines include prompts, entered commands, output from commands, and diagnostic messages. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c86d2385/docs/command_interface/src/asciidoc/_chapters/introduction.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/introduction.adoc b/docs/command_interface/src/asciidoc/_chapters/introduction.adoc index ef489cd..a54532b 100644 --- a/docs/command_interface/src/asciidoc/_chapters/introduction.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/introduction.adoc @@ -21,14 +21,14 @@ //// = Introduction -The Trafodion Command Interface (TrafCI) is a command-line interface that you download and install on a client workstation that has the +The Trafodion Command Interface (trafci) is a command-line interface that you download and install on a client workstation that has the Trafodion JDBC Type 4 Driver installed. Operating systems that support the JDBC driver include Windows and Linux. The JDBC driver connects -TrafCI on a client workstation to a Trafodion database. +trafci on a client workstation to a Trafodion database. -image:{images}/VST101.jpg["TrafCI Connected to a Trafodion Database"] +image:{images}/VST101.jpg["trafci Connected to a Trafodion Database"] -TrafCI enables you to perform daily administrative and database management tasks by running SQL statements or other commands -interactively or from script files. You can also run TrafCI from a Perl or Python command line or from Perl or Python programs. +trafci enables you to perform daily administrative and database management tasks by running SQL statements or other commands +interactively or from script files. You can also run trafci from a Perl or Python command line or from Perl or Python programs. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/c86d2385/docs/command_interface/src/asciidoc/_chapters/launch.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/launch.adoc b/docs/command_interface/src/asciidoc/_chapters/launch.adoc index b59916c..1aa42ee 100644 --- a/docs/command_interface/src/asciidoc/_chapters/launch.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/launch.adoc @@ -23,15 +23,15 @@ */ //// -= Launch TrafCI += Launch trafci -This chapter describes how to launch TrafCI from the Window or Linux environment of a client workstation. -For information about launching TrafCI from Perl or Python, see <<perl_python, Run TrafCI from Perl or Python>>. +This chapter describes how to launch trafci from the Window or Linux environment of a client workstation. +For information about launching trafci from Perl or Python, see <<perl_python, Run trafci from Perl or Python>>. -IMPORTANT: Before launching TrafCI, make sure that you have set the Java path to the correct location. +IMPORTANT: Before launching trafci, make sure that you have set the Java path to the correct location. See <<install_verify, Verify and Set Java Path>>. -== Launch TrafCI on Windows Workstation +== Launch trafci on Windows Workstation 1. Find the Windows launch file, `trafci.cmd`, in the `bin` folder: + @@ -39,13 +39,13 @@ image:{images}/winbin.jpg[width=400,height=400,alt="Navigate to bin folder"] 2. Double-click the `trafci.cmd` file. + -TrafCI appears, prompting you to enter the host name or IP address of the database platform, your user name, and password. +trafci appears, prompting you to enter the host name or IP address of the database platform, your user name, and password. See <<trafci_login, Log In to Database Platform>>. <<< [[trafci_shortcut]] === Create `trafci.cmd` Shortcut -To enable a user to launch TrafCI from a shortcut icon on the desktop: +To enable a user to launch trafci from a shortcut icon on the desktop: 1. Right-click the desktop and select *New>Shortcut*: + @@ -57,7 +57,7 @@ image:{images}/shortct1.jpg[width=400,height=400,alt="Select trafci.cmd file"] + image:{images}/shortct2.jpg[width=400,height=400,alt="Select shortcut from menu"] + -For the locations of the installed TrafCI software files, +For the locations of the installed trafci software files, see the http://trafodion.incubator.apache.org/docs/client_install/latest/index.html[_Trafodion Client Installation Guide_]. 3. Type a name for the shortcut and click *Finish*: @@ -80,14 +80,14 @@ image:{images}/shortct5.jpg[width=400,height=400,alt="Add optional launch parame For more information, see <<trafci_optional_params, Optional Launch Parameters>>. d. Click *OK*. -5. To launch TrafCI, double-click the shortcut icon. +5. To launch trafci, double-click the shortcut icon. + -TrafCI appears. If you did not set the optional launch parameters, TrafCI prompts you to enter the +trafci appears. If you did not set the optional launch parameters, trafci prompts you to enter the host name or IP address of the database platform, your user name, and password. See <<trafci_login, Log In to Database Platform>>. <<< -== Launch TrafCI on Linux Workstation +== Launch trafci on Linux Workstation In the terminal window, enter: @@ -95,13 +95,13 @@ In the terminal window, enter: ./<trafci-installation-directory>/trafci/bin/trafci.sh ``` -_<trafci-installation-directory>_ is the directory where you installed the TrafCI software files. +_<trafci-installation-directory>_ is the directory where you installed the trafci software files. For more information, see the http://trafodion.incubator.apache.org/docs/latest/client_install/index.html[_Trafodion Client Installation Guide_]. === Set `trafci.sh` PATH -To enable a user to launch TrafCI anywhere on the client workstation: +To enable a user to launch trafci anywhere on the client workstation: 1. Open the user profile (`.profile` or `.bash_profile` for the Bash shell) in the `$HOME` directory. @@ -117,7 +117,7 @@ vi .profile export PATH=/<trafci-installation-directory>/trafci/bin/: ... ``` + -_trafci-installation-directory_ is the directory where you installed the TrafCI software files. +_trafci-installation-directory_ is the directory where you installed the trafci software files. For more information, see the http://trafodion.incubator.apache.org/docs/latest/client_install/index.html[_Trafodion Client Installation Guide_]. Check that no space is after the colon (`:`) in the path. @@ -132,16 +132,16 @@ NOTE: In the C shell, use the `setenv` command instead of `export`. + <<< -4. On the command line, execute the `trafci.sh` file to launch TrafCI: +4. On the command line, execute the `trafci.sh` file to launch trafci: + ``` trafci.sh ``` + -TrafCI appears, prompting you to enter the host name or IP address of the database platform, your user name, and password. +trafci appears, prompting you to enter the host name or IP address of the database platform, your user name, and password. See <<trafci_login, Log In to Database Platform>>. + -NOTE: To enable all users to launch TrafCI anywhere on the system, create a symbolic link to the +NOTE: To enable all users to launch trafci anywhere on the system, create a symbolic link to the `trafci.sh` file in the `/usr/bin` or `/usr/local/bin` directory: + ``` @@ -154,7 +154,7 @@ ln -s ./<trafci-installation-directory>/trafci/bin/trafci.sh /usr/bin/trafci.sh To preset the optional launch parameters for each session, use an `alias` in the shell command. ``` -alias trafci='trafci.sh -h 16.123.456.78:37800 -u user1 -p xxxxxx' +alias trafci='trafci.sh -h 16.123.456.78:23400 -u user1 -p xxxxxx' ``` You can add the alias, trafci, to the user profile, or you can enter it at a command prompt. @@ -167,9 +167,9 @@ see <<trafci_optional_params, Use Optional Launch Parameters>>. === Log In Without Login Parameters -If you launch TrafCI and do not specify login parameters on the command line, follow these steps: +If you launch trafci and do not specify login parameters on the command line, follow these steps: -1. After you launch TrafCI, TrafCI shows the welcome banner and prompts you to enter the host name +1. After you launch trafci, trafci shows the welcome banner and prompts you to enter the host name or IP address of the database platform: + ``` @@ -182,8 +182,8 @@ Enter a host name: host-name[.domain-name][:port-number] ``` + -* If you do not specify the domain name, TrafCI uses the domain of the client workstation. -* If you do not specify a port number, TrafCI uses the default port umber, which is `37800`. +* If you do not specify the domain name, trafci uses the domain of the client workstation. +* If you do not specify a port number, trafci uses the default port umber, which is `23400`. + Or enter an IP address: + @@ -202,15 +202,15 @@ SQL> ``` At the prompt, you can enter an SQL statement or an interface command. -For more information, see <<run_interactive, Run Interactive Commands in TrafCI>>. +For more information, see <<run_interactive, Run Interactive Commands in trafci>>. -NOTE: TrafCI allows you to reenter the login values, with a maximum of three retries, +NOTE: trafci allows you to reenter the login values, with a maximum of three retries, before it closes the session. For more information, see <<trafci_retry, Retry Login>>. [[trafci_login_params]] === Use Login Parameters -To avoid entering a host name, user name, or password each time you launch TrafCI, use these login parameters: +To avoid entering a host name, user name, or password each time you launch trafci, use these login parameters: * `-h` or `-host` * `-u` or `-user` @@ -221,17 +221,17 @@ To avoid entering a host name, user name, or password each time you launch TrafC ``` cd <trafci-installation-directory>\Trafodion Command Interface\bin -trafci.cmd -h 16.123.456.78:37800 -u user1 -p xxxxxx +trafci.cmd -h 16.123.456.78:23400 -u user1 -p xxxxxx ``` *Example: Linux Login* ``` cd <trafci-installation-directory>/trafci/bin -./trafci.sh -h 16.123.456.78:37800 -u user1 -p xxxxxx +./trafci.sh -h 16.123.456.78:23400 -u user1 -p xxxxxx ``` -TrafCI launches and prompts you to enter an SQL statement or an interface command: +trafci launches and prompts you to enter an SQL statement or an interface command: ``` Welcome to Trafodion Command Interface @@ -252,11 +252,11 @@ TIP: You can include these parameters in a shortcut to the `trafci.cmd` file or [[trafci_retry]] == Retry Login -TrafCI allows you to reenter the login values, with a maximum of three retries, before it closes the session. +trafci allows you to reenter the login values, with a maximum of three retries, before it closes the session. -TrafCI applies the retry logic as follows: +trafci applies the retry logic as follows: -* If you specify an invalid host name, TrafCI prompts you to reenter the host name. +* If you specify an invalid host name, trafci prompts you to reenter the host name. + *Example* + @@ -278,10 +278,10 @@ Connected to Trafodion SQL> ``` <<< -* If you specify an invalid user name or password, TrafCI prompts you to reenter the user name +* If you specify an invalid user name or password, trafci prompts you to reenter the user name and password. + -If you specify an invalid password, TrafCI prompts only for your user name and password. +If you specify an invalid password, trafci prompts only for your user name and password. After three unsuccessful retries, the session is terminated: + *Example* @@ -308,14 +308,14 @@ Press any key to close this session ``` <<< -* If all the login parameters that you specify are invalid, TrafCI prompts you to enter the host -name. When you enter a valid host name or IP address, TrafCI prompts you to enter a user name and password. +* If all the login parameters that you specify are invalid, trafci prompts you to enter the host +name. When you enter a valid host name or IP address, trafci prompts you to enter a user name and password. * The retry logic applies to the CONNECT and RECONNECT commands. For the RECONNECT command, the retry logic applies only when no prior connection has been established (`-noconnect`). + For example, if you specify the CONNECT command with a valid user name and host name, then -TrafCI prompts for the user name and password only. +trafci prompts for the user name and password only. + ``` SQL> connect user1/[email protected] @@ -329,19 +329,19 @@ Connected to Trafodion SQL> ``` -* TrafCI does not prompt you to reenter the login values in these cases: +* trafci does not prompt you to reenter the login values in these cases: * When you include the `-q` or `-version` parameter on the command line. (The `-s` parameter permits login retries.) ** For a session started using redirected or piped input. -In these cases, TrafCI returns an error message and closes the session. You must re-launch the TrafCI session +In these cases, trafci returns an error message and closes the session. You must re-launch the trafci session to connect to the Trafodion database. <<< [[trafci_option_params]] == Optional Launch Parameters -To customize how you launch and log in to TrafCI, use the optional parameters described in the table below on the command line: +To customize how you launch and log in to trafci, use the optional parameters described in the table below on the command line: ``` trafci{.sh | .cmd} [optional-parameter]... @@ -358,8 +358,8 @@ is one of the launch or login parameters. For details, see the following table. `{-h \| -host} IP-address[:port-number]` | Specifies the host name or IP address of the database platform to which you want the client to connect. The _host-name_ should include the domain name of the database platform if it is different from the domain -of the client workstation. If you do not specify a port number, TrafCI uses the default port number, which -is `37800`. + +of the client workstation. If you do not specify a port number, trafci uses the default port number, which +is `23400`. + + See <<trafici_login_parameters, Use Login Parameters>>. @@ -376,39 +376,39 @@ platform. _password_ is case-sensitive. + For an example, see <<trafici_login_parameters, Use Login Parameters>>. | `{-q \| -sql} "_command_"` | Specifies that an SQL statement or an interface command be run when -launching TrafCI. You cannot specify this parameter at the same time as +launching trafci. You cannot specify this parameter at the same time as the -s or -script parameter. + + -For more information, see <<trafci_run_command, Run Command When Launching TrafCI>>. +For more information, see <<trafci_run_command, Run Command When Launching trafci>>. -| `{-s \| -script} _script-file-name_` | Specifies that a script file be run when launching TrafCI in interactive +| `{-s \| -script} _script-file-name_` | Specifies that a script file be run when launching trafci in interactive mode. You cannot specify this parameter at the same time as the -q or -sql parameter. + + -For more information, see <<trafci_run_script, Run Script When Launching TrafCI>>. +For more information, see <<trafci_run_script, Run Script When Launching trafci>>. -| `-noconnect` | Launches an TrafCI session without connecting to the database. + +| `-noconnect` | Launches an trafci session without connecting to the database. + + -For more information, see <<trafci_noconnect, Launch TrafCI Without Connecting to the Database>>. +For more information, see <<trafci_noconnect, Launch trafci Without Connecting to the Database>>. -| `-version` | Displays the build version of TrafCI and the Trafodion JDBC Type 4 +| `-version` | Displays the build version of trafci and the Trafodion JDBC Type 4 Driver. Upon completion of the display, the client exits. + + If any other parameters are included with the `-version` parameter, they are ignored. + + -For more information, see <<trafci_with_version, Run TrafCI With `-version`>>. +For more information, see <<trafci_with_version, Run trafci With `-version`>>. | `-help` | Displays a list of accepted arguments with descriptions and then exits. + + -For more information, see <<trafci_with_version, Run TrafCI With `-version`>>. +For more information, see <<trafci_with_version, Run trafci With `-version`>>. |=== <<< [[trafci_run_command]] -== Run Command When Launching TrafCI +== Run Command When Launching trafci -To execute an SQL statement or an interface command when launching TrafCI, use the `-q` or `-sql` +To execute an SQL statement or an interface command when launching trafci, use the `-q` or `-sql` command-line parameter. This parameter enables you to run a single command on the command line -without having to enter commands in TrafCI. +without having to enter commands in trafci. NOTE: You cannot specify this parameter at the same time as the `-s` or `-script` parameter. @@ -420,7 +420,7 @@ Although you can run any of the interface commands with `-q` or `-sql`, the *Example* -Use `-q` or `-sql` with the `CREATE SCHEMA` statement to create a schema when launching TrafCI: +Use `-q` or `-sql` with the `CREATE SCHEMA` statement to create a schema when launching trafci: * On Windows, in the *Command Prompt* window, enter: + @@ -436,12 +436,12 @@ cd _trafci-installation-directory_/trafci/bin ./trafci.sh -q "create schema persnl" ``` -After you enter the SQL statement, TrafCI launches and prompts you to log in by default +After you enter the SQL statement, trafci launches and prompts you to log in by default (if you did not specify `-h`, `-u`, and `-p` on the command line), runs the SQL statement, and then returns to the command prompt: ``` -Host Name/IP Address: 16.123.456.78:37800 User Name: user1 +Host Name/IP Address: 16.123.456.78:23400 User Name: user1 Password: @@ -469,28 +469,28 @@ cd <trafci-installation-directory>/trafci/bin ./trafci.sh -q "prun" ``` -After you enter the interface command, TrafCI launches and prompts you to log in by default (if you did not specify +After you enter the interface command, trafci launches and prompts you to log in by default (if you did not specify `-h`, `-u`, and `-p` on the command line), and runs the command.\ The parallel run (`PRUN`) operation prompts you to -enter settings and then executes the script files. At the end of the `PRUN` operation, TrafCI returns to the command prompt. +enter settings and then executes the script files. At the end of the `PRUN` operation, trafci returns to the command prompt. For more information about the `PRUN` operation, see <<trafci_prun, `PRUN` Command>>. <<< [[trafci_run_script]] -== Run Script When Launching TrafCI +== Run Script When Launching trafci -To run a script file when launching TrafCI, use the `-s` or `-script` command-line parameter. +To run a script file when launching trafci, use the `-s` or `-script` command-line parameter. NOTE: You cannot specify this parameter at the same time as the `-q` or `-sql` parameter. -After you launch TrafCI with `-s` or `-script`, TrafCI executes the script file in interactive mode. -TrafCI remains open until you enter the `EXIT`, `QUIT`, or `DISCONNECT` command. To quit the interface +After you launch trafci with `-s` or `-script`, trafci executes the script file in interactive mode. +trafci remains open until you enter the `EXIT`, `QUIT`, or `DISCONNECT` command. To quit the interface immediately after executing a script file, include the `EXIT`, `QUIT`, or `DISCONNECT` command at the end of the script file. *Example* -You can create a script file that contains `SET` commands that customize a session when you launch TrafCI: +You can create a script file that contains `SET` commands that customize a session when you launch trafci: image:{images}/launchs1.jpg[image] @@ -517,14 +517,14 @@ cd <trafci-installation-directory>/trafci/bin + Specify the full path of the script file if it is outside the directory of `trafci.sh`. <<< -TrafCI launches and prompts you to log in by default (if you did not specify `-h`, `-u`, and `-p` +trafci launches and prompts you to log in by default (if you did not specify `-h`, `-u`, and `-p` on the command line), and runs the commands in the script file: ``` Welcome to Trafodion Command Interface Copyright(C) 2013â2105 Apache Software Foundation -Host Name/IP Address: 16.123.456.78:37800 User Name: user1 +Host Name/IP Address: 16.123.456.78:23400 User Name: user1 Password: Connected to Trafodion @@ -541,9 +541,9 @@ SQL>SET SQLPROMPT * <<< [[trafci_noconnect]] -== Launch TrafCI Without Connecting to the Database +== Launch trafci Without Connecting to the Database -To start TrafCI without connecting to a Trafodion database, use the `-noconnect option`. +To start trafci without connecting to a Trafodion database, use the `-noconnect option`. See <<cmd_disconnect, `DISCONNECT` command>> for a list of interface commands that can be run without a connection. @@ -565,8 +565,8 @@ cd <trafci-installation-directory>/trafci/bin <<< [[trafci_with_version]] -== Run TrafCI With `-version` -To display the build version of TrafCI and the Trafodion JDBC Type 4 Driver, use the `-version` +== Run trafci With `-version` +To display the build version of trafci and the Trafodion JDBC Type 4 Driver, use the `-version` option. If other parameters are included with the `-version` parameter, they are ignored. *Example* @@ -590,12 +590,12 @@ Welcome to Trafodion Command Interface Copyright(C) 2013â2105 Apache Software Foundation Trafodion JDBC Type 4 Driver : Traf_JDBC_Type4_Build_40646 Trafodion -Command Interface : TrafCI_Build_40646 +Command Interface : trafci_Build_40646 ``` <<< [[trafci_help]] -== Run TrafCI With -help +== Run trafci With -help To display a list of acceptable list of parameters, including proper usage information, use the `-help` option. After displaying this information the application exits. @@ -617,9 +617,9 @@ cd <trafci-installation-directory>/trafci/bin ``` [[trafci_quit]] -== Exit TrafCI +== Exit trafci -To exit TrafCI, enter one of these commands at a prompt: +To exit trafci, enter one of these commands at a prompt: * `EXIT` * `QUIT` @@ -631,7 +631,7 @@ SQL> QUIT ``` These commands are not case-sensitive and do not require a terminator before you press *Enter*. -After you enter one of these commands, TrafCI immediately quits running and disappears from the screen. +After you enter one of these commands, trafci immediately quits running and disappears from the screen.
