Major reorganization of the Client Installation Guide. Corresponding changes in the odb User's Guide to keep installation in one place.
Formatting changes in some guides. Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/da748b4d Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/da748b4d Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/da748b4d Branch: refs/heads/master Commit: da748b4d887f20026d0afc1d137fc88a72cf717b Parents: 9c712a4 Author: Gunnar Tapper <[email protected]> Authored: Tue Nov 1 20:37:58 2016 +0000 Committer: Gunnar Tapper <[email protected]> Committed: Tue Nov 1 20:37:58 2016 +0000 ---------------------------------------------------------------------- .../jdbcT4/src/main/samples/t4jdbc.properties | 2 +- docs/client_install/pom.xml | 600 +- .../src/asciidoc/_chapters/SQuirrel.adoc | 148 +- .../src/asciidoc/_chapters/about.adoc | 331 +- .../src/asciidoc/_chapters/dbviz.adoc | 193 +- .../src/asciidoc/_chapters/howto.adoc | 164 + .../src/asciidoc/_chapters/introduction.adoc | 217 +- .../src/asciidoc/_chapters/jdbct4.adoc | 742 +- .../src/asciidoc/_chapters/odb.adoc | 311 +- .../src/asciidoc/_chapters/odbc_linux.adoc | 701 +- .../src/asciidoc/_chapters/odbc_windows.adoc | 490 +- .../src/asciidoc/_chapters/preparation.adoc | 273 + .../src/asciidoc/_chapters/sample_prog.adoc | 150 +- .../src/asciidoc/_chapters/tableau.adoc | 83 + .../src/asciidoc/_chapters/trafci.adoc | 984 +- docs/client_install/src/asciidoc/index.adoc | 138 +- .../Database_Connection_in_DbVisualizer.jpg | Bin 58043 -> 63604 bytes .../src/images/DbVisualizer_Driver_Manager.jpg | Bin 80198 -> 79645 bytes .../src/images/Extracted_Files.jpg | Bin 28327 -> 26389 bytes .../src/images/InstallComplete.jpg | Bin 47365 -> 73963 bytes .../src/images/Physical_Connection.jpg | Bin 185241 -> 71998 bytes .../src/images/SQuirrel_Add_Alias.jpg | Bin 0 -> 50396 bytes .../src/images/SQuirrel_Extra_Class_Path.jpg | Bin 0 -> 54897 bytes .../src/images/SQuirrel_New_Driver.jpg | Bin 0 -> 31639 bytes .../src/images/tableau_connect.jpg | Bin 0 -> 39547 bytes .../src/images/trafci_Installation_Choices.jpg | Bin 0 -> 78358 bytes .../src/images/winodbc_admin_add.jpg | Bin 0 -> 60817 bytes .../src/images/winodbc_admin_add_general.jpg | Bin 0 -> 48930 bytes .../images/winodbc_admin_add_general_edited.jpg | Bin 0 -> 50337 bytes .../src/images/winodbc_admin_add_network.jpg | Bin 0 -> 79462 bytes .../src/images/winodbc_admin_add_schema.jpg | Bin 0 -> 32986 bytes .../winodbc_admin_add_test_connection.jpg | Bin 0 -> 43949 bytes .../winodbc_admin_add_tested_connection.jpg | Bin 0 -> 44916 bytes .../images/winodbc_admin_add_translate_dll.jpg | Bin 0 -> 46249 bytes .../src/images/winodbc_admin_intro.jpg | Bin 0 -> 59907 bytes .../src/images/winodbc_destination.jpg | Bin 0 -> 36788 bytes .../src/images/winodbc_install_finished.jpg | Bin 0 -> 36769 bytes .../src/images/winodbc_license.jpg | Bin 0 -> 58430 bytes .../src/images/winodbc_ready_to_install.jpg | Bin 0 -> 34193 bytes .../src/images/winodbc_welcome.jpg | Bin 0 -> 39496 bytes .../src/resources/source/basicsql.cpp | 850 +- .../src/resources/source/build.bat | 50 +- .../client_install/src/resources/source/run.bat | 46 +- .../src/resources/tableau/trafodion.tdc | 16 + .../resources/tableau/trafodion.tdc.template | 16 + .../src/asciidoc/_chapters/binder_msgs.adoc | 6 +- .../src/asciidoc/_chapters/install.adoc | Bin 13248 -> 2252 bytes .../src/resources/source/partLocations.java | 42 + .../src/resources/source/partlocations.java | 42 - .../src/resources/source/supplierInfo.java | 38 + .../src/resources/source/supplierinfo.java | 38 - .../src/resources/source/supplyQuantities.java | 32 + .../src/resources/source/supplyquantities.java | 32 - docs/sql_reference/pom.xml | 602 +- .../src/asciidoc/_chapters/about.adoc | 424 +- .../src/asciidoc/_chapters/introduction.adoc | 1036 +- .../src/asciidoc/_chapters/limits.adoc | 74 +- .../src/asciidoc/_chapters/olap_functions.adoc | 2156 +-- .../src/asciidoc/_chapters/reserved_words.adoc | 572 +- .../src/asciidoc/_chapters/runtime_stats.adoc | 2706 +-- .../src/asciidoc/_chapters/sql_clauses.adoc | 2864 +-- .../sql_functions_and_expressions.adoc | 15770 +++++++-------- .../_chapters/sql_language_elements.adoc | 8176 ++++---- .../src/asciidoc/_chapters/sql_statements.adoc | 17004 +++++++++-------- .../src/asciidoc/_chapters/sql_utilities.adoc | 2382 +-- docs/sql_reference/src/asciidoc/index.adoc | 137 +- 66 files changed, 30729 insertions(+), 29909 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/core/conn/jdbcT4/src/main/samples/t4jdbc.properties ---------------------------------------------------------------------- diff --git a/core/conn/jdbcT4/src/main/samples/t4jdbc.properties b/core/conn/jdbcT4/src/main/samples/t4jdbc.properties index d4c1f98..d8ae73e 100755 --- a/core/conn/jdbcT4/src/main/samples/t4jdbc.properties +++ b/core/conn/jdbcT4/src/main/samples/t4jdbc.properties @@ -20,7 +20,7 @@ # @@@ END COPYRIGHT @@@ catalog = TRAFODION -schema = SCH +schema = SEABASE url = jdbc:t4jdbc://server:port/: user = usr password = pwd http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/pom.xml ---------------------------------------------------------------------- diff --git a/docs/client_install/pom.xml b/docs/client_install/pom.xml index 45491a3..7d6d122 100644 --- a/docs/client_install/pom.xml +++ b/docs/client_install/pom.xml @@ -1,300 +1,300 @@ -<?xml version="1.0" encoding="UTF-8"?> -<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; - xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> - <!-- -* @@@ START COPYRIGHT @@@ -* -* Licensed to the Apache Software Foundation (ASF) under one -* or more contributor license agreements. See the NOTICE file -* distributed with this work for additional information -* regarding copyright ownership. The ASF licenses this file -* to you under the Apache License, Version 2.0 (the -* "License"); you may not use this file except in compliance -* with the License. You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, -* software distributed under the License is distributed on an -* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -* KIND, either express or implied. See the License for the -* specific language governing permissions and limitations -* under the License. -* -* @@@ END COPYRIGHT @@@ ---> - <modelVersion>4.0.0</modelVersion> - <groupId>org.apache.trafodion</groupId> - <artifactId>client-install-guide</artifactId> - <version>${env.TRAFODION_VER}</version> - <packaging>pom</packaging> - <name>Trafodion Client Installation Guide</name> - <description>This guide describes how to install different Trafodion client applications.</description> - <url>http://trafodion.incubator.apache.org</url> - <inceptionYear>2015</inceptionYear> - - <parent> - <groupId>org.apache.trafodion</groupId> - <artifactId>trafodion</artifactId> - <version>1.3.0</version> - <relativePath>../../pom.xml</relativePath> - </parent> - - - <licenses> - <license> - <name>The Apache Software License, Version 2.0</name> - <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> - <distribution>repo</distribution> - <comments>A business-friendly OSS license</comments> - </license> - </licenses> - - <organization> - <name>Apache Software Foundation</name> - <url>http://www.apache.org</url> - </organization> - - <issueManagement> - <system>JIRA</system> - <url>http://issues.apache.org/jira/browse/TRAFODION</url> - </issueManagement> - - <scm> - <connection>scm:git:http://git-wip-us.apache.org/repos/asf/incubator-trafodion.git</connection> - <developerConnection>scm:git:https://git-wip-us.apache.org/repos/asf/incubator-trafodion.git</developerConnection> - <url>https://git-wip-us.apache.org/repos/asf?p=incubator-trafodion.git</url> - <tag>HEAD</tag> - </scm> - - <ciManagement> - <system>Jenkins</system> - <url>https://jenkins.esgyn.com</url> - </ciManagement> - - <properties> - <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> - <asciidoctor.maven.plugin.version>1.5.2.1</asciidoctor.maven.plugin.version> - <asciidoctorj.pdf.version>1.5.0-alpha.11</asciidoctorj.pdf.version> - <asciidoctorj.version>1.5.4</asciidoctorj.version> - <rubygems.prawn.version>2.0.2</rubygems.prawn.version> - <jruby.version>9.0.4.0</jruby.version> - <dependency.locations.enabled>false</dependency.locations.enabled> - </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> - <dependency> - <groupId>org.jruby</groupId> - <artifactId>jruby-complete</artifactId> - <version>${jruby.version}</version> - </dependency> - <dependency> - <groupId>org.asciidoctor</groupId> - <artifactId>asciidoctorj</artifactId> - <version>${asciidoctorj.version}</version> - </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> - <configuration> - <encoding>UTF-8</encoding> - <attributes> - <generateReports>false</generateReports> - </attributes> - </configuration> - </plugin> - <plugin> - <groupId>org.asciidoctor</groupId> - <artifactId>asciidoctor-maven-plugin</artifactId> - <version>${asciidoctor.maven.plugin.version}</version> - <dependencies> - <dependency> - <groupId>org.asciidoctor</groupId> - <artifactId>asciidoctorj-pdf</artifactId> - <version>${asciidoctorj.pdf.version}</version> - </dependency> - <dependency> - <groupId>org.asciidoctor</groupId> - <artifactId>asciidoctorj</artifactId> - <version>${asciidoctorj.version}</version> - </dependency> - </dependencies> - <configuration> - <sourceDirectory>${basedir}/src</sourceDirectory> - </configuration> - <executions> - <execution> - <id>generate-html-doc</id> - <goals> - <goal>process-asciidoc</goal> - </goals> - <phase>site</phase> - <configuration> - <doctype>book</doctype> - <backend>html5</backend> - <sourceHighlighter>coderay</sourceHighlighter> - <outputDirectory>${basedir}/target/site</outputDirectory> - <requires> - <require>${basedir}/../shared/google-analytics-postprocessor.rb</require> - </requires> - <attributes> - <!-- Location of centralized stylesheet --> - <stylesheet>${basedir}/../shared/trafodion-manuals.css</stylesheet> - <project-version>${env.TRAFODION_VER}</project-version> - <project-name>Trafodion</project-name> - <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo> - <project-support>[email protected]</project-support> - <docs-url>http://trafodion.incubator.apache.org/docs</docs-url> - <download-url>http://http://trafodion.incubator.apache.org/download.html</download-url> - <build-date>${maven.build.timestamp}</build-date> - <google-analytics-account>UA-72491210-1</google-analytics-account> - </attributes> - </configuration> - </execution> - <execution> - <id>generate-pdf-doc</id> - <phase>site</phase> - <goals> - <goal>process-asciidoc</goal> - </goals> - <configuration> - <doctype>book</doctype> - <backend>pdf</backend> - <sourceHighlighter>coderay</sourceHighlighter> - <outputDirectory>${basedir}/target</outputDirectory> - <attributes> - <pdf-stylesdir>${basedir}/../shared</pdf-stylesdir> - <pdf-style>trafodion</pdf-style> - <icons>font</icons> - <pagenums/> - <toc/> - <idprefix/> - <idseparator>-</idseparator> - <project-version>${env.TRAFODION_VER}</project-version> - <project-name>Trafodion</project-name> - <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo> - <project-support>[email protected]</project-support> - <docs-url>http://trafodion.incubator.apache.org/docs</docs-url> - <download-url>http://http://trafodion.incubator.apache.org/download.html</download-url> - <build-date>${maven.build.timestamp}</build-date> - </attributes> - </configuration> - </execution> - </executions> - </plugin> - <!-- Rename target/site/index.pdf to client-install-guide.pdf --> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-antrun-plugin</artifactId> - <version>1.8</version> - <inherited>false</inherited> - <executions> - <execution> - <id>populate-release-directories</id> - <phase>post-site</phase> - <configuration> - <target name="Populate Release Directories"> - <!-- The website uses the following organization for the docs/target/docs directory: - - To ensure a known location, the base directory contains the LATEST version of the web book and the PDF files. - - The know location is docs/target/docs/<document> - - target/docs/<version>/<document> contains version-specific renderings of the documents. - - target/docs/<version>/<document> contains the PDF version and the web book. The web book is named index.html - --> - <!-- Copy the PDF file to its target directories --> - <copy file="${basedir}/target/index.pdf" tofile="${basedir}/../target/docs/client_install/Trafodion_Client_Installation_Guide.pdf" /> - <copy file="${basedir}/target/index.pdf" tofile="${basedir}/../target/docs/${project.version}/client_install/Trafodion_Client_Installation_Guide.pdf" /> - <!-- Copy the Web Book files to their target directories --> - <copy todir="${basedir}/../target/docs/client_install"> - <fileset dir="${basedir}/target/site"> - <include name="**/*.*"/> <!--All sub-directories, too--> - </fileset> - </copy> - <copy todir="${basedir}/../target/docs/${project.version}/client_install"> - <fileset dir="${basedir}/target/site"> - <include name="**/*.*"/> <!--All sub-directories, too--> - </fileset> - </copy> - </target> - </configuration> - <goals> - <goal>run</goal> - </goals> - </execution> - </executions> - </plugin> - </plugins> - </build> - - <!-- Included because this is required. No reports are generated. --> - <reporting> - <excludeDefaults>true</excludeDefaults> - <plugins> - <plugin> - <groupId>org.apache.maven.plugins</groupId> - <artifactId>maven-project-info-reports-plugin</artifactId> - <version>2.8</version> - <reportSets> - <reportSet> - <reports> - </reports> - </reportSet> - </reportSets> - </plugin> - </plugins> - </reporting> - - <distributionManagement> - <site> - <id>trafodion.incubator.apache.org</id> - <name>Trafodion Website at incubator.apache.org</name> - <!-- On why this is the tmp dir and not trafodion.incubator.apache.org, see - https://issues.apache.org/jira/browse/HBASE-7593?focusedCommentId=13555866&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-13555866 - --> - <url>file:///tmp</url> - </site> - </distributionManagement> -</project> +<?xml version="1.0" encoding="UTF-8"?> +<project xmlns="http://maven.apache.org/POM/4.0.0"; xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; + xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd";> + <!-- +* @@@ START COPYRIGHT @@@ +* +* Licensed to the Apache Software Foundation (ASF) under one +* or more contributor license agreements. See the NOTICE file +* distributed with this work for additional information +* regarding copyright ownership. The ASF licenses this file +* to you under the Apache License, Version 2.0 (the +* "License"); you may not use this file except in compliance +* with the License. You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, +* software distributed under the License is distributed on an +* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +* KIND, either express or implied. See the License for the +* specific language governing permissions and limitations +* under the License. +* +* @@@ END COPYRIGHT @@@ +--> + <modelVersion>4.0.0</modelVersion> + <groupId>org.apache.trafodion</groupId> + <artifactId>client-install-guide</artifactId> + <version>${env.TRAFODION_VER}</version> + <packaging>pom</packaging> + <name>Trafodion Client Installation Guide</name> + <description>This guide describes how to install different Trafodion client applications.</description> + <url>http://trafodion.incubator.apache.org</url> + <inceptionYear>2015</inceptionYear> + + <parent> + <groupId>org.apache.trafodion</groupId> + <artifactId>trafodion</artifactId> + <version>1.3.0</version> + <relativePath>../../pom.xml</relativePath> + </parent> + + + <licenses> + <license> + <name>The Apache Software License, Version 2.0</name> + <url>http://www.apache.org/licenses/LICENSE-2.0.txt</url> + <distribution>repo</distribution> + <comments>A business-friendly OSS license</comments> + </license> + </licenses> + + <organization> + <name>Apache Software Foundation</name> + <url>http://www.apache.org</url> + </organization> + + <issueManagement> + <system>JIRA</system> + <url>http://issues.apache.org/jira/browse/TRAFODION</url> + </issueManagement> + + <scm> + <connection>scm:git:http://git-wip-us.apache.org/repos/asf/incubator-trafodion.git</connection> + <developerConnection>scm:git:https://git-wip-us.apache.org/repos/asf/incubator-trafodion.git</developerConnection> + <url>https://git-wip-us.apache.org/repos/asf?p=incubator-trafodion.git</url> + <tag>HEAD</tag> + </scm> + + <ciManagement> + <system>Jenkins</system> + <url>https://jenkins.esgyn.com</url> + </ciManagement> + + <properties> + <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> + <asciidoctor.maven.plugin.version>1.5.2.1</asciidoctor.maven.plugin.version> + <asciidoctorj.pdf.version>1.5.0-alpha.11</asciidoctorj.pdf.version> + <asciidoctorj.version>1.5.4</asciidoctorj.version> + <rubygems.prawn.version>2.0.2</rubygems.prawn.version> + <jruby.version>9.0.4.0</jruby.version> + <dependency.locations.enabled>false</dependency.locations.enabled> + </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> + <dependency> + <groupId>org.jruby</groupId> + <artifactId>jruby-complete</artifactId> + <version>${jruby.version}</version> + </dependency> + <dependency> + <groupId>org.asciidoctor</groupId> + <artifactId>asciidoctorj</artifactId> + <version>${asciidoctorj.version}</version> + </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> + <configuration> + <encoding>UTF-8</encoding> + <attributes> + <generateReports>false</generateReports> + </attributes> + </configuration> + </plugin> + <plugin> + <groupId>org.asciidoctor</groupId> + <artifactId>asciidoctor-maven-plugin</artifactId> + <version>${asciidoctor.maven.plugin.version}</version> + <dependencies> + <dependency> + <groupId>org.asciidoctor</groupId> + <artifactId>asciidoctorj-pdf</artifactId> + <version>${asciidoctorj.pdf.version}</version> + </dependency> + <dependency> + <groupId>org.asciidoctor</groupId> + <artifactId>asciidoctorj</artifactId> + <version>${asciidoctorj.version}</version> + </dependency> + </dependencies> + <configuration> + <sourceDirectory>${basedir}/src</sourceDirectory> + </configuration> + <executions> + <execution> + <id>generate-html-doc</id> + <goals> + <goal>process-asciidoc</goal> + </goals> + <phase>site</phase> + <configuration> + <doctype>book</doctype> + <backend>html5</backend> + <sourceHighlighter>coderay</sourceHighlighter> + <outputDirectory>${basedir}/target/site</outputDirectory> + <requires> + <require>${basedir}/../shared/google-analytics-postprocessor.rb</require> + </requires> + <attributes> + <!-- Location of centralized stylesheet --> + <stylesheet>${basedir}/../shared/trafodion-manuals.css</stylesheet> + <project-version>${env.TRAFODION_VER}</project-version> + <project-name>Trafodion</project-name> + <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo> + <project-support>[email protected]</project-support> + <docs-url>http://trafodion.incubator.apache.org/docs</docs-url> + <download-url>http://trafodion.incubator.apache.org/download.html</download-url> + <build-date>${maven.build.timestamp}</build-date> + <google-analytics-account>UA-72491210-1</google-analytics-account> + </attributes> + </configuration> + </execution> + <execution> + <id>generate-pdf-doc</id> + <phase>site</phase> + <goals> + <goal>process-asciidoc</goal> + </goals> + <configuration> + <doctype>book</doctype> + <backend>pdf</backend> + <sourceHighlighter>coderay</sourceHighlighter> + <outputDirectory>${basedir}/target</outputDirectory> + <attributes> + <pdf-stylesdir>${basedir}/../shared</pdf-stylesdir> + <pdf-style>trafodion</pdf-style> + <icons>font</icons> + <pagenums/> + <toc/> + <idprefix/> + <idseparator>-</idseparator> + <project-version>${env.TRAFODION_VER}</project-version> + <project-name>Trafodion</project-name> + <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo> + <project-support>[email protected]</project-support> + <docs-url>http://trafodion.incubator.apache.org/docs</docs-url> + <download-url>http://http://trafodion.incubator.apache.org/download.html</download-url> + <build-date>${maven.build.timestamp}</build-date> + </attributes> + </configuration> + </execution> + </executions> + </plugin> + <!-- Rename target/site/index.pdf to client-install-guide.pdf --> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-antrun-plugin</artifactId> + <version>1.8</version> + <inherited>false</inherited> + <executions> + <execution> + <id>populate-release-directories</id> + <phase>post-site</phase> + <configuration> + <target name="Populate Release Directories"> + <!-- The website uses the following organization for the docs/target/docs directory: + - To ensure a known location, the base directory contains the LATEST version of the web book and the PDF files. + - The know location is docs/target/docs/<document> + - target/docs/<version>/<document> contains version-specific renderings of the documents. + - target/docs/<version>/<document> contains the PDF version and the web book. The web book is named index.html + --> + <!-- Copy the PDF file to its target directories --> + <copy file="${basedir}/target/index.pdf" tofile="${basedir}/../target/docs/client_install/Trafodion_Client_Installation_Guide.pdf" /> + <copy file="${basedir}/target/index.pdf" tofile="${basedir}/../target/docs/${project.version}/client_install/Trafodion_Client_Installation_Guide.pdf" /> + <!-- Copy the Web Book files to their target directories --> + <copy todir="${basedir}/../target/docs/client_install"> + <fileset dir="${basedir}/target/site"> + <include name="**/*.*"/> <!--All sub-directories, too--> + </fileset> + </copy> + <copy todir="${basedir}/../target/docs/${project.version}/client_install"> + <fileset dir="${basedir}/target/site"> + <include name="**/*.*"/> <!--All sub-directories, too--> + </fileset> + </copy> + </target> + </configuration> + <goals> + <goal>run</goal> + </goals> + </execution> + </executions> + </plugin> + </plugins> + </build> + + <!-- Included because this is required. No reports are generated. --> + <reporting> + <excludeDefaults>true</excludeDefaults> + <plugins> + <plugin> + <groupId>org.apache.maven.plugins</groupId> + <artifactId>maven-project-info-reports-plugin</artifactId> + <version>2.8</version> + <reportSets> + <reportSet> + <reports> + </reports> + </reportSet> + </reportSets> + </plugin> + </plugins> + </reporting> + + <distributionManagement> + <site> + <id>trafodion.incubator.apache.org</id> + <name>Trafodion Website at incubator.apache.org</name> + <!-- On why this is the tmp dir and not trafodion.incubator.apache.org, see + https://issues.apache.org/jira/browse/HBASE-7593?focusedCommentId=13555866&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-13555866 + --> + <url>file:///tmp</url> + </site> + </distributionManagement> +</project> http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/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 563993f..bde3a3f 100644 --- a/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc +++ b/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc @@ -1,72 +1,76 @@ -//// -/** - *@@@ START COPYRIGHT @@@ - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * @@@ END COPYRIGHT @@@ - */ -//// - -= Configure SQuirreL Client -These configuration instructions apply to {project-name} Release 1.3.*_n_* and subsequent updates of {project-name} until otherwise indicated. - -== Prerequisite Software - -Make sure that you have this software installed on your workstation: - -* Java Runtime Environment (JRE) 1.7 or higher. See <<jdbct4-java-environment, Java Environment>> in the <<jdbct4, Install JDBC Type-4 Driver>> chapter above. -* {project-name} JDBC Type-4 Driver. See <<jdbct4,Install JDBC Type-4 Driver>> above. -* SQuirreL SQL Client 3.5.0. See the http://squirrel-sql.sourceforge.net/[_SQuirreL SQL Client website_]. - -<<< -== Configuration Instructions -=== Register JDBC Type-4 Driver - -Use the *Add Driver* function and register the {project-name} JDBC Type-4 Driver: - -1. Click on the *Add* button and locate the {project-name} 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[alt="SQuirreL Add Driver Dialog Box"] -+ -* Name: `{project-name}` -* Example URL: `jdbc:t4jdbc://_host-name or ip-address_:37800/:` (Default port number: *23400*) - -<<< -=== Connect to {project-name} - -Use the Add Alias dialog box and create an alias for your {project-name} System: - -image:{images}/Add_Alias_SQuirreL.jpg[alt="SQuirreL Add Alias Dialog Box"] - -1. Edit the connection *URL* to match your {project-name} system's host name and port number: -+ -*Example* -+ -``` -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[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. - +//// +/** + *@@@ START COPYRIGHT @@@ + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * @@@ END COPYRIGHT @@@ + */ +//// + += Configure SQuirreL Client + +== Prerequisites + +If you have not done so already, please ensure that you have <<java-setup, setup your Java environment>>, +<<download-software, unpackaged the {project-name} client software>>, and <<jdbct4, installed the JDBC Type-4 Driver>>. + +You also need SQuirreL SQL Client 3.7.0 or later. See the http://squirrel-sql.sourceforge.net/[_SQuirreL SQL Client website_]. + +== Configuration Instructions +=== Register JDBC Type-4 Driver + +. Start SQuirreL SQL Client +. Click in the rectangle box in the upper left of the window that has âDriversâ printed sideways. +. Select the "+ New Driver. . ." under "Drivers" from the top menu. ++ +image:{images}/SQuirrel_New_Driver.jpg[alt="SQuirreL New Driver Dialog Box"] + +. In the *Add Driver* dialog box: +.. Enter `Trafodion` in the *Name* field. +.. Enter `jdbc:t4jdbc://<host-name or ip-address:23400/:` in the *Example URL* field. ++ +The default port number is 23400. If you have configured JDBC server on Trafodion with a different port number, +then you will need to change the 23400 value to match. +.. Select the *Extra Class Path* tab and then click the *Add* button. ++ +Use the file browser to navigate to the directory where you installed the +drivers and select the driver. (`jdbct4\lib\jdbcT4.jar`) +.. Enter `org.trafodion.jdbc.t4.T4Driver` in the Class Name field at the bottom of the dialog box and then click on *OK*. +.. If configured correctly, you will see a message stating +"Driver class org.trafodion.jdbc.t4.T4Driver successfully registered for driver definition: Trafodion" in the text box +at the bottom of the SQuirreL SQL window. ++ +image:{images}/SQuirrel_Extra_Class_Path.jpg[scaledwidth="75%",alt="SQuirreL Extra Class Path Dialog Box"] + +. Click in the rectangle box in the upper left of the window that has "Drivers" printed sideways. + +<<< +=== Connect to {project-name} + +Use the Add Alias dialog box and create an alias for your Trafodion System. + +. Select the "+ New Alias. . ." under *Aliases* from the top menu. +. In the *Add Alias* dialog box: +.. Enter `Trafodion Cluster` or however you want to identify the cluster in the Name field. +.. Select *Trafodion* from the Driver select menu. +.. Enter <your user name> in the User Name field. +.. Enter <your password> in the Password field. +.. Click on the *Properties* button. In the Schema tab, select the *Load all and cache all Schemas* radio button. +.. Click on the *OK* button to close the Properties dialog and then click on the *OK* button to close the *Add Aliases* window. ++ +image:{images}/SQuirrel_Add_Alias.jpg[alt="SQuirreL Add Alias Dialog Box"] +. You will now be presented with a dialog to connect. Click on the *Connect* button and then issue a query to test the connection. + http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/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 25e220c..e64cc3a 100644 --- a/docs/client_install/src/asciidoc/_chapters/about.adoc +++ b/docs/client_install/src/asciidoc/_chapters/about.adoc @@ -1,166 +1,165 @@ -//// -/** -* @@@ START COPYRIGHT @@@ -* -* Licensed to the Apache Software Foundation (ASF) under one -* or more contributor license agreements. See the NOTICE file -* distributed with this work for additional information -* regarding copyright ownership. The ASF licenses this file -* to you under the Apache License, Version 2.0 (the -* "License"); you may not use this file except in compliance -* with the License. You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, -* software distributed under the License is distributed on an -* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY -* KIND, either express or implied. See the License for the -* specific language governing permissions and limitations -* under the License. -* -* @@@ END COPYRIGHT @@@ -*/ -//// - -= About This Document -This manual describes how to install and configure client applications that enable you to connect to and use a {project-name} database. - -== Intended Audience -This manual is intended for users who want to connect to and use a {project-name} database. - -== New and Changed Information -This manual shows updated versions for {project-name} Release {project-version}. It also provides instructions on how to download and install <<odb,{project-name} odb>>, a -new multi-threaded, ODBC-based command-line tool for parallel data loading and extracting. - -== Notation Conventions -This list summarizes the notation conventions for syntax presentation in this manual. - -* 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. -+ -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. -+ -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. -+ -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] -``` - -== Comments Encouraged -We encourage your comments concerning this document. We are committed to providing documentation that meets your -needs. Send any errors found, suggestions for improvement, or compliments to {project-support}. - -Include the document title and any comment, error found, or suggestion for improvement you have concerning this document. +//// +/** +* @@@ START COPYRIGHT @@@ +* +* Licensed to the Apache Software Foundation (ASF) under one +* or more contributor license agreements. See the NOTICE file +* distributed with this work for additional information +* regarding copyright ownership. The ASF licenses this file +* to you under the Apache License, Version 2.0 (the +* "License"); you may not use this file except in compliance +* with the License. You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, +* software distributed under the License is distributed on an +* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +* KIND, either express or implied. See the License for the +* specific language governing permissions and limitations +* under the License. +* +* @@@ END COPYRIGHT @@@ +*/ +//// + += About This Document +This manual describes how to install and configure client applications that enable you to connect to and use a {project-name} database. + +== Intended Audience +This manual is intended for users who want to connect to and use a {project-name} database. + +== New and Changed Information +This manual shows updated versions for {project-name} Release {project-version}. + +== Notation Conventions +This list summarizes the notation conventions for syntax presentation in this manual. + +* 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. ++ +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. ++ +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. ++ +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] +``` + +== Comments Encouraged +We encourage your comments concerning this document. We are committed to providing documentation that meets your +needs. Send any errors found, suggestions for improvement, or compliments to {project-support}. + +Include the document title and any comment, error found, or suggestion for improvement you have concerning this document. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/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 d064e2a..a982504 100644 --- a/docs/client_install/src/asciidoc/_chapters/dbviz.adoc +++ b/docs/client_install/src/asciidoc/_chapters/dbviz.adoc @@ -1,83 +1,110 @@ -//// -/** - *@@@ START COPYRIGHT @@@ - * Licensed to the Apache Software Foundation (ASF) under one - * or more contributor license agreements. See the NOTICE file - * distributed with this work for additional information - * regarding copyright ownership. The ASF licenses this file - * to you under the Apache License, Version 2.0 (the - * "License"); you may not use this file except in compliance - * with the License. You may obtain a copy of the License at - * - * http://www.apache.org/licenses/LICENSE-2.0 - * - * Unless required by applicable law or agreed to in writing, software - * distributed under the License is distributed on an "AS IS" BASIS, - * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - * See the License for the specific language governing permissions and - * limitations under the License. - * @@@ END COPYRIGHT @@@ - */ -//// - -= Configure DbVisualizer - -== Prerequisite Software - -Make sure that you have this software installed on your workstation: - -* Java Runtime Environment (JRE) 1.7 or higher. See <<jdbct4-java-environment, Java Environment>> in the <<jdbct4, Install JDBC Type-4 Driver>> chapter above. -+ -In addition, see DbVisualizerâs FAQ âHow toâ page: -http://confluence.dbvis.com/pages/viewpage.action?pageId=3146120[_How do I change the Java version that DbVisualizer uses?_] -* {project-name} JDBC Type-4 Driver. See <<jdbct4,Install JDBC Type-4 Driver>> above. -* DbVisualizer 9.x.x. See the http://www.dbvis.com/[_DbVisualizer website_]. - -== Configuration Instructions - -=== Disable Connection Validation Select Option - -==== DbVisualizer 9.1 (or an earlier version) -Edit the `_DbVisualizer-Install-Dir_\resources\dbvis-custom.prefs` file and -disable the `ConnectionValidationSelect` option as shown below: - -``` -dbvis.generic.-ConnectionValidationSelect=disabled -``` - -==== DbVisualizer 9.2 (or a later version) -Set the *Physical Connection* property to keep your connections alive. Follow these steps: - -1. Double-click the database connection, select the *Properties* tab. -2. In the left navigation tree, expand the *Generic* connection properties, and select *Physical Connection*. -3. Under *Validation SQL*, enter `values(current_timestamp)` and click *Apply*. -+ -<<< -image:{images}/Physical_Connection.jpg[width=600,height=600,alt="DbVisualizer Physical Connection"] - -<<< -=== Register JDBC Type-4 Driver - -Use the DbVisualizer Driver Manager and register the {project-name} JDBC Type-4 Driver. - -image:{images}/DbVisualizer_Driver_Manager.jpg[image] - -* Use the Open File icon and locate the {project-name} JDBC Type-4 Driver. -* Use the JDBC URL format: -+ -``` -jdbc:t4jdbc://<host-name or ip-address>:23400/: -``` -+ -*NOTE*: This example uses a modified port number (*37800*) rather than the default port number (*23400*). - -<<< -=== Connect to {project-name} - -Create a new connection by selecting the {project-name} JDBC Type-4 Driver and filling in the connection parameters. Edit the database URL to match -your {project-name} systemâs host name and port number; for example: `jdbc:t4jdbc://<host-name or ip-address>:37800/:` (default is: *23400*). - -image:{images}/Database_Connection_in_DbVisualizer.jpg[image] - -Once you have connected successfully, execute a query using SQL Commander to confirm the connection. - +//// +/** + *@@@ START COPYRIGHT @@@ + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + * @@@ END COPYRIGHT @@@ + */ +//// + += Configure DBVisualizer + +== Prerequisites + +If you have not done so already, please ensure that you have <<java-setup, setup your Java environment>>, +<<download-software, unpackaged the {project-name} client software>>, and <<jdbct4, installed the JDBC Type-4 Driver>>. + +You also need DBVisualizer 9.x.x. See the http://www.dbvis.com/[_DbVisualizer website_]. +In addition, see DBVisualizerâs FAQ âHow toâ page: +http://confluence.dbvis.com/pages/viewpage.action?pageId=3146120[_How do I change the Java version that DBVisualizer uses?_] + +The examples in this chapter assumes that you have unpackaged the trafci installation file +to `c:\trafodion\trafci` (Windows) or `$HOME/trafodion/trafci` (Linux). + +== Configuration Instructions + +=== Register JDBC Type-4 Driver + +. Select *Tools>Driver Manager*. +. Click on the green plus sign to add a new driver. ++ +image:{images}/DbVisualizer_Driver_Manager.jpg[height=500,width=500,alt="DBVizualizer Add New Driver"] ++ +* Use the Open File icon and locate the {project-name} JDBC Type-4 Driver. +`c:\trafodion\jdbct4\lib\jdbcT4.jar` (Windows) or `$HOME/trafodion/jdbct4/lib/jdbcT4.jar` (Linux). +* Use the JDBC URL format (literary, do not replace the placeholders): ++ +``` +jdbc:t4jdbc://<host-name or ip-address>:23400/: +``` + +. Close the dialog box to save the settings. + +=== Create Database Connection + +. Select *Database>Create Database Connection*. +. Click on the *Driver (JDBC)* field. This presents you with a drop-down list of drivers. +. Select the driver you created in the step above. (`Trafodion`) +. Right-click the *Database URL* field. Select the URL format that pops up. ++ +The field should be populated with: `jdbc:t4jdbc://<host-name or ip-address>:23400/:` + +. Edit (double-click the field) the database URL to match your target host name and port number. ++ +*Example* ++ +``` +jdbc:t4jdbc://node01.host.com:23400/: +``` +. Add your *Database Userid*. +. Add your *Database Password*. ++ +image:{images}/Database_Connection_in_DbVisualizer.jpg[height=500,width=500,alt="DBVizualizer Make Connection"] + +<<< +=== Disable Connection Validation Select Option + +==== DBVisualizer 9.2 (or a later version) + +Set the *Physical Connection* property to keep your connections alive. Follow these steps: + +. Open the database connection you created earlier if it's not open. +. Select the *Properties* tab. +. In the left navigation tree, expand the *Generic* connection properties, and select *Physical Connection*. +. Under *Validation SQL*, enter `values(current_timestamp)` and click *Apply*. ++ +image:{images}/Physical_Connection.jpg[height=500,width=500,alt="DBVisualizer Physical Connection"] + +==== DBVisualizer 9.1 (or an earlier version) +Edit the `_DBVisualizer-Install-Dir_\resources\dbvis-custom.prefs` file and +disable the `ConnectionValidationSelect` option as shown below: + +``` +dbvis.generic.-ConnectionValidationSelect=disabled +``` + +=== Connect to {project-name} + +. Right click on the database connection. +. Select *Connect*. + +Once connected: + +. Select *SQL Commander>New SQL Commander*. (CTRL+T) +. Browse the tree structure in the left pane under *Connections*. +. Try a query. + + http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/docs/client_install/src/asciidoc/_chapters/howto.adoc ---------------------------------------------------------------------- diff --git a/docs/client_install/src/asciidoc/_chapters/howto.adoc b/docs/client_install/src/asciidoc/_chapters/howto.adoc new file mode 100644 index 0000000..e721255 --- /dev/null +++ b/docs/client_install/src/asciidoc/_chapters/howto.adoc @@ -0,0 +1,164 @@ +//// +/** +* @@@ START COPYRIGHT @@@ +* +* Licensed to the Apache Software Foundation (ASF) under one +* or more contributor license agreements. See the NOTICE file +* distributed with this work for additional information +* regarding copyright ownership. The ASF licenses this file +* to you under the Apache License, Version 2.0 (the +* "License"); you may not use this file except in compliance +* with the License. You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, +* software distributed under the License is distributed on an +* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +* KIND, either express or implied. See the License for the +* specific language governing permissions and limitations +* under the License. +* +* @@@ END COPYRIGHT @@@ +*/ +//// + += How To + +[[howto-setup-path]] +== Set Up Path Variable + +You need to update your PATH variable for Java and the {project-name} clients. +The examples below show how to add Java to your PATH variable. The process +is similar for the different {project-name} clients. + +NOTE: You typically point the PATH variable to the `bin` directory, if it exists. +Otherwise, you point the PATH variable to the directory containing the client executable. +The examples below point to the Java `bin` directory. + +[[howto-setup-path-windows]] +=== Set PATH Variable on Windows + +==== Windows 10 + +. Right-click on the Windows icon on the menu bar. Select *System*. +. Click on *Advanced System Settings*. +. In the *System Properties* dialog box, click the *Advanced* tab. +. Click the *Environment Variables* button. +. Under *System* variables, select the variable named *Path*, and then click *Edit. . .*: ++ +image:{images}/win10_edit_path.jpg[Windows 10 Edit Path Variable] ++ +<<< +. Click *Browse. . .*. Find the directory where you installed Java or the {project-name} client. Select the `bin` directory as applicable. ++ +image:{images}/win10_select_java.jpg[image] + +. Click *OK* to close the browse window. Click *OK* to close the edit window. +. Verify that the updated *Path* appears under *System* variables, and click *OK*. +. In the *System Properties* dialog box, click *OK* to accept the changes. + +<<< +==== Windows 8 + +. Right-click the *Computer* icon on your desktop, and then select *Properties*. The *Control Panel > System and Security > System* window appears. + +. In the left navigation bar, click the *Advanced* system settings link. + +. In the *System Properties* dialog box, click the *Environment Variables* button. + +. Under *System* variables, select the variable named *Path*, and then click *Edit*: ++ +image:{images}/path2.jpg[image] + +. Place the cursor at the start of the *Variable* value field and +enter the path of the Java or {project-name} client `bin` directory, ending with a semicolon (;): ++ +image:{images}/varval2.jpg[image] ++ +*Example* ++ +``` +"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. + +. Click *OK*. +. Verify that the updated *Path* appears under *System* variables, and click *OK*. +. In the *System Properties* dialog box, click *OK* to accept the changes. + +For a full installation, a sample PATH variable may contain: + +``` +SET PATH=%PATH%;C:\Program Files\Java\jre1.8.0_101\;C:\trafodion\trafci\bin\; +``` + + +[[howto-setup-path-linux]] +=== Set PATH Variable on Linux + +. Open the user profile (`.profile` or `.bash_profile` for the Bash shell) in the `$HOME` directory. ++ +``` +cd $HOME +vi .profile +``` + +. In the user profile, set the `PATH` environment variable to include the path of the Java +or {project-name} client `bin` directory. ++ +``` +export PATH=$PATH:/usr/lib/jvm/java-1.7.0/bin +``` ++ +NOTE: Place the path of the Java bin directory after `$PATH` separated by colon (`:`). + +. To activate the changes, either log out and log in again or source in the user profile. ++ +``` +source profile +``` + +For a full installation, a sample PATH variable may contain: + +``` +export PATH=$PATH:/usr/lib/jvm/java-1.7.0/bin:/opt/user/trafodion/trafci/bin +``` + +[[howto-setup-path-verify]] +=== Verify PATH Variable + +Ensure that you can access the Java or {project-name} client +from the command line. + +*Examples* + +Display the Java version. + +``` +c:\trafodion> 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:\trafodion> +``` + +Display the trafci version. + +``` +c:\trafodion> trafci -version + +Welcome to EsgynDB Enterprise Command Interface +Copyright (c) 2015-2016 Esgyn Corporation + +JDBC Type 4 Driver Build ID : Traf_JDBC_Type4_Build_439d96b +Command Interface Build ID : TrafCI_Build_439d96b + +c:\trafodion> +``` + +If you cannot display the version information, then you need to +check your PATH variable settings again. + http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/da748b4d/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 8e9f06d..4b9172e 100644 --- a/docs/client_install/src/asciidoc/_chapters/introduction.adoc +++ b/docs/client_install/src/asciidoc/_chapters/introduction.adoc @@ -1,147 +1,70 @@ -//// -/** -*@@@ START COPYRIGHT @@@ -* Licensed to the Apache Software Foundation (ASF) under one -* or more contributor license agreements. See the NOTICE file -* distributed with this work for additional information -* regarding copyright ownership. The ASF licenses this file -* to you under the Apache License, Version 2.0 (the -* "License"); you may not use this file except in compliance -* with the License. You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -* @@@ END COPYRIGHT @@@ -*/ -//// - -[[introduction]] -= Introduction -This manual describes how to install and configure the following client applications, which enable you to connect to and use a {project-name} -database. - -== Client Summary - -=== JDBC-Based Clients - -The following table lists JDBC-based clients supported by {project-name}. -[cols="30%,70%",options="header"] -|=== -| Client Name | Description -| *{project-name} JDBC Type 4 Driver* | A driver that enables Java applications that run on a client workstation to connect to a {project-name} database. + - + -*NOTE:* The {project-name} Command Interface (TrafCI), DbVisualizer, and SQuirreL SQL Client require this driver to be installed on the client -workstation. -| *{project-name} Command Interface (TrafCI)* | A command-line interface that allows you to connect to a {project-name} database and run SQL statements and other commands interactively or from -script files. For more information, see the http://trafodion.incubator.apache.org/docs/command_interface/index.html[{project-name} Command Interface Guide]. -| *DbVisualizer* | A third-party database tool that allows you to connect to a {project-name} 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 {project-name} database. For more information, see the -http://squirrel-sql.sourceforge.net/[SQuirreL SQL Client website]. -|=== - -=== ODBC-Based Clients - -The following table lists ODBC-based clients supported by {project-name}. -[cols="30%,70%",options="header"] -|=== -| Client Name | Description -| *{project-name} ODBC Driver for Linux* | A driver that enables applications, which were developed for the Microsoft ODBC API and run on a Linux workstation, to connect to a -{project-name} database. -| *{project-name} ODBC Driver for Windows* | *[Not included in this release]*^1^ + - + -A driver that enables applications, which were developed for the Microsoft Open Database Connectivity (ODBC) application programming -interface (API) and which run on a Windows workstation, to connect to a {project-name} database. -| *{project-name} odb tool* | A multi-threaded, ODBC-based command-line tool for parallel data loading and extracting. For more information, see the -{docs-url}/odb/index.html[{project-name} odb User Guide]. -|=== - -^1^ License issues prevent us from including the ODBC Driver for Windows in this release. Contact -{project-support} for help obtaining the driver. - -<<< -[[introduction-download]] -== Download Installation Package -The {project-name} client software is available from the {download-url}[{project-name} Download] page. There is one -`{project-name} Clients` package per release listed under *<version> Binaries*. - -The `{project-name} Clients` package consists of a zipped tar file that contains the {project-name} Clients tar file. The {project-name} Client -binaries are located in the Clients folder, which contains the following files: - -[cols="30%l,70%", options="header"] -|=== -| File | Usage -| odbc64_linux.tar.gz | {project-name} odb tool. -| TFODBC64-*.exe | *[Not included in this release]*^1^ {project-name} ODBC Driver for Windows. -| TRAF_ODBC_Linux_Driver_64.tar.gz | {project-name} ODBC driver for Linux. -| trafci.zip | The {project-name} command interpreter `trafci`. -| JDBCT4.zip | {project-name} JDBC Type 4 Driver. -|=== - -^1^ License issues prevent us from including the ODBC Driver for Windows in this release. Contact -{project-support} for help obtaining the driver. - -[[introduction-windows-download]] -=== Windows Download - -Do the following: - -1. Create a download folder on the client workstation. For example, `{project-name} Downloads`. - -2. Open a Web browser and navigate to the {project-name} downloads site {download-url}. - -3. Orient yourself to the binaries for the release you're installing. -Click on the `{project-name} Clients` link to start downloading the {project-name} clients tar file to your workstation. - -4. Place the `apache-trafodion-clients-*.tar.gz` file into the download folder. - -5. Unpack the `apache-trafodion-clients-\*.tar.gz` file using an unzip program of your choice. This creates -an `apache-trafodion-clients-*.tar` file. - -6. Unpack the `apache-trafodion-clients-*.tar` file using an unzip program of your choice. This creates -the `clients` folder, which has the following content: -+ -``` -JDBCT4.zip odb64_linux.tar.gz trafci.zip TRAF_ODBC_Linux_Driver_64.tar.gz -``` -+ -You use these files to install the different {project-name} clients. - -[[introduction-linux-download]] -=== Linux Download - -Do the following: - -1. Create a download directory on the client workstation. For example, `$HOME/trafodion-downloads`. - -2. Open a Web browser and navigate to the {project-name} downloads site {download-url}. - -3. Orient yourself to the binaries for the release you're installing. -Right-click on the `{project-name} Clients` link and select *Copy link address*. - -4. Go to the download directory on the client workstation and use `wget` to download the client package -using the link address you copied in step 3 above. - -5. Unpack the `apache-trafodion-clients-*.tar.gz` using `tar`. -+ -*Example* -+ -``` -$ mkdir $HOME/trafodion-downloads -$ cd $HOME/trafodion-downloads -$ wget <link to package> -$ tar -xzf apache-trafodion-clients-1.3.0-incubating-bin.tar.gz -$ cd clients -$ ls -JDBCT4.zip odb64_linux.tar.gz trafci.zip TRAF_ODBC_Linux_Driver_64.tar.gz -$ -``` -+ -You use these files to install the different {project-name} clients. - - - +//// +/** +*@@@ START COPYRIGHT @@@ +* Licensed to the Apache Software Foundation (ASF) under one +* or more contributor license agreements. See the NOTICE file +* distributed with this work for additional information +* regarding copyright ownership. The ASF licenses this file +* to you under the Apache License, Version 2.0 (the +* "License"); you may not use this file except in compliance +* with the License. You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, software +* distributed under the License is distributed on an "AS IS" BASIS, +* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +* See the License for the specific language governing permissions and +* limitations under the License. +* @@@ END COPYRIGHT @@@ +*/ +//// + +[[introduction]] += Introduction +This manual describes how to install and configure the following client applications, which enable you to connect to and use a {project-name} +database. + +== Client Summary + +=== JDBC-Based Clients + +The following table lists JDBC-based clients supported by {project-name}. +[cols="30%,70%",options="header"] +|=== +| Client Name | Description +| *{project-name} JDBC Type 4 Driver* | A driver that enables Java applications that run on a client workstation to connect to a {project-name} database. + + + +*NOTE:* The {project-name} Command Interface (trafci), DBVisualizer, and SQuirreL SQL Client require this driver to be installed on the client +workstation. +| *{project-name} Command Interface (trafci)* | A command-line interface that allows you to connect to a {project-name} database and run SQL statements and other commands interactively or from +script files. For more information, see the http://trafodion.incubator.apache.org/docs/command_interface/index.html[{project-name} Command Interface Guide]. +| *DBVisualizer* | A third-party database tool that allows you to connect to a {project-name} 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 {project-name} database. For more information, see the +http://squirrel-sql.sourceforge.net/[SQuirreL SQL Client website]. +|=== + +=== ODBC-Based Clients + +The following table lists ODBC-based clients supported by {project-name}. +[cols="30%,70%",options="header"] +|=== +| Client Name | Description +| *{project-name} ODBC Driver for Linux* | A driver that enables applications, which were developed for the Microsoft ODBC API and run on a Linux workstation, to connect to a +{project-name} database. +| *{project-name} ODBC Driver for Windows* | *[Not included in this release]*^1^ + + + +A driver that enables applications, which were developed for the Microsoft Open Database Connectivity (ODBC) application programming +interface (API) and which run on a Windows workstation, to connect to a {project-name} database. +| *{project-name} odb tool* | A multi-threaded, ODBC-based command-line tool for parallel data loading and extracting. For more information, see the +{docs-url}/odb/index.html[{project-name} odb User Guide]. +| *Tableau* | An interactive data visualization products focused on business intelligence +For more information, see the http://www.tableau.com/[Tableau Software website]. +|=== + +^1^ License issues prevent us from including the ODBC Driver for Windows in this release. Contact +{project-support} for help obtaining the driver. + + + +
