Programs: OdxSQL

Options

There are many options that can be set in OdxSQL. They are described below.

SET API

The SET command by itself shows the values for all of the settings in OdxSQL.

SET

SET API

The SET API option determines whether statements should be run through the default API, called OmniAccess, or through the client interfaces of ODBC and JDBC.

The default setting is OA.

SET API <OA | ODBC | JDBC>

SET AUTODISPLAY

The SET AUTODISPLAY option determines whether the results from a SELECT statement should be displayed using a LIST view or a FORM view. In a LIST view, multiple columns appear per row with column headings at the top. In a FORM view, each column for each row is displayed on a separate line.

The default setting is LIST.

SET AUTODISPLAY <LIST | FORM>

SET AUTOEXPLAIN

The SET AUTOEXPLAIN option determines whether the query plan for a SELECT statement should be displayed. The value of ON shows the query plan instead of the result set, and the value of AFTER shows the query plan after the result set.

The default setting is OFF.

SET AUTOEXPLAIN <ON | OFF | AFTER>

SET AUTOFETCH

The SET AUTOFETCH option determines whether the results from a SELECT statement should be automatically fetched and displayed.

The default setting is ON.

SET AUTOFETCH <ON | OFF>

SET AUTORESET

The SET AUTORESET option determines whether QUALIFY statements that return a zero qualifying count are automatically backed out.

The default setting is OFF.

SET AUTORESET <ON | OFF>

SET CHAR

The SET CHAR option determines the number of characters display for binary data.

The default setting is AUTO.

SET CHAR <AUTO | n>

SET CURSOR

The SET CURSOR option determines which cursor to use for subequent statements. This is only relevant if the OPEN CURSOR command has been issued.

The default setting is 0.

SET CURSOR n

SET CURSORDISPLAY

The SET CURSORDISPLAY option displays the cursor used for each statement.

The default setting is OFF.

SET CURSORDISPLAY <ON | OFF>

SET DEFAULTS

The SET DEFAULTS option returns all settings to their default values.

SET DEFAULTS

SET ERRORDISPLAY

The SET ERRORDISPLAY option determines how much detail to show when an error occurs.

The default setting is MESSAGE.

SET ERRORDISPLAY <NONE | MESSAGE | DETAIL | FULL>

SET ERRORS

The SET ERRORS option determines what action to take if a statement produces an error condition. This setting only applies when statements are run in a command file with the USE <file> command. The value of ABORT causes the processing of the command file to stop. The value of CONTINUE causes the processing to continue. The value of EXIT causes the processing of the command file to stop and OdxSQL to exit with an error status.

The default setting is ABORT.

SET ERRORS <ABORT | CONTINUE | EXIT>

SET EXPLAIN

The SET EXPLAIN option determines what information to display in query plans. The value of COUNTS displays row counts and timings. The value of TEXT displays PowerSearch translations.

SET EXPLAIN [<COUNTS | NOCOUNTS>] [<TEXT | NOTEXT>]

SET HEADERS

The SET HEADERS option determines whether column headers will be displays after results have been fetched from a SELECT statement.

The default setting is ON.

SET HEADERS <ON | OFF>

SET HEX

The SET HEX option determines whether the results of a SELECT statement should be display in hex.

The default setting is HEX.

SET HEX <ON | OFF | ONLY>

SET HISTORY

The SET HISTORY option determines how many statements to record in the history stack for this session of OdxSQL.

The default setting is 100.

SET HISTORY n

SET INSTANCE

The SET INSTANCE option determines which instance to use for subsequent statements. This is only relevant if the SET MULTICONNECT ON option has been issued.

The default setting is 0.

SET INSTANCE n

SET MULTICONNECT

The SET MULTICONNECT option determines whether a CONNECT statement will automatically disconnect the current connection or establish an additional, concurrent connection.

The default setting is OFF.

SET MULTICONNECT] <ON | OFF

SET MULTILINE

The SET MULTILINE option determines whether long character or string columns will be display on multiple lines.

The default setting is OFF.

SET MULTILINE] <ON | OFF | n

SET NULL_INDICATORS

The SET NULL_INDICATORS option determines whether null indicators will be shown in the result set for a SELECT statement.

The default setting is OFF.

SET NULL_INDICATORS <ON | OFF | string>

SET OMNIDEX_DEBUG

The SET OMNIDEX_DEBUG option allows debug settings to be issued from within OdxSQL.

The default setting is OFF.

SET OMNIDEX_DEBUG <ON | OFF | profile> [FILE=filename] [FOR SERVER]

SET PAGELENGTH

The SET PAGELENGTH option determines how many lines to display per page. The value of 0 disables all paging.

The default setting is 24.

SET PAGELENGTH n

SET PAGEWIDTH

The SET PAGEWIDTH option determines how many columns to display per page.

The default setting is 80.

SET PAGEWIDTH n

SET POWERSEARCH

The SET POWERSEARCH option determines whether queries should automatically use PowerSearch.

The default setting is OFF.

SET POWERSEARCH <ON | OFF | list>

SET PROMPT

The SET PROMPT option determines the prompt to use within OdxSQL.

The default setting is “> ”.

SET PROMPT ["string"] [WITH [FILE] [LINE] [COMMAND]]

SET QUALIFY_COUNTS

The SET QUALIFY_COUNTS option determines which types of counts to display following QUALIFY and JOIN commands.

The default setting is PARENT NOPREINTERSECT.

SET QUALIFY_COUNTS [<PARENT | NOPARENT>] [<PREINTERSECT | NOPREINTERSECT>]

SET QUALIFY_MODE

The SET QUALIFY_MODE option determines whether to use the current parser for QUALIFY statements, or the legacy parsers from earlier versions of Omnidex.

The default setting is PARSER.

SET QUALIFY_MODE <PARSER | ODXFIND | OX_FIND>

SET SILENT_MODE

The SET SILENT_MODE option determines whether results should be displayed following SELECT statements.

The default setting is OFF.

SET SILENT_MODE <ON | OFF>

SET STATISTICS

The SET STATISTICS option determines whether to maintain a log of commands issued in OdxSQL. The log file is a delimited file named odxsql.log.

The default setting is OFF.

SET STATISTICS <ON | OFF | filename>

SET STATUSDISPLAY

The SET STATUSDISPLAY option determines whether to display the results of the internal status structure for every command. The status structure contains information about the statement, such as error codes and counts.

The default setting is OFF.

SET STATUSDISPLAY <ON | OFF>

SET TIMEOUT

The SET TIMEOUT option determines whether to automatically apply timeouts to SELECT statements.

The default setting is OFF.

SET TIMEOUT <seconds | OFF>

SET TIMER

The SET TIMER option determines whether to display timing statistics for each command. The value of CUMULATIVE displays a second clock with cumulative times since the last RESET TIMER command.

The default setting is OFF.

SET TIMER <ON | CUMULATIVE | OFF>

SET TIMEZONE

The SET TIMEZONE option determines the timezone to use for Omnidex statements.

The default setting is the timezone for the server.

SET TIMEZONE timezone

Additional Resources

See also:

 
Back to top
programs/odxsql/options.txt · Last modified: 2016/06/28 22:38 (external edit)