help

Syntax

help [command [command ...]| all | comments | attributes]

Description

Prints brief or detailed help information for commands.

If specific commands are given as arguments, then detailed help for each command is printed.

If you do not know the exact name of a command, try typing just a few characters that may be part of the command name. ttIsql searches and displays help for any commands that include the characters.

If all is given as an argument, then detailed help for all commands is printed.

If comments is given as an argument, then information on using ttIsql comments within scripts is printed.

If attributes is given as an argument, then information on the set/show attributes is printed.

If no argument is given, then brief help information for all commands is printed. See Help Commands.

Examples

Command> help;
 Use "help all" to get a description of all commands or use "help <cmd>" to
limit it to that command.

?                         fetchnext                 sqlcolumns
!                         free                      sqlgetinfo
@@                        functions                 sqlquerytimeout
accept                    getenv                    sqlquerytimeoutmsec
allfunctions              help                      sqlstatistics
allindexes                history                   sqltables
allpackages               host                      statsclear
allprocedures             if                        statsestimate
allsequences              indexes                   statsupdate
allsynonyms               isolation                 synonyms
alltables                 monitor                   tables
allviews                  multipleconnections       tblsize

….….…                   ….….…                   ….….


Command> help explain;

Arguments in <> are required.
Arguments in [] are optional.


Command Usage: explain [plan for] {[<connection_name>.]<ttisqlcmdid> | sqlcmdid
<sqlcmdid> | <stmt> | !<historyitem> }
Command Aliases: (none)
Description: Explain a plan for either the prepared ttisql cmd, the sqlcmdid,
<sqlstmt>, or the statement from the given history item..  When the SQL text
is given this is shorthand for "autocommit 0; showplan 1; prepare <sqlstmt>;
restore autocommit and showplan." The literals "plan for" are not required for
TT, but are part of the Oracle RDBMS syntax; ttIsql will insert the keywords
'plan for' when passthrough=3. When a cmdid is given, the plan is retrieved
via the builtin ttsqlcmdqueryplan(). The cmdid form will not work with
passthrough > 0.
Requires an active connection: YES
Requires autocommit turned off: NO
Reports elapsed execution time: YES
Works only with a TimesTen data source: YES
Example: explain select * from dual; -or- explain plan for select * from dual;