Help Commands
The ttIsql utility has an online version of command syntax
definitions and descriptions for all built-in ttIsql commands.
To access this online help from within
ttIsql, use the
help command from the shell's command
prompt:$ ttIsql -help
Usage: ttIsql [-h | -help | -helpcmds | -helpfull | -V]
ttIsql [-f <filename>] [-v <verbosity>] [-e <commands>]
[-interactive] [-N <ncharEncoding>] [-wait]
[{<DSN> | -connstr <connStr>}]
-h Prints this message and exits.
-help Prints this message and exits.
-helpcmds Prints a brief description of ttIsql commands and exits.
-helpfull Prints a full description of ttIsql commands and exits.
-V Prints version information and exits.
<DSN>, <connStr> The ODBC connection string or DSN to use as an
argument to the connect command. The connect command
will then be the first command executed when
starting ttIsql.
-f <filename> Specifies an input file of ttIsql commands to be
executed on start up.
-v <verbosity> Specifies the output verbosity level. The output
verbosity level argument takes a value of 0, 1, 2,
3 or 4.
If verbosity = 0 then only error messages are displayed.
If verbosity = 1 then the basic output generated by
commands is displayed.
Verbosity = 2 is the default verbosity level. At this level
simplified SQL error and information messages are
displayed. Command output includes additional information,
and commands that are read from an external file are
echoed to the display.
If verbosity = 3 then more detailed SQL error and
information messages are displayed.
If verbosity = 4 then the most detailed SQL error and
information messages are displayed. At this level
additional informational messages are displayed depending
upon the command executed.
-e <commands> Specifies a semicolon-separated list of ttIsql commands
to execute on start up.
-N <ncharEncoding> Specifies the character encoding method for native
character input/output. Valid values are ASCII,
and LOCALE. The default encoding method (LOCALE)
is derived from the current environment locale settings.
-wait Forces the program to wait during a connection attempt
until the connection attempt is successful.
-interactive Forces interactive mode. This is useful when running from
an emacs comint buffer.
Default command line options can be set by exporting an environment
variable called TTISQL. The value of the TTISQL environment variable
is a string with the same syntax requirements as the ttIsql command
line. If the same option is present in the TTISQL environment
variable and the command line, then the command line version always
takes precedence.
Examples:
ttIsql -connStr "DSN=mydsn" -v 4
ttIsql -helpfull
ttIsql -connStr "DSN=mydsn" -e "autocommit 0; showplan 1;"
ttIsql -connStr "DSN=mydsn" -f script.sql -N ASCIITo view the list of available commands displayed by the help
command:
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
autocommit multipleconnections tblsize
builtins ncharencoding timing
cachegroups noecho tryhash
cachesqlget optfirstrow trymaterialize
cd optprofile trymergejoin
clearhistory packages trynestedloopjoin
clienttimeout passthrough tryrowid
close prefetchcount tryrowlocks
closeall prepare tryserial
cmdcache print trytbllocks
columnlabels procedures trytmphash
commit putenv trytmptable
commitdurable prompt trytmprange
compact remark tryrange
compare repschemes undefine
connect retryconnect unsetjoinorder
createandloadfromoraquery rollback unsetuseindex
define rpad use
describe run variable
disconnect savehistory verbosity
dssize sequences version
e: set vertical
edit setjoinorder views
exec setuseindex waitfor
execandfetch setvariable waitforresult
exit show whenever
explain showjoinorder xlabookmarkdelete
fetchall showplan <sql_statement>
fetchone sleep To view a detailed description of any built-in ttIsql
commands, type the help command followed by one or more
ttIsql commands to display help for. The example below displays the
online description for the connect and disconnect
commands:
Command>help connect disconnect
Arguments in <> are required.
Arguments in [] are optional.
Command Usage: connect [DSN|connection_string] [as <connection_id>]
Command Aliases: (none)
Description: Connects to the data source specified by the optional DSN or
connection string argument. If an argument is not given, then the DSN or
connection string from the last successful connection is used. A connection ID
may optionally be specified, for use in referring to the connection when multiple
connections are enabled. The DSN is used as the default connection ID. If that ID
is already in use, the connection will be assigned the ID "conN", where N is some
number larger than 0.
Requires an active connection: NO
Requires autocommit turned off: NO
Reports elapsed execution time: YES
Works only with a TimesTen data source: NO
Example: connect; -or- connect RunData; -or- connect "DSN=RunData";
-or- connect RunData as rundata1;
Command Usage: disconnect [all]
Command Aliases: (none)
Description: Disconnects from the currently connected data source or all
connections when the "all" argument is included. If a transaction is active when
disconnecting then the transaction will be rolled back automatically. If a
connection exists when executing the "bye", "quit" or "exit" commands then the
"disconnect" command will be executed automatically.
Requires an active connection: NO
Requires autocommit turned off: NO
Reports elapsed execution time: YES
Works only with a TimesTen data source: NO
Example: disconnect;
In case of attributes, you can view and set attributes with the
show and set commands and in case of commands, you
can run built-in commands from the ttIsql utility. See View and Set Attributes.
To view the list of
attributes:
Command>help attributes
Known attributes:
- autoprint
- autovariables
- autocommit
- clienttimeout
- columnlabels
- connstr
- define
- distribution
- dynamicloadenable
- dynamicloaderrormode
- echo
- editline
- failovermessage
- errors
- feedback
- isolation
- long
- longchunksize
- multipleconnections
- ncharencoding
- optfirstrow
- optprofile
- passthrough
- prefetchcount
- prompt
- querythreshold
- rowdelimiters
- sqlquerytimeout
- sqlquerytimeoutmsec
- serveroutput
- session_action
- session_client_info
- session_module
- showcurrenttime
- showplan
- termout
- timing
- tryhash
- trymaterialize
- trymergejoin
- trynestedloopjoin
- tryrange
- tryrowid
- tryrowlocks
- tryserial
- trytbllocks
- trytmphash
- trytmprange
- trytmptable
- verbosity
- vertical
For detailed attribute help, do "help attribute <attributename>"
To view help for a specific
attribute:
Command>help attribute showcurrenttime;
Attribute usage: showcurrenttime
Attribute Usage: showcurrenttime [0|off|1|on]
Description: The current time is printed just after the command is read and
before the command is executed.
Used with Set: YES
Used with Show: YES