This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
programs:odxsql:options [2015/06/10 21:57] doc |
programs:odxsql:options [2016/06/28 22:38] (current) |
||
|---|---|---|---|
| Line 16: | Line 16: | ||
| - | ===== SET API ===== | + | ==== SET API ==== |
| - | The SET API option | + | The SET command by itself shows the values for all of the settings in OdxSQL. |
| + | |||
| + | <code> | ||
| + | SET | ||
| + | </code> | ||
| + | |||
| + | ==== 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. | The default setting is OA. | ||
| Line 26: | Line 34: | ||
| </code> | </code> | ||
| - | ===== SET AUTODISPLAY ===== | + | ==== SET AUTODISPLAY ==== |
| - | The SET AUTODISPLAY option | + | 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. | The default setting is LIST. | ||
| Line 36: | Line 44: | ||
| </code> | </code> | ||
| - | ===== SET AUTOEXPLAIN ===== | + | ==== SET AUTOEXPLAIN ==== |
| - | The SET AUTOEXPLAIN option | + | 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. | The default setting is OFF. | ||
| Line 46: | Line 54: | ||
| </code> | </code> | ||
| - | ===== SET AUTOFETCH ===== | + | ==== SET AUTOFETCH ==== |
| - | The SET AUTOFETCH option | + | The SET AUTOFETCH option determines whether the results from a SELECT statement should be automatically fetched and displayed. |
| The default setting is ON. | The default setting is ON. | ||
| Line 56: | Line 64: | ||
| </code> | </code> | ||
| - | ===== SET AUTORESET ===== | + | ==== SET AUTORESET ==== |
| - | The SET AUTORESET option | + | The SET AUTORESET option determines whether QUALIFY statements that return a zero qualifying count are automatically backed out. |
| The default setting is OFF. | The default setting is OFF. | ||
| Line 66: | Line 74: | ||
| </code> | </code> | ||
| - | ===== SET CHAR ===== | + | ==== SET CHAR ==== |
| - | The SET CHAR option | + | The SET CHAR option determines the number of characters display for binary data. |
| The default setting is AUTO. | The default setting is AUTO. | ||
| Line 76: | Line 84: | ||
| </code> | </code> | ||
| - | ===== SET CURSOR ===== | + | ==== SET CURSOR ==== |
| - | The SET CURSOR option | + | 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. | The default setting is 0. | ||
| Line 86: | Line 94: | ||
| </code> | </code> | ||
| - | ===== SET CURSORDISPLAY ===== | + | ==== SET CURSORDISPLAY ==== |
| - | The SET CURSORDISPLAY option | + | The SET CURSORDISPLAY option displays the cursor used for each statement. |
| The default setting is OFF. | The default setting is OFF. | ||
| Line 96: | Line 104: | ||
| </code> | </code> | ||
| - | ===== SET DEFAULTS ===== | + | ==== SET DEFAULTS ==== |
| - | The SET DEFAULTS option | + | The SET DEFAULTS option returns all settings to their default values. |
| <code> | <code> | ||
| Line 104: | Line 112: | ||
| </code> | </code> | ||
| - | ===== SET EDITOR ===== | + | ==== SET ERRORDISPLAY ==== |
| - | The SET EDITOR option | + | The SET ERRORDISPLAY option determines how much detail to show when an error occurs. |
| - | + | ||
| - | The default setting is DEFAULT. | + | |
| - | + | ||
| - | <code> | + | |
| - | SET EDITOR <NOTEPAD | WORDPAD | VI | EMACS | path | + | |
| - | </code> | + | |
| - | + | ||
| - | ===== SET ERRORDISPLAY ===== | + | |
| - | + | ||
| - | The SET ERRORDISPLAY option | + | |
| The default setting is MESSAGE. | The default setting is MESSAGE. | ||
| Line 124: | Line 122: | ||
| </code> | </code> | ||
| - | ===== SET ERRORS ===== | + | ==== SET ERRORS ==== |
| - | The SET ERRORS option | + | 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. | The default setting is ABORT. | ||
| Line 134: | Line 132: | ||
| </code> | </code> | ||
| - | ===== SET EXPLAIN ===== | + | ==== SET EXPLAIN ==== |
| - | The SET EXPLAIN option | + | 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. |
| - | + | ||
| - | The default setting is NOCOUNTS SUMMARY DETAILS ADDIN NOTEXT NONODES. | + | |
| <code> | <code> | ||
| - | SET EXPLAIN [<COUNTS | NOCOUNTS>] [<TEXT | NOTEXT>] [<NODES | NONODES>] | + | SET EXPLAIN [<COUNTS | NOCOUNTS>] [<TEXT | NOTEXT>] |
| </code> | </code> | ||
| - | ===== SET HEADERS ===== | + | ==== SET HEADERS ==== |
| - | The SET HEADERS option | + | 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. | The default setting is ON. | ||
| Line 154: | Line 150: | ||
| </code> | </code> | ||
| - | ===== SET HEX ===== | + | ==== SET HEX ==== |
| - | The SET HEX option | + | The SET HEX option determines whether the results of a SELECT statement should be display in hex. |
| The default setting is HEX. | The default setting is HEX. | ||
| Line 164: | Line 160: | ||
| </code> | </code> | ||
| - | ===== SET HISTORY ===== | + | ==== SET HISTORY ==== |
| - | The SET HISTORY option | + | The SET HISTORY option determines how many statements to record in the history stack for this session of OdxSQL. |
| The default setting is 100. | The default setting is 100. | ||
| Line 174: | Line 170: | ||
| </code> | </code> | ||
| - | ===== SET INSTANCE ===== | + | ==== SET INSTANCE ==== |
| - | The SET INSTANCE option | + | 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. | The default setting is 0. | ||
| Line 184: | Line 180: | ||
| </code> | </code> | ||
| - | ===== SET INTERRUPTS ===== | + | ==== SET MULTICONNECT ==== |
| - | The SET INTERRUPTS option | + | 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 ON. | + | |
| - | + | ||
| - | <code> | + | |
| - | SET INTERRUPTS <ON | OFF | API> | + | |
| - | </code> | + | |
| - | + | ||
| - | ===== SET MULTICONNECT ===== | + | |
| - | + | ||
| - | The SET MULTICONNECT option | + | |
| The default setting is OFF. | The default setting is OFF. | ||
| Line 204: | Line 190: | ||
| </code> | </code> | ||
| - | ===== SET MULTILINE ===== | + | ==== SET MULTILINE ==== |
| - | The SET MULTILINE option | + | The SET MULTILINE option determines whether long character or string columns will be display on multiple lines. |
| The default setting is OFF. | The default setting is OFF. | ||
| Line 214: | Line 200: | ||
| </code> | </code> | ||
| - | ===== SET NULL_INDICATORS ===== | + | ==== SET NULL_INDICATORS ==== |
| - | The SET NULL_INDICATORS option | + | 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. | The default setting is OFF. | ||
| Line 224: | Line 210: | ||
| </code> | </code> | ||
| - | ===== SET OMNIDEX_DEBUG ===== | + | ==== SET OMNIDEX_DEBUG ==== |
| - | The SET OMNIDEX_DEBUG option | + | The SET OMNIDEX_DEBUG option allows debug settings to be issued from within OdxSQL. |
| The default setting is OFF. | The default setting is OFF. | ||
| Line 234: | Line 220: | ||
| </code> | </code> | ||
| - | ===== SET OPTIMIZATION ===== | + | ==== SET PAGELENGTH ==== |
| - | The SET OPTIMIZATION option | + | The SET PAGELENGTH option determines how many lines to display per page. The value of 0 disables all paging. |
| - | + | ||
| - | The default setting is DEFAULT. | + | |
| - | + | ||
| - | <code> | + | |
| - | SET OPTIMIZATION options | + | |
| - | </code> | + | |
| - | + | ||
| - | ===== SET PAGELENGTH ===== | + | |
| - | + | ||
| - | The SET PAGELENGTH option | + | |
| The default setting is 24. | The default setting is 24. | ||
| Line 254: | Line 230: | ||
| </code> | </code> | ||
| - | ===== SET PAGEWIDTH ===== | + | ==== SET PAGEWIDTH ==== |
| - | The SET PAGEWIDTH option | + | The SET PAGEWIDTH option determines how many columns to display per page. |
| The default setting is 80. | The default setting is 80. | ||
| Line 264: | Line 240: | ||
| </code> | </code> | ||
| - | ===== SET POWERSEARCH ===== | + | ==== SET POWERSEARCH ==== |
| - | The SET POWERSEARCH option | + | The SET POWERSEARCH option determines whether queries should automatically use PowerSearch. |
| The default setting is OFF. | The default setting is OFF. | ||
| Line 274: | Line 250: | ||
| </code> | </code> | ||
| - | ===== SET PROMPT ===== | + | ==== SET PROMPT ==== |
| - | The SET PROMPT option | + | The SET PROMPT option determines the prompt to use within OdxSQL. |
| The default setting is "> ". | The default setting is "> ". | ||
| Line 284: | Line 260: | ||
| </code> | </code> | ||
| - | ===== SET QUALIFY_COUNTS ===== | + | ==== SET QUALIFY_COUNTS ==== |
| - | The SET QUALIFY_COUNTS option | + | The SET QUALIFY_COUNTS option determines which types of counts to display following QUALIFY and JOIN commands. |
| The default setting is PARENT NOPREINTERSECT. | The default setting is PARENT NOPREINTERSECT. | ||
| Line 294: | Line 270: | ||
| </code> | </code> | ||
| - | ===== SET QUALIFY_MODE ===== | + | ==== SET QUALIFY_MODE ==== |
| - | The SET QUALIFY_MODE option | + | 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. | The default setting is PARSER. | ||
| Line 304: | Line 280: | ||
| </code> | </code> | ||
| - | ===== SET REQUIRED_OPTIMIZATION ===== | + | ==== SET SILENT_MODE ==== |
| - | The SET REQUIRED_OPTIMIZATION option | + | The SET SILENT_MODE option determines whether results should be displayed following SELECT statements. |
| - | + | ||
| - | The default setting is NONE. | + | |
| - | + | ||
| - | <code> | + | |
| - | SET REQUIRED_OPTIMIZATION options | + | |
| - | </code> | + | |
| - | + | ||
| - | ===== SET SILENT_MODE ===== | + | |
| - | + | ||
| - | The SET SILENT_MODE option | + | |
| The default setting is OFF. | The default setting is OFF. | ||
| Line 324: | Line 290: | ||
| </code> | </code> | ||
| - | ===== SET SQL_SYNTAX ===== | + | ==== SET STATISTICS ==== |
| - | + | ||
| - | The SET SQL_SYNTAX option | + | |
| - | + | ||
| - | The default setting is OMNIDEX. | + | |
| - | + | ||
| - | <code> | + | |
| - | SET SQL_SYNTAX <OMNIDEX | ORACLE | SQLSERVER> | + | |
| - | </code> | + | |
| - | + | ||
| - | ===== SET STATISTICS ===== | + | |
| - | The SET STATISTICS option | + | 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. | The default setting is OFF. | ||
| Line 344: | Line 300: | ||
| </code> | </code> | ||
| - | ===== SET STATUSDISPLAY ===== | + | ==== SET STATUSDISPLAY ==== |
| - | The SET STATUSDISPLAY option | + | 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. | The default setting is OFF. | ||
| Line 354: | Line 310: | ||
| </code> | </code> | ||
| - | ===== SET TIMEOUT ===== | + | ==== SET TIMEOUT ==== |
| - | The SET TIMEOUT option | + | The SET TIMEOUT option determines whether to automatically apply timeouts to SELECT statements. |
| The default setting is OFF. | The default setting is OFF. | ||
| Line 364: | Line 320: | ||
| </code> | </code> | ||
| - | ===== SET TIMER ===== | + | ==== SET TIMER ==== |
| - | The SET TIMER option | + | 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. | The default setting is OFF. | ||
| Line 374: | Line 330: | ||
| </code> | </code> | ||
| - | ===== SET TIMEZONE ===== | + | ==== SET TIMEZONE ==== |
| - | The SET TIMEZONE option | + | The SET TIMEZONE option determines the timezone to use for Omnidex statements. |
| The default setting is the timezone for the server. | The default setting is the timezone for the server. | ||
| Line 386: | Line 342: | ||
| ===== ===== | ===== ===== | ||
| - | **[[programs:odxsql:commands|Prev]]** | **[[programs:odxsql:files|Next]]** | | + | **[[programs:odxsql:commands|Prev]]** | **[[programs:odxsql:cmdline|Next]]** |
| ====== Additional Resources ====== | ====== Additional Resources ====== | ||