Appendix A. SqlTool System PL Variables

As of SqlFile revision 5339

SqlTool System PL variables are the mechanism used to configure SqlTool behavior. You can list all set PL variables by running the SqlTool command * listvalues. If a SqlTool System variable is not shown, then it is unset (which is equivalent to non-null). But if a system variable is not set, that doesn't mean that the setting behavior will be unset, but rather that the default behavior will apply. For example, if you * listvalues and the variable *DSV_COL_DELIM is not listed, that doesn't mean that there will be no DSV column delimiter, but that the default DSV column delimiter will be used. The in-program help can be used to determine what the default behavior is. (In the case of *DSV_COL_DELIM, you can see the default behavior by running \x?.

Besides System PL variables, there are also user PL variables which have names beginning with a letter, and the special variables ? and NULL. NULL is completely equivalent to *NULL, which is explained below. See the SqlTool chapter about ?.

*ALL_QUOTED

Boolean. Whether to quote all values (excluding null values) in a \xq export. No effect on any command other than \xq.

*BOTTOM_HTMLFRAG_FILE

File path to HTML fragment file to close the HTML report or DSV import reject file.

*DSV_COL_DELIM

Literal string (which may contain character escapes). DSV or CSV output column delimiter literal. Run \x? to see default value and details.

*DSV_COL_SPLITTER

Regular expression. DSV or CSV input column delimiter regular expression. Run \x? to see default value and details.

*DSV_CONST_COLS

A list of column_name = column_value|... settings. Specifies constant import values. Run \x? to see default value and details.

*DSV_RECORDS_PER_COMMIT

Integer. How often to commit upon DSV/CSV imports. Run \x? to see default value and details.

*DSV_REJECT_FILE

File path. Path to DSV file of rejects rejected upon CSV/DSV imports. Run \x? to see default value and details.

*DSV_REJECT_REPORT

File path. Path to HTML report about CSV/DSV import failures. Run \x? to see default value and details.

*DSV_ROW_DELIM

Literal string (which may contain character escapes). DSV or CSV output row delimiter literal. Run \x? to see default value and details.

*DSV_ROW_SPLITTER

Regular expression. DSV or CSV input row delimiter regular expression. Run \x? to see default value and details.

*DSV_SKIP_COLS

A list of column names to skip, like column1|column2 Specifies columns to omit from CSV or DSV importing or exporting. Run \x? to see default value and details.

*DSV_SKIP_PREFIX

Literal string (which may contain character escapes). Specifies comment delimiter character or string in DSV or CSV files. Run \x? to see default value and details.

*DSV_TRIM_ALL

Boolean. Trim leading and trailing white space from every cell in CSV or DSV file upon import. Run \x? to see default value and details.

*DSV_TARGET_FILE

File path. File where to export CSV or DSV to. Run \x? to see default value and details.

*DSV_TARGET_TABLE

Table name. Table where to import CSV or DSV to. Run \x? to see default value and details.

*IGNORE_BANG_STATUS

Boolean. If true, then if an external command executed by \! returns error (non-zero) status, SqlTool will not report or try to act on the error. (This will have no effect on what the external program may do).

*NULL

Null (i.e. always unset).

*NULL_REP_HTML

Literal string (which may contain character escapes). Same as *NULL_REP_TOKEN, but only applies to HTML reports.

*NULL_REP_TOKEN

Literal string (which may contain character escapes). String value to represent SQL nulls from VARCHAR columns and null (unset) PL variable values. Applies to what displays on screen and what gets written into export files.

*REVISION

Read only. Literal string.

*ROW

Read only. Literal string. Set only inside of * forrow loop bodies. If there is only a single column fetched, then this is equal to that cell of the current row, unless that value is null, in which case *ROW will be the *NULL_REP_TOKEN value.

*START_TIME

Read only. Literal string. Automatically set to a localized string presenting the date and time.

*TIMESTAMP

Read only. Literal string. Only usable if *TIMESTAMP_FORMAT has been set. Displays the date and/or time at which this variable is dereferenced.

*TIMESTAMP_FORMAT

Formatting string, as described below. Setting this variable enables the *TIMESTAMP read-only variable to be used. Set to a date and/or time format like yyyy-MM-dd'T'HH:mm:ss.SSSZ, as described at http://download.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html

*TOP_HTMLFRAG_FILE

File path. File path to HTML fragment file to open the HTML report or DSV import reject file.

$Revision: 5063 $