Prepared documents for TLP and centralized shared information.
Project: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/commit/21d6d8d3 Tree: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/tree/21d6d8d3 Diff: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/diff/21d6d8d3 Branch: refs/heads/master Commit: 21d6d8d36fdb21854acdd6737e597034b76552f9 Parents: 716b92e Author: Gunnar Tapper <gtapper@esgyn.local> Authored: Sun May 1 23:58:28 2016 -0600 Committer: Gunnar Tapper <gtapper@esgyn.local> Committed: Sun May 1 23:58:28 2016 -0600 ---------------------------------------------------------------------- docs/client_install/pom.xml | 10 + .../src/asciidoc/_chapters/SQuirrel.adoc | 16 +- .../src/asciidoc/_chapters/about.adoc | 16 +- .../src/asciidoc/_chapters/dbviz.adoc | 12 +- .../src/asciidoc/_chapters/introduction.adoc | 104 +++--- .../src/asciidoc/_chapters/jdbct4.adoc | 32 +- .../src/asciidoc/_chapters/odb.adoc | 8 +- .../src/asciidoc/_chapters/odbc_linux.adoc | 18 +- .../src/asciidoc/_chapters/odbc_windows.adoc | 54 +-- .../src/asciidoc/_chapters/trafci.adoc | 10 +- docs/client_install/src/asciidoc/index.adoc | 28 +- docs/command_interface/pom.xml | 8 + .../src/asciidoc/_chapters/about.adoc | 22 +- .../src/asciidoc/_chapters/commands.adoc | 40 +- .../src/asciidoc/_chapters/install.adoc | 4 +- .../src/asciidoc/_chapters/interactive.adoc | 14 +- .../src/asciidoc/_chapters/introduction.adoc | 6 +- .../src/asciidoc/_chapters/launch.adoc | 16 +- .../src/asciidoc/_chapters/perlpython.adoc | 6 +- .../src/asciidoc/_chapters/scripts.adoc | 4 +- docs/command_interface/src/asciidoc/index.adoc | 29 +- docs/cqd_reference/pom.xml | 8 + .../src/asciidoc/_chapters/about.adoc | 23 +- .../src/asciidoc/_chapters/debugging.adoc | 14 +- .../src/asciidoc/_chapters/histograms.adoc | 16 +- .../src/asciidoc/_chapters/introduction.adoc | 8 +- .../_chapters/operational_controls.adoc | 26 +- .../src/asciidoc/_chapters/query_execution.adoc | 46 +-- .../src/asciidoc/_chapters/query_plans.adoc | 78 ++-- .../asciidoc/_chapters/runtime_controls.adoc | 6 +- .../src/asciidoc/_chapters/schema_controls.adoc | 8 +- .../asciidoc/_chapters/table_definition.adoc | 28 +- .../src/asciidoc/_chapters/transactions.adoc | 6 +- .../src/asciidoc/_chapters/update_stats.adoc | 14 +- docs/cqd_reference/src/asciidoc/index.adoc | 21 +- docs/jdbct4ref_guide/src/asciidoc/index.adoc | 11 +- .../src/resources/acknowledgements.txt | 38 -- docs/load_transform/pom.xml | 8 + .../src/asciidoc/_chapters/about.adoc | 31 +- .../src/asciidoc/_chapters/bulk_load.adoc | 34 +- .../src/asciidoc/_chapters/bulk_unload.adoc | 12 +- .../src/asciidoc/_chapters/introduction.adoc | 24 +- .../src/asciidoc/_chapters/monitor.adoc | 8 +- .../src/asciidoc/_chapters/tables_indexes.adoc | 24 +- .../src/asciidoc/_chapters/trickle_load.adoc | 54 +-- .../src/asciidoc/_chapters/troubleshoot.adoc | 20 +- docs/load_transform/src/asciidoc/index.adoc | 22 +- docs/messages_guide/pom.xml | 8 + .../src/asciidoc/_chapters/about.adoc | 25 +- .../src/asciidoc/_chapters/binder_msgs.adoc | 162 ++++---- .../src/asciidoc/_chapters/compiler_msgs.adoc | 164 ++++---- .../src/asciidoc/_chapters/ddl_msgs.adoc | 156 ++++---- .../src/asciidoc/_chapters/executor_msgs.adoc | 82 ++-- .../asciidoc/_chapters/file_system_errors.adoc | 6 +- .../src/asciidoc/_chapters/generator_msgs.adoc | 4 +- .../src/asciidoc/_chapters/introduction.adoc | 34 +- .../src/asciidoc/_chapters/optimizer_msgs.adoc | 6 +- .../src/asciidoc/_chapters/parser_msgs.adoc | 74 ++-- .../src/asciidoc/_chapters/sort_msgs.adoc | 68 ++-- .../src/asciidoc/_chapters/sqlstate.adoc | 78 ++-- .../_chapters/udr_language_mgr_msgs.adoc | 26 +- docs/messages_guide/src/asciidoc/index.adoc | 21 +- docs/odb_user/pom.xml | 8 + .../src/asciidoc/_chapters/a_warnings.adoc | 4 +- docs/odb_user/src/asciidoc/_chapters/about.adoc | 24 +- .../src/asciidoc/_chapters/b_develop.adoc | 2 +- .../src/asciidoc/_chapters/compare_tables.adoc | 2 +- .../src/asciidoc/_chapters/concepts.adoc | 10 +- .../src/asciidoc/_chapters/install.adoc | Bin 13598 -> 13534 bytes .../src/asciidoc/_chapters/introduction.adoc | 36 +- docs/odb_user/src/asciidoc/_chapters/load.adoc | 12 +- .../src/asciidoc/_chapters/query_driver.adoc | 4 +- .../src/asciidoc/_chapters/sql_interpreter.adoc | 4 +- docs/odb_user/src/asciidoc/index.adoc | 21 +- docs/provisioning_guide/pom.xml | 10 + .../src/asciidoc/_chapters/about.adoc | 35 +- .../src/asciidoc/_chapters/activate.adoc | 30 +- .../src/asciidoc/_chapters/enable_security.adoc | 52 +-- .../src/asciidoc/_chapters/introduction.adoc | 184 ++++----- .../src/asciidoc/_chapters/prepare.adoc | 84 ++--- .../src/asciidoc/_chapters/requirements.adoc | 124 +++--- .../src/asciidoc/_chapters/script_install.adoc | 80 ++-- .../src/asciidoc/_chapters/script_remove.adoc | 22 +- .../src/asciidoc/_chapters/script_upgrade.adoc | 82 ++-- docs/provisioning_guide/src/asciidoc/index.adoc | 22 +- docs/shared/acknowledgements.txt | 38 ++ docs/shared/revisions.txt | 32 ++ .../spj_guide/src/asciidoc/_chapters/about.adoc | 2 +- .../src/asciidoc/_chapters/create_spjs.adoc | 36 +- .../src/asciidoc/_chapters/deploy_spjs.adoc | 34 +- .../src/asciidoc/_chapters/develop_spjs.adoc | 36 +- .../src/asciidoc/_chapters/execute_spjs.adoc | 34 +- .../src/asciidoc/_chapters/get_started.adoc | 36 +- .../asciidoc/_chapters/grant_privileges.adoc | 36 +- .../src/asciidoc/_chapters/introduction.adoc | 36 +- .../_chapters/performance_troubleshooting.adoc | 36 +- .../src/asciidoc/_chapters/sample_database.adoc | 36 +- .../src/asciidoc/_chapters/sample_spjs.adoc | 38 +- docs/spj_guide/src/asciidoc/index.adoc | 11 +- .../src/resources/acknowledgements.txt | 38 -- docs/sql_reference/pom.xml | 8 + .../src/asciidoc/_chapters/about.adoc | 48 +-- .../src/asciidoc/_chapters/introduction.adoc | 112 +++--- .../src/asciidoc/_chapters/limits.adoc | 4 +- .../src/asciidoc/_chapters/olap_functions.adoc | 19 +- .../src/asciidoc/_chapters/reserved_words.adoc | 13 +- .../src/asciidoc/_chapters/runtime_stats.adoc | 13 +- .../src/asciidoc/_chapters/sql_clauses.adoc | 26 +- .../sql_functions_and_expressions.adoc | 304 +++++++-------- .../_chapters/sql_language_elements.adoc | 160 ++++---- .../src/asciidoc/_chapters/sql_statements.adoc | 374 +++++++++---------- .../src/asciidoc/_chapters/sql_utilities.adoc | 84 ++--- docs/sql_reference/src/asciidoc/index.adoc | 27 +- 113 files changed, 2172 insertions(+), 2310 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/client_install/pom.xml ---------------------------------------------------------------------- diff --git a/docs/client_install/pom.xml b/docs/client_install/pom.xml index 0deba63..fe19517 100644 --- a/docs/client_install/pom.xml +++ b/docs/client_install/pom.xml @@ -184,6 +184,11 @@ <!-- 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>u...@trafodion.incubator.apache.org</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> @@ -209,6 +214,11 @@ <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>u...@trafodion.incubator.apache.org</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> http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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 3c3315f..563993f 100644 --- a/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc +++ b/docs/client_install/src/asciidoc/_chapters/SQuirrel.adoc @@ -21,39 +21,39 @@ //// = Configure SQuirreL Client -These configuration instructions apply to Trafodion Release 1.3.*_n_* and subsequent updates of Trafodion until otherwise indicated. +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. -* Trafodion JDBC Type-4 Driver. See <<jdbct4,Install JDBC Type-4 Driver>> 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 Trafodion 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 Trafodion 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: `Trafodion` +* Name: `{project-name}` * Example URL: `jdbc:t4jdbc://_host-name or ip-address_:37800/:` (Default port number: *23400*) <<< -=== Connect to Trafodion +=== Connect to {project-name} -Use the Add Alias dialog box and create an alias for your Trafodion System: +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 Trafodion system's host name and port number: +1. Edit the connection *URL* to match your {project-name} system's host name and port number: + *Example* + http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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 1f42ab3..25e220c 100644 --- a/docs/client_install/src/asciidoc/_chapters/about.adoc +++ b/docs/client_install/src/asciidoc/_chapters/about.adoc @@ -20,17 +20,17 @@ * 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 Trafodion database. +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 Trafodion database. +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 Trafodion Release {project-version}. It also provides instructions on how to download and install <<odb,Trafodion odb>>, a +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 @@ -160,11 +160,7 @@ match-value [NOT] LIKE _pattern ``` == Comments Encouraged -The Trafodion community encourages your comments concerning this document. We are committed to providing documentation that meets your -needs. Send any errors found, suggestions for improvement, or compliments to: - -iss...@trafodion.incubator.apache.org +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. -Or, even better, join our community and help us improve our documentation. Please refer to -http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for details. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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 b355cfb..d064e2a 100644 --- a/docs/client_install/src/asciidoc/_chapters/dbviz.adoc +++ b/docs/client_install/src/asciidoc/_chapters/dbviz.adoc @@ -30,7 +30,7 @@ Make sure that you have this software installed on your workstation: + 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?_] -* Trafodion JDBC Type-4 Driver. See <<jdbct4,Install JDBC Type-4 Driver>> above. +* {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 @@ -58,11 +58,11 @@ image:{images}/Physical_Connection.jpg[width=600,height=600,alt="DbVisualizer Ph <<< === Register JDBC Type-4 Driver -Use the DbVisualizer Driver Manager and register the Trafodion 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 Trafodion JDBC Type-4 Driver. +* Use the Open File icon and locate the {project-name} JDBC Type-4 Driver. * Use the JDBC URL format: + ``` @@ -72,10 +72,10 @@ 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 Trafodion +=== Connect to {project-name} -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; for example: `jdbc:t4jdbc://<host-name or ip-address>:37800/:` (default is: *23400*). +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] http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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 91485b7..8e9f06d 100644 --- a/docs/client_install/src/asciidoc/_chapters/introduction.adoc +++ b/docs/client_install/src/asciidoc/_chapters/introduction.adoc @@ -1,101 +1,101 @@ //// /** - *@@@ 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 @@@ - */ +*@@@ 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 Trafodion +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 Trafodion. +The following table lists JDBC-based clients supported by {project-name}. [cols="30%,70%",options="header"] |=== | Client Name | Description -| *Trafodion JDBC Type 4 Driver* | A driver that enables Java applications that run on a client workstation to connect to a Trafodion database. + +| *{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 Trafodion Command Interface (TrafCI), DbVisualizer, and SQuirreL SQL Client require this driver to be installed on the client +*NOTE:* The {project-name} 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 http://trafodion.incubator.apache.org/docs/command_interface/index.html[Trafodion Command Interface 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 +| *{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 Trafodion. +The following table lists ODBC-based clients supported by {project-name}. [cols="30%,70%",options="header"] |=== | Client Name | Description -| *Trafodion 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 -Trafodion database. -| *Trafodion ODBC Driver for Windows* | *[Not included in this release]*^1^ + +| *{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 Trafodion database. -| *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/docs/odb/index.html[Trafodion odb User Guide]. +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 the -Trafodion user e-mail list (u...@trafodion.incubator.apache.org) for help obtaining the 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-download]] == Download Installation Package -The Trafodion client software is available from the http://http://trafodion.apache.org/download.html[Trafodion Download] page. There is one -`Trafodion Clients` package per release listed under *<version> Binaries*. +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 `Trafodion Clients` package consists of a zipped tar file that contains the Trafodion Clients tar file. The Trafodion Client +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 | Trafodion odb tool. -| TFODBC64-*.exe | *[Not included in this release]*^1^ Trafodion ODBC Driver for Windows. -| TRAF_ODBC_Linux_Driver_64.tar.gz | Trafodion ODBC driver for Linux. -| trafci.zip | The Trafodion command interpreter `trafci`. -| JDBCT4.zip | Trafodion JDBC Type 4 Driver. +| 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 the -Trafodion user e-mail list (u...@trafodion.incubator.apache.org) for help obtaining the 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, `Trafodion Downloads`. +1. Create a download folder on the client workstation. For example, `{project-name} Downloads`. -2. Open a Web browser and navigate to the Trafodion downloads site http://trafodion.incubator.apache.org/download.html. +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 `Trafodion Clients` link to start downloading the Trafodion clients tar file to your workstation. +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. @@ -109,7 +109,7 @@ 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 Trafodion clients. +You use these files to install the different {project-name} clients. [[introduction-linux-download]] === Linux Download @@ -118,10 +118,10 @@ 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 Trafodion downloads site http://trafodion.incubator.apache.org/download.html. +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 `Trafodion Clients` link and select *Copy link address*. +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. @@ -141,7 +141,7 @@ JDBCT4.zip odb64_linux.tar.gz trafci.zip TRAF_ODBC_Linux_Driver_64.tar.gz $ ``` + -You use these files to install the different Trafodion clients. +You use these files to install the different {project-name} clients. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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 74b68c2..e6261ca 100644 --- a/docs/client_install/src/asciidoc/_chapters/jdbct4.adoc +++ b/docs/client_install/src/asciidoc/_chapters/jdbct4.adoc @@ -26,12 +26,12 @@ [[jdbct4-installation-requirements]] == Installation Requirements -The Trafodion JDBC Type 4 Driver requires a Java-enabled platform that supports the Java Development Kit (JDK) 1.7 or higher. +The {project-name} JDBC Type 4 Driver requires a Java-enabled platform that supports the Java Development Kit (JDK) 1.7 or higher. [[jdbct4-java-environment]] === Java Environment -The Trafodion JDBC Type 4 Driver requires that a compatible Java version be installed on the client workstation and that the Java path be set to +The {project-name} JDBC Type 4 Driver requires that a compatible Java version be installed on the client workstation and that the Java path be set to the correct location. The supported Java version is 1.7 or higher. NOTE: If you plan to do Java-based development, install the Java Development Kit (JDK) rather than the Java Runtime Environment (JRE). @@ -166,7 +166,7 @@ use the setenv command instead of export. [[jdbct4-install-instructions]] == Installation Instructions -You download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above. +You download and extract the {project-name} client package using the instructions in <<introduction-download, Download Installation Package>> above. [[jdbct4-install-driver]] === Install JDBC Type-4 Driver @@ -204,7 +204,7 @@ The content of the target directory is as follows: === Java Development -If you plan to write and run Java applications that use the Trafodion JDBC Type 4 Driver to connect to a Trafodion database, then set these +If you plan to write and run Java applications that use the {project-name} JDBC Type 4 Driver to connect to a {project-name} database, then set these 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: @@ -232,13 +232,13 @@ Set these values for your environment: * _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 *23400* by default. See the -http://trafodion.incubator.apache.org/docs/dcs_reference/index.html[Trafodion Database Connectivity Services Reference Guide] +{project-name} Database Connectivity Service (DCS) is running, which is *23400* by default. See the +http://trafodion.incubator.apache.org/docs/dcs_reference/index.html[{project-name} Database Connectivity Services Reference Guide] for information about how to configure the DCS port. *Example* -In this example, Trafodion authentication has not been enabled. Therefore, you can use a dummy +In this example, {project-name} authentication has not been enabled. Therefore, you can use a dummy user and password. If authentication is enabled, then use your user and password information. ``` @@ -257,22 +257,22 @@ NOTE: The driverâs class name is `org.trafodion.jdbc.t4.T4Driver`. == Test Programs The `README` file in the `samples` folder provide information for how you build and run sample Java programs. -You can use these programs to verify the setup of the Trafodion JDBC Type-4 driver. +You can use these programs to verify the setup of the {project-name} JDBC Type-4 driver. See the <<jdbct4-install-driver, Install JDBC Type-4 Driver>> section above for information on the different -sample programs that are included with the Trafodion JDBC Type-4 driver. +sample programs that are included with the {project-name} JDBC Type-4 driver. *Example* Build and run the StatementSample test program to verify the JDBC Type-4 driver installation. ``` -C:\Development Tools\Trafodion JDBCT4\samples>cd StatementSample +C:\Development Tools\{project-name} JDBCT4\samples>cd StatementSample -C:\Development Tools\Trafodion JDBCT4\samples\StatementSample>%JAVA_HOME%\bin\javac -classpath ..\..\lib\jdbcT4.jar *.java ..\common\*.java +C:\Development Tools\{project-name} JDBCT4\samples\StatementSample>%JAVA_HOME%\bin\javac -classpath ..\..\lib\jdbcT4.jar *.java ..\common\*.java Note: ..\common\sampleUtils.java uses or overrides a deprecated API. Note: Recompile with -Xlint:deprecation for details. v -C:\Development Tools\Trafodion JDBCT4\samples\StatementSample>%JAVA_HOME%\bin\java -classpath ..\..\lib\jdbcT4.jar;..;. -Dt4jdbc.properties=..\t4jdbc.properties StatementSample +C:\Development Tools\{project-name} JDBCT4\samples\StatementSample>%JAVA_HOME%\bin\java -classpath ..\..\lib\jdbcT4.jar;..;. -Dt4jdbc.properties=..\t4jdbc.properties StatementSample Mar 16, 2016 9:36:54 PM common.sampleUtils getPropertiesConnection INFO: DriverManager.getConnection(url, props) passed @@ -341,12 +341,12 @@ Column 12 - -100.12,-100.12 End of Data -C:\Development Tools\Trafodion JDBCT4\samples\StatementSample> +C:\Development Tools\{project-name} JDBCT4\samples\StatementSample> ``` <<< == Uninstall JDBC Type-4 Driver -Run one of these sets of commands to remove the Trafodion JDBC Type 4 Driver: +Run one of these sets of commands to remove the {project-name} JDBC Type 4 Driver: * On Linux: + @@ -408,7 +408,7 @@ C:\> == Reinstall JDBC Type-4 Driver 1. Close all applications running on the workstation, except the Web browser. -2. Download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above. -3. Install the new Trafodion JDBC Type-4 driver. See <<jdbct4-install-driver, Install JDBC Type-4 Driver>>. +2. Download and extract the {project-name} client package using the instructions in <<introduction-download, Download Installation Package>> above. +3. Install the new {project-name} JDBC Type-4 driver. See <<jdbct4-install-driver, Install JDBC Type-4 Driver>>. 4. Set up the client environment. Please refer to: <<jdbct4-setup-env, Set Up Client Environment>>. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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 ff8745d..512a0ea 100644 --- a/docs/client_install/src/asciidoc/_chapters/odb.adoc +++ b/docs/client_install/src/asciidoc/_chapters/odb.adoc @@ -28,15 +28,15 @@ The odb tool runs on 64-bit Linux. On a Linux workstation, odb requires `pthread` libraries, which are usually installed by default. It also requires the unixODBC Driver Manager to be installed and configured on the client workstation. For more information, see the -http://trafodion.apache.org/docs/odb/index.html[_Trafodion odb User Guide_]. +{docs-url}/odb/index.html[_{project-name} odb User Guide_]. [[installation-instructions]] == Installation Instructions NOTE: Before following these installation instructions, please make sure to install and configure unixODBC on the client workstation. For more -information, see the http://trafodion.apache.org/docs/odb/index.html[_Trafodion odb User Guide_]. +information, see the {docs-url}/odb/index.html[_{project-name} odb User Guide_]. -You download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above. +You download and extract the {project-name} client package using the instructions in <<introduction-download, Download Installation Package>> above. [[odb-install]] === Install odb @@ -54,7 +54,7 @@ The command extracts these files: * `README` * `/bin/odb64luo` (the odb executable) -3. You are now ready to run the odb executable. For more information, see the http://trafodion.apache.org/docs/odb/index.html[_Trafodion odb User Guide_]. +3. You are now ready to run the odb executable. For more information, see the {docs-url}/odb/index.html[_{project-name} odb User Guide_]. [[odb-uninstall]] == Uninstall odb http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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 e0419e3..6838df8 100644 --- a/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc +++ b/docs/client_install/src/asciidoc/_chapters/odbc_linux.adoc @@ -30,9 +30,9 @@ If you are building ODBC applications, please use the preferred build platform, == Installation Instructions -You download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above. +You download and extract the {project-name} client package using the instructions in <<introduction-download, Download Installation Package>> above. -The package file contains the Trafodion ODBC distribution file, `TRAF_ODBC_Linux_Driver_64.tar.gz`, which is extracted to the `clients` subdirectory. +The package file contains the {project-name} ODBC distribution file, `TRAF_ODBC_Linux_Driver_64.tar.gz`, which is extracted to the `clients` subdirectory. It contains the following files: ``` @@ -48,13 +48,13 @@ MD5SUM TRAFDSN ``` -By default, a new version of the Trafodion ODBC driver is installed in the following directories unless you specify a different directory +By default, a new version of the {project-name} ODBC driver is installed in the following directories unless you specify a different directory during installation: * `/usr/lib64` * `/etc/odbc` -NOTE: The following header files are not packaged with the Trafodion ODBC driver: + +NOTE: The following header files are not packaged with the {project-name} ODBC driver: + + - `sql.h` + - `sqlext.h` + @@ -65,7 +65,7 @@ To install those header files, <<win_odbc_client_env, Setting Up the Client Envi === Install/Reinstall Linux ODBC Driver -NOTE: You must have root access to install the Trafodion ODBC Driver for Linux at the default system location. +NOTE: You must have root access to install the {project-name} ODBC Driver for Linux at the default system location. 1. Change the directory to the clients subdirectory, and decompress the `.tar.gz` distribution file: + @@ -124,11 +124,11 @@ The `yum` command automatically installs the header files in the `/usr/include` === Enable Compression When compression is enabled in the ODBC driver, the ODBC driver can send and receive large volumes of data quickly and efficiently to and from -the Trafodion Database Connectivity Services (DCS) server over a TCP/IP network. By default, compression is disabled. +the {project-name} Database Connectivity Services (DCS) server over a TCP/IP network. By default, compression is disabled. To enable compression in the ODBC driver or to change the compression setting, follow these steps: -* If you are using the Trafodion ODBC driver manager, add +* If you are using the {project-name} ODBC driver manager, add + ``` Compression = compression-level @@ -171,7 +171,7 @@ to `odbc.ini`). NOTE: The examples after each step assume that you have default installation directories. -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 +If you have a previous version of the {project-name} 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: ``` @@ -241,7 +241,7 @@ Connect Test Passed... NOTE: The Basic SQL sample program is not currently bundled with the ODBC Linux driver. To obtain the source code for this program, see <<odbc_sample_program, `basicsql` (Sample ODBC Program)>>. -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 +If you have a previous version of the {project-name} 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: ``` http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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 98995b9..1ed67a3 100644 --- a/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc +++ b/docs/client_install/src/asciidoc/_chapters/odbc_windows.adoc @@ -24,7 +24,7 @@ = Install Windows ODBC Driver WARNING: License issues prevent us from including the ODBC Driver for Windows in this release. Contact the -Trafodion user e-mail list (u...@trafodion.incubator.apache.org) for help obtaining the driver. +{project-name} user e-mail list ({project-support}) for help obtaining the driver. == Installation Requirements @@ -45,7 +45,7 @@ Trafodion user e-mail list (u...@trafodion.incubator.apache.org) for help obtain NOTE: To install the driver on your PC, you must be logged on with a user ID that has administrator privileges. -You download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above. +You download and extract the {project-name} client package using the instructions in <<introduction-download, Download Installation Package>> above. The ODBC client installation file, `TFODBC64-*.exe`, which installs or links to multiple client components: @@ -54,7 +54,7 @@ The ODBC client installation file, `TFODBC64-*.exe`, which installs or links to | 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. +| {project-name} ODBC driver | Implements ODBC function calls to enable an ODBC client application to access the {project-name} database. | Microsoft ODBC Administrator | Adds, configures, and removes ODBC data sources on client workstations. |=== @@ -64,11 +64,11 @@ during installation: [cols="40%l,60%",options="header"] |=== | Default Installation Directory | Client Operating System -| C:\Program Files\Trafodion\TRAF | ODBC _version_ Windows 64-bit +| C:\Program Files\{project-name}\TRAF | ODBC _version_ Windows 64-bit |=== === Start the InstallShield wizard -The InstallShield wizard walks you through the steps to install the client components (Trafodion ODBC 1.0) on your workstation. You can +The InstallShield wizard walks you through the steps to install the client components ({project-name} ODBC 1.0) on your workstation. You can perform the installation in _interactive mode_, in which you provide input or accept defaults when prompted as ODBC is installed. Please refer to <<win_odbc_interactive_mode,Interactive Mode Installation>> below. @@ -78,7 +78,7 @@ Please refer to <<win_odbc_interactive_mode,Interactive Mode Installation>> belo 1. Double-click the `TFODBC64-*.exe` distribution file to start the InstallShield wizard. 2. On the *Welcome* page, click *Next*. 3. Read and select the *I accept the agreement* radio button. Click *Next*. -4. On the *Destination Folder* page, click *Install* to select the default location: `C:\Program Files\Trafodion\TRAF ODBC _version_\` +4. On the *Destination Folder* page, click *Install* to select the default location: `C:\Program Files\{project-name}\TRAF ODBC _version_\` + This location is the installation directory for ODBC header and help files. All other ODBC files are installed in `%SYSTEMROOT%\system32`. @@ -88,12 +88,12 @@ This location is the installation directory for ODBC header and help files. All === Add a client data source 1. Start the Microsoft ODBC Administrator: -* On Windows 7: *Start>All Programs>Trafodion ODBC _version_>MS ODBC Administrator* -* On Windows 8: Right-click the *Trafodion ODBC _version_* icon on the desktop and select MS ODBC Administrator. +* On Windows 7: *Start>All Programs>{project-name} ODBC _version_>MS ODBC Administrator* +* On Windows 8: Right-click the *{project-name} ODBC _version_* icon on the desktop and select MS ODBC Administrator. * On Windows 10: Right-click the Windows icon in the menu bar. Select *Settings*. Search for *Set up ODBC data sources (64-bit)*. Click on the found item. 2. In the *ODBC Data Source Administrator* dialog box, click *Add*. -3. Select *TRAF ODBC _version_*, and then click *Finish* to start the *Create a New Trafodion ODBC Data Source* wizard. +3. Select *TRAF ODBC _version_*, and then click *Finish* to start the *Create a New {project-name} ODBC Data Source* wizard. 4. Enter the data source name (for example, `Default_DataSource_Schema1`) and an optional description, and click *Next*. 5. Enter the `IP address` or `host name` for the database platform. Enter the default port number as *23400*^1^. Leave the defaults as is, and click *Next*. 6. Enter the schema name. The default schema name is `SEABASE`. Click *Next*. @@ -110,7 +110,7 @@ Click *Finish*. The wizard attempts to connect to the data source and displays a message stating whether it was successful or not. 10. Click *OK* to save the data source, or click *Cancel* _twice_ to quit the *Create Data Source* wizard. -^1^ Your specific installation may use a different port number. Check with your Trafodion administrator. +^1^ Your specific installation may use a different port number. Check with your {project-name} administrator. <<< [[win_odbc_client_env]] @@ -130,8 +130,8 @@ definitions with different schemas on the workstation. The client data source wi To create a data source on the client workstation, follow these steps: 1. Launch the *MS ODBC Administrator*. -* On Windows 7: *Start>All Programs>Trafodion ODBC _version_>MS ODBC Administrator* -* On Windows 8: Right-click the *Trafodion ODBC _version_* icon on the desktop and select MS ODBC Administrator. +* On Windows 7: *Start>All Programs>{project-name} ODBC _version_>MS ODBC Administrator* +* On Windows 8: Right-click the *{project-name} ODBC _version_* icon on the desktop and select MS ODBC Administrator. * On Windows 10: Right-click the Windows icon in the menu bar. Select *Settings*. Search for *Set up ODBC data sources (64-bit)*. Click on the found item. 2. In the *ODBC Data Source Administrator* dialog box, select the *User DSN* tab, and click *Add*. @@ -139,7 +139,7 @@ To create a data source on the client workstation, follow these steps: + A new dialog box appears, prompting you to create a new data source. 4. Enter the name of the data source, `Default_DataSource`, and click *Next* to continue. -5. Enter the IP address and port number of the Trafodion system to which will be connecting. By default, the port number is *23400*^1^. +5. Enter the IP address and port number of the {project-name} system to which will be connecting. By default, the port number is *23400*^1^. Click *Next* to continue. 6. Select the default schema. If you do not select a schema, the default is `SEABASE`. Click *Next* to continue. + @@ -147,25 +147,25 @@ Click *Next* to continue. 7. If desired, configure the *translate dll*, which translates data from one character set to another, and configure the localization. By default, the client error message language is English, and the clientâs local character set is used. Click *Finish* to continue. + -The *Test Trafodion ODBC Connection* dialog box appears, allowing you to test the connection using the data source that you created. +The *Test {project-name} ODBC Connection* dialog box appears, allowing you to test the connection using the data source that you created. 8. Click *Test Connection*. 9. When prompted, enter your user name and password, and, optionally, schema. Click *OK*. + -If the connection is successful, you will see `Connected Successfully` in the *Test Trafodion ODBC Connection* dialog box. +If the connection is successful, you will see `Connected Successfully` in the *Test {project-name} ODBC Connection* dialog box. 10. Click *OK* to save the data source, or click *Cancel* _twice_ to quit the *Create Data Source* wizard. -^1^ Your specific installation may use a different port number. Check with your Trafodion administrator. +^1^ Your specific installation may use a different port number. Check with your {project-name} administrator. === Enable Compression When compression is enabled in the ODBC driver, the ODBC driver can send and receive large volumes of data quickly and efficiently to and from -the Trafodion Database Connectivity Services (DCS) server over a TCP/IP network. By default, compression is disabled. +the {project-name} Database Connectivity Services (DCS) server over a TCP/IP network. By default, compression is disabled. To enable compression in the ODBC driver or to change the compression setting, follow these steps: 1. Launch the MS ODBC Administrator. -* On Windows 7: *Start>All Programs>Trafodion ODBC _version_>MS ODBC Administrator* -* On Windows 8: Right-click the *Trafodion ODBC _version_* icon on the desktop and select MS ODBC Administrator. +* On Windows 7: *Start>All Programs>{project-name} ODBC _version_>MS ODBC Administrator* +* On Windows 8: Right-click the *{project-name} ODBC _version_* icon on the desktop and select MS ODBC Administrator. * On Windows 10: Right-click the Windows icon in the menu bar. Select *Settings*. Search for *Set up ODBC data sources (64-bit)*. Click on the found item. 2. In the *ODBC Data Source Administrator* dialog box, select the *User DSN* tab, select the name of your data source under @@ -198,7 +198,7 @@ To build and run the executable file, follow these steps: *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 +4. Before running the sample program, create a {project-name} 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: + @@ -226,19 +226,19 @@ Basic SQL ODBC Test Passed! <<< == Reinstall Windows ODBC Driver To reinstall the driver, we recommend that you fully remove your ODBC driver and then install the new version. Please refer to -<<win_odbc_uninstall,Uninstalling the Trafodion ODBC Driver for Windows>> and then <<win_odbc_install, Installing the Trafodion ODBC Driver for Windows>>. +<<win_odbc_uninstall,Uninstalling the {project-name} ODBC Driver for Windows>> and then <<win_odbc_install, Installing the {project-name} ODBC Driver for Windows>>. [[win_odbc_uninstall]] == Uninstalling Windows ODBC Driver 1. Start to remove the ODBC driver: -* On Windows 7: *Start>All Programs>Trafodion ODBC _version_>Remove TRAF ODBC _version_* -* On Windows 8: Right-click the *Trafodion ODBC _version_* icon on the desktop and select *Remove TRAF ODBC _version_*. -* On Windows 10: Right-click the Windows icon in the menu bar. Select *Control Panel*. Click on *Uninstall a program*. Locate *Trafodion ODBC64 _version_* and select it. Click on *Uninstall*. +* On Windows 7: *Start>All Programs>{project-name} ODBC _version_>Remove TRAF ODBC _version_* +* On Windows 8: Right-click the *{project-name} ODBC _version_* icon on the desktop and select *Remove TRAF ODBC _version_*. +* On Windows 10: Right-click the Windows icon in the menu bar. Select *Control Panel*. Click on *Uninstall a program*. Locate *{project-name} ODBC64 _version_* and select it. Click on *Uninstall*. 2. When the *Windows Installer* dialog box asks you if you want to uninstall this product, click *Yes*. -3. The *Trafodion ODBC _version_* dialog box displays the status and asks you to wait while `Windows configures Trafodion ODBC _version_` (that is, removes -the Trafodion ODBC Driver from your Windows workstation). +3. The *{project-name} ODBC _version_* dialog box displays the status and asks you to wait while `Windows configures {project-name} ODBC _version_` (that is, removes +the {project-name} ODBC Driver from your Windows workstation). + -After this dialog box disappears, Trafodion ODBC _version_ is no longer on your workstation. +After this dialog box disappears, {project-name} ODBC _version_ is no longer on your workstation. NOTE: Uninstalling the ODBC driver does not remove pre-existing data source definitions from the Windows registry. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/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 2a21d2a..3ab5f7a 100644 --- a/docs/client_install/src/asciidoc/_chapters/trafci.adoc +++ b/docs/client_install/src/asciidoc/_chapters/trafci.adoc @@ -49,7 +49,7 @@ Jython open source extensions. To download them manually, see the `README` in th [[trafci-installation-instructions]] == Installation Instructions -You download and extract the Trafodion client package using the instructions in <<introduction-download, Download Installation Package>> above. +You download and extract the {project-name} client package using the instructions in <<introduction-download, Download Installation Package>> above. 1. Change the directory to the `clients` subdirectory. @@ -124,7 +124,7 @@ where you will install trafci. image:{images}/InstallerWizardPaths.jpg[trafci select path dialog] 3. To locate the JDBC driver JAR file, click *Browse* next to the *JDBC Type 4 Driver JAR File*. -4. In the *Select JDBC Type 4 Driver JAR File* dialog box, navigate to and select the lib folder of the Trafodion JDBC driver, and then click *Open*. +4. In the *Select JDBC Type 4 Driver JAR File* dialog box, navigate to and select the lib folder of the {project-name} JDBC driver, and then click *Open*. 5. Select `jdbcT4.jar` so that it appears in the *File Name* box, and then click *Select*. + The Installer Wizard now displays the path of the JDBC driver JAR file. @@ -349,9 +349,9 @@ After downloading and running the installer file, verify that the trafci softwar | 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_]. +{docs-url}/command_interface/index.html[_Trafodion Command Interface Guide_]. | | trafci.py | Python wrapper script. trafci-python.py is renamed as trafci.py. To run this script, see the -http://trafodion.incubator.apache.com/docs/command_interface/index.html[_Trafodion Command Interface Guide_]. +{docs-url}/command_interface/index.html[_Trafodion Command Interface Guide_]. | | trafci.sh | Linux launch file. | | trafci-perl.pl | Perl wrapper script. This script has been modified to invoke trafci.pl. This script is retained for backward compatibility. | | trafci-python.py | Python wrapper script. This script has been modified to invoke trafci.py. This script is retained for backward compatibility. @@ -384,7 +384,7 @@ momentarily in the trafci window before the trafci window disappears: ``` For information about setting up and using trafci, such as choosing the look and feel of the interface or presetting launch parameters, see the -http://trafodion.incubator.apache.com/docs/command_interface/index.html[Trafodion Command Interface Guide]. +{docs-url}/command_interface/index.html[Trafodion Command Interface Guide]. <<< === Windows Example http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/client_install/src/asciidoc/index.adoc ---------------------------------------------------------------------- diff --git a/docs/client_install/src/asciidoc/index.adoc b/docs/client_install/src/asciidoc/index.adoc index 9dc187f..f8ae3b8 100644 --- a/docs/client_install/src/asciidoc/index.adoc +++ b/docs/client_install/src/asciidoc/index.adoc @@ -32,7 +32,8 @@ :experimental: :source-language: text :revnumber: {project-version} -:title-logo-image: ../../../shared/trafodion-logo.jpg +:title-logo-image: {project-logo} +:project-name: {project-name} :images: ../images :sourcedir: ../../resources/source @@ -43,29 +44,14 @@ // processing of files found in directories starting with an _. This // prevents each chapter being built as its own book. -**License Statement** +include::../../shared/license.txt[] -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. +include::../../shared/acknowledgements.txt[] -**Acknowledgements** - -Microsoft(R) and Windows® are U.S. registered trademarks of Microsoft Corporation. Java® is a registered trademark of Oracle and/or its affiliates. DbVisualizer⢠is a trademark of DbVis Software AB. - -*Revision History* - -[cols="2",options="header"] -|=== -| Version | Date -| 2.0.0 | To be announced. -| 1.3.0 | January, 2016 -|=== +<<< +include::../../shared/revisions.txt[] include::asciidoc/_chapters/about.adoc[] include::asciidoc/_chapters/introduction.adoc[] http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/pom.xml ---------------------------------------------------------------------- diff --git a/docs/command_interface/pom.xml b/docs/command_interface/pom.xml index 5d24b1d..587f74d 100644 --- a/docs/command_interface/pom.xml +++ b/docs/command_interface/pom.xml @@ -184,6 +184,10 @@ <!-- 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>u...@trafodion.incubator.apache.org</project-support> + <docs-url>http://trafodion.incubator.apache.org/docs</docs-url> <build-date>${maven.build.timestamp}</build-date> <google-analytics-account>UA-72491210-1</google-analytics-account> </attributes> @@ -202,6 +206,10 @@ <outputDirectory>${basedir}/target</outputDirectory> <attributes> <project-version>${env.TRAFODION_VER}</project-version> + <project-name>Trafodion</project-name> + <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo> + <project-support>u...@trafodion.incubator.apache.org</project-support> + <docs-url>http://trafodion.incubator.apache.org/docs</docs-url> <build-date>${maven.build.timestamp}</build-date> <pdf-stylesdir>${basedir}/../shared</pdf-stylesdir> <pdf-style>trafodion</pdf-style> http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/_chapters/about.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/about.adoc b/docs/command_interface/src/asciidoc/_chapters/about.adoc index dccb28f..fb54286 100644 --- a/docs/command_interface/src/asciidoc/_chapters/about.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/about.adoc @@ -24,14 +24,14 @@ //// = About This Document -This guide describes how to use the Trafodion Command Interface (trafci) on a client workstation to connect to and query a Trafodion database. +This guide describes how to use the Trafodion Command Interface (trafci) on a client workstation to connect to and query a {project-name} database. The trafci enables you to run SQL statements interactively or from script files. == Intended Audience -This guide is intended for database administrators and support personnel who are maintaining and monitoring a Trafodion database. +This guide is intended for database administrators and support personnel who are maintaining and monitoring a {project-name} database. == New and Changed Information -This manual shows updated versions for Trafodion Release 1.3.0. +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. @@ -159,20 +159,8 @@ match-value [NOT] LIKE _pattern [ESCAPE esc-char-expression] ``` -== Publishing History -[cols="2*",options="header"] -|=== -| Product Version | Publication Date -| Trafodion Release 1.3.0 | To be announced. -|=== - == Comments Encouraged -The Trafodion community encourages your comments concerning this document. We are committed to providing documentation that meets your -needs. Send any errors found, suggestions for improvement, or compliments to: - -iss...@trafodion.incubator.apache.org +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. -Or, even better, join our community and help us improve our documentation. Please refer to -http://trafodion.incubator.apache.org/contributing_redirect.html[Trafodion Contributor Guide] for details. - http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/_chapters/commands.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/commands.adoc b/docs/command_interface/src/asciidoc/_chapters/commands.adoc index 5dbfa7f..dacf0ef 100644 --- a/docs/command_interface/src/asciidoc/_chapters/commands.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/commands.adoc @@ -32,9 +32,9 @@ TrafCI supports these commands in the command-line interface or in script files | / | Runs the previously executed SQL statement. | <<cmd_slash, / Command>> | ALIAS | Maps a string to any interface or SQL command. | <<cmd_alias, ALIAS Command>> | CLEAR | Clears the command console so that only the prompt appears at the top of the screen. | <<cmd_clear, CLEAR Command>> -| CONNECT | Creates a new connection to the Trafodion database from a current or existing TrafCI session. | <<cmd_connect, CONNECT Command>> +| CONNECT | Creates a new connection to the {project-name} database from a current or existing TrafCI session. | <<cmd_connect, CONNECT Command>> | DELAY | Allows the TrafCI session to be in sleep mode for the specified interval. | <<cmd_delay, DELAY Command>> -| DISCONNECT | Terminates the connection to the Trafodion database. | <<cmd_disconnect, DISCONNECT Command>> +| DISCONNECT | Terminates the connection to the {project-name} database. | <<cmd_disconnect, DISCONNECT Command>> | ENV | Displays attributes of the current TrafCI session. | <<cmd_env, ENV Command>> | EXIT | Disconnects from and exits the command-line interface. | <<cmd_exit, EXIT Command>> | FC | Edits and re-executes a previous command. This command is restricted to the command-line @@ -50,7 +50,7 @@ interface and is disallowed in script files. | OBEY | Runs the SQL statements and interface commands contained in a specified script file. | <<cmd_obey, OBEY Command>> | PRUN | Runs script files in parallel. | <<cmd_prun, PRUN Command>> | QUIT | Disconnects from and exits TrafCI. | <<cmd_quit, QUIT Command>> -| RECONNECT | Creates a new connection to the Trafodion database using the login credentials of the last +| RECONNECT | Creates a new connection to the {project-name} database using the login credentials of the last successful connection. | <<cmd_reconnect, RECONNECT Command>> | REPEAT | Re-executes a command. | <<cmd_repeat, REPEAT Command>> | RESET LASTERROR | Resets the last error code to `0`. | <<cmd_reset_lasterror, RESET LASTERROR Command>> @@ -347,7 +347,7 @@ specifies the host name or IP address of the database platform to which you want === Examples -* This command creates a new connection to the Trafodion database from the current or existing TrafCI session: +* This command creates a new connection to the {project-name} database from the current or existing TrafCI session: + ``` SQL> CONNECT @@ -355,10 +355,10 @@ SQL> CONNECT User Name: user1 Password: -Connected to Trafodion +Connected to {project-name} ``` -* This command creates a new connection to the Trafodion database from the current or existing TrafCI session: +* This command creates a new connection to the {project-name} database from the current or existing TrafCI session: + ``` SQL> CONNECT user1/password @@ -366,7 +366,7 @@ SQL> CONNECT user1/password Connected to Trafodion ``` -* This command creates a new connection to the Trafodion database from the current or existing TrafCI session: +* This command creates a new connection to the {project-name} database from the current or existing TrafCI session: + ``` SQL> CONNECT user1/password@host0101 @@ -374,7 +374,7 @@ SQL> CONNECT user1/password@host0101 Connected to Trafodion ``` -* This command creates a new connection to the Trafodion database from the current or existing TrafCI session: +* This command creates a new connection to the {project-name} database from the current or existing TrafCI session: + ``` SQL> CONNECT user2 @@ -446,7 +446,7 @@ is the same as the condition parameter defined for the <<cmd_if_then, IF&8230;TH === Considerations * You must enter the command on one line. The command does not require an SQL terminator. -* After you disconnect from the Trafodion database, you can still run these interface commands: +* After you disconnect from the {project-name} database, you can still run these interface commands: + [cols="15%,20%,28%,32%"] |=== @@ -464,7 +464,7 @@ is the same as the condition parameter defined for the <<cmd_if_then, IF&8230;TH <<< === Examples -This command terminates the connection to the Trafodion database. You can connect to the Trafodion database by using the `CONNECT` +This command terminates the connection to the {project-name} database. You can connect to the {project-name} database by using the `CONNECT` and `RECONNECT` commands: ``` @@ -1156,7 +1156,7 @@ SQL> LABEL MyNewLabel * This command creates a label using a quoted string: + ``` -SQL> LABEL "Trafodion Label" +SQL> LABEL "{project-name} Label" ``` <<< @@ -1826,7 +1826,7 @@ SQL> QUIT IF errorcode=4082 [[cmd_reconnect]] == RECONNECT Command -The `RECONNECT` command creates a new connection to the Trafodion database using the login credentials of the last successful connection. +The `RECONNECT` command creates a new connection to the {project-name} database using the login credentials of the last successful connection. === Syntax @@ -1843,7 +1843,7 @@ If TrafCI was invoked with the `-noconnect` launch parameter, TrafCI prompts you === Examples -* This command creates a new connection to the Trafodion database using the login credentials of the last successful connection: +* This command creates a new connection to the {project-name} database using the login credentials of the last successful connection: + ``` SQL> RECONNECT @@ -2645,7 +2645,7 @@ The parameter name and value are associated with one of these parameter types: A prepared statement is one that you SQL compile by using the PREPARE statement. For more information about PREPARE, see the -http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_]. After running `SET PARAM` commands in the session: @@ -2655,7 +2655,7 @@ After running `SET PARAM` commands in the session: that contains literal values and/or a list of the named parameters set by `SET PARAM`. The `EXECUTE` statement substitutes parameter values for the parameters in the prepared statement. For more information about `EXECUTE`, see the -http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_]. <<< === Syntax @@ -3046,7 +3046,7 @@ SQL> ``` For more information on the STATISTICS command, see the -http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_]. <<< [[cmd_set_time]] @@ -4264,8 +4264,8 @@ For more information, see <<interactive_log_output, Log Output>>. [[cmd_version]] == VERSION Command -The `VERSION` command displays the build versions of the Trafodion database, Trafodion Connectivity Service, -Trafodion JDBC Type 4 Driver, and TrafCI. +The `VERSION` command displays the build versions of the {project-name} database, {project-name} Connectivity Service, +{project-name} JDBC Type 4 Driver, and TrafCI. === Syntax @@ -4279,7 +4279,7 @@ You must enter the command on one line. The command does not require an SQL term === Example -* This command shows versions of the Trafodion database, Trafodion Connectivity Service, Trafodion JDBC Type 4 Driver, and TrafCI: +* This command shows versions of the {project-name} database, {project-name} Connectivity Service, {project-name} JDBC Type 4 Driver, and TrafCI: + ``` SQL> VERSION @@ -4294,7 +4294,7 @@ SQL> <<< * If TrafCI is started with the -noconnect parameter, the `VERSION` command displays only TrafCI and the -Trafodion JDBC Type 4 Driver versions. +{project-name} JDBC Type 4 Driver versions. + ``` C:\Program Files (x86)\Apache Software Foundation\Trafodion Command Interface\bin> TRAFCI -noconnect http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/_chapters/install.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/install.adoc b/docs/command_interface/src/asciidoc/_chapters/install.adoc index 6251908..c204432 100644 --- a/docs/command_interface/src/asciidoc/_chapters/install.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/install.adoc @@ -28,7 +28,7 @@ == Install trafci To install trafci on a client workstation, follow the procedures in the -http://trafodion.incubator.apache.org/docs/client_install/index.html[Trafodion Client Installation Guide]. +{docs-url}/client_install/index.html[{project-name} Client Installation Guide]. Ensure that you set up the Java Path per the instructions in that guide. == Test trafci Launch @@ -45,5 +45,5 @@ image:{images}/launch02.jpg[image] * The Java path is set to the correct location. See <<install_verify, Verify and Set the Java Path>>. * You installed the trafci and JDBC software files correctly. -See the http://trafodion.incubator.apache.org/docs/latest/client_install/index.html[Trafodion Client Installation Guide]. +See the {docs-url}/client_install/index.html[{project-name} Client Installation Guide]. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/_chapters/interactive.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/interactive.adoc b/docs/command_interface/src/asciidoc/_chapters/interactive.adoc index 9e73208..126ecc5 100644 --- a/docs/command_interface/src/asciidoc/_chapters/interactive.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/interactive.adoc @@ -20,7 +20,7 @@ * under the License. * * @@@ END COPYRIGHT @@@ - */ +*/ //// = Run Commands Interactively @@ -51,7 +51,7 @@ You can continue any SQL statement over multiple lines, breaking that statement within a word, a numeric literal, or a multi-character operator (for example, `<=`). To break a string literal in a DML statement, use a concatenation operator (`||`). For more information, see the concatenation operator in the -http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_]. To terminate an SQL statement that spans multiple lines, use the SQL terminator for the session. You can also include several SQL statements on the same command line provided that each one is @@ -303,7 +303,7 @@ the schema in a script file, reset the default schema for the session at the end file. For more information about the SET SCHEMA statement, see the -http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_]. The `SHOW SCHEMA` command displays the current schema for the session. @@ -443,9 +443,9 @@ For more information, see the <<cmd_help, HELP Command>>. == Run SQL Statements In trafci, you can run SQL statements interactively. trafci supports all the SQL statements, -SQL utilities, and other SQL-related commands that the Trafodion database engine supports. +SQL utilities, and other SQL-related commands that the {project-name} database engine supports. For more information about those SQL statements, see the -http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_]. To run SQL statements from script files in trafci, see <<run_scripts, Run Scripts>>. @@ -583,7 +583,7 @@ SQL> PREPARE empcom FROM ``` For the syntax of the PREPARE statement, see the -http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_]. [[interactive_set_parameters]] ==== Setting Parameters @@ -787,7 +787,7 @@ SQL> ``` For the syntax of the EXECUTE statement, see the -http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_]. <<< [[interactive_log_output]] http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/_chapters/introduction.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/introduction.adoc b/docs/command_interface/src/asciidoc/_chapters/introduction.adoc index a54532b..7d3a67c 100644 --- a/docs/command_interface/src/asciidoc/_chapters/introduction.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/introduction.adoc @@ -22,10 +22,10 @@ = Introduction The Trafodion Command Interface (trafci) is a command-line interface that you download and install on a client workstation that has the -Trafodion JDBC Type 4 Driver installed. Operating systems that support the JDBC driver include Windows and Linux. The JDBC driver connects -trafci on a client workstation to a Trafodion database. +{project-name} JDBC Type 4 Driver installed. Operating systems that support the JDBC driver include Windows and Linux. The JDBC driver connects +trafci on a client workstation to a {project-name} database. -image:{images}/VST101.jpg["trafci Connected to a Trafodion Database"] +image:{images}/VST101.jpg["trafci Connected to a {project-name} Database"] trafci enables you to perform daily administrative and database management tasks by running SQL statements or other commands interactively or from script files. You can also run trafci from a Perl or Python command line or from Perl or Python programs. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/_chapters/launch.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/launch.adoc b/docs/command_interface/src/asciidoc/_chapters/launch.adoc index 1aa42ee..f4a61ef 100644 --- a/docs/command_interface/src/asciidoc/_chapters/launch.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/launch.adoc @@ -20,7 +20,7 @@ * under the License. * * @@@ END COPYRIGHT @@@ - */ +*/ //// = Launch trafci @@ -58,7 +58,7 @@ image:{images}/shortct1.jpg[width=400,height=400,alt="Select trafci.cmd file"] image:{images}/shortct2.jpg[width=400,height=400,alt="Select shortcut from menu"] + For the locations of the installed trafci software files, -see the http://trafodion.incubator.apache.org/docs/client_install/latest/index.html[_Trafodion Client Installation Guide_]. +see the {docs-url}/client_install/index.html[_{project-name} Client Installation Guide_]. 3. Type a name for the shortcut and click *Finish*: + @@ -97,7 +97,7 @@ In the terminal window, enter: _<trafci-installation-directory>_ is the directory where you installed the trafci software files. For more information, -see the http://trafodion.incubator.apache.org/docs/latest/client_install/index.html[_Trafodion Client Installation Guide_]. +see the {docs-url}/client_install/index.html[_{project-name} Client Installation Guide_]. === Set `trafci.sh` PATH @@ -119,7 +119,7 @@ export PATH=/<trafci-installation-directory>/trafci/bin/: ... + _trafci-installation-directory_ is the directory where you installed the trafci software files. For more information, -see the http://trafodion.incubator.apache.org/docs/latest/client_install/index.html[_Trafodion Client Installation Guide_]. +see the {docs-url}/client_install/index.html[_{project-name} Client Installation Guide_]. Check that no space is after the colon (`:`) in the path. + NOTE: In the C shell, use the `setenv` command instead of `export`. @@ -335,7 +335,7 @@ Connected to Trafodion SQL> ** For a session started using redirected or piped input. In these cases, trafci returns an error message and closes the session. You must re-launch the trafci session -to connect to the Trafodion database. +to connect to the {project-name} database. <<< [[trafci_option_params]] @@ -391,7 +391,7 @@ For more information, see <<trafci_run_script, Run Script When Launching trafci> + For more information, see <<trafci_noconnect, Launch trafci Without Connecting to the Database>>. -| `-version` | Displays the build version of trafci and the Trafodion JDBC Type 4 +| `-version` | Displays the build version of trafci and the {project-name} JDBC Type 4 Driver. Upon completion of the display, the client exits. + + If any other parameters are included with the `-version` parameter, they are ignored. + @@ -543,7 +543,7 @@ SQL>SET SQLPROMPT * [[trafci_noconnect]] == Launch trafci Without Connecting to the Database -To start trafci without connecting to a Trafodion database, use the `-noconnect option`. +To start trafci without connecting to a {project-name} database, use the `-noconnect option`. See <<cmd_disconnect, `DISCONNECT` command>> for a list of interface commands that can be run without a connection. @@ -566,7 +566,7 @@ cd <trafci-installation-directory>/trafci/bin <<< [[trafci_with_version]] == Run trafci With `-version` -To display the build version of trafci and the Trafodion JDBC Type 4 Driver, use the `-version` +To display the build version of trafci and the {project-name} JDBC Type 4 Driver, use the `-version` option. If other parameters are included with the `-version` parameter, they are ignored. *Example* http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/_chapters/perlpython.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/perlpython.adoc b/docs/command_interface/src/asciidoc/_chapters/perlpython.adoc index 2516849..3c80303 100644 --- a/docs/command_interface/src/asciidoc/_chapters/perlpython.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/perlpython.adoc @@ -20,7 +20,7 @@ * under the License. * * @@@ END COPYRIGHT @@@ - */ +*/ //// = Run trafci From Perl or Python @@ -198,7 +198,7 @@ You can launch the Perl or Python wrapper scripts as shown below: === Example Perl Program (`sample.pl`) You can download the `sample.pl` example from -http://trafodion.incubator.apache.org/docs/command_interface/resources/source/sample.pl. +{docs-url}/command_interface/resources/source/sample.pl. Alternatively, copy and paste the following code into a file named `sample.pl`: @@ -211,7 +211,7 @@ include::{sourcedir}/sample.pl[] === Example Python Program (`sample.py`) You can download the `sample.py` example from -http://trafodion.incubator.apache.org/docs/command_interface/resources/source/sample.py. +{docs-url}/command_interface/resources/source/sample.py. Alternatively, copy and paste the following code into a file named `sample.py`: http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/_chapters/scripts.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/_chapters/scripts.adoc b/docs/command_interface/src/asciidoc/_chapters/scripts.adoc index e74107d..245ca9d 100644 --- a/docs/command_interface/src/asciidoc/_chapters/scripts.adoc +++ b/docs/command_interface/src/asciidoc/_chapters/scripts.adoc @@ -20,7 +20,7 @@ * under the License. * * @@@ END COPYRIGHT @@@ - */ +*/ //// = Run Scripts @@ -45,7 +45,7 @@ that run trafci, see <<perl_or_python, Run trafci from Perl or Python>>. Script files support any of the various SQL statements that you can run in trafci. For more information about SQL statements, see the -http://trafodion.incubator.apache.org/docs/sql_reference/index.html[_Trafodion SQL Reference Manual_]. +{docs-url}/sql_reference/index.html[_{project-name} SQL Reference Manual_]. [[script_commands]] == Commands http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/command_interface/src/asciidoc/index.adoc ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/asciidoc/index.adoc b/docs/command_interface/src/asciidoc/index.adoc index a9d1bec..dc5739b 100644 --- a/docs/command_interface/src/asciidoc/index.adoc +++ b/docs/command_interface/src/asciidoc/index.adoc @@ -32,7 +32,8 @@ :experimental: :source-language: text :revnumber: {project-version} -:title-logo-image: ../../../shared/trafodion-logo.jpg +:title-logo-image: {project-logo} +:project-name: {project-name} :images: ../images :sourcedir: ../../resources/source @@ -42,29 +43,13 @@ // processing of files found in directories starting with an _. This // prevents each chapter being built as its own book. -**License Statement** +include::../../shared/license.txt[] +<<< -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 +include::../../shared/acknowledgements.txt[] -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. - -**Acknowledgements** - -Microsoft® and Windows® are U.S. registered trademarks of Microsoft Corporation. Java® is a registered trademark of Oracle and/or its affiliates. DbVisualizer⢠is a trademark of DbVis Software AB. - -*Revision History* - -[cols="2",options="header"] -|=== -| Version | Date -| 2.0.0 | To be announced. -| 1.3.0 | January, 2016 -|=== +<<< +include::../../shared/revisions.txt[] include::asciidoc/_chapters/about.adoc[] include::asciidoc/_chapters/introduction.adoc[] http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/21d6d8d3/docs/cqd_reference/pom.xml ---------------------------------------------------------------------- diff --git a/docs/cqd_reference/pom.xml b/docs/cqd_reference/pom.xml index 2075c15..cfc3c80 100644 --- a/docs/cqd_reference/pom.xml +++ b/docs/cqd_reference/pom.xml @@ -186,6 +186,10 @@ <!-- 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>u...@trafodion.incubator.apache.org</project-support> + <docs-url>http://trafodion.incubator.apache.org/docs</docs-url> <build-date>${maven.build.timestamp}</build-date> <google-analytics-account>UA-72491210-1</google-analytics-account> </attributes> @@ -204,6 +208,10 @@ <outputDirectory>${basedir}/target</outputDirectory> <attributes> <project-version>${env.TRAFODION_VER}</project-version> + <project-name>Trafodion</project-name> + <project-logo>${basedir}/../shared/trafodion-logo.jpg</project-logo> + <project-support>u...@trafodion.incubator.apache.org</project-support> + <docs-url>http://trafodion.incubator.apache.org/docs</docs-url> <build-date>${maven.build.timestamp}</build-date> <pdf-stylesdir>${basedir}/../shared</pdf-stylesdir> <pdf-style>trafodion</pdf-style>
