You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafodion.apache.org by sv...@apache.org on 2016/01/14 19:18:38 UTC
[34/42] incubator-trafodion git commit: Updated the Command Interface
Guide to use the standard PDF template.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/17b39a0a/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 0a4b24f..f755c90 100644
--- a/docs/command_interface/src/asciidoc/_chapters/install.adoc
+++ b/docs/command_interface/src/asciidoc/_chapters/install.adoc
@@ -35,7 +35,7 @@ http://trafodion.incubator.apache.org/docs/client_install/index.html[_Trafodion
=== 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.
+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*:
@@ -47,9 +47,9 @@ image:{images}/path2.jpg[image]
+
image:{images}/varval2.jpg[image]
+
-====
-*"C:\Program Files (x86)\Java\jre7\bin";*
-====
+```
+"C:\Program Files (x86)\Java\jre7\bin";
+```
+
NOTE: Check that no space exists after the semicolon (;) in the path. If there are spaces in the directory name, delimit the entire directory
path in double quotes (") before the semicolon.
@@ -61,25 +61,25 @@ path in double quotes (") before the semicolon.
=== Set PATH on Linux
1. Open the user profile (`.profile` or `.bash_profile` for the Bash shell) in the `$HOME` directory.
+
-====
-*vi .profile*
-====
+```
+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*
-====
+```
+export PATH=/opt/java1.7/jre/bin:$PATH
+```
+
NOTE: Place the path of the Java bin directory before `$PATH`, and check that no space exists after the colon (`:`) in the path.
In the C shell, use the `setenv` command instead of export.
3. To activate the changes, either log out and log in again or execute the user profile.
+
-====
-*. .profile*
-====
+```
+. .profile
+```
== Test TrafCI Launch
1. Launch TrafCI and verify that you can connect to the database. For
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/17b39a0a/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 caee6d5..8c85560 100644
--- a/docs/command_interface/src/asciidoc/_chapters/interactive.adoc
+++ b/docs/command_interface/src/asciidoc/_chapters/interactive.adoc
@@ -48,7 +48,7 @@ on one line. If you accidentally break an interface command across more than one
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
+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_].
@@ -86,9 +86,9 @@ or `SESSION` command.
This SESSION command displays the session attributes:
-====
-`SQL>`*session*
```
+SQL> SESSION
+
COLSEP " "
HISTOPT DEFAULT [No expansion of script files]
IDLETIMEOUT 0 min(s) [Never Expires]
@@ -104,9 +104,9 @@ STATISTICS OFF
TIME OFF
TIMING OFF
USER user1
+
+SQL>
```
-`SQL>`
-====
For more information, see <<cmd_env, ENV Command>> <<cmd_show_session,SHOW SESSION Command>>.
@@ -122,10 +122,10 @@ To set the idle timeout value of a session, enter the `SET IDLETIMEOUT` command.
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>`
-====
+```
+SQL> SET IDLETIMEOUT 0
+SQL>
+```
To show the idle timeout value that is in effect for the session, enter the `SHOW IDLETIMEOUT` command.
@@ -134,14 +134,13 @@ To show the idle timeout value that is in effect for the session, enter the `SHO
This `SHOW IDLETIMEOUT` command displays an idle timeout of zero minutes, which means that the session
never expires:
-====
-`SQL>`*show idletimeout*
```
+SQL> SHOW IDLETIMEOUT
+
IDLETIMEOUT 0 min(s) [Never Expires]
+SQL>
```
-`SQL>`
-====
For more information, see the <<cmd_set_idletimeout,SET IDLETIMEOUT Command>> and the
<<cmd_show_idletimeout, SET IDLETIMEOUT Command>.
@@ -160,11 +159,11 @@ The `SET PROMPT` command changes the default prompt to a specified character or
This `SET PROMPT` command changes the prompt to the current user (`user1`) and `ENTER>`:
-====
-`SQL>`*set prompt "%USER ENTER>"* +
- +
-`user1 ENTER>`
-====
+```
+SQL>set prompt "%USER ENTER>"
+
+user1 ENTER>
+```
For more information, see <<cmd_set_prompt, SET PROMPT Command>>.
@@ -173,19 +172,19 @@ For more information, see <<cmd_set_prompt, SET PROMPT 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>`
-====
+```
+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>`
-====
+```
+20:32:26 SQL ENTER> SET TIME OFF
+
+SQL ENTER>
+```
For more information, see the <<cmd_set_time, SET TIME Command>>.
@@ -202,15 +201,16 @@ To change the SQL terminator, enter the `SET SQLTERMINATOR` command.
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>
+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.
@@ -219,13 +219,12 @@ To show the SQL terminator that is in effect for the session, enter the `SHOW SQ
This `SHOW SQLTERMINATOR` command displays SQLTERMINATOR `.`, where the period (`.`) is the
SQL terminator for the session:
-====
-`SQL>`*show sqlterminator*
-```
+```
+SQL> SHOW SQLTERMINATOR
SQLTERMINATOR .
+
+SQL>
```
-`SQL>`
-====
For more information, see the <<cmd_set_sqlterminator, SET SQLTERMINATOR Command>> and
the <<cmd_show_sqlterminator, SHOW SQLTERMINATOR Command>>.
@@ -238,35 +237,35 @@ By default, TrafCI does not display the elapsed time of an SQL statement after t
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;*
```
+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>`*/*
```
+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>
```
-`SQL>`
-====
For more information, see the <<cmd_set_timing, SET TIMING Command>>.
@@ -281,19 +280,19 @@ allows you to set the schema for the TrafCI session.
This `SET SCHEMA` statement changes the default schema to `PERSNL` for the session:
-====
-`SQL>`*set schema persnl;*
```
+SQL> SET SCHEMA persnl;
+
--- SQL operation complete.
-```
-`SQL>`*delete from employee* +
-`+>` *where first_name='TIM' and* +
-`+>` *last_name='WALKER';*
-```
+
+SQL> DELETE FROM employee
++> WHERE first_name='TIM' AND
++> last_name='WALKER';
+
--- 1 row(s) deleted.
+
+SQL>
```
-`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.
@@ -313,10 +312,10 @@ The `SHOW SCHEMA` command displays the current schema for the session.
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>`
-====
+```
+SQL> SHOW SCHEMA SCHEMA persnl
+SQL>
+```
For more information, <<cmd_show_schema, SHOW SCHEMA Command>>.
@@ -329,9 +328,9 @@ in the session, enter the `SET LIST_COUNT` command.
This `SET LIST_COUNT` command limits the result set of queries to 20 rows:
-====
-`SQL>`*set list_count 20*
-====
+```
+SQL> SET LIST_COUNT 20
+```
To show the limit that is in effect for the session, enter the `SHOW LIST_COUNT` command.
@@ -340,12 +339,11 @@ To show the limit that is in effect for the session, enter the `SHOW LIST_COUNT`
This `SHOW LIST_COUNT` command shows that the number of rows returned by `SELECT` statements
is unlimited:
-====
-`SQL>`*show list_count*
```
+SQL> SHOW LIST_COUNT
+
LISTCOUNT 0 [All Rows]
```
-====
For more information, see the <<cmd_set_list_count, SET LIST_COUNT Command>> and
<<cmd_show_list_count, SHOW LIST_COUNT Command>>.
@@ -363,15 +361,15 @@ you can use to reexecute or edit the command with the `FC` command. See
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> HISTORY
+
+1> SET IDLETIMEOUT 0
+2> SET SCHEMA persnl;
+3> SELECT * FROM project;
+
+SQL>
```
-`SQL>`
-====
To save the session history in a user-specified file, enter the `SAVEHIST` command.
@@ -380,9 +378,9 @@ To save the session history in a user-specified file, enter the `SAVEHIST` comma
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*
-====
+```
+SQL> SAVEHIST history.txt
+```
For more information, see the <<cmd_history,HISTORY Command>> and
the <<cmd_savehist, SAVEHIST Command>>.
@@ -399,14 +397,14 @@ To display the commands in the history buffer, use the `HISTORY` command. See
This *FC* command and its delete (`D`) editing command correct a `SELECT` statement that was entered incorrectly:
-====
-`SQL>`*fc*
```
-SQL> selecct * from employee;
+SQL> FC
+
+SQL> SELECCT FROM employee;
.... d
-SQL> select * from employee;
+SQL> SELECT FROM employee;
+
```
-====
Pressing Enter executes the corrected `SELECT` statement. For more information, see the
<<cmd_fc, FC Command>>.
@@ -421,9 +419,9 @@ After entering commands in TrafCI, you can clear the interface window by using t
This `CLEAR` command clears the interface window so that only the prompt appears at the top of the
window:
-====
-`SQL>`*clear*
-====
+```
+SQL> CLEAR
+```
For more information, see the <<cmd_clear, CLEAR Command>>.
@@ -435,9 +433,9 @@ To display help text for an interface command that is supported in TrafCI, enter
This `HELP` command displays syntax and examples of the `FC` command:
-====
-`SQL>`*help fc*
-====
+```
+SQL> HELP FC
+```
For more information, see the <<cmd_help, HELP Command>>.
@@ -458,11 +456,11 @@ To run SQL statements from script files in TrafCI, see <<run_scripts, Run Script
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;*
```
+SQL> SELECT salary
++> FROM persnl.employee
++> WHERE jobcode=100;
+
SALARY
----------
175500.00
@@ -478,9 +476,9 @@ SALARY
56000.00
--- 11 row(s) selected.
+
+SQL>
```
-`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
@@ -491,9 +489,9 @@ execution of the SQL statement, TrafCI returns an error message.
To run a previously executed SQL statement, use the `/`, `RUN`, or `REPEAT` command.
-====
-`SQL>`*/*
```
+SQL> /
+
SALARY
----------
175500.00
@@ -509,9 +507,9 @@ SALARY
56000.00
--- 11 row(s) selected.
+
+SQL>
```
-`SQL>`
-====
For more information, see the <<cmd_slash, / Command>>,
<<cmd_run, RUN Command>>, or <<cmd_repeat, REPEAT Command>>.
@@ -522,33 +520,32 @@ For more information, see the <<cmd_slash, / Command>>,
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
+[[interactive_prepare_sql_statement]]
+==== Prepare a 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:
+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>`
-====
+```
+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> 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
@@ -562,89 +559,82 @@ in the SQL statement:
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> 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> 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
-
+==== Setting Parameters
In an TrafCI session, you can set a parameter of an SQL statement (either prepared or not)
-by using the `SET PARAM` command.
+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`.
+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
+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*
-====
+```
+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*;*
-====
+```
+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*
-====
+```
+SQL> SET PARAM ?dn 1500
+```
For the syntax of the `SET PARAM` command, see the <<cmd_set_param, SET PARAM Command>>.
[[interactive_display_session_parameters]]
-==== Display Session Parameters
-
-To determine what parameters you have set in the current session, use the `SHOW PARAM` command.
+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:
+This SHOW PARAM command displays the recent SET PARAM settings:
-====
-`SQL>`*show param dn 1500*
```
+SQL> SHOW PARAM dn 1500
sal 40000.00
+SQL>
```
-`SQL>`
-====
For the syntax of the `SHOW PARAM` command, <<cmd_show_param, SHOW PARAM Command>>.
@@ -652,41 +642,41 @@ For the syntax of the `SHOW PARAM` command, <<cmd_show_param, 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.
+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`:
+Suppose that you want to change the salary parameter to 80000.00:
-====
-`SQL>`*reset param ?sal* +
-`SQL>`*set param ?sal 80000.00* +
-`SQL>`
-====
+```
+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>`
-====
+```
+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* +
```
+SQL> SET PARAM ?dn 1500
+SQL> SET PARAM ?sal 80000.00
+SQL> SHOW PARAM dn 1500
+
sal 80000.00
+
+SQL>
```
-`SQL>`
-====
For the syntax of the `RESET PARAM` command, see the <<cmd_reset_param, RESET PARAM Command>>.
@@ -699,9 +689,9 @@ To execute a prepared SQL statement, use the `EXECUTE` statement.
This `EXECUTE` statement executes the prepared `empsal` statement, which does not have any parameters:
-====
-`SQL>`*execute empsal;*
```
+SQL> EXECUTE empsal;
+
SALARY
----------
137000.10
@@ -717,17 +707,17 @@ SALARY
118000.00
--- 11 row(s) selected.
+
+SQL>
```
-`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;*
```
+SQL>EXECUTE empcom;
+
FIRST_NAME LAST_NAME DEPTNUM
--------------- -------------------- -------
ALAN TERRY 3000
@@ -747,9 +737,7 @@ BILL WINN 2000
MIRIAM KING 2500
GINNY FOSTER 3300
```
-====
<<<
-====
```
MARIA JOSEF 4000
HERB ALBERT 3300
@@ -772,18 +760,18 @@ HERBERT KARAJAN 3200
JESSICA CRINER 3500
--- 35 row(s) selected.
+
+SQL>
```
-`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;*
```
+SQL> EXECUTE findemp USING ?sal, 100;
+
EMP_NUM FIRST_NAME LAST_NAME DEPTNUM JOBCODE SALARY
------- --------------- -------------------- ------- ------- ---------
213 ROBERT WHITE 1500 100 90000.00
@@ -791,12 +779,12 @@ EMP_NUM FIRST_NAME LAST_NAME DEPTNUM JOBCODE SALARY
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
+ 43 PAUL WINTER 3100 100 90000.00
65 RACHEL MCKAY 4000 100 118000.00
---- 7 row(s) selected. SQL>
+--- 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_].
@@ -827,18 +815,18 @@ file, which TrafCI stores in the bin directory:
* On Windows:
+
-====
-`_trafci-installation-directory_\Trafodion Command Interface\bin\sqlspool.lst`
-====
+```
+<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>/trafci/bin/sqlspool.lst
+```
+
`_trafci-installation-directory_` is the directory where you installed
the TrafCI software files.
@@ -847,9 +835,9 @@ the TrafCI software files.
This SPOOL ON command starts logging the session in the `sqlspool.lst` file:
-====
-`SQL>`*spool on*
-====
+```
+SQL> SPOOL ON
+```
=== `SPOOL _log-file_` or `LOG _log-file_` Command
@@ -864,24 +852,24 @@ directory must exist as specified. Otherwise, an error occurs when you try to ru
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*
-====
+```
+SQL> SPOOL C:\log\persnl_updates.log
+```
<<<<
==== Using the `CLEAR` Option
-The `CLEAR` option clears the contents of an existing log file before logging new information to
-the file. If you omit `CLEAR`, TrafCI appends new information to existing information in the log file.
+The 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
+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*
-====
+```
+SQL> SPOOL C:\log\persnl_updates.log clear
+```
==== Log Concurrent the TrafCI Sessions
@@ -901,9 +889,9 @@ To stop logging, enter one of these commands:
This SPOOL OFF command stops logging in an TrafCI session:
-====
-`SQL>`*spool off*
-====
+```
+SQL> SPOOL OFF
+```
<<<
=== View the Contents of a Log File
@@ -916,39 +904,38 @@ output from commands, and diagnostic messages.
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> SET TRANSACTION ISOLATION LEVEL SERIALIZABLE;
--- SQL operation complete. SQL>begin work;
--- SQL operation complete.
-SQL>delete from employee where empnum=32;
+SQL> DELETE FROM employee WHERE empnum=32;
-- 1 row(s) deleted.
-SQL>insert into employee
+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
+SQL> UPDATE dept SET manager=50
where deptnum=1000;
--- 1 row(s) updated.
-SQL>commit work;
+SQL> COMMIT WORK;
--- SQL operation complete.
-SQL>log off
+SQL> LOG OFF
```
-====
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/17b39a0a/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 bf1d78e..b59916c 100644
--- a/docs/command_interface/src/asciidoc/_chapters/launch.adoc
+++ b/docs/command_interface/src/asciidoc/_chapters/launch.adoc
@@ -35,7 +35,7 @@ See <<install_verify, Verify and Set Java Path>>.
1. Find the Windows launch file, `trafci.cmd`, in the `bin` folder:
+
-image:{images}/winbin.jpg[alt="Navigate to bin folder"]
+image:{images}/winbin.jpg[width=400,height=400,alt="Navigate to bin folder"]
2. Double-click the `trafci.cmd` file.
+
@@ -47,7 +47,7 @@ See <<trafci_login, Log In to Database Platform>>.
=== 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*:
+1. Right-click the desktop and select *New>Shortcut*:
+
image:{images}/shortct1.jpg[width=400,height=400,alt="Select trafci.cmd file"]
+
@@ -72,7 +72,7 @@ image:{images}/shortct3.jpg[width=400,height=400,alt="Name shortcut"]
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"`
+ 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"]
@@ -91,11 +91,11 @@ See <<trafci_login, Log In to Database Platform>>.
In the terminal window, enter:
-====
-*./_trafci-installation-directory_/trafci/bin/trafci.sh*
-====
+```
+./<trafci-installation-directory>/trafci/bin/trafci.sh
+```
-_trafci-installation-directory_ is the directory where you installed the TrafCI software files.
+_<trafci-installation-directory>_ is the directory where you installed the TrafCI software files.
For more information,
see the http://trafodion.incubator.apache.org/docs/latest/client_install/index.html[_Trafodion Client Installation Guide_].
@@ -106,16 +106,16 @@ 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*
-====
+```
+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/: ...*
-====
+```
+export PATH=/<trafci-installation-directory>/trafci/bin/: ...
+```
+
_trafci-installation-directory_ is the directory where you installed the TrafCI software files.
For more information,
@@ -126,17 +126,17 @@ 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*
-====
+```
+. .profile
+```
+
<<<
4. On the command line, execute the `trafci.sh` file to launch TrafCI:
+
-====
-*trafci.sh*
-====
+```
+trafci.sh
+```
+
TrafCI appears, prompting you to enter the host name or IP address of the database platform, your user name, and password.
See <<trafci_login, Log In to Database Platform>>.
@@ -144,18 +144,18 @@ See <<trafci_login, Log In to Database Platform>>.
NOTE: To enable all users to launch TrafCI anywhere on the system, create a symbolic link to the
`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*
-====
+```
+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'*
-====
+```
+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,
@@ -172,36 +172,34 @@ If you launch TrafCI and do not specify login parameters on the command line, fo
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: _*
-====
+```
+Host Name/IP Address: _
+```
+
Enter a host name:
+
-====
-*_host-name_[._domain-name_][:_port-number_]*
-====
+```
+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_]*
-====
+```
+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 <<run_interactive, Run Interactive Commands in TrafCI>>.
@@ -220,22 +218,21 @@ To avoid entering a host name, user name, or password each time you launch TrafC
*Example: Windows Login*
-====
-*cd _trafci-installation-directory_\Trafodion Command Interface\bin* +
- +
-*trafci.cmd -h 16.123.456.78:37800 -u user1 -p xxxxxx*
-====
+```
+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*
-====
+```
+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
@@ -244,7 +241,6 @@ Connected to Trafodion
SQL>
```
-====
For more information about the login parameters, see <<trafci_optional_params, Use Optional Launch Parameters>>.
@@ -264,9 +260,9 @@ TrafCI applies the retry logic as follows:
+
*Example*
+
-====
-`$` *trafci –h dd* <- _dd is invalid_
-```
+```
+$ trafci –h dd # dd is invalid
+
Welcome to Trafodion Command Interface
Copyright(C) 2013–2105 Apache Software
@@ -278,8 +274,8 @@ 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
@@ -290,27 +286,26 @@ After three unsuccessful retries, the session is terminated:
+
*Example*
+
-====
-`$` *trafci –h 172.16.1.1 –u user1 –p x*
```
+$ 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]
+**** 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]
+**** 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] +
+**** 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
@@ -322,17 +317,17 @@ 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]
+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.
@@ -348,19 +343,19 @@ to connect to the Trafodion database.
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]...*
-====
+```
+trafci{.sh | .cmd} [optional-parameter]...
+```
-_optional-parameter_
-[role="indented"]
+* `_optional-parameter_`
++
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
+| `{-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
@@ -429,23 +424,22 @@ Use `-q` or `-sql` with the `CREATE SCHEMA` statement to create a schema when la
* On Windows, in the *Command Prompt* window, enter:
+
-====
-*cd _trafci-installation-directory_\Trafodion Command Interface\bin* +
-*trafci.cmd -q "create schema persnl"*
-====
+```
+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"*
-====
+```
+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
@@ -453,9 +447,8 @@ Password:
--- SQL operation complete.
-C:\Program Files (x86)\Apache Software Foundation\Trafodion Command Interface\bin>_
+C:\Program Files (x86)\Apache Software Foundation\Trafodion Command Interface\bin>
```
-====
<<<
*Example*
@@ -464,17 +457,17 @@ Use `-q` or `-sql` with the `PRUN` command to run multiple script files simultan
* On Windows, in the *Command Prompt* window, enter:
+
-====
-*cd _trafci-installation-directory_\Trafodion Command Interface\bin* +
-*trafci.cmd -q "prun"*
-====
+```
+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"*
-====
+```
+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
@@ -507,19 +500,19 @@ For more information, <<script_create, Create a Script File>>.
* On Windows, in the *Command Prompt* window, enter:
+
-====
-*cd _trafci-installation-directory_\Trafodion Command Interface\bin* +
-*trafci.cmd -s settings.txt*
-====
+```
+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*
-====
+```
+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`.
@@ -527,7 +520,6 @@ Specify the full path of the script file if it is outside the directory of `traf
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
@@ -546,7 +538,6 @@ SQL>SET SQLPROMPT *
2:14:57 PM *SET SQLTERMINATOR .
```
-====
<<<
[[trafci_noconnect]]
@@ -560,17 +551,17 @@ be run without a connection.
* On Windows, in the *Command Prompt* window, enter:
+
-====
-*cd _trafci-installation-directory_\Trafodion Command Interface\bin* +
-*trafci.cmd -noconnect*
-====
+```
+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*
-====
+```
+cd <trafci-installation-directory>/trafci/bin
+./trafci.sh -noconnect
+```
<<<
[[trafci_with_version]]
@@ -582,19 +573,18 @@ option. If other parameters are included with the `-version` parameter, they are
* On Windows, in the *Command Prompt* window, enter:
+
-====
-*cd _trafci-installation-directory_\Trafodion Command Interface\bin* +
-*trafci.cmd -version*
-====
+```
+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*
-====
-
-====
+```
+cd <trafci-installation-directory>/trafci/bin
+./trafci.sh -version
+```
++
```
Welcome to Trafodion Command Interface
Copyright(C) 2013–2105 Apache Software Foundation
@@ -602,7 +592,6 @@ 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]]
@@ -615,17 +604,17 @@ To display a list of acceptable list of parameters, including proper usage infor
* On Windows, in the *Command Prompt* window, enter:
+
-====
-*cd _trafci-installation-directory_\Trafodion Command Interface\bin* +
-*trafci -help*
-====
+```
+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*
-====
+```
+cd <trafci-installation-directory>/trafci/bin
+./trafci.sh -help
+```
[[trafci_quit]]
== Exit TrafCI
@@ -637,9 +626,9 @@ To exit TrafCI, enter one of these commands at a prompt:
*Example*
-====
-`SQL>` *quit*
-====
+```
+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/17b39a0a/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 07aeeb7..f560abd 100644
--- a/docs/command_interface/src/asciidoc/_chapters/perlpython.adoc
+++ b/docs/command_interface/src/asciidoc/_chapters/perlpython.adoc
@@ -36,12 +36,12 @@ see <<install, Install and Configure>>.
Before launching TrafCI from Perl or Python, set these login environment variables:
-[cols="45%,55%",options="header"]
+[cols="45%l,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.
+| 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.
|===
@@ -71,11 +71,11 @@ the system or user by including them in the System Properties.
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 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
@@ -121,22 +121,21 @@ for each user by including the variables in the user profile on a Linux or UNIX
==== 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_*
-====
+```
+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_*
-====
+```
+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
@@ -146,28 +145,28 @@ To set the login environment variables in the user profile:
+
*Example*
+
-====
-*vi .profile*
-====
+```
+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_*
-====
+```
+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*
-====
+```
+. .profile
+```
== Perl and Python Wrapper Scripts
@@ -175,11 +174,11 @@ The Perl or Python wrapper scripts enable you to run SQL statements and script f
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"]
+[cols="30%h,70%l",options="header"]
|===
| Operating System | Directory
-| Windows | `_trafci-installation-directory_\Trafodion Command Interface\bin`
-| Linux/Unix | `_trafci-installation-directory_/trafci/bin`
+| 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.
@@ -188,17 +187,16 @@ _trafci-installation-directory_ is the directory where you installed the TrafCI
You can launch the Perl or Python wrapper scripts as shown below:
-[cols="15%h,50%,35%",options="header"]
+[cols="15%h,50%l,35%l",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*
+| 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';
@@ -221,12 +219,10 @@ $retval=$sess->execute("get statistics"); print $retval;
print "\n\nSession 1: Disconnecting first session. \n\n";
$sess->disconnect();
----
-====
<<<
=== Example Python Program (`sample.py`)
-====
[source,python]
----
import os import sys
@@ -259,4 +255,4 @@ sess.disconnect()
del sess
sess=None
----
-====
\ No newline at end of file
+
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/17b39a0a/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 ec120e8..7d9176f 100644
--- a/docs/command_interface/src/asciidoc/_chapters/scripts.adoc
+++ b/docs/command_interface/src/asciidoc/_chapters/scripts.adoc
@@ -62,9 +62,9 @@ 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_*
-====
+```
+-- comment
+```
The end of the line marks the end of the comment.
@@ -74,7 +74,7 @@ The end of the line marks the end of the comment.
To create sections of commands within a script file, put a section header at the beginning of each section:
====
-*?SECTION _section-name_*
+?SECTION section-name
====
The `_section-name_` cannot begin with a number or an underscore. Each section name in a script file should be unique
@@ -98,50 +98,48 @@ in TrafCI. To run a script file when launching TrafCI, see <<trafci_run_script,
This `@` command runs a script file, `sch_invent.sql`, that creates tables in the inventory schema:
====
-*@C:\ddl_scripts\sch_invent.sql*
+@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>@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>-- 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>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 <<cmd_at_sign, @ Command>> and
the <<cmd_obey, OBEY Command>>.
http://git-wip-us.apache.org/repos/asf/incubator-trafodion/blob/17b39a0a/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
index e5bc28c..d3e25cb 100644
Binary files a/docs/command_interface/src/images/launch02.jpg and b/docs/command_interface/src/images/launch02.jpg differ