Return-Path: X-Original-To: apmail-trafodion-commits-archive@www.apache.org Delivered-To: apmail-trafodion-commits-archive@www.apache.org Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by minotaur.apache.org (Postfix) with SMTP id 4F0C218B35 for ; Thu, 14 Jan 2016 18:18:26 +0000 (UTC) Received: (qmail 96111 invoked by uid 500); 14 Jan 2016 18:18:26 -0000 Delivered-To: apmail-trafodion-commits-archive@trafodion.apache.org Received: (qmail 96082 invoked by uid 500); 14 Jan 2016 18:18:26 -0000 Mailing-List: contact commits-help@trafodion.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: commits@trafodion.apache.org Delivered-To: mailing list commits@trafodion.apache.org Received: (qmail 96027 invoked by uid 99); 14 Jan 2016 18:18:26 -0000 Received: from Unknown (HELO spamd1-us-west.apache.org) (209.188.14.142) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 14 Jan 2016 18:18:26 +0000 Received: from localhost (localhost [127.0.0.1]) by spamd1-us-west.apache.org (ASF Mail Server at spamd1-us-west.apache.org) with ESMTP id 9178BC056A for ; Thu, 14 Jan 2016 18:18:25 +0000 (UTC) X-Virus-Scanned: Debian amavisd-new at spamd1-us-west.apache.org X-Spam-Flag: NO X-Spam-Score: 1.81 X-Spam-Level: * X-Spam-Status: No, score=1.81 tagged_above=-999 required=6.31 tests=[KAM_ASCII_DIVIDERS=0.8, KAM_LAZY_DOMAIN_SECURITY=1, RP_MATCHES_RCVD=-0.001, T_FILL_THIS_FORM_SHORT=0.01, URIBL_BLOCKED=0.001] autolearn=disabled Received: from mx1-us-west.apache.org ([10.40.0.8]) by localhost (spamd1-us-west.apache.org [10.40.0.7]) (amavisd-new, port 10024) with ESMTP id G_VBHhVSmK1r for ; Thu, 14 Jan 2016 18:18:10 +0000 (UTC) Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by mx1-us-west.apache.org (ASF Mail Server at mx1-us-west.apache.org) with SMTP id 0694B20CCD for ; Thu, 14 Jan 2016 18:18:05 +0000 (UTC) Received: (qmail 94447 invoked by uid 99); 14 Jan 2016 18:18:05 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Thu, 14 Jan 2016 18:18:05 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 82006E3892; Thu, 14 Jan 2016 18:18:05 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit From: svarnau@apache.org To: commits@trafodion.incubator.apache.org Date: Thu, 14 Jan 2016 18:18:14 -0000 Message-Id: <19367a1e9a87446ab99f581341d8d426@git.apache.org> In-Reply-To: <3aad26bdc11743f787cd4a32bac0850f@git.apache.org> References: <3aad26bdc11743f787cd4a32bac0850f@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [10/42] incubator-trafodion git commit: Rechecking of asciidoc conversion due to weird Windows10 upgrade. http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/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 new file mode 100644 index 0000000..0a4b24f --- /dev/null +++ b/docs/command_interface/src/asciidoc/_chapters/install.adoc @@ -0,0 +1,99 @@ +//// +/** +* @@@ 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 @@@ + */ +//// + +[[install]] += Install and Configure + +== Install TrafCI +To install TrafCI on a client workstation, follow the procedures in the +http://trafodion.incubator.apache.org/docs/client_install/index.html[_Trafodion Client Installation Guide_]. + +[[install_verify]] +== Verify and Set the Java Path +=== Set PATH on Windows + +1. Right-click the *Computer* icon on your desktop, and then select *Properties*. +The *Control Panel->System and Security->System* window appears. +2. In the left navigation bar, click the *Advanced* system settings link. +3. In the *System Properties* dialog box, click the *Environment Variables* button. +4. Under _System variables_, select the variable named *Path*, and then click *Edit*: ++ +image:{images}/path2.jpg[image] + +5. Place the cursor at the beginning of the _Variable_ value field and enter the path of the Java +`bin` directory, ending with a semicolon (`;`): ++ +image:{images}/varval2.jpg[image] ++ +==== +*"C:\Program Files (x86)\Java\jre7\bin";* +==== ++ +NOTE: Check that no space exists after the semicolon (;) in the path. If there are spaces in the directory name, delimit the entire directory +path in double quotes (") before the semicolon. + +6. Click *OK*. +7. Verify that the updated Path appears under _System variables_, and click OK. +8. In the *System Properties* dialog box, click *OK* to accept the changes. + +=== Set PATH on Linux +1. Open the user profile (`.profile` or `.bash_profile` for the Bash shell) in the `$HOME` directory. ++ +==== +*vi .profile* +==== + +2. In the user profile, set the `PATH` environment variable to include path of the Java bin +directory. ++ +==== +*export PATH=/opt/java1.7/jre/bin:$PATH* +==== ++ +NOTE: Place the path of the Java bin directory before `$PATH`, and check that no space exists after the colon (`:`) in the path. +In the C shell, use the `setenv` command instead of export. + +3. To activate the changes, either log out and log in again or execute the user profile. ++ +==== +*. .profile* +==== + +== Test TrafCI Launch +1. Launch TrafCI and verify that you can connect to the database. For +instructions, see <>. ++ +This window should appear: ++ +image:{images}/launch02.jpg[image] + +2. If you cannot launch TrafCI or connect to the database, verify that: ++ +* The database platform is available and running, and the port number is correct for the database platform. +* The Java path is set to the correct location. See <>. +* 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_]. + http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/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 new file mode 100644 index 0000000..caee6d5 --- /dev/null +++ b/docs/command_interface/src/asciidoc/_chapters/interactive.adoc @@ -0,0 +1,954 @@ +//// +/** +* @@@ 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 @@@ + */ +//// + += Run Commands Interactively +After launching TrafCI, you can run SQL statements and interface commands in the command-line interface. + +== User Inteface + +=== Product Banner + +After you launch TrafCI and connect to the database platform, the product banner appears in the +command-line interface: + +image:{images}/launch02.jpg[Product banner] + +=== Interface Prompt + +The standard prompt is `SQL>`. You can change the prompt, `SQL>`, to something else by using the +`SET SQLPROMPT` or `SET PROMPT` command. For more information, +<>. + +=== Break the Command Line + +You cannot break an interface command over multiple lines. Each interface command must be entered +on one line. If you accidentally break an interface command across more than one line, enter the +SQL terminator and then reenter the command on one line. + +You can continue any SQL statement over multiple lines, breaking that statement at any point except +within a word, a numeric literal, or a multicharacter 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/sql_reference/index.html[_Trafodion 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 +terminated by the SQL terminator. For more information, see +<>. + +<<< +=== Case Sensitivity + +In the command-line interface, you can enter SQL statements and interface commands in uppercase, +lowercase, or mixed-case characters. All parts of statements and commands are case-insensitive except +for parts that you enclose in single-quotes (`'`) or double-quotes (`"`). + +<<< +== Interface Commands + +The interface commands allow you to customize TrafCI (for example, by using `SET` commands) or +return information about the interface settings or database objects (for example, +by using `SHOW commands`). + +For more information about the interface commands, see <>. + +NOTE: Each interface command must be entered on one line. If you accidentally break an interface +command across more than one line, enter the SQL terminator and then reenter the command on one line. + +=== Show Session Attributes + +To display the attributes and settings of the current TrafCI session, use the `ENV`, `SHOW SESSION`, +or `SESSION` command. + +*Example* + +This SESSION command displays the session attributes: + +==== +`SQL>`*session* +``` +COLSEP " " +HISTOPT DEFAULT [No expansion of script files] +IDLETIMEOUT 0 min(s) [Never Expires] +LIST_COUNT 0 [All Rows] +LOG FILE c:\session.txt +LOG OPTIONS APPEND,CMDTEXT ON +MARKUP RAW +PROMPT SQL> +SCHEMA SEABASE +SERVER sqws135.houston.host.com:37800 +SQLTERMINATOR ; +STATISTICS OFF +TIME OFF +TIMING OFF +USER user1 +``` +`SQL>` +==== + +For more information, see <> <>. + +<<< +[[interactive_idle_timeout]] +=== Set and Show Session Idle Timeout Value + +The idle timeout value of a session determines when the session expires after a period of inactivity. +To set the idle timeout value of a session, enter the `SET IDLETIMEOUT` command. + +*Example* + +This `SET IDLETIMEOUT 0` command sets the idle timeout to an infinite amount of time so that the +session never expires: + +==== +`SQL>`*set idletimeout 0* + +`SQL>` +==== + +To show the idle timeout value that is in effect for the session, enter the `SHOW IDLETIMEOUT` command. + +*Example* + +This `SHOW IDLETIMEOUT` command displays an idle timeout of zero minutes, which means that the session +never expires: + +==== +`SQL>`*show idletimeout* +``` +IDLETIMEOUT 0 min(s) [Never Expires] + +``` +`SQL>` +==== + +For more information, see the <> and the +<. + +<<< +[[interactive_customize_prompt]] +=== Customize the Standard Prompt + +To change the standard prompt in the command-line interface, use one or both of these commands: + +==== SET PROMPT Command + +The `SET PROMPT` command changes the default prompt to a specified character or string. + +*Example* + +This `SET PROMPT` command changes the prompt to the current user (`user1`) and `ENTER>`: + +==== +`SQL>`*set prompt "%USER ENTER>"* + + + +`user1 ENTER>` +==== + +For more information, see <>. + +==== SET TIME Command + +The `SET TIME ON` command causes the current time of the client workstation to be +displayed in the prompt: + +==== +`SQL ENTER>` *set time on* + + + +`20:32:26 SQL ENTER>` +==== + +The `SET TIME OFF` command removes the current time from the prompt: + +==== +`20:32:26 SQL ENTER>` *set time off* + + + +`SQL ENTER>` +==== + +For more information, see the <>. + +<<< +[[interactive_set_show_terminator]] +=== Set and Show the SQL Terminator + +The SQL terminator symbolizes the end of an SQL statement. By default, the SQL terminator +is a semicolon (`;`). + +To change the SQL terminator, enter the `SET SQLTERMINATOR` command. + +*Example* + +This SET SQLTERMINATOR command sets the SQL terminator to a period (`.`): + +==== +`SQL>`*set sqlterminator .* + +`SQL>`*insert into sales.custlist* + +`+>` *(select * from invent.supplier* + +`+>` *where suppnum=8).* +``` +--- 1 row(s) inserted. SQL> +``` +==== + +To show the SQL terminator that is in effect for the session, enter the `SHOW SQLTERMINATOR` command. + +*Example* + +This `SHOW SQLTERMINATOR` command displays SQLTERMINATOR `.`, where the period (`.`) is the +SQL terminator for the session: + +==== +`SQL>`*show sqlterminator* +``` +SQLTERMINATOR . +``` +`SQL>` +==== + +For more information, see the <> and +the <>. + +<<< +[[interactive_display_elapsed_time]] +=== Display the Elapsed Time + +By default, TrafCI does not display the elapsed time of an SQL statement after the statement +executes. To display the elapsed time after each SQL statement executes, enter the `SET TIMING ON` +command: + +==== +`SQL>`*set timing on* + +`SQL>`*select suppname, street, city, state, postcode* + +`+>` *from invent.supplier* + +`+>` *where suppnum=3;* +``` +SUPPNAME STREET CITY STATE POSTCODE +----------------- -------------------- -------------- ------------ ---------- +HIGH DENSITY INC 7600 EMERSON NEW YORK NEW YORK 10230 + +--- 1 row(s) selected. Elapsed :00:00:00.111 SQL> +``` +==== + +To prevent the elapsed time from being displayed after each SQL statement executes, +enter the `SET TIMING OFF` command: + +==== +`SQL>`*set timing off* + +`SQL>`*/* +``` +SUPPNAME STREET CITY STATE POSTCODE +----------------- -------------------- -------------- ------------ ---------- +HIGH DENSITY INC 7600 EMERSON NEW YORK NEW YORK 10230 + +--- 1 row(s) selected. +``` +`SQL>` +==== + +For more information, see the <>. + +<<< +[[interactive_set_show_current_schema]] +=== Set and Show the Current Schema + +By default, the schema of the session is `USR`. The SQL statement, `SET SCHEMA`, +allows you to set the schema for the TrafCI session. + +*Example* + +This `SET SCHEMA` statement changes the default schema to `PERSNL` for the session: + +==== +`SQL>`*set schema persnl;* +``` +--- SQL operation complete. +``` +`SQL>`*delete from employee* + +`+>` *where first_name='TIM' and* + +`+>` *last_name='WALKER';* +``` +--- 1 row(s) deleted. +``` +`SQL>` +==== + +The schema that you specify with `SET SCHEMA` remains in effect until the end of the session +or until you execute another `SET SCHEMA` statement. + +If you execute this statement in a script file, it affects not only the SQL statements in the +script file but all subsequent SQL statements that are run in the current session. If you set +the schema in a script file, reset the default schema for the session at the end of the script +file. + +For more information about the SET SCHEMA statement, see the +http://trafodion.incubator.apache.org/sql_reference/index.html[_Trafodion SQL Reference Manual_]. + +The `SHOW SCHEMA` command displays the current schema for the session. + +*Example* + +This `SHOW SCHEMA` command displays `SCHEMA PERSNL`, where `PERSNL` is the name of the current +schema for the session: + +==== +`SQL>`*show schema SCHEMA PERSNL* + +`SQL>` +==== + +For more information, <>. + +=== Limit Query Result Set + +To set the maximum number of rows to be returned by `SELECT` statements that are executed +in the session, enter the `SET LIST_COUNT` command. + +*Example* + +This `SET LIST_COUNT` command limits the result set of queries to 20 rows: + +==== +`SQL>`*set list_count 20* +==== + +To show the limit that is in effect for the session, enter the `SHOW LIST_COUNT` command. + +*Example* + +This `SHOW LIST_COUNT` command shows that the number of rows returned by `SELECT` statements +is unlimited: + +==== +`SQL>`*show list_count* +``` +LISTCOUNT 0 [All Rows] +``` +==== + +For more information, see the <> and +<>. + +<<< +[[interactive_history]] +=== Display Executed Commands + +To display commands that were recently executed in the TrafCI session, enter the +`HISTORY` command. The `HISTORY` command associates each command with a number that +you can use to reexecute or edit the command with the `FC` command. See +<>. + +*Example* + +This `HISTORY` command displays a maximum of 100 commands that were entered in the session: + +==== +`SQL>`*history* +``` +1> set idletimeout 0 +2> set schema persnl; +3> select * from project; +``` +`SQL>` +==== + +To save the session history in a user-specified file, enter the `SAVEHIST` command. + +*Example* + +This `SAVEHIST` command saves the session history inca file named `history.txt` in the +local directory where you are running TrafCI: + +==== +`SQL>`*savehist history.txt* +==== + +For more information, see the <> and +the <>. + +<<< +[[edit_reexecute_command]] +=== Edit and Reexecute a Command + +To edit and reexecute a command in the history buffer of an TrafCI session, enter the `FC` command. +To display the commands in the history buffer, use the `HISTORY` command. See +<>. + +*Example* + +This *FC* command and its delete (`D`) editing command correct a `SELECT` statement that was entered incorrectly: + +==== +`SQL>`*fc* +``` +SQL> selecct * from employee; + .... d +SQL> select * from employee; +``` +==== + +Pressing Enter executes the corrected `SELECT` statement. For more information, see the +<>. + +<<< +=== Clear the Interface Window + +After entering commands in TrafCI, you can clear the interface window by using the `CLEAR` command. + +*Example* + +This `CLEAR` command clears the interface window so that only the prompt appears at the top of the +window: + +==== +`SQL>`*clear* +==== + +For more information, see the <>. + +=== Obtain Help + +To display help text for an interface command that is supported in TrafCI, enter the `HELP` command. + +*Example* + +This `HELP` command displays syntax and examples of the `FC` command: + +==== +`SQL>`*help fc* +==== + +For more information, see the <>. + +<<< +== 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. +For more information about those SQL statements, see the +http://trafodion.incubator.apache.org/sql_reference/index.html[_Trafodion SQL Reference Manual_]. + +To run SQL statements from script files in TrafCI, see <>. + +=== Execute an SQL Statement + +*Example* + +You can query the `EMPLOYEE` table and return an employee’s salary by executing this `SELECT` statement +in TrafCI: + +==== +`SQL>`*select salary* + +`+>` *from persnl.employee* + +`+>` *where jobcode=100;* +``` +SALARY +---------- + 175500.00 + 137000.10 + 139400.00 + 138000.40 + 75000.00 + 90000.00 + 118000.00 + 80000.00 + 70000.00 + 90000.00 + 56000.00 + +--- 11 row(s) selected. +``` +`SQL>` +==== + +If the SQL statement executes successfully, TrafCI returns a message indicating that the SQL +operation was successful, followed by the standard prompt. If a problem occurs during the +execution of the SQL statement, TrafCI returns an error message. + +<<< +=== Repeat an SQL Statement + +To run a previously executed SQL statement, use the `/`, `RUN`, or `REPEAT` command. + +==== +`SQL>`*/* +``` +SALARY +---------- + 175500.00 + 137000.10 + 139400.00 + 138000.40 + 75000.00 + 90000.00 + 118000.00 + 80000.00 + 70000.00 + 90000.00 + 56000.00 + +--- 11 row(s) selected. +``` +`SQL>` +==== + +For more information, see the <>, +<>, or <>. + +<<< +=== Prepare and Execute SQL Statements + +You can prepare, or compile, an SQL statement by using the `PREPARE` statement and +later execute the prepared SQL statement by using the `EXECUTE` statement. + +==== Prepare an SQL Statement + +Use the `PREPARE` statement to compile an SQL statement for later execution with the +`EXECUTE` statement. You can also use the `PREPARE` statement to check the syntax of +an SQL statement without executing the statement. + +*Example* + +This `PREPARE` statement compiles a `SELECT` statement named empsal and detects a syntax error: + +==== +`SQL>`*prepare empsal from* + +`+>` *select salary from employee* + +`+>` *where jobcode = 100;* + +`SQL>` +==== + +You can then correct the syntax of the SQL statement and prepare it again: + +==== +`SQL>`*prepare empsal from* + +`+>` *select salary from persnl.employee* + +`+>` *where jobcode = 100;* +``` +--- SQL command prepared. +``` +==== + +To specify a parameter to be supplied later, either in a `SET PARAM` statement or +in the `USING` clause of an `EXECUTE` statement, use one of these types of parameters +in the SQL statement: + +* Named parameter, which is represented by `?_param-name_` +* Unnamed parameter, which is represented by a question mark (`?`) character + +<<< +*Example* + +This prepared `SELECT` statement specifies unnamed parameters for salary and job code: + +==== +`SQL>`*prepare findemp from* + +`+>` *select * from persnl.employee* + +`+>` *where salary > ? and jobcode = ?;* +``` +--- SQL command prepared. +``` +==== + +This PREPARE statement prepares another `SELECT` statement named `empcom`, which has one +named parameter, `?_dn_`, for the department number, which appears twice in the statement: + +==== +`SQL>`*prepare empcom from* + +`+>` *select first_name, last_name, deptnum* + +`+>` *from persnl.employee* + +`+>` *where deptnum <> ?dn and salary <=* + +`+>` *(select avg(salary)* + +`+>` *from persnl.employee* + +`+>` *where deptnum = ?dn);* +``` +--- SQL command prepared. +``` +==== + +For the syntax of the PREPARE statement, see the +http://trafodion.incubator.apache.org/sql_reference/index.html[_Trafodion SQL Reference Manual_]. + +[[interactive_set_parameters]] +==== Set Parameters + +In an TrafCI session, you can set a parameter of an SQL statement (either prepared or not) +by using the `SET PARAM` command. + +NOTE: The parameter name is case-sensitive. If you specify it in lowercase in the +`SET PARAM` command, you must specify it in lowercase in other statements, such as +DML statements or `EXECUTE`. + +<<< +*Example* + +This SET PARAM command sets a value for the parameter named `?sal`, which you can apply +to one of the unnamed parameters in the prepared findemp statement or to a named parameter +with an identical name in an SQL statement: + +==== +`SQL>`*set param ?sal 40000.00* +==== + +This `SELECT` statement uses sal as a named parameter: + +==== +`SQL>`*select last_name* + +`+>` *from persnl.employee* + +`+>` *where salary = *?sal*;* +==== + +This `SET PARAM` command sets a value for the parameter named `dn`, which you can apply +to the named parameter, `?dn`, in the prepared `empcom` statement or to a named parameter +with an identical name in an SQL statement: + +==== +`SQL>`*set param ?dn 1500* +==== + +For the syntax of the `SET PARAM` command, see the <>. + +[[interactive_display_session_parameters]] +==== Display Session Parameters + +To determine what parameters you have set in the current session, use the `SHOW PARAM` command. + +*Example* + +This `SHOW PARAM` command displays the recent `SET PARAM` settings: + +==== +`SQL>`*show param dn 1500* +``` +sal 40000.00 +``` +`SQL>` +==== + +For the syntax of the `SHOW PARAM` command, <>. + +<<< +[[interactive_reset_parameters]] +==== Reset the Parameters + +To change the value of a parameter, specify the name of the parameter in the `RESET PARAM` +command and then use the `SET PARAM` command to change the setting. + +*Example* + +Suppose that you want to change the salary parameter to `80000.00`: + +==== +`SQL>`*reset param ?sal* + +`SQL>`*set param ?sal 80000.00* + +`SQL>` +==== + +Entering the `RESET PARAM` command without specifying a parameter name clears all +parameter settings in the session. + +*Example* + +==== +`SQL>`*reset param* + +`SQL>`*show param* + +`SQL>` +==== + +To use the parameters that you had set before, you must reenter them in the session: + +==== +`SQL>`*set param ?dn 1500* + +`SQL>`*set param ?sal 80000.00* + +`SQL>`*show param dn 1500* + +``` +sal 80000.00 +``` +`SQL>` +==== + +For the syntax of the `RESET PARAM` command, see the <>. + +<<< +=== Execute a Prepared SQL Statement + +To execute a prepared SQL statement, use the `EXECUTE` statement. + +*Example* + +This `EXECUTE` statement executes the prepared `empsal` statement, which does not have any parameters: + +==== +`SQL>`*execute empsal;* +``` +SALARY +---------- + 137000.10 + 90000.00 + 75000.00 + 138000.40 + 56000.00 + 136000.00 + 80000.00 + 70000.00 + 175500.00 + 90000.00 + 118000.00 + +--- 11 row(s) selected. +``` +`SQL>` +==== + +<<< +This `EXECUTE` statement executes the prepared empcom statement, which has one named parameter, +`?dn`, which was set by `SET PARAM` for the department number: + +==== +`SQL>`*execute empcom;* +``` +FIRST_NAME LAST_NAME DEPTNUM +--------------- -------------------- ------- +ALAN TERRY 3000 +DAVID TERRY 2000 +PETE WELLINGTON 3100 +JOHN CHOU 3500 +MANFRED CONRAD 4000 +DINAH CLARK 9000 +DAVE FISHER 3200 +GEORGE FRENCHMAN 4000 +KARL HELMSTED 4000 +JOHN JONES 4000 +JOHN HUGHES 3200 +WALTER LANCASTER 4000 +MARLENE BONNY 4000 +BILL WINN 2000 +MIRIAM KING 2500 +GINNY FOSTER 3300 +``` +==== +<<< +==== +``` +MARIA JOSEF 4000 +HERB ALBERT 3300 +RICHARD BARTON 1000 +XAVIER SEDLEMEYER 3300 +DONALD TAYLOR 3100 +LARRY CLARK 1000 +JIM HERMAN 3000 +GEORGE STRICKER 3100 +OTTO SCHNABL 3200 +TIM WALKER 3000 +TED MCDONALD 2000 +PETER SMITH 3300 +MARK FOLEY 4000 +HEIDI WEIGL 3200 +ROCKY LEWIS 2000 +SUE CRAMER 1000 +MARTIN SCHAEFFER 3200 +HERBERT KARAJAN 3200 +JESSICA CRINER 3500 + +--- 35 row(s) selected. +``` +`SQL>` +==== + +<<< +This `EXECUTE` statement executes the prepared findemp statement, which has two +unnamed parameters: `?sal`, which was set by `SET PARAM` for the salary, and a +parameter that was not set in advance for the job code: + +==== +`SQL>`*execute findemp using ?sal, 100;* +``` +EMP_NUM FIRST_NAME LAST_NAME DEPTNUM JOBCODE SALARY +------- --------------- -------------------- ------- ------- --------- + 213 ROBERT WHITE 1500 100 90000.00 + 23 JERRY HOWARD 1000 100 137000.10 + 1 ROGER GREEN 9000 100 175500.00 + 29 JANE RAYMOND 3000 100 136000.00 + 32 THOMAS RUDLOFF 2000 100 138000.40 +` 43 PAUL WINTER 3100 100 90000.00 + 65 RACHEL MCKAY 4000 100 118000.00 + +--- 7 row(s) selected. SQL> +``` +==== + +For the syntax of the EXECUTE statement, see the +http://trafodion.incubator.apache.org/sql_reference/index.html[_Trafodion SQL Reference Manual_]. + +<<< +[[interactive_log_output]] +== Log Output + +To log an TrafCI session, use the `SPOOL` or `LOG` command. The `SPOOL` and `LOG` commands +record into a log file the commands that you enter in the command-line interface and the +output of those commands. + +=== Start the Logging Process + +To start logging, enter one of these commands: + +* `SPOOL ON` or `LOG ON` +* `SPOOL _log-file_` or `LOG _log-file_` + +For more information, see the <> and +the <>. + +<<< +==== `SPOOL ON` or `LOG ON` Command + +The `SPOOL ON` or `LOG ON` command logs information about a session in the `sqlspool.lst` +file, which TrafCI stores in the bin directory: + +* On Windows: ++ +==== +`_trafci-installation-directory_\Trafodion Command Interface\bin\sqlspool.lst` +==== ++ +`_trafci-installation-directory_` is the directory where you installed the +TrafCI software files. + +* On Linux: ++ +==== +`_trafci-installation-directory_/trafci/bin/sqlspool.lst` +==== ++ +`_trafci-installation-directory_` is the directory where you installed +the TrafCI software files. + +*Example* + +This SPOOL ON command starts logging the session in the `sqlspool.lst` file: + +==== +`SQL>`*spool on* +==== + +=== `SPOOL _log-file_` or `LOG _log-file_` Command + +The `SPOOL _log-file_` and `LOG _log-file_` commands record information about a session +in a log file that you specify. If you specify a directory for the log file, the +directory must exist as specified. Otherwise, an error occurs when you try to run the +`SPOOL` or `LOG` command. If you do not specify a directory for the log file, TrafCI uses the +`bin` directory. + +*Example* + +This `SPOOL _log-file_` command starts logging the session in the `persnl_updates.log` file in +the `C:\log directory`: + +==== +`SQL>`*spool C:\log\persnl_updates.log* +==== + +<<<< +==== Using the `CLEAR` Option + +The `CLEAR` option clears the contents of an existing log file before logging new information to +the file. If you omit `CLEAR`, TrafCI appends new information to existing information in the log file. + +*Example* + +This `SPOOL _log-file_ CLEAR` command clears existing information from the specified log file and +starts logging the session in the log file: + +==== +`SQL>`*spool C:\log\persnl_updates.log clear* +==== + +==== Log Concurrent the TrafCI Sessions + +If you plan to run two or more TrafCI sessions concurrently on the same workstation, use the +`SPOOL _log-file_` or `LOG _log-file_` command and specify a unique name for each log file. +Otherwise, each session writes information to the same log file, making it difficult to determine +which information belongs to each session. + +=== Stopping the Logging Process + +To stop logging, enter one of these commands: + +* `SPOOL OFF` +* `LOG OFF` + +*Example* + +This SPOOL OFF command stops logging in an TrafCI session: + +==== +`SQL>`*spool off* +==== + +<<< +=== View the Contents of a Log File + +The log file is an ASCII text file that contains all the lines in TrafCI from the time you start +logging to the time you stop logging. The logged lines include prompts, entered commands, +output from commands, and diagnostic messages. + +*Example* + +This log file contains information from when you started logging to when you stopped logging: + +==== +``` +================================================================================ +Spooling started at May 29, 2105 4:52:23 PM +================================================================================ + +SQL>set transaction isolation level serializable; + +--- SQL operation complete. SQL>begin work; + +--- SQL operation complete. + +SQL>delete from employee where empnum=32; + +-- 1 row(s) deleted. + +SQL>insert into employee +(empnum, first_name, last_name, deptnum, salary) values(51, 'JERRY', +'HOWARD', 1000, 137000.00); + +-- 1 row(s) inserted. + +SQL>update dept set manager=50 +where deptnum=1000; + +--- 1 row(s) updated. + +SQL>commit work; + +--- SQL operation complete. + +SQL>log off +``` +==== + + http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/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 new file mode 100644 index 0000000..ef489cd --- /dev/null +++ b/docs/command_interface/src/asciidoc/_chapters/introduction.adoc @@ -0,0 +1,34 @@ +//// +/** + *@@@ 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 +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. + +image:{images}/VST101.jpg["TrafCI Connected to a Trafodion Database"] + +TrafCI enables you to perform daily administrative and database management tasks by running SQL statements or other commands +interactively or from script files. You can also run TrafCI from a Perl or Python command line or from Perl or Python programs. + + + http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/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 new file mode 100644 index 0000000..bf1d78e --- /dev/null +++ b/docs/command_interface/src/asciidoc/_chapters/launch.adoc @@ -0,0 +1,648 @@ +//// +/** +* @@@ 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 @@@ + */ +//// + += Launch TrafCI + +This chapter describes how to launch TrafCI from the Window or Linux environment of a client workstation. +For information about launching TrafCI from Perl or Python, see <>. + +IMPORTANT: Before launching TrafCI, make sure that you have set the Java path to the correct location. +See <>. + +== Launch TrafCI on Windows Workstation + +1. Find the Windows launch file, `trafci.cmd`, in the `bin` folder: ++ +image:{images}/winbin.jpg[alt="Navigate to bin folder"] + +2. Double-click the `trafci.cmd` file. ++ +TrafCI appears, prompting you to enter the host name or IP address of the database platform, your user name, and password. +See <>. + +<<< +[[trafci_shortcut]] +=== Create `trafci.cmd` Shortcut +To enable a user to launch TrafCI from a shortcut icon on the desktop: + +1. Right-click the desktop and select *New->Shortcut*: ++ +image:{images}/shortct1.jpg[width=400,height=400,alt="Select trafci.cmd file"] ++ +<<< + +2. Type the location of `trafci.cmd` within double quotes (`"`) or click *Browse* to locate that file, and then click *Next*: ++ +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_]. + +3. Type a name for the shortcut and click *Finish*: ++ +image:{images}/shortct3.jpg[width=400,height=400,alt="Name shortcut"] ++ +<<< + +4. If desired, specify optional launch parameters for the shortcut: + a. Right-click the shortcut icon and select *Properties*: ++ +image:{images}/shortct4.jpg[width=400,height=400,alt="Select properties"] + + b. Select the *Shortcut* tab. + c. In the *Target* box, insert a space after `"...\Trafodion Command Interface\bin\trafci.cmd"` +and add the optional launch parameters: ++ +image:{images}/shortct5.jpg[width=400,height=400,alt="Add optional launch parameters"] ++ +For more information, see <>. + d. Click *OK*. + +5. To launch TrafCI, double-click the shortcut icon. ++ +TrafCI appears. If you did not set the optional launch parameters, TrafCI prompts you to enter the +host name or IP address of the database platform, your user name, and password. +See <>. + +<<< +== Launch TrafCI on Linux Workstation + +In the terminal window, enter: + +==== +*./_trafci-installation-directory_/trafci/bin/trafci.sh* +==== + +_trafci-installation-directory_ is the directory where you installed the TrafCI software files. +For more information, +see the http://trafodion.incubator.apache.org/docs/latest/client_install/index.html[_Trafodion Client Installation Guide_]. + +=== Set `trafci.sh` PATH + +To enable a user to launch TrafCI anywhere on the client workstation: + +1. Open the user profile (`.profile` or `.bash_profile` for the Bash shell) in the +`$HOME` directory. ++ +==== +*cd $HOME* + +*vi .profile* +==== + +2. In the user profile, set the PATH environment variable to include the path of the `trafci.sh` file. ++ +==== +*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_]. +Check that no space is after the colon (`:`) in the path. ++ +NOTE: In the C shell, use the `setenv` command instead of `export`. + +3. To activate the changes, either log out and log in again or execute the user profile. ++ +==== +*. .profile* +==== ++ +<<< + +4. On the command line, execute the `trafci.sh` file to launch TrafCI: ++ +==== +*trafci.sh* +==== ++ +TrafCI appears, prompting you to enter the host name or IP address of the database platform, your user name, and password. +See <>. ++ +NOTE: To enable all users to launch TrafCI anywhere on the system, create a symbolic link to the +`trafci.sh` file in the `/usr/bin` or `/usr/local/bin` directory: ++ +==== +*ln -s ./_trafci-installation-directory_/trafci/bin/trafci.sh /usr/bin/trafci.sh* +==== + +[[trafci_preset]] +=== Preset the Optional Launch Parameters + +To preset the optional launch parameters for each session, use an `alias` in the shell command. + +==== +*alias trafci='trafci.sh -h 16.123.456.78:37800 -u user1 -p xxxxxx'* +==== + +You can add the alias, trafci, to the user profile, or you can enter it at a command prompt. +For more information about the optional launch parameters, +see <>. + +<<< +[[trafci_login]] +== Log In to Database Platform + +=== Log In Without Login Parameters + +If you launch TrafCI and do not specify login parameters on the command line, follow these steps: + +1. After you launch TrafCI, TrafCI shows the welcome banner and prompts you to enter the host name +or IP address of the database platform: ++ +==== +*Host Name/IP Address: _* +==== ++ +Enter a host name: ++ +==== +*_host-name_[._domain-name_][:_port-number_]* +==== ++ +* If you do not specify the domain name, TrafCI uses the domain of the client workstation. +* If you do not specify a port number, TrafCI uses the default port umber, which is `37800`. ++ +Or enter an IP address: ++ +==== +*_IP-address_[:_port-number_]* +==== + +2. Enter your directory-service (or LDAP) user name. User names are case-insensitive. +3. Enter your password. Passwords are case-sensitive. +4. After you finish logging in to the database platform, the SQL prompt appears: ++ +==== +``` +Connected to Trafodion + +SQL> +``` +==== + +At the prompt, you can enter an SQL statement or an interface command. +For more information, see <>. + +NOTE: TrafCI allows you to reenter the login values, with a maximum of three retries, +before it closes the session. For more information, see <>. + +[[trafci_login_params]] +=== Use Login Parameters + +To avoid entering a host name, user name, or password each time you launch TrafCI, use these login parameters: + +* `-h` or `-host` +* `-u` or `-user` +* `-p` or `-password` + +*Example: Windows Login* + +==== +*cd _trafci-installation-directory_\Trafodion Command Interface\bin* + + + +*trafci.cmd -h 16.123.456.78:37800 -u user1 -p xxxxxx* +==== + +*Example: Linux Login* +==== +*cd _trafci-installation-directory_/trafci/bin* + + + +*./trafci.sh -h 16.123.456.78:37800 -u user1 -p xxxxxx* +==== + +TrafCI launches and prompts you to enter an SQL statement or an interface command: + +==== +``` +Welcome to Trafodion Command Interface +Copyright(C) 2013–2105 Apache Software Foundation + +Connected to Trafodion + +SQL> +``` +==== + +For more information about the login parameters, see <>. + +TIP: You can include these parameters in a shortcut to the `trafci.cmd` file or in a launch file for the +`trafci.sh` file. For more information, see <> or +<>, respectively. + +<<< +[[trafci_retry]] +== Retry Login + +TrafCI allows you to reenter the login values, with a maximum of three retries, before it closes the session. + +TrafCI applies the retry logic as follows: + +* If you specify an invalid host name, TrafCI prompts you to reenter the host name. ++ +*Example* ++ +==== +`$` *trafci –h dd* <- _dd is invalid_ +``` +Welcome to Trafodion Command Interface +Copyright(C) 2013–2105 Apache Software + +Unknown Host: dd + +Host Name/IP Address: 172.16.1.1 + +User Name: user1 +Password: + +Connected to Trafodion SQL> +``` +==== + +<<< +* If you specify an invalid user name or password, TrafCI prompts you to reenter the user name +and password. ++ +If you specify an invalid password, TrafCI prompts only for your user name and password. +After three unsuccessful retries, the session is terminated: ++ +*Example* ++ +==== +`$` *trafci –h 172.16.1.1 –u user1 –p x* +``` +Welcome to Trafodion Command Interface +Copyright(C) 2013–2105 Apache Software + +** ERROR[8837] CLI Authentication : User: user1 : invalid username or password [2105-03-12 16:23:44] + +User Name: user1 +Password: + +** ERROR[8837] CLI Authentication : User: user1 : invalid username or password [2105-03-12 16:25:28] + +User Name: user1 +Password: + +** ERROR[8837] CLI Authentication : User: user1 : invalid username or password [2105-03-12 16:26:36] + + +Press any key to close this session +``` +==== + +<<< +* If all the login parameters that you specify are invalid, TrafCI prompts you to enter the host +name. When you enter a valid host name or IP address, TrafCI prompts you to enter a user name and password. + +* The retry logic applies to the CONNECT and RECONNECT commands. For the RECONNECT command, the retry logic +applies only when no prior connection has been established (`-noconnect`). ++ +For example, if you specify the CONNECT command with a valid user name and host name, then +TrafCI prompts for the user name and password only. ++ +==== +`SQL>` *connect user1/xxx@172.16.1.1* +``` +com.hp.jdbc.HPT4Exception: ** ERROR[8837] CLI Authentication : User: user1 : invalid username or password [2105-03-12 16:35:15] + +User Name: user1 +Password: abc + +Connected to Trafodion SQL> +``` +==== + +* TrafCI does not prompt you to reenter the login values in these cases: +* When you include the `-q` or `-version` parameter on the command line. +(The `-s` parameter permits login retries.) +** For a session started using redirected or piped input. + +In these cases, TrafCI returns an error message and closes the session. You must re-launch the TrafCI session +to connect to the Trafodion database. + +<<< +[[trafci_option_params]] +== Optional Launch Parameters + +To customize how you launch and log in to TrafCI, use the optional parameters described in the table below on the command line: + +==== +*trafci{.sh | .cmd} [optional-parameter]...* +==== + +_optional-parameter_ +[role="indented"] +is one of the launch or login parameters. For details, see the following table. + +[cols="2*",options="header"] +|=== +| Launch or Login Parameter | Description +| `{-h \| -host} _host-name_[:_port-number_]` + +`{-h \| -host} _IP-address_[:_port-number_]` | Specifies the host name or IP address of the database +platform to which you want the client to connect. +The _host-name_ should include the domain name of the database platform if it is different from the domain +of the client workstation. If you do not specify a port number, TrafCI uses the default port number, which +is `37800`. + + + +See <>. + +| `{-u \| -user} _username_` | Specifies the user name for logging in to the database platform. +The _username_ is case-insensitive. + + + +For an example, see <>. + +| `{-r \| -role} _role-name_` | Reserved for future use. + +| `{-p \| -password} _password_` | Specifies the password of the user for logging in to the database +platform. _password_ is case-sensitive. + + + +For an example, see <>. + +| `{-q \| -sql} "_command_"` | Specifies that an SQL statement or an interface command be run when +launching TrafCI. You cannot specify this parameter at the same time as +the -s or -script parameter. + + + +For more information, see <>. + +| `{-s \| -script} _script-file-name_` | Specifies that a script file be run when launching TrafCI in interactive +mode. You cannot specify this parameter at the same time as the -q or +-sql parameter. + + + +For more information, see <>. + +| `-noconnect` | Launches an TrafCI session without connecting to the database. + + + +For more information, see <>. + +| `-version` | Displays the build version of TrafCI and the Trafodion JDBC Type 4 +Driver. Upon completion of the display, the client exits. + + + +If any other parameters are included with the `-version` parameter, they are ignored. + + + +For more information, see <>. +| `-help` | Displays a list of accepted arguments with descriptions and then exits. + + + +For more information, see <>. +|=== + +<<< +[[trafci_run_command]] +== Run Command When Launching TrafCI + +To execute an SQL statement or an interface command when launching TrafCI, use the `-q` or `-sql` +command-line parameter. This parameter enables you to run a single command on the command line +without having to enter commands in TrafCI. + +NOTE: You cannot specify this parameter at the same time as the `-s` or `-script` parameter. + +When using `-q` or `-sql`, you must enclose the command in double quotes (`"`). The SQL terminator +is not required at the end of an SQL statement and is disallowed after an interface command. + +Although you can run any of the interface commands with `-q` or `-sql`, the +`@`, `OBEY`, and `PRUN` commands are the most useful. + +*Example* + +Use `-q` or `-sql` with the `CREATE SCHEMA` statement to create a schema when launching TrafCI: + +* On Windows, in the *Command Prompt* window, enter: ++ +==== +*cd _trafci-installation-directory_\Trafodion Command Interface\bin* + +*trafci.cmd -q "create schema persnl"* +==== + +* On Linux or UNIX, in the terminal window, enter: ++ +==== +*cd _trafci-installation-directory_/trafci/bin* + +*./trafci.sh -q "create schema persnl"* +==== + +After you enter the SQL statement, TrafCI launches and prompts you to log in by default +(if you did not specify `-h`, `-u`, and `-p` on the command line), runs the SQL statement, +and then returns to the command prompt: + +==== +``` +Host Name/IP Address: 16.123.456.78:37800 User Name: user1 + +Password: + +--- SQL operation complete. + +C:\Program Files (x86)\Apache Software Foundation\Trafodion Command Interface\bin>_ +``` +==== + +<<< +*Example* + +Use `-q` or `-sql` with the `PRUN` command to run multiple script files simultaneously from the command line: + +* On Windows, in the *Command Prompt* window, enter: ++ +==== +*cd _trafci-installation-directory_\Trafodion Command Interface\bin* + +*trafci.cmd -q "prun"* +==== + +* On Linux, in the terminal window, enter: ++ +==== +*cd _trafci-installation-directory_/trafci/bin* + +*./trafci.sh -q "prun"* +==== + +After you enter the interface command, TrafCI launches and prompts you to log in by default (if you did not specify +`-h`, `-u`, and `-p` on the command line), and runs the command.\ The parallel run (`PRUN`) operation prompts you to +enter settings and then executes the script files. At the end of the `PRUN` operation, TrafCI returns to the command prompt. + +For more information about the `PRUN` operation, see <>. + +<<< +[[trafci_run_script]] +== Run Script When Launching TrafCI + +To run a script file when launching TrafCI, use the `-s` or `-script` command-line parameter. + +NOTE: You cannot specify this parameter at the same time as the `-q` or `-sql` parameter. + +After you launch TrafCI with `-s` or `-script`, TrafCI executes the script file in interactive mode. +TrafCI remains open until you enter the `EXIT`, `QUIT`, or `DISCONNECT` command. To quit the interface +immediately after executing a script file, include the `EXIT`, `QUIT`, or `DISCONNECT` command +at the end of the script file. + +*Example* + +You can create a script file that contains `SET` commands that customize a session when you launch TrafCI: + +image:{images}/launchs1.jpg[image] + +For more information, <>. + +*Example* + +* On Windows, in the *Command Prompt* window, enter: ++ +==== +*cd _trafci-installation-directory_\Trafodion Command Interface\bin* + +*trafci.cmd -s settings.txt* +==== ++ +Specify the full path of the script file if it is outside the directory of `trafci.cmd`. + +* On Linux, in the terminal window, enter: ++ +==== +*cd _trafci-installation-directory_/trafci/bin* + +*./trafci.sh -s settings.txt* +==== ++ +Specify the full path of the script file if it is outside the directory of `trafci.sh`. + +<<< +TrafCI launches and prompts you to log in by default (if you did not specify `-h`, `-u`, and `-p` +on the command line), and runs the commands in the script file: + +==== +``` +Welcome to Trafodion Command Interface +Copyright(C) 2013–2105 Apache Software Foundation + +Host Name/IP Address: 16.123.456.78:37800 User Name: user1 +Password: +Connected to Trafodion + +SQL>SET IDLETIMEOUT 0 + +SQL>SET SQLPROMPT * + +*SET TIME ON + +14:14:57 *SET TIMING ON + +2:14:57 PM *SET SQLTERMINATOR . +``` +==== + +<<< +[[trafci_noconnect]] +== Launch TrafCI Without Connecting to the Database + +To start TrafCI without connecting to a Trafodion database, use the `-noconnect option`. +See <> for a list of interface commands that can +be run without a connection. + +*Example* + +* On Windows, in the *Command Prompt* window, enter: ++ +==== +*cd _trafci-installation-directory_\Trafodion Command Interface\bin* + +*trafci.cmd -noconnect* +==== + +* On Linux, in the terminal window, enter: ++ +==== +*cd _trafci-installation-directory_/trafci/bin* + +*./trafci.sh -noconnect* +==== + +<<< +[[trafci_with_version]] +== Run TrafCI With `-version` +To display the build version of TrafCI and the Trafodion JDBC Type 4 Driver, use the `-version` +option. If other parameters are included with the `-version` parameter, they are ignored. + +*Example* + +* On Windows, in the *Command Prompt* window, enter: ++ +==== +*cd _trafci-installation-directory_\Trafodion Command Interface\bin* + +*trafci.cmd -version* +==== + +* On Linux, in the terminal window, enter: ++ +==== +*cd _trafci-installation-directory_/trafci/bin* + +*./trafci.sh -version* +==== + +==== +``` +Welcome to Trafodion Command Interface +Copyright(C) 2013–2105 Apache Software Foundation + +Trafodion JDBC Type 4 Driver : Traf_JDBC_Type4_Build_40646 Trafodion +Command Interface : TrafCI_Build_40646 +``` +==== + +<<< +[[trafci_help]] +== Run TrafCI With -help + +To display a list of acceptable list of parameters, including proper usage information, use the +`-help` option. After displaying this information the application exits. + +*Example* + +* On Windows, in the *Command Prompt* window, enter: ++ +==== +*cd _trafci-installation-directory_\Trafodion Command Interface\bin* + +*trafci -help* +==== + +* On Linux, in the terminal window, enter: ++ +==== +*cd _trafci-installation-directory_/trafci/bin* + +*./trafci.sh -help* +==== + +[[trafci_quit]] +== Exit TrafCI + +To exit TrafCI, enter one of these commands at a prompt: + +* `EXIT` +* `QUIT` + +*Example* + +==== +`SQL>` *quit* +==== + +These commands are not case-sensitive and do not require a terminator before you press *Enter*. +After you enter one of these commands, TrafCI immediately quits running and disappears from the screen. + + + http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/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 new file mode 100644 index 0000000..07aeeb7 --- /dev/null +++ b/docs/command_interface/src/asciidoc/_chapters/perlpython.adoc @@ -0,0 +1,262 @@ +//// +/** +* @@@ 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 @@@ + */ +//// + += Run TrafCI From Perl or Python + +You can execute SQL statements in Perl or Python by invoking the TrafCI +Perl or Python wrapper script. + +These instructions assume that you installed the TrafCI product. For more information, +see <>. + +== Set the Login Environment Variables + +Before launching TrafCI from Perl or Python, set these login environment variables: + + +[cols="45%,55%",options="header"] +|=== +|Environment Variable | Description +| `TRAFCI_PERL_JSERVER=_JavaServer_jar_path_` | Specifies the Perl JavaServer JAR location. +| `TRAFCI_PYTHON_JSERVER=_Jython_jar_path_` | Specifies the Jython JAR file location. +| `TRAFCI_PERL_JSERVER_PORT=_port_number_` | Specifies the port on which the JavaServer is listening. +|=== + + +The Trafodion Command Interface Installer Wizard can attempt to automatically download and install both the Perl JavaServer +and Jython open source extensions. If you wish to download and install them manually, refer to the instructions in the `README` file +in the samples directory. + +To set the login environment variables, see the instructions for the operating system of the client workstation: + +* <>. +* <>. + +NOTE: The Perl and Python wrapper scripts do not require these environment variables: + +* `TRAFCI_SERVER` +* `TRAFCI_USER` +* `TRAFCI_PASSWORD` + +<<< +[[perlpython_env_windows]] +=== Set the Login Environment Variables on Windows + +You can set the login environment variables for the session at command prompts, or you can set the login environment variables for +the system or user by including them in the System Properties. + +==== Set Login Environment Variables on the Command Line + +At each command prompt, enter one of these commands: + +==== +*set TRAFCI_PERL_JSERVER=_absolute-path-of-JavaServer.jar_* + +*set TRAFCI_PYTHON_JSERVER=_absolute-path-of-Jython.jar_* + +*set TRAFCI_PERL_JSERVER_PORT=_portnumber_* +==== + +=== Set Login Environment Variables in the System Properties + +1. Right-click the *Computer* icon on your desktop, and then select *Properties*: ++ +image:{images}/mycomp.jpg[Select computer properties] + +2. In the *Control Panel*, click the *Advanced* system settings. +3. In the *System Properties* dialog box, click the *Advanced* tab. ++ +<<< +4. Click the *Environment Variables* button: ++ +image:{images}/sysprop.jpg[Click Environment Variables button] ++ +[[perlpython_win_env_step5]] ++ +<<< + +5. In the *Environment Variables* dialog box, click *New* under _System_ or _User_ variables, whichever you prefer. ++ +image:{images}/envvar.jpg[Environment Variables dialog box] + +6. In the *New System Variable* (or *New User Variable*) dialog box, type the name of the login environment variable for the _Variable Name_ and the +required value for the _Variable Value_, and then click *OK*: ++ +image:{images}/logvar_new.jpg[New System Variable dialog box] ++ +[[perlpython_win_env_step7]] + +7. Verify that the environment variable appears under _System_ or _User_ variables. +8. Repeat <> to <> for each login environment variable. +9. After adding all three environment variables, click *OK* in the *Environment Variables and System Properties* dialog boxes +to accept the changes. + + +<<< +[[perlpython_env_linux]] +=== Set the Login Environment Variables on Linux or UNIX + +You can set the login environment variables for the session at command prompts, or you can set the login environment variables +for each user by including the variables in the user profile on a Linux or UNIX client workstation. + +==== Set Login Environment Variables on the Command Line + + +At each command prompt in any shell except the C shell, enter one of these commands: + +==== +*export TRAFCI_PERL_JSERVER=_absolute-path-of-JavaServer.jar_* + +*export TRAFCI_PYTHON_JSERVER=_absolute-path-of-Jython.jar_* + +*export TRAFCI_PERL_JSERVER_PORT=_portnumber_* +==== + +At each command prompt in the C shell, enter one of these commands: + +==== +*setenv TRAFCI_PERL_SERVER=_absolute-path-of-JavaServer.jar_* + +*setenv TRAFCI_PYTHON_JSERVER=_absolute-path-of-Jython.jar_* + +*setenv TRAFCI_PERL_JSERVER_PORT=_portnumber_* +==== + +==== Setting Login Environment Variables in the User Profile + +To set the login environment variables in the user profile: + +1. Open the user profile (`.profile` or `.bash_profile` for the Bash shell) in the `$HOME` directory. ++ +*Example* ++ +==== +*vi .profile* +==== + +2. Add these `export` commands (or `setenv` commands for the C shell) to the user profile. ++ +*Example* ++ +==== +*export TRAFCI_PERL_JSERVER=_absolute-path-of-JavaServer.jar_* + +*export TRAFCI_PYTHON_JSERVER=_absolute-path-of-Jython.jar_* + +*export TRAFCI_PERL_JSERVER_PORT=_portnumber_* +==== ++ +<<< +3. To activate the changes, either log out and log in again or execute the user profile. ++ +*Example* ++ +==== +*. .profile* +==== + +== Perl and Python Wrapper Scripts + +The Perl or Python wrapper scripts enable you to run SQL statements and script files using a single connection or +multiple connections within Perl or Python programs. The Perl wrapper script is `trafci.pl`, and the Python wrapper +script is `trafci.py`. By default, these wrapper scripts are located in the `bin` directory: + +[cols="30%h,70%",options="header"] +|=== +| Operating System | Directory +| Windows | `_trafci-installation-directory_\Trafodion Command Interface\bin` +| Linux/Unix | `_trafci-installation-directory_/trafci/bin` +|=== + +_trafci-installation-directory_ is the directory where you installed the TrafCI software files. + +== Launch TrafCI From the Perl or Python Command Line + +You can launch the Perl or Python wrapper scripts as shown below: + +[cols="15%h,50%,35%",options="header"] +|=== +| Language | Launch Command | Example +| Perl | *perl trafci.pl _perl-script-filename_* | `>`*perl trafci.pl example.pl* +| Python | *python trafci.py _python-script-filename_* | `>`*python trafci.py example.py* +|=== + +<<< +=== Example Perl Program (`sample.pl`) + +==== +[source,perl] +---- +use lib 'C:\\Program Files (x86)\\Apache Software Foundation\\Trafodion Command Interface\\lib\\perl'; +use Session; + +# create a new session +$sess = Session->new(); + +# connect to the database +$sess->connect("user1","password","16.123.456.78","37800"); + +$retval=$sess->execute(" set schema TRAFODION.CI_SAMPLE "); +print $retval; + +# Execute sample queries +$retval=$sess->execute("select * from employee"); print $retval; +$retval=$sess->execute("get statistics"); print $retval; + +# disconnect from the database +print "\n\nSession 1: Disconnecting first session. \n\n"; +$sess->disconnect(); +---- +==== + +<<< +=== Example Python Program (`sample.py`) + +==== +[source,python] +---- +import os import sys + +## Modify this path +sys.path.append("C:\\Program Files (x86)\\Apache Software Foundation\\Trafodion Command Interface\\lib\\python") +import Session + +# create a new session +sess = Session.Session() + +# Connect to the database +x=sess. connect ("user1","password","16.123.456.78","37800") + +# Execute sample queries + +# execute takes the query string as argument +setSchema = "set schema TRAFODION.CI_SAMPLE" +selectTable = "select * from employee" +getStats = "get statistics" + +#Contruct a list of SQL statements to be executed +queryList = [setSchema, selectTable, getStats] print "\n"; + +for query in queryList: + print sess.execute (query) + +# disconnect the session +sess.disconnect() +del sess +sess=None +---- +==== \ No newline at end of file http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/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 new file mode 100644 index 0000000..ec120e8 --- /dev/null +++ b/docs/command_interface/src/asciidoc/_chapters/scripts.adoc @@ -0,0 +1,166 @@ +//// +/** +* @@@ 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 @@@ + */ +//// + += Run Scripts + +[[script_create]] +== Create a Script File + +A script file that you run in TrafCI must be an ASCII text file that contains only these elements: + +* <> +* <> +* <> +* <> + +For an example, see >. + +NOTE: You cannot use shell commands in a script file that you run in TrafCI. To create shell scripts +that run TrafCI, see <>. + +[[script_sql_statements]] +== SQL Statements + +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/sql_reference/index.html[_Trafodion SQL Reference Manual_]. + +[[script_commands]] +== Commands + +Most interface commands are supported in script files except the FC command. For a list of the interface commands, see +<>. + +[[script_comments]] +== Comments + +You can include comments anywhere in a script file. SQL also supports comments. Comments are useful for documenting +the functionality of the script file and for debugging. When debugging, use comments to disable +specific statements or commands without removing them from the script file. + +To denote a comment in a script file, use two hyphens before the comment: + +==== +*-- _comment_* +==== + +The end of the line marks the end of the comment. + +[[script_section_headers]] +== Section Headers + +To create sections of commands within a script file, put a section header at the beginning of each section: + +==== +*?SECTION _section-name_* +==== + +The `_section-name_` cannot begin with a number or an underscore. Each section name in a script file should be unique +because TrafCI executes the first section that it finds that matches the section name in the `@` or `OBEY` command. +For more information, see the <> <>. + +[[script_example]] +== Example Script File + +This script file creates tables in the inventory schema: + +image:{images}/script.jpg[Sample script] + +== Run a Script File + +To run a script file in TrafCI, use the `@` or OBEY command. The `@` and `OBEY` commands run one script file at a time +in TrafCI. To run a script file when launching TrafCI, see <>. + +*Example* + +This `@` command runs a script file, `sch_invent.sql`, that creates tables in the inventory schema: + +==== +*@C:\ddl_scripts\sch_invent.sql* +==== + +NOTE: If the script file is outside the directory of the `trafci.cmd` or `trafci.sh` file (by default, the `bin` directory), +you must specify the full path of the script file in the `@` or `OBEY` command. + +==== +`SQL>`*@C:\ddl_scripts\sch_invent.sql* + +`SQL>`*-- CREATE SCHEMA* + +`SQL>`*CREATE SCHEMA INVENT;* + +``` +--- SQL operation complete. +==== +<<< +==== +`SQL>`*-- CREATE TABLES/VIEWS in SCHEMA INVENT SQL>SET SCHEMA INVENT;* +``` +--- SQL operation complete. +``` +`SQL>`*CREATE TABLE INVENT.supplier (* + +`+>` *suppnum NUMERIC (4) UNSIGNED* + +`+>` *NO DEFAULT* + +`+>` *NOT NULL* + +`+>` *,suppname CHARACTER (18)* + +`+>` *NO DEFAULT* + +`+>` *NOT NULL* + +`+>` *,street CHARACTER (22)* + +`+>` *NO DEFAULT* + +`+>` *NOT NULL* + +`+>` *,city CHARACTER (14)* + +`+>` *NO DEFAULT* + +`+>` *NOT NULL* + +`+>` *,state CHARACTER (12)* + +`+>` *NO DEFAULT* + +`+>` *NOT NULL* + +`+>` *,postcode CHARACTER (10)* + +`+>` *NO DEFAULT* + +`+>` *NOT NULL* + +`+>` *,PRIMARY KEY (suppnum)* + +`+>` *);* +``` +--- SQL operation complete. +``` +==== + +For more information about the `@` and `OBEY` commands, see the <> and +the <>. + +== Log Output + +To log output of an TrafCI session while running one script file at a time, use the `SPOOL` or `LOG` command. +When you run an `OBEY` or `@` command, TrafCI displays each command in the script file, the output for each +command, and diagnostic messages in TrafCI. The `SPOOL` or `LOG` command captures this output as it appears +in TrafCI and logs it in a log file. + +For more information, <>. + +== Run Scripts in Parallel + +In TrafCI, the `@` and `OBEY` commands allow you to run only one script file at a time. However, the `PRUN` command +allows you to run multiple script files simultaneously. + +The `PRUN` command is most useful for running sets of data definition language (DDL) statements simultaneously, which +speeds up the process of creating large databases. Put all dependent or related DDL statements in the same script file. +For more information on running scripts in parallel using the `PRUN` command, see the <>. + http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/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 new file mode 100644 index 0000000..ac125ba --- /dev/null +++ b/docs/command_interface/src/asciidoc/index.adoc @@ -0,0 +1,75 @@ +//// +* @@@ START COPYRIGHT @@@ +* +* Licensed to the Apache Software Foundation (ASF) under one +* or more contributor license agreements. See the NOTICE file +* distributed with this work for additional information +* regarding copyright ownership. The ASF licenses this file +* to you under the Apache License, Version 2.0 (the +* "License"); you may not use this file except in compliance +* with the License. You may obtain a copy of the License at +* +* http://www.apache.org/licenses/LICENSE-2.0 +* +* Unless required by applicable law or agreed to in writing, +* software distributed under the License is distributed on an +* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +* KIND, either express or implied. See the License for the +* specific language governing permissions and limitations +* under the License. +* +* @@@ END COPYRIGHT @@@ +//// + += Trafodion Command Interface Guide +Version 1.3.0, January 2016 +:doctype: book +:numbered: +:toc: left +:toclevels: 3 +:toc-title: Table of Contents +:icons: font +:iconsdir: icons +:experimental: +:source-language: text + +:images: ../images +:leveloffset: 1 + +// The directory is called _chapters because asciidoctor skips direct +// processing of files found in directories starting with an _. This +// prevents each chapter being built as its own book. + +**License Statement** + +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. + +**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. + +[cols="2",options="header"] +|=== +| Version | Date +| 1.3.0 | January, 2016 +|=== + +include::asciidoc/_chapters/about.adoc[] +include::asciidoc/_chapters/introduction.adoc[] +include::asciidoc/_chapters/install.adoc[] +include::asciidoc/_chapters/launch.adoc[] +include::asciidoc/_chapters/interactive.adoc[] +include::asciidoc/_chapters/scripts.adoc[] +include::asciidoc/_chapters/perlpython.adoc[] +include::asciidoc/_chapters/commands.adoc[] + + + + http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/VST101.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/VST101.jpg b/docs/command_interface/src/images/VST101.jpg new file mode 100644 index 0000000..0aa50ce Binary files /dev/null and b/docs/command_interface/src/images/VST101.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/VST401.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/VST401.jpg b/docs/command_interface/src/images/VST401.jpg new file mode 100644 index 0000000..ff9ac1a Binary files /dev/null and b/docs/command_interface/src/images/VST401.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/VST601.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/VST601.jpg b/docs/command_interface/src/images/VST601.jpg new file mode 100644 index 0000000..2b6dd10 Binary files /dev/null and b/docs/command_interface/src/images/VST601.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/dpnvslf.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/dpnvslf.jpg b/docs/command_interface/src/images/dpnvslf.jpg new file mode 100644 index 0000000..8d72042 Binary files /dev/null and b/docs/command_interface/src/images/dpnvslf.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/envvar.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/envvar.jpg b/docs/command_interface/src/images/envvar.jpg new file mode 100644 index 0000000..cb17094 Binary files /dev/null and b/docs/command_interface/src/images/envvar.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/instlcm1.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/instlcm1.jpg b/docs/command_interface/src/images/instlcm1.jpg new file mode 100644 index 0000000..b9e620e Binary files /dev/null and b/docs/command_interface/src/images/instlcm1.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/instlcm2.3.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/instlcm2.3.jpg b/docs/command_interface/src/images/instlcm2.3.jpg new file mode 100644 index 0000000..e9ab310 Binary files /dev/null and b/docs/command_interface/src/images/instlcm2.3.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/instlcm2.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/instlcm2.jpg b/docs/command_interface/src/images/instlcm2.jpg new file mode 100644 index 0000000..6b47cb2 Binary files /dev/null and b/docs/command_interface/src/images/instlcm2.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz1.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz1.jpg b/docs/command_interface/src/images/iwiz1.jpg new file mode 100644 index 0000000..c8f1a4f Binary files /dev/null and b/docs/command_interface/src/images/iwiz1.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz2.3.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz2.3.jpg b/docs/command_interface/src/images/iwiz2.3.jpg new file mode 100644 index 0000000..a5727e6 Binary files /dev/null and b/docs/command_interface/src/images/iwiz2.3.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz2.3b.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz2.3b.jpg b/docs/command_interface/src/images/iwiz2.3b.jpg new file mode 100644 index 0000000..89e7270 Binary files /dev/null and b/docs/command_interface/src/images/iwiz2.3b.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz2.3c.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz2.3c.jpg b/docs/command_interface/src/images/iwiz2.3c.jpg new file mode 100644 index 0000000..904ae73 Binary files /dev/null and b/docs/command_interface/src/images/iwiz2.3c.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz2.3comp.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz2.3comp.jpg b/docs/command_interface/src/images/iwiz2.3comp.jpg new file mode 100644 index 0000000..906fa8f Binary files /dev/null and b/docs/command_interface/src/images/iwiz2.3comp.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz2.3d.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz2.3d.jpg b/docs/command_interface/src/images/iwiz2.3d.jpg new file mode 100644 index 0000000..bf7997f Binary files /dev/null and b/docs/command_interface/src/images/iwiz2.3d.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz2.3e.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz2.3e.jpg b/docs/command_interface/src/images/iwiz2.3e.jpg new file mode 100644 index 0000000..3d05f64 Binary files /dev/null and b/docs/command_interface/src/images/iwiz2.3e.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz2.3f.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz2.3f.jpg b/docs/command_interface/src/images/iwiz2.3f.jpg new file mode 100644 index 0000000..5a409d0 Binary files /dev/null and b/docs/command_interface/src/images/iwiz2.3f.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz2.3h.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz2.3h.jpg b/docs/command_interface/src/images/iwiz2.3h.jpg new file mode 100644 index 0000000..aa3f8ad Binary files /dev/null and b/docs/command_interface/src/images/iwiz2.3h.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz2.3n.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz2.3n.jpg b/docs/command_interface/src/images/iwiz2.3n.jpg new file mode 100644 index 0000000..15c6229 Binary files /dev/null and b/docs/command_interface/src/images/iwiz2.3n.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz2.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz2.jpg b/docs/command_interface/src/images/iwiz2.jpg new file mode 100644 index 0000000..c80174f Binary files /dev/null and b/docs/command_interface/src/images/iwiz2.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz3.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz3.jpg b/docs/command_interface/src/images/iwiz3.jpg new file mode 100644 index 0000000..6f347d1 Binary files /dev/null and b/docs/command_interface/src/images/iwiz3.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz4.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz4.jpg b/docs/command_interface/src/images/iwiz4.jpg new file mode 100644 index 0000000..8be568c Binary files /dev/null and b/docs/command_interface/src/images/iwiz4.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz5.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz5.jpg b/docs/command_interface/src/images/iwiz5.jpg new file mode 100644 index 0000000..d1b11cb Binary files /dev/null and b/docs/command_interface/src/images/iwiz5.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz7.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz7.jpg b/docs/command_interface/src/images/iwiz7.jpg new file mode 100644 index 0000000..8451c07 Binary files /dev/null and b/docs/command_interface/src/images/iwiz7.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz8.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz8.jpg b/docs/command_interface/src/images/iwiz8.jpg new file mode 100644 index 0000000..896b389 Binary files /dev/null and b/docs/command_interface/src/images/iwiz8.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwiz9.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwiz9.jpg b/docs/command_interface/src/images/iwiz9.jpg new file mode 100644 index 0000000..f214ea9 Binary files /dev/null and b/docs/command_interface/src/images/iwiz9.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwizediturl.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwizediturl.jpg b/docs/command_interface/src/images/iwizediturl.jpg new file mode 100644 index 0000000..c78b55b Binary files /dev/null and b/docs/command_interface/src/images/iwizediturl.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwizone2.3.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwizone2.3.jpg b/docs/command_interface/src/images/iwizone2.3.jpg new file mode 100644 index 0000000..640d897 Binary files /dev/null and b/docs/command_interface/src/images/iwizone2.3.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwizopensource.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwizopensource.jpg b/docs/command_interface/src/images/iwizopensource.jpg new file mode 100644 index 0000000..fb5a842 Binary files /dev/null and b/docs/command_interface/src/images/iwizopensource.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/iwizproxyset.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/iwizproxyset.jpg b/docs/command_interface/src/images/iwizproxyset.jpg new file mode 100644 index 0000000..1d4596c Binary files /dev/null and b/docs/command_interface/src/images/iwizproxyset.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/java-opt.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/java-opt.jpg b/docs/command_interface/src/images/java-opt.jpg new file mode 100644 index 0000000..33d4035 Binary files /dev/null and b/docs/command_interface/src/images/java-opt.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/launch02.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/launch02.jpg b/docs/command_interface/src/images/launch02.jpg new file mode 100644 index 0000000..e5bc28c Binary files /dev/null and b/docs/command_interface/src/images/launch02.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/launchs1.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/launchs1.jpg b/docs/command_interface/src/images/launchs1.jpg new file mode 100644 index 0000000..f9f16a0 Binary files /dev/null and b/docs/command_interface/src/images/launchs1.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/log-file.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/log-file.jpg b/docs/command_interface/src/images/log-file.jpg new file mode 100644 index 0000000..b06fdf9 Binary files /dev/null and b/docs/command_interface/src/images/log-file.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/logvar.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/logvar.jpg b/docs/command_interface/src/images/logvar.jpg new file mode 100644 index 0000000..35ac669 Binary files /dev/null and b/docs/command_interface/src/images/logvar.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/logvar_new.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/logvar_new.jpg b/docs/command_interface/src/images/logvar_new.jpg new file mode 100644 index 0000000..383abf0 Binary files /dev/null and b/docs/command_interface/src/images/logvar_new.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/mycomp.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/mycomp.jpg b/docs/command_interface/src/images/mycomp.jpg new file mode 100644 index 0000000..43f3e10 Binary files /dev/null and b/docs/command_interface/src/images/mycomp.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/new_iwiz2.3.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/new_iwiz2.3.jpg b/docs/command_interface/src/images/new_iwiz2.3.jpg new file mode 100644 index 0000000..2a7b263 Binary files /dev/null and b/docs/command_interface/src/images/new_iwiz2.3.jpg differ http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/859a7e4c/docs/command_interface/src/images/p-errlog.jpg ---------------------------------------------------------------------- diff --git a/docs/command_interface/src/images/p-errlog.jpg b/docs/command_interface/src/images/p-errlog.jpg new file mode 100644 index 0000000..57c785b Binary files /dev/null and b/docs/command_interface/src/images/p-errlog.jpg differ