You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafodion.apache.org by sv...@apache.org on 2016/01/14 19:18:37 UTC
[33/42] incubator-trafodion git commit: Updated to use standard theme.
Updated to use standard theme.
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/8681b498
Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/8681b498
Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/8681b498
Branch: refs/heads/master
Commit: 8681b49819031d3c1f4da6cf9b93de88de5fa1ff
Parents: d16c4a1
Author: Gunnar Tapper <gt...@esgyn.local>
Authored: Sun Jan 10 21:50:09 2016 -0700
Committer: Gunnar Tapper <gt...@esgyn.local>
Committed: Sun Jan 10 21:50:09 2016 -0700
----------------------------------------------------------------------
docs/client_install/pom.xml | 45 +++++
.../src/asciidoc/_chapters/SQuirrel.adoc | 14 +-
.../src/asciidoc/_chapters/about.adoc | 169 +++++++++++-----
.../src/asciidoc/_chapters/dbviz.adoc | 14 +-
.../src/asciidoc/_chapters/introduction.adoc | 6 +-
.../src/asciidoc/_chapters/jdbct4.adoc | 185 ++++++++----------
.../src/asciidoc/_chapters/odb.adoc | 25 +--
.../src/asciidoc/_chapters/odbc_linux.adoc | 164 ++++++++--------
.../src/asciidoc/_chapters/odbc_windows.adoc | 33 ++--
.../src/asciidoc/_chapters/trafci.adoc | 191 +++++++++----------
10 files changed, 459 insertions(+), 387 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/8681b498/docs/client_install/pom.xml
----------------------------------------------------------------------
diff --git a/docs/client_install/pom.xml b/docs/client_install/pom.xml
index 8d21424..b59f86d 100644
--- a/docs/client_install/pom.xml
+++ b/docs/client_install/pom.xml
@@ -69,11 +69,54 @@
<asciidoctor.maven.plugin.version>1.5.2.1</asciidoctor.maven.plugin.version>
<asciidoctorj.pdf.version>1.5.0-alpha.10.1</asciidoctorj.pdf.version>
<asciidoctorj.version>1.5.3.2</asciidoctorj.version>
+ <rubygems.prawn.version>2.0.2</rubygems.prawn.version>
</properties>
+ <repositories>
+ <repository>
+ <id>rubygems-proxy-releases</id>
+ <name>RubyGems.org Proxy (Releases)</name>
+ <url>http://rubygems-proxy.torquebox.org/releases</url>
+ <releases>
+ <enabled>true</enabled>
+ </releases>
+ <snapshots>
+ <enabled>false</enabled>
+ </snapshots>
+ </repository>
+ </repositories>
+
+ <dependencies>
+ <dependency>
+ <groupId>rubygems</groupId>
+ <artifactId>prawn</artifactId>
+ <version>${rubygems.prawn.version}</version>
+ <type>gem</type>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+
<build>
<plugins>
<plugin>
+ <groupId>de.saumya.mojo</groupId>
+ <artifactId>gem-maven-plugin</artifactId>
+ <version>1.0.10</version>
+ <configuration>
+ <!-- align JRuby version with AsciidoctorJ to avoid redundant downloading -->
+ <jrubyVersion>${jruby.version}</jrubyVersion>
+ <gemHome>${project.build.directory}/gems</gemHome>
+ <gemPath>${project.build.directory}/gems</gemPath>
+ </configuration>
+ <executions>
+ <execution>
+ <goals>
+ <goal>initialize</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ <plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-resources-plugin</artifactId>
<version>2.7</version>
@@ -135,6 +178,8 @@
<sourceHighlighter>coderay</sourceHighlighter>
<outputDirectory>${basedir}/target</outputDirectory>
<attributes>
+ <pdf-stylesdir>${basedir}/../css</pdf-stylesdir>
+ <pdf-style>trafodion</pdf-style>
<icons>font</icons>
<pagenums/>
<toc/>
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/8681b498/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc b/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc
index 1f88b98..0d11df5 100644
--- a/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc
@@ -41,7 +41,7 @@ Use the *Add Driver* function and register the Trafodion JDBC Type-4 Driver:
2. Click on the *List Drivers* button to find the JDBC Driver Class Name.
3. Set the properties as shown below:
+
-image:{images}/Add_Driver_SQuirreL.jpg[image]
+image:{images}/Add_Driver_SQuirreL.jpg[alt="SQuirreL Add Driver Dialog Box"]
+
* Name: `Trafodion`
* Example URL: `jdbc:t4jdbc://_host-name or ip-address_:37800/:`
@@ -51,18 +51,20 @@ image:{images}/Add_Driver_SQuirreL.jpg[image]
Use the Add Alias dialog box and create an alias for your Trafodion System:
-image:{images}/Add_Alias_SQuirreL.jpg[image]
+image:{images}/Add_Alias_SQuirreL.jpg[alt="SQuirreL Add Alias Dialog Box"]
1. Edit the connection *URL* to match your Trafodion system's host name and port number:
+
-====
-*jdbc:t4jdbc://_host-name or ip-address_:37800/:*
-====
+```
+jdbc:t4jdbc://<host-name or ip-address>:37800/:
+```
2. Click on the *Properties* button for the alias.
++
+<<<
3. In the *Schemas* tab, select the option *Load all and cache all Schemas*.
+
-image:{images}/Properties_for_Alias_SQuirreL.jpg[image]
+image:{images}/Properties_for_Alias_SQuirreL.jpg[width=400,height=400,alt="SQuirreL Properties Dialog Box"]
Once you have a successful connection, use the SQL tab and run a query to confirm the connection.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/8681b498/docs/client_install/src/asciidoc/_chapters/about.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/about.adoc b/docs/client_install/src/asciidoc/_chapters/about.adoc
index 6c38694..3b14fd7 100644
--- a/docs/client_install/src/asciidoc/_chapters/about.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/about.adoc
@@ -36,64 +36,127 @@ new multi-threaded, ODBC-based command-line tool for parallel data loading and e
== Notation Conventions
This list summarizes the notation conventions for syntax presentation in this manual.
-[cols="15%,30%,25%,30%",options="header"]
-|===
-| Notation | Usage | Example | Notes
-| UPPERCASE LETTERS | Uppercase letters indicate keywords and reserved words. Type these items exactly as shown. Items not enclosed in brackets are required. | SELECT |
-| _Italic Letters_ | Italic letters, regardless of font, indicate variable items that you supply. Items not enclosed in brackets are required. | _file-name_ |
-| `Computer Type` | Computer type letters within text indicate case-sensitive keywords and reserved words. Type these items exactly as shown. Items not enclosed in
-brackets are required. | `myfile.sh` |
-| *Bold Text* | Bold text in an example indicates user input typed at the terminal. | `ENTER RUN CODE:` +
- ?**123** +
- `CODE RECEIVED: 123.00` | The user must press the Return key after typing the input.
-| [ ] Brackets | Brackets enclose optional syntax items. |
-DATETIME [__start-field__ TO] +
-_end-field_
-| A group of items enclosed in brackets is a list from which you can choose one item or none.
-
+* UPPERCASE LETTERS
++
+Uppercase letters indicate keywords and reserved words. Type these items exactly as shown. Items not enclosed in brackets are required.
++
+```
+SELECT
+```
+
+* lowercase letters
++
+Lowercase letters, regardless of font, indicate variable items that you supply. Items not enclosed in brackets are required.
++
+```
+file-name
+```
+
+<<<
+* [ ] Brackets
++
+Brackets enclose optional syntax items.
++
+```
+DATETIME [start-field TO] end-field
+```
++
+A group of items enclosed in brackets is a list from which you can choose one item or none.
++
The items in the list can be arranged either vertically, with aligned brackets on each side of the list, or horizontally, enclosed in a pair of brackets and separated by vertical lines.
-
-For example:
-
-`DROP SCHEMA _schema_ [CASCADE]` +
-`DROP SCHEMA _schema_ [ CASCADE \| RESTRICT ]`
-| { } Braces | Braces enclose required syntax items. | `FROM { __grantee__[, __grantee__]...}` | A group of items enclosed in braces is a list from which you are required to choose one item.
-
++
+For example:
++
+```
+DROP SCHEMA schema [CASCADE]
+DROP SCHEMA schema [ CASCADE | RESTRICT ]
+```
+
+* { } Braces
++
+Braces enclose required syntax items.
++
+```
+FROM { grantee [, grantee ] ... }
+```
++
+A group of items enclosed in braces is a list from which you are required to choose one item.
++
The items in the list can be arranged either vertically, with aligned braces on each side of the list, or horizontally, enclosed in a pair of braces and separated by vertical lines.
-
++
For example:
-
-`INTERVAL { _start-field_ TO _end-field_ }` +
-`{ _single-field_ }` +
-`INTERVAL { _start-field_ TO _end-field_ \| _single-field_ }`
---
-| \| Vertical Line | A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces. | `{__expression__ \| NULL}` |
-| … Ellipsis | An ellipsis immediately following a pair of brackets or braces indicates that you can repeat the enclosed sequence of syntax items any number of times. |
-`ATTRIBUTE[S] _attribute_ [, __attribute__]...` +
-`{, __sql-expression__}...`
-| An ellipsis immediately following a single syntax item indicates that you can repeat that syntax item any number of times.
-
++
+```
+INTERVAL { start-field TO end-field }
+{ single-field }
+INTERVAL { start-field TO end-field | single-field }
+```
+* | Vertical Line
++
+A vertical line separates alternatives in a horizontal list that is enclosed in brackets or braces.
+```
+{expression | NULL}
+```
+
+<<<
+* … Ellipsis
++
+An ellipsis immediately following a pair of brackets or braces indicates that you can repeat the enclosed sequence of syntax items any number of times.
++
+```
+ATTRIBUTE[S] attribute [, attribute] ...
+{, sql-expression } ...
+```
++
+An ellipsis immediately following a single syntax item indicates that you can repeat that syntax item any number of times.
++
For example:
-
-`__expression-n__…`
-| Punctuation | Parentheses, commas, semicolons, and other symbols not previously described must be typed as shown. |
-DAY (__datetime-expression__)` +
-`@__script-file__` | Quotation marks around a symbol such as a bracket or brace indicate the symbol is a required character that you must type as shown.
-
+```
+expression-n ...
+```
+
+* Punctuation
++
+Parentheses, commas, semicolons, and other symbols not previously described must be typed as shown.
++
+```
+DAY (datetime-expression)
+@script-file
+```
++
+Quotation marks around a symbol such as a bracket or brace indicate the symbol is a required character that you must type as shown.
++
For example:
-
-`"{" _module-name_ [, __module-name__]... "}"`
-| Item Spacing | Spaces shown between items are required unless one of the items is a punctuation symbol such as a parenthesis or a comma. |
-`DAY (__datetime-expression__) DAY(__datetime-expression__)` | If there is no space between two items, spaces are not permitted. In this example, no spaces are permitted between the period and any other items:
-
-`__myfile__.sh`
-
-| Line Spacing | If the syntax of a command is too long to fit on a single line, each continuation line is indented three spaces and is separated from the preceding line by a blank line.
-
-This spacing distinguishes items in a continuation line from items in a vertical list of selections. |
-`_match-value_ [NOT] LIKE _pattern_`
- [ESCAPE __esc-char-expression__] |
-|===
++
+```
+"{" module-name [, module-name] ... "}"
+```
+
+* Item Spacing
++
+Spaces shown between items are required unless one of the items is a punctuation symbol such as a parenthesis or a comma.
++
+```
+DAY (datetime-expression) DAY(datetime-expression)
+```
++
+If there is no space between two items, spaces are not permitted. In this example, no spaces are permitted between the period and any other items:
++
+```
+myfile.sh
+```
+
+<<<
+* Line Spacing
++
+If the syntax of a command is too long to fit on a single line, each continuation line is indented three spaces and is separated from the preceding line by a blank line.
++
+This spacing distinguishes items in a continuation line from items in a vertical list of selections.
++
+```
+match-value [NOT] LIKE _pattern
+ [ESCAPE esc-char-expression]
+```
== Publishing History
[cols="2*",options="header"]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/8681b498/docs/client_install/src/asciidoc/_chapters/dbviz.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/dbviz.adoc b/docs/client_install/src/asciidoc/_chapters/dbviz.adoc
index ee82f0b..127af27 100644
--- a/docs/client_install/src/asciidoc/_chapters/dbviz.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/dbviz.adoc
@@ -44,9 +44,9 @@ http://confluence.dbvis.com/pages/viewpage.action?pageId=3146120[_How do I chang
Edit the `_DbVisualizer-Install-Dir_\resources\dbvis-custom.prefs` file and
disable the `ConnectionValidationSelect` option as shown below:
-====
-*dbvis.generic.-ConnectionValidationSelect=disabled*
-====
+```
+dbvis.generic.-ConnectionValidationSelect=disabled
+```
==== DbVisualizer 9.2 (or a later version)
Set the *Physical Connection* property to keep your connections alive. Follow these steps:
@@ -68,15 +68,15 @@ image:{images}/DbVisualizer_Driver_Manager.jpg[image]
* Use the Open File icon and locate the Trafodion JDBC Type-4 Driver.
* Use the JDBC URL format:
+
-====
-*jdbc:t4jdbc://_host-name or ip-address_:37800/:*
-====
+```
+jdbc:t4jdbc://<host-name or ip-address>:37800/:
+```
<<<
=== Connect to Trafodion
Create a new connection by selecting the Trafodion JDBC Type-4 Driver and filling in the connection parameters. Edit the database URL to match
-your Trafodion system’s host name and port number: `jdbc:t4jdbc://_host-name or ip-address_:37800/:`
+your Trafodion system’s host name and port number: `jdbc:t4jdbc://<host-name or ip-address>:37800/:`
image:{images}/Database_Connection_in_DbVisualizer.jpg[image]
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/8681b498/docs/client_install/src/asciidoc/_chapters/introduction.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/introduction.adoc b/docs/client_install/src/asciidoc/_chapters/introduction.adoc
index f9d6ed1..cd577ab 100644
--- a/docs/client_install/src/asciidoc/_chapters/introduction.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/introduction.adoc
@@ -38,9 +38,9 @@ Trafodion database.
NOTE: The Trafodion Command Interface (TrafCI), DbVisualizer, and SQuirreL SQL Client require this driver to be installed on the client
workstation.
| Trafodion Command Interface (TrafCI) | A command-line interface that allows you to connect to a Trafodion database and run SQL statements and other commands interactively or from
-script files. For more information, see the __Trafodion Command Interface Guide__.
-| Trafodion odb tool | A multi-threaded, ODBC-based command-line tool for parallel data loading and extracting. For more information, see the __Trafodion odb User
-Guide__.
+script files. For more information, see the http://trafodion.incubator.apache.org/command_interface/index.html[_Trafodion Command Interface Guide_].
+| Trafodion odb tool | A multi-threaded, ODBC-based command-line tool for parallel data loading and extracting. For more information, see the
+http://trafodion.incubator.apache.org/odb_user/index.html[_Trafodion odb User Guide_].
| DbVisualizer | A third-party database tool that allows you to connect to a Trafodion database. For more information, see the http://www.dbvis.com/[_DbVisualizer website_].
| SQuirreL SQL Client | A third-party database tool that allows you to connect to a Trafodion database. For more information, see the
http://squirrel-sql.sourceforge.net/[_SQuirreL SQL Client website_].
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/8681b498/docs/client_install/src/asciidoc/_chapters/jdbct4.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/jdbct4.adoc b/docs/client_install/src/asciidoc/_chapters/jdbct4.adoc
index d213856..a2c2e34 100644
--- a/docs/client_install/src/asciidoc/_chapters/jdbct4.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/jdbct4.adoc
@@ -30,10 +30,10 @@ on the Trafodion downloads site http://trafodion.incubator.apache.org/download.h
Use this distribution file to install the Trafodion JDBC Type 4 Driver:
-[cols="35%,35%,30%",options="header"]
+[cols="35%l,35%,30%",options="header"]
|===
| Distribution File | Description | Client Operating System
-| `JDBCT4.zip` | Zip file | Windows or Linux
+| JDBCT4.zip | Zip file | Windows or Linux
|===
By default, a new version of the JDBC Type 4 driver will be installed in this directory and its folders unless you specify a
@@ -42,24 +42,24 @@ different directory during installation:
[cols="65%,35%",options="header"]
|===
| Default Installation Directory | Client Operating System
-| `_<user-specified directory>_` (For example: `/usr/local/jdbc)` | Windows or Linux
+| _<user-specified directory>_ (For example: /usr/local/jdbc) | Windows or Linux
|===
-[cols="30%,25%,45%",options="header"]
+[cols="30%l,25%l,45%",options="header"]
|===
| Installation Folder | Files | Description
-| `/lib` | `jdbcT4.jar` | Product JAR file.
-| `/samples` | `t4jdbc.properties` | Properties file that you can configure for your application environment.
-| | `README` | Readme file that explains how to use the common sample set.
-| `/samples/common` | `sampleUtils.java` | Sample source code for creating, populating, and dropping sample tables.
-| `/samples/DBMetaSample` | `DBMetaSample.java` | Sample source code for getting metadata about the sample tables.
-| | `README` | Readme file that explains how to use this sample set.
-| `/samples/PreparedStatementSample` | `PreparedStatementSample.java` | Sample code for simple or parameterized SELECT statements that are prepared.
-| | `README` | Readme file that explains how to use this sample set.
-| `/samples/ResultSetSample` | `README` | Readme file that explains how to use this sample set.
-| | `ResultSetSample.java` | Sample source code for fetching rows from a result set.
-| `/samples/StatementSample` | `README` | Readme file that explains how to use this sample set.
-| | `StatementSample.java` | Sample source code for fetching rows from a simple SELECT statement.
+| /lib | jdbcT4.jar | Product JAR file.
+| /samples | t4jdbc.properties | Properties file that you can configure for your application environment.
+| | README | Readme file that explains how to use the common sample set.
+| /samples/common | sampleUtils.java | Sample source code for creating, populating, and dropping sample tables.
+| /samples/DBMetaSample | DBMetaSample.java | Sample source code for getting metadata about the sample tables.
+| | README | Readme file that explains how to use this sample set.
+| /samples/PreparedStatementSample | PreparedStatementSample.java | Sample code for simple or parameterized SELECT statements that are prepared.
+| | README | Readme file that explains how to use this sample set.
+| /samples/ResultSetSample | README | Readme file that explains how to use this sample set.
+| | ResultSetSample.java | Sample source code for fetching rows from a result set.
+| /samples/StatementSample | README | Readme file that explains how to use this sample set.
+| | StatementSample.java | Sample source code for fetching rows from a simple SELECT statement.
|===
== Installation Requirements
@@ -79,18 +79,18 @@ the correct location. The supported Java version is 1.7 or higher.
To display the Java version of the client workstation on the screen, enter:
-====
-*java -version*
-====
+```
+java -version
+```
-====
-`C:\>` *java -version*
```
-java version "1.7.0_45" #_This is the version you need to check_
+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:\>`
-====
+C:\>
+```
The Java version should be *1.7* or higher. If the returned version is not supported, please refer to
<<jdbct4_install_java, Installing a Supported Java Version>> below.
@@ -98,11 +98,9 @@ The Java version should be *1.7* or higher. If the returned version is not suppo
<<<
If you see this message:
-====
```
'java' is not recognized as an internal or external command, operable program or batch file.`
```
-====
It indicates that the Java PATH is not set. Follow one of these sets of instructions, depending on the operating system of your client
workstation:
@@ -139,9 +137,9 @@ image:{images}/varval2.jpg[image]
+
*Example*
+
-====
-*"C:\Program Files (x86)\Java\jre7\bin";*
-====
+```
+"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.
@@ -155,26 +153,26 @@ path in double quotes (") before the semicolon.
1. Open the user profile (`.profile` or `.bash_profile` for the Bash shell) in the `$HOME` directory.
+
-====
-*cd $HOME* +
-*vi .profile*
-====
+```
+cd $HOME
+vi .profile
+```
2. In the user profile, set the `PATH` environment variable to include the path of the Java bin
directory.
+
-====
-*export PATH=/opt/java1.7/jre/bin:$PATH*
-====
+```
+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*
-====
+```
+. .profile
+```
<<<
[[jdbct4_install]]
@@ -189,9 +187,9 @@ use the setenv command instead of export.
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*
-====
+```
+tar -xzf clients-1.3.0.tar.gz
+```
+
The package file contains the `JDBCT4.zip` distribution file, which is extracted to the clients subdirectory.
@@ -203,9 +201,9 @@ The package file contains the `JDBCT4.zip` distribution file, which is extracted
1. Change the directory to the clients subdirectory.
2. Extract the contents of the `JDBCT4.zip` file by using the unzip command (or the WinZip extract tool):
+
-====
-*unzip JDBCT4.zip*
-====
+```
+unzip JDBCT4.zip
+```
+
The command creates these subdirectories:
+
@@ -220,75 +218,60 @@ Run one of these sets of commands to remove the Trafodion JDBC Type 4 Driver:
* On Linux:
+
-====
-*rm -rf _jdbc-installation-directory_*
-====
+```
+rm -rf <jdbc-installation-directory>
+```
+
*Example*
+
-====
-*rm -rf /usr/local/jdbc*
-====
+```
+rm -rf /usr/local/jdbc
+```
<<<
* On Windows:
+
-====
-*del _jdbc-installation-directory_* +
-*rmdir _jdbc-installation-directory_*
-====
+```
+del <jdbc-installation-directory>
+rmdir <jdbc-installation-directory>
+```
+
*Example*
+
Windows uninstall
+
-====
-`C:\>`*del /s JDBC +
-`C:\JDBC\*, Are you sure (Y/N)?` *Y* +
-`C:\JDBC\install\*, Are you sure (Y/N)?` *Y*
```
+C:\>del /s JDBC
+C:\JDBC\, Are you sure (Y/N)? Y
+C:\JDBC\install\*, Are you sure (Y/N)? Y
Deleted file - C:\JDBC\install\t4jdbcSanityCheck.class
Deleted file - C:\JDBC\install\t4jdbcUninstall.class
Deleted file - C:\JDBC\install\product.contents
-```
-`C:\JDBC\lib\*, Are you sure (Y/N)?` *Y*
-```
+C:\JDBC\lib\*, Are you sure (Y/N)? Y
Deleted file - C:\JDBC\lib\jdbcT4.jar
-```
-`C:\JDBC\samples\*, Are you sure (Y/N)?` *Y*
-```
+C:\JDBC\samples\*, Are you sure (Y/N)? Y
Deleted file - C:\JDBC\samples\t4jdbc.properties
Deleted file - C:\JDBC\samples\README
-```
-`C:\JDBC\samples\common\*, Are you sure (Y/N)?` *Y*
-```
+C:\JDBC\samples\common\*, Are you sure (Y/N)? Y
Deleted file - C:\JDBC\samples\common\sampleUtils.java
-```
-`C:\JDBC\samples\DBMetaSample\*, Are you sure (Y/N)?` *Y*
-```
+C:\JDBC\samples\DBMetaSample\*, Are you sure (Y/N)? Y
Deleted file - C:\JDBC\samples\DBMetaSample\DBMetaSample.java
Deleted file - C:\JDBC\samples\DBMetaSample\README
-```
-`C:\JDBC\samples\PreparedStatementSample\*, Are you sure (Y/N)?` *Y*
-```
+C:\JDBC\samples\PreparedStatementSample\*, Are you sure (Y/N)? Y
Deleted file - C:\JDBC\samples\PreparedStatementSample\PreparedStatementSample.java
Deleted file - C:\JDBC\samples\PreparedStatementSample\README
-```
-`C:\JDBC\samples\ResultSetSample\*, Are you sure (Y/N)?` *Y*
-```
+C:\JDBC\samples\ResultSetSample\*, Are you sure (Y/N)? Y
Deleted file - C:\JDBC\samples\ResultSetSample\README
Deleted file - C:\JDBC\samples\ResultSetSample\ResultSetSample.java
-```
-`C:\JDBC\samples\StatementSample\*, Are you sure (Y/N)?` *Y*
-```
+C:\JDBC\samples\StatementSample\*, Are you sure (Y/N)? Y
Deleted file - C:\JDBC\samples\StatementSample\README
Deleted file - C:\JDBC\samples\StatementSample\StatementSample.java
+C:\>rmdir /s JDBC
+JDBC, Are you sure (Y/N)? Y
+C:\>
```
-`C:\>`*rmdir /s JDBC* +
-`JDBC, Are you sure (Y/N)?` *Y* +
-`C:\>`
-====
+<<<
=== Reinstall JDBC Type-4 Driver
1. Close all applications running on the workstation, except the Web browser.
@@ -297,7 +280,6 @@ Deleted file - C:\JDBC\samples\StatementSample\StatementSample.java
3. Extract the contents of the zip file by following these instructions: <<jdbct4_install_zip, Installing the Trafodion JDBC Type 4 Driver From the Zip File>>.
4. Set up the client environment. Please refer to: <<jdbct4_setup_env, Setting Up the Client Environment>>.
-<<<
[[jdbct4_setup_env]]
== Set Up Client Environment
@@ -308,37 +290,36 @@ If you plan to write and run Java applications that use the Trafodion JDBC Type
environment variables on the client workstation, replacing `_jdk-directory_` with the location of your Java Development Kit and
replacing `_jdbc-installation-directory_` with the name of the directory where you downloaded the JDBC Type 4 driver:
-[cols="20%,40%,40%",options="header"]
+[cols="20%l,40%l,40%l",options="header"]
|===
-| Environment Variable | On Windows | On Linux
-| `JAVA_HOME` | `set JAVA_HOME=_jdk-directory_` | `export JAVA_HOME=_jdk-directory_`
-| `PATH` | `set PATH=%PATH%;%JAVA_HOME%\bin` | `export PATH=$PATH:$JAVA_HOME/bin`
-| `CLASSPATH` | `set CLASSPATH=%CLASSPATH%;_jdbc-installation-directory_\lib\jdbcT4.jar;` | `export CLASSPATH=$CLASSPATH:_jdbc-installation-directory_/lib/jdbcT4.jar:`
+| Environment Variable | On Windows | On Linux
+| JAVA_HOME | set JAVA_HOME=_jdk-directory_ | export JAVA_HOME=_jdk-directory_
+| PATH | set PATH=%PATH%;%JAVA_HOME%\bin | export PATH=$PATH:$JAVA_HOME/bin
+| CLASSPATH | set CLASSPATH=%CLASSPATH%;_jdbc-installation-directory_\lib\jdbcT4.jar; | export CLASSPATH=$CLASSPATH:_jdbc-installation-directory_/lib/jdbcT4.jar:
|===
+<<<
=== Configure Applications
Edit the `t4jdbc.properties` file. Set these values for your environment:
-* `catalog`: Specify a catalog that exists in the database.
-* `schema`: Specify a schema that exists in the database.
-* `user`: Specify the name of a user who will be accessing the database.
-* `password`: Specify the password of a user who will be accessing the database.
-* `url`: Specify this string: `jdbc:t4jdbc://_host-name_:_port-number_/:`
+* _catalog_: Specify a catalog that exists in the database.
+* _schema_: Specify a schema that exists in the database.
+* _user_: Specify the name of a user who will be accessing the database.
+* _password_: Specify the password of a user who will be accessing the database.
+* _url_: Specify this string: _jdbc:t4jdbc://_host-name_:_port-number_/:_
-`_host-name_` is the IP address or host name of the database platform, and `_port-number_` is the location where the
-Trafodion Database Connectivity Service (DCS) is running, which is `37800` by default.
+_host-name_ is the IP address or host name of the database platform, and _port-number_ is the location where the
+Trafodion Database Connectivity Service (DCS) is running, which is 37800 by default.
*Example*
-====
```
-catalog = _your-catalog_ schema = _your-schema_ user = _user-name_
-password = _password_
+catalog = <your-catalog> schema = <your-schema> user = <user-name>
+password = <password>
-url = jdbc:t4jdbc://_host-name_:_port-number_/:
+url = jdbc:t4jdbc://<host-name>:<port-number>/:
```
-====
NOTE: The driver’s class name is `org.trafodion.jdbc.t4.T4Driver`.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/8681b498/docs/client_install/src/asciidoc/_chapters/odb.adoc
----------------------------------------------------------------------
diff --git a/docs/client_install/src/asciidoc/_chapters/odb.adoc b/docs/client_install/src/asciidoc/_chapters/odb.adoc
index a9e1e98..4d84388 100644
--- a/docs/client_install/src/asciidoc/_chapters/odb.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/odb.adoc
@@ -29,11 +29,11 @@ The distribution file for odb is packaged within the Trafodion clients tar file,
on the Trafodion downloads site http://trafodion.incubator.apache.org/download.html.
Use this distribution file to install odb:
-[cols="35%,35%,30%",options="header"]
+[cols="35%l,35%l,30%",options="header"]
|===
| Distribution File | File Contents | Client Operating System
-| `odb64_linux.tar.gz` | `README` +
-`/bin/odb64luo` | 64-bit Linux
+| odb64_linux.tar.gz | README +
+/bin/odb64luo | 64-bit Linux
|===
== Installation Requirements
@@ -54,6 +54,7 @@ Follow these instructions to download and install odb on the client workstation.
To uninstall odb, please refer to <<odb_uninstall, Uninstalling odb>>.
+<<<
[[odb_download]]
=== Download odb
@@ -63,9 +64,9 @@ To uninstall odb, please refer to <<odb_uninstall, Uninstalling odb>>.
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*
-====
+```
+tar -xzf clients-1.3.0.tar.gz
+```
+
The package file contains the `odb64_linux.tar.gz` distribution file, which is extracted to the clients subdirectory.
@@ -77,9 +78,9 @@ The package file contains the `odb64_linux.tar.gz` distribution file, which is e
1. Change the directory to the clients subdirectory.
2. Unpack the contents of the `odb64_linux.tar.gz` file to a location on your client workstation:
+
-====
-*tar -xzf odb64_linux.tar.gz*
-====
+```
+tar -xzf odb64_linux.tar.gz
+```
+
The command extracts these files:
+
@@ -93,6 +94,6 @@ The command extracts these files:
To uninstall odb, delete the `README` and `/bin/odb64luo` files from their installed location.
-====
-*rm -rf _odb-installation-directory_*
-====
+```
+rm -rf odb-installation-directory
+```
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/8681b498/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 340f9eb..0d4a7ac 100644
--- a/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc
@@ -30,7 +30,6 @@ The distribution file for the Trafodion ODBC Driver for Linux is packaged within
`TRAF_ODBC_Linux_Driver_64.tar.gz` is used to install the Trafodion ODBC Driver for Linux. It contains the following files:
-====
```
connect_test.cpp
install.sh
@@ -43,7 +42,6 @@ license.txt
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
during installation:
@@ -77,9 +75,9 @@ If you are building ODBC applications, please use the preferred build platform,
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*
-====
+```
+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.
@@ -89,23 +87,21 @@ NOTE: You must have root access to install the Trafodion ODBC Driver for Linux a
1. Change the directory to the clients subdirectory, and decompress the `.tar.gz` distribution file:
+
-====
-*gunzip TRAF_ODBC_Linux_Driver_64.tar.gz*
-====
+```
+gunzip TRAF_ODBC_Linux_Driver_64.tar.gz
+```
2. Extract the contents of the `.tar` file. A directory called `PkgTmp` is created.
+
-====
-*tar –xvf TRAF_ODBC_Linux_Driver_64.tar*
-====
-+
-<<<
+```
+tar –xvf TRAF_ODBC_Linux_Driver_64.tar
+```
3. Install the product by entering these commands:
+
-====
-*cd PkgTmp +
-*./install.sh*
-====
+```
+cd PkgTmp
+./install.sh
+```
+
Except for the sample file, the `install.sh` script saves a copy (`.SAV`) of your previous installation files if they exist.
4. Accept the terms of the license agreement by entering *yes*.
@@ -135,9 +131,9 @@ 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*
-====
+```
+yum install libiodbc libiodbc-devel
+```
The `yum` command automatically installs the header files in the `/usr/include` and `/usr/include/libiodbc` directories.
@@ -151,17 +147,17 @@ To enable compression in the ODBC driver or to change the compression setting, f
* If you are using the Trafodion ODBC driver manager, add
+
-====
-*Compression = _compression-level_*
-====
+```
+Compression = compression-level
+```
+
to the `DSN` section of `TRAFDSN` file.
* If you are using a third-party driver manager, such as unixODBC, add
+
-====
-*Compression = _compression-level_*
-====
+```
+Compression = compression-level
+```
+
to the `DSN` section of the `odbc.ini` file.
@@ -194,59 +190,57 @@ NOTE: The examples after each step assume that you have default installation dir
If you have a previous version of the Trafodion ODBC driver installed, you need to re-link your existing application to ensure that you pick up
the correct version of the driver. If you are unsure of the version, check the version of your application with this command:
-====
-*ldd _object-file_*
-====
+```
+ldd object-file
+```
1. Move to the directory where you installed the sample program:
+
-====
-*cd /etc/odbc*
-====
+```
+cd /etc/odbc
+```
+
2. Set the environment variable `LD_LIBRARY_PATH`:
+
-====
-*export LD_LIBRARY_PATH=_<path-to-odbc-library-files or /usr/lib64>_*
-====
-+
-<<<
+```
+export LD_LIBRARY_PATH=<path-to-odbc-library-files or /usr/lib64>
+```
3. In the `/etc/odbc/TRAFDSN` file, add the correct IP address to the `Server` parameter for the `Default_DataSource`.
+
*Example*
+
-====
-`[Default_DataSource]` +
-`Description = Default Data Source` +
-`Catalog = TRAFODION` +
-`Schema = SEABASE` +
-`DataLang = 0` +
-`FetchBufferSize = SYSTEM_DEFAULT` +
-`Server = TCP:1.2.3.4:37800` <- _Set IP Address_ +
-`SQL_ATTR_CONNECTION_TIMEOUT = SYSTEM_DEFAULT` +
-`SQL_LOGIN_TIMEOUT = SYSTEM_DEFAULT` +
-`SQL_QUERY_TIMEOUT = NO_TIMEOUT`
-====
+```
+[Default_DataSource]
+Description = Default Data Source
+Catalog = TRAFODION
+Schema = SEABASE
+DataLang = 0
+FetchBufferSize = SYSTEM_DEFAULT
+Server = TCP:1.2.3.4:37800 <- _Set IP Address_
+SQL_ATTR_CONNECTION_TIMEOUT = SYSTEM_DEFAULT
+SQL_LOGIN_TIMEOUT = SYSTEM_DEFAULT
+SQL_QUERY_TIMEOUT = NO_TIMEOUT
+```
+
4. Compile the sample program.
+
-====
-*g++ -g connect_test.cpp -L/usr/lib64 -I/usr/include/odbc -ltrafodbc64 -o connect_test*
-====
+```
+g++ -g connect_test.cpp -L/usr/lib64 -I/usr/include/odbc -ltrafodbc64 -o connect_test
+```
5. Run the sample program:
+
-====
-*./connect_test -d Default_DataSource -u _username_ -p _password_*
-====
+```
+./connect_test -d Default_DataSource -u username -p password
+```
If the sample program runs successfully, you should see output similar to the following:
-====
```
Using Connect String: DSN=Default_DataSource;UID=username;PWD=****;
Connect Test Passed...
```
-====
<<<
[[linux_odbc_run_basicsql]]
@@ -258,48 +252,51 @@ NOTE: The Basic SQL sample program is not currently bundled with the ODBC Linux
If you have a previous version of the Trafodion ODBC driver installed, you need to re-link your existing application to ensure that you pick up
the correct version of the driver. If you are unsure of the version, check the version of your application with this command:
-====
-*ldd _object-file_*
-====
+```
+ldd object-file
+```
1. Move to the directory where you put the `basicsql.cpp` file.
+
2. Set the environment variable `LD_LIBRARY_PATH`:
+
-====
-*export LD_LIBRARY_PATH=_<path-to-odbc-driver-dlls>_*
-====
+```
+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*
+
-====
-`[Default_DataSource]` +
-`Description = Default Data Source` +
-`Catalog = TRAFODION` +
-`Schema = SEABASE` +
-`DataLang = 0` +
-`FetchBufferSize = SYSTEM_DEFAULT` +
-`Server = TCP:1.2.3.4:37800` <- _Set IP Address_ +
-`SQL_ATTR_CONNECTION_TIMEOUT = SYSTEM_DEFAULT` +
-`SQL_LOGIN_TIMEOUT = SYSTEM_DEFAULT` +
-`SQL_QUERY_TIMEOUT = NO_TIMEOUT`
-====
+```
+[Default_DataSource]
+Description = Default Data Source
+Catalog = TRAFODION
+Schema = SEABASE
+DataLang = 0
+FetchBufferSize = SYSTEM_DEFAULT
+Server = TCP:1.2.3.4:37800
+SQL_ATTR_CONNECTION_TIMEOUT = SYSTEM_DEFAULT
+SQL_LOGIN_TIMEOUT = SYSTEM_DEFAULT
+SQL_QUERY_TIMEOUT = NO_TIMEOUT
+```
4. Compile the sample program.
+
-====
-*g++ -g basicsql.cpp -L. -I. -ltrafodbc64 -o basicsql*
-====
+```
+g++ -g basicsql.cpp -L. -I. -ltrafodbc64 -o basicsql
+```
+
5. Run the sample program:
+
-====
-`basicsql Default_DataSource _username password_`
-====
+```
+basicsql Default_DataSource <username> <password>
+```
-<<<
If the sample program runs successfully, you should see output similar to the following:
-====
```
Using Connect String: DSN=Default_DataSource;UID=user1;PWD=pwd1;
Successfully connected using SQLDriverConnect.
@@ -311,4 +308,3 @@ Fetching data using SQLExecDirect, SQLFetch, SQLGetData
Data selected: 1000 CREATE REPORTS 2014-3-22
Basic SQL ODBC Test Passed!
```
-====
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/8681b498/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 336ab69..887d15f 100644
--- a/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc
@@ -27,26 +27,26 @@ These installation instructions apply to Trafodion Release 1.3.*_n_* and subsequ
The installer file for the Trafodion ODBC Driver for Windows 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 installer file to install the Trafodion ODBC Driver for Windows:
-[cols="25%,25%,50%",options="header"]
+[cols="25%l,25%,50%",options="header"]
|===
| Installer File | Description | Client Operating System
-| `TFODBC64-1.3.*_n_*.msi` | Windows MSI installer file | Windows 64-bit
+| TFODBC64-1.3.*_n_*.msi | Windows MSI installer file | Windows 64-bit
|===
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:
-[cols="40%,60%",options="header"]
+[cols="40%l,60%",options="header"]
|===
| Default Installation Directory | Client Operating System
-| `C:\Program Files\Trafodion\TRAF` | ODBC 1.0 Windows 64-bit
+| C:\Program Files\Trafodion\TRAF | ODBC 1.0 Windows 64-bit
|===
The ODBC client installation file installs or links to multiple client components:
[cols="40%s,60%",options="header"]
|===
-| This client component... | Does this...
+| This client component… | Does this…
| Microsoft ODBC Driver Manager | Manages access to ODBC drivers for applications. The driver manager loads and unloads drivers and passes calls for ODBC functions to the
correct driver.
| Trafodion ODBC driver | Implements ODBC function calls to enable an ODBC client application to access the Trafodion database.
@@ -100,7 +100,7 @@ Administrator until you have restarted your system.
==== Task 3: 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 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.
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.
@@ -109,12 +109,12 @@ Administrator until you have restarted your system.
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*.
@@ -129,7 +129,7 @@ To reinstall the driver, we recommend that you fully remove your ODBC driver and
[[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 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
@@ -158,7 +158,7 @@ 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*.
+For example, on Windows 7, select *Start>All Programs>Trafodion ODBC 1.0>MS ODBC Administrator*.
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*.
+
@@ -183,7 +183,7 @@ 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. For example, on Windows 7, select *Start>All Programs>Trafodion ODBC 1.0>MS ODBC Administrator*.
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>>.
@@ -209,22 +209,21 @@ files for this program, please refer to <<odbc_sample_program, ODBC Sample Prog
To build and run the executable file, follow these steps:
1. Open a Visual Studio x64 Win64 Command Prompt. Make sure to select the x64 version of the command prompt. For example, on Windows 7, select
-*Start->All Programs->Microsoft Visual Studio 2010->Visual Studio Tools->Visual Studio x64 Win64 Command Prompt*.
+*Start>All Programs>Microsoft Visual Studio 2010>Visual Studio Tools>Visual Studio x64 Win64 Command Prompt*.
2. At the command prompt, move to the directory where you put the `basicsql.cpp` and build files.
3. Run build at the command prompt. You will see `basicsql.exe` created in the same directory as the source file.
4. Before running the sample program, create a Trafodion data source named `Default_DataSource` on the client workstation using MS ODBC
Administrator. For instructions, please refer to <<win_odbc_client_env,Set Up Client Environment>>.
5. From the command prompt, run the sample program by entering either run or this command:
+
-====
-*basicsql Default_DataSource _username password_*
-====
+```
+basicsql DefaultDataSource <username> <password>
+```
+
If the sample program executes successfully, you should see this output:
+
*Example*
+
-====
```
Using Connect String: DSN=Default_DataSource;UID=user1;PWD=pwd1;
Successfully connected using SQLDriverConnect.
@@ -237,4 +236,4 @@ Fetching data using SQLExecDirect, SQLFetch, SQLGetData
Data selected: 1000 CREATE REPORTS 2014-3-22
Basic SQL ODBC Test Passed!
```
-====
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/8681b498/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 0980b3a..b9a8f0a 100644
--- a/docs/client_install/src/asciidoc/_chapters/trafci.adoc
+++ b/docs/client_install/src/asciidoc/_chapters/trafci.adoc
@@ -29,10 +29,10 @@ The distribution file for the Trafodion Command Interface (TrafCI) is packaged w
`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%,35%,30%",options="header"]
+[cols="35%l,35%,30%",options="header"]
|===
| Distribution File | Description | Client Operating System
-| `trafci.zip` | Zip file | Windows or Linux
+| trafci.zip | Zip file | Windows or Linux
|===
The distribution zip file contains this installer file: `trafciInstaller.jar`, an executable JAR file.
@@ -68,37 +68,37 @@ To display the version of the JDBC driver that is already installed on the clien
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*
-====
+```
+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*
-====
+```
+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*
-====
+```
+java -jar jdbcT4.jar
+```
+
-====
-`C:\>` *cd "\<user-specified directory>\lib"* +
-`C:\<user-specified directory>\lib>` *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>
```
-`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
@@ -134,23 +134,24 @@ To uninstall TrafCI, see <<trafci_uninstall, Uninstall_TrafCI>>.
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*
-====
+```
+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):
+
-====
-*unzip trafci.zip*
-====
+```
+unzip trafci.zip
+```
+
The command extracts these files:
+
@@ -174,6 +175,7 @@ Wizard Graphical User Interface (GUI) or from the command line:
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.
@@ -182,18 +184,17 @@ does not have the X Window system, see <<trafci_cmd_install, Command-Line Instal
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_*
-====
+```
+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*
-====
+```
+java -jar trafciInstaller.jar
+```
7. Proceed to <<trafci_using_wizard, Using the Installer Wizard>>.
@@ -209,8 +210,7 @@ image:{images}/InstallerWizardWelcome.jpg[image]
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.
+
@@ -235,8 +235,7 @@ The Installer Wizard displays the directory where TrafCI is installed.
The Installer Wizard dialog box shows which components are available for you to download and install.
+
image:{images}/OptionalComponents.jpg[image]
-+
-<<<
+
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:
@@ -254,8 +253,7 @@ 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
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:
+
@@ -284,32 +282,29 @@ image:{images}/InstallComplete.jpg[image]
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*
-====
+```
+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
+_-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*
-====
+```
+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
********************************************************************
@@ -323,7 +318,6 @@ 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.
@@ -332,26 +326,21 @@ NOTE: All items in square brackets are default values. Press Enter to accept the
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
@@ -359,65 +348,59 @@ Extracted 18 files from the
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* +
```
+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*
-====
+```
+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* +
```
+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* +
-```
+
+Install Perl XML SAX Module? [Y]: Y
+
Perl SAX XML Module URL (PerlSAX.pm)
-```
-`Install Jython, a Java implementation of Python? [Y]:` *Y* +
-```
+
+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-sourcecomponents. 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 +
+Downloading Perl JavaServer [2 of 3] - JavaArray.pm1
......................... 100%
Downloading Perl JavaServer [3 of 3] - JavaServer.jar
......................... 100%
@@ -430,7 +413,6 @@ Sucessfully Installed Jython. Successfully added settings.py
Trafodion Command Interface Installation Complete.
/home/myname/trafcitemp>
```
-====
[[trafci_uninstall]]
=== Uninstall TrafCI
@@ -444,45 +426,48 @@ If you used the executable JAR file, `trafciInstaller.jar`, to install TrafCI, d
After downloading and running the installer file, verify that the TrafCI software files are installed in the correct locations:
-[cols="15%,20%,65%",options="header"]
+[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 _Trafodion Command Interface Guide_.
-| | `trafci.py` | Python wrapper script. `trafci-python.py` is renamed as `trafci.py`. To run this script, see the http://trafodion.incubator.apache.com/docs/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 rowcounts. The file accepts a wildcard argument on the command line.
-| | `sampleTables.py` | Sample Python file that lists all tables and respective rowcounts. The file accepts a wildcard argument on the command line.
+| 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
+http://trafodion.incubator.apache.com/docs/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
+http://trafodion.incubator.apache.com/docs/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 rowcounts. The file accepts a wildcard argument on the command line.
+| | sampleTables.py | Sample Python file that lists all tables and respective rowcounts. The file accepts a wildcard 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_windows, Setting the PATH to a Supported >>
* <<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 the client, such as choosing the look and feel of the interface or presetting launch parameters, see the
-_Trafodion Command Interface Guide_.
+http://trafodion.incubator.apache.com/docs/command_interface/index.html[_Trafodion Command Interface Guide_].
+