Command Reference Guide > Command Reference Guide > Using Actian X Commands > sql Command--Start the Line-based SQL Terminal Monitor
Was this helpful?
sql Command--Start the Line-based SQL Terminal Monitor
The sql command invokes the line-based Terminal Monitor for SQL, as described in the SQL Reference Guide.
The sql command has the following format:
sql [SQL option flags] [line-mode flags] dbname |vnode::dbname[/server_class] [+user=[authuser]] [<altin] [>altout]
SQL option flags
Specifies flags that can be used with the line-based Terminal Monitor and other commands where noted. The SQL option flags determine the format of output or the behavior of the DBMS. You can specify a maximum of twelve SQL option flags. The flags are as follows:
-cN
Sets the minimum field width for printing character columns to N. The default is 6.
-fkxM.N
Sets floating-point output column width to M characters (total), including N decimal places, and (if warranted) e+-xx and the decimal indicator character itself.
k can be 4 or 8 to apply to f4’s or f8’s respectively.
x can be E, F, G or N (uppercase or lowercase) to specify an output format. E indicates exponential format. F indicates floating-point format. G indicates the floating-point format and guarantees decimal alignment. N indicates floating-point format, decimal alignment, and right-justification.
If you specify N or G and the number is too large for the format indicated by the flag, it is displayed in exponential format. To prevent this format overflow, M should be greater than or equal to N + 7.
The default display format for both f4 and f8 is n10.3, unless your computer supports the IEEE standard for floating-point numbers, in which case the display format for f4 and f8 is n11.3.
-Ggroupid
Specifies a group identifier, as described in Standard Flags and Parameters.
-ikN
Sets integer output column width to N. k can be 1, 2, or 4 for i1’s, i2’s, or i4’s, respectively. The default for N is 6 for i1 and i2 fields, and 13 for i4 fields.
-l
Locks the database for your exclusive use. When you specify this flag, no one else can open the database while you are in it. If you attempt to take an exclusive lock on a database that is in use, the system informs you that the database is temporarily unavailable.
-nM
Sets modify mode on the index command to M. M must be one of the following storage structures: ISAM, CISAM, B-tree, CB-tree, Hash, or CHash. The default is ISAM.
-no_x100
Disables the creation of X100 tables and use of X100 operations for the session.
-numeric_overflow = fail | warn | ignore
Sets error handling mode for numeric overflow, underflow, and division by zero.
fail—(Default) Aborts the statement and issues an error message. For ANSI-compliant behavior, use this setting (or omit the flag).
warn—Issues a warning message
ignore—Issues no error message
-Rroleid
Specifies a role identifier for the session, as described in Standard Flags and Parameters.
-string_truncation = fail | warn | ignore
Sets error handling mode for string truncation errors. This error occurs if you attempt to insert a string into a table column that is too short to contain the value.
fail—Aborts the statement and issues an error message. For ANSI-compliant behavior, use this setting.
warn—Truncates and inserts the string but issues a warning message.
ignore—(Default) Truncates and inserts the string without issuing an error message.
-tN
Sets the minimum field width for printing text columns to N. The default is 6.
-uusername
Specifies the effective user for the session, as described in Standard Flags and Parameters.
+U|-U
Enables (+U) or disables (-U) user updating of the system catalogs and secondary indexes, and takes an exclusive lock on the database. To update system catalogs, you must have the update system tables privilege obtained through accessdb.
+w|-w
Indicates to wait (+w) or not wait (-w) for the database. The default is ‑w. If you specify +w, you must wait if certain processes are running (sql –l, sql –U, verifydb, rollforwarddb, or sysmod) on the given database, before the operation proceeds.
If you specify –w and the database is not available, a message is returned and execution is stopped. If you omit the w flag and the database is unavailable, an error message is returned if running in foreground (more precisely, if the standard input is from a terminal). Otherwise, the wait option is invoked.
+Y|-Y
Enables (+Y) or disables (-Y) user updating of the system catalogs and secondary indexes, but does not take an exclusive lock on the database.
line-mode flags
Specify flags that can be used with the line-based Terminal Monitor only. The flags are as follows:
+a|-a
Sets (+a) or clears (-a) the autoclear option in the terminal monitor. The default is +a.
+d|-d
Prints (+d) or does not print (-d) the dayfile. The default is +d.
-history_recall | nohistory_recall
Invokes the terminal monitor with or without history recall functionality, which lets you retrieve the history of commands typed in the session and perform other functions. For details, see the SQL Reference Guide.
-Ppassword
Specifies the user password.
-Rrole-name/role-password
Identifies the role name and optional role password. Separate the name and password with a slash (/).
+s|-s
Prints (+s) or does not print (-s) the monitor messages, including prompts. The default is +s. If you specify -s, the dayfile is not displayed.
-S
Runs the Terminal Monitor in silent mode, which shows query output only, and suppresses headers, footers, separators, lines, and row counts. This allows simple reports to be created as SQL scripts and then run without having to edit the output.
-vX
Sets the column separator to the character specified by X. The default is vertical bar (|).
dbname
Specifies the name of the database, and if required, the vnode and server_class, as described in Standard Flags and Parameters.
+user=[authuser]
Specifies or prompts for the user name and password used for connecting to a remote database, as described in Standard Flags and Parameters.
<altin
Specifies a file from which the Terminal Monitor reads commands. The file must contain all terminal monitor commands needed to run the session.
>altout
Directs output from the Terminal Monitor to the specified file. If you specify this parameter, you will not see any output.
Last modified date: 11/09/2022