help

構文

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

説明

コマンドの簡単なヘルプ情報または詳細なヘルプ情報を出力します。

引数として特定のコマンドを指定した場合は、各コマンドの詳細なヘルプが出力されます。

コマンドの正確な名前がわからない場合は、コマンド名の一部の可能性がある数文字のみを入力します。ttIsqlでは、それらの文字を含むすべてのコマンドのヘルプが検索され、表示されます。

引数としてallを指定した場合は、すべてのコマンドの詳細なヘルプが出力されます。

引数としてcommentsを指定した場合は、スクリプト内でのttIsqlコメントの使用に関する情報が出力されます。

引数としてattributesを指定した場合は、set/show属性に関する情報が出力されます。

引数を指定しない場合は、すべてのコマンドの簡単なヘルプ情報が出力されます。「helpコマンド」を参照してください。

例

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

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


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;