This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
programs:odxsql:settings:home [2009/12/03 17:19] tdo |
programs:odxsql:settings:home [2012/10/26 14:57] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| {{page>:top_add&nofooter&noeditbtn}} | {{page>:top_add&nofooter&noeditbtn}} | ||
| <html><div align="center"><span style="color:red">DRAFT</span></div></html> | <html><div align="center"><span style="color:red">DRAFT</span></div></html> | ||
| + | ~~NOTOC~~ | ||
| ====== OdxSQL Settings ====== | ====== OdxSQL Settings ====== | ||
| + | {{page>:sql_odxsql_bar&nofooter&noeditbtn}} | ||
| - | OdxSQL's operation is controlled by several settings. These settings can be dynamically changed by using the OdxSQL SET Command. | + | OdxSQL's operation is controlled by several settings. These settings can be dynamically changed by using the OdxSQL SET Command. The following is a list of all of the available OdxSQL settings. |
| + | |||
| + | ^ OdxSQL Settings ^ ^ ^ ^ ^ ^ | ||
| + | |API |AUTODISPLAY |AUTOEXPLAIN |AUTOFETCH |AUTOPSEUDOCOLUMNS |AUTORECONNECT| | ||
| + | |AUTOSUBPROCESS|CHAR|CURSOR|CURSORDISPLAY|DEFAULTS|EDITOR| | ||
| + | |ENDIAN |ERRORDISPLAY|ERRORS|EXPLAIN|FILE_BASELINE|HEADERS| | ||
| + | |HEX|HISTORY|INSTANCE|INTERRUPTS|MEMORY_BASELINE|MULTICONNECT| | ||
| + | |MULTILINE|NULL_INDICATORS|OMNIDEX_DEBUG|OPTIMIZATION|ODXSQL_DEBUG|PAGELENGTH| | ||
| + | |PAGEWIDTH|PREPROCESSOR|PROGRESS|PROMPT|PSEUDOCOLUMNS|QUALIFY_COUNTS| | ||
| + | |REDEFROWIDS|REQUIRED_OPTIMIZATION|SILENT_MODE|SQL_LOGFILE|SQL_LOGGING|SQL_SYNTAX| | ||
| + | |STATISTICS|STATISTICS_COMMENT|STATUSDISPLAY|TERMINATION|TIMEOUT|TIMER| | ||
| To see OdxSQL's current settings, issue the SET Command without any arguments. | To see OdxSQL's current settings, issue the SET Command without any arguments. | ||
| Line 9: | Line 21: | ||
| > SET | > SET | ||
| + | To see OdxSQL's a list of all the settings and the available setting values issue the SET ? command. | ||
| + | |||
| + | > SET ? | ||
| + | ===== OdxSQL All Settings in Alphabetical Order ===== | ||
| ^ Setting ^ Default ^ Other Options ^ Description ^ | ^ Setting ^ Default ^ Other Options ^ Description ^ | ||
| - | | [[API]] | OA | ODBC %%|%% JDBC %%|%% CLOA |Sets which API to use. | | + | | [[dev:odxsql:settings:api| API]] | OA | ODBC %%|%% JDBC %%|%% CLOA |Sets which API to use before the first CONNECT Statement. | |
| - | | [[AUTODISPLAY]] | LIST | FORM>| Sets Columns across (LIST) or Columns stacked (FROM). | | + | | [[[[dev:odxsql:settings:AUTODISPLAY]] | LIST | FORM| Sets Columns across (LIST) or Columns stacked (FROM). | |
| - | | [[AUTOEXPLAIN]] | OFF | ON %%|%% AFTER>| Shows the Explain Plan after each Select | | + | | [[[[dev:odxsql:settings:AUTOEXPLAIN]] | OFF | ON %%|%% AFTER | Shows the Explain Plan for the SELECT statement instead of processing the SELECT. | |
| - | | [[AUTOFETCH]] | ON | OFF| Automatically fetch records after a SELECT or QUALIFY. | | + | | [[[[dev:odxsql:settings:AUTOFETCH]] | ON | OFF| Automatically fetch records after a SELECT or QUALIFY. | |
| | [[AUTOPSEUDOCOLUMNS]] | OFF | ON| | | | [[AUTOPSEUDOCOLUMNS]] | OFF | ON| | | ||
| | [[AUTORECONNECT]] | OFF | ON| | | | [[AUTORECONNECT]] | OFF | ON| | | ||
| | [[AUTOSUBPROCESS]] | NONE | n | | | | [[AUTOSUBPROCESS]] | NONE | n | | | ||
| | [[CHAR]] | AUTO | n| | | | [[CHAR]] | AUTO | n| | | ||
| - | | [[CONTINUATION]] | ON | OFF| When ON automatically terminates statements. | | + | | [[CURSOR]] | last opened | n | Sets the default Cursor to use for processing. | |
| - | | [[CURSOR]] | 0 | n | | | + | | [[CURSORDISPLAY]] | OFF | ON| The cursor number being used can be set to automatically display. | |
| - | | [[CURSORDISPLAY]] | OFF | ON| | | + | |
| | [[DEFAULTS]] | <none> | <none> | Resets all settings to their initial defaults. | | | [[DEFAULTS]] | <none> | <none> | Resets all settings to their initial defaults. | | ||
| | [[EDITOR]] | NOTEPAD or vi | WORDPAD %%|%% EMACS %%|%% path | Sets which editor to use with the EDIT Command | | | [[EDITOR]] | NOTEPAD or vi | WORDPAD %%|%% EMACS %%|%% path | Sets which editor to use with the EDIT Command | | ||
| - | | [[ENDIAN]] | LITTLE | BIG %%|%% NATIVE %%|%% OPPOSITE> | | | + | | [[ENDIAN]] | LITTLE | BIG %%|%% NATIVE %%|%% OPPOSITE | | |
| | [[ERRORDISPLAY]] | MESSAGE | NONE %%|%% DETAIL %%|%% FULL | | | | [[ERRORDISPLAY]] | MESSAGE | NONE %%|%% DETAIL %%|%% FULL | | | ||
| - | | [[ERRORS]] | ABORT | CONTINUE %%|%% EXIT | Set processing of USE file. | | + | | [[ERRORS]] | ABORT | CONTINUE %%|%% EXIT | Set processing errors of statements from a USE file. | |
| - | | [[EXPLAIN]] | SUMMARY DETAILS ADDIN | | [NO]COUNTS %%|%% TEXT | | | + | | [[EXPLAIN]] | SUMMARY DETAILS ADDIN |[NO]COUNTS %%|%% TEXT |Sets the EXPLAIN Command options. | |
| - | | [[FILE_BASELINE]] | OFF | | | | + | | [[ FILE_BASELINE]] | OFF | | | |
| - | | [[HEADERS]] | ON | OFF | Turn the Column Headers ON or OFF.s| | + | | [[ HEADERS]] | ON | OFF | Turn the Column Headers ON or OFF.s| |
| - | | [[HEX]] | OFF | ON %%|%% ONLY>| | | + | | [[ HEX]] | OFF | ON %%|%% ONLY | Set the display of output values in HEX | |
| - | | [[HISTORY]] | 100 | n |Sets the size of the Command History stack. | | + | | [[ HISTORY]] | 100 | n |Sets the size of the Command History stack. | |
| - | | [[INSTANCE]] | last connection | n | | Sets the default Instance to use for processing. | | + | | [[ INSTANCE]] | last connection | n | Sets the default Instance to use for processing. | |
| - | | [[INTERRUPTS]] |ON | OFF %%|%% API| | | + | | [[ INTERRUPTS]] |ON | OFF %%|%% API| | |
| - | | [[MEMORY_BASELINE]] | OFF | | | | + | | [[ MEMORY_BASELINE]] | OFF | | | |
| - | | [[MULTILINE]] | OFF |ON %%|%% n | | | + | | [[ MULTICONNECT ]]| OFF | ON| Allows OdxSQL to connect to multiple Environments. | |
| - | | [[NULL_INDICATORS]] | OFF | ON %%|%% string| | | + | | [[ MULTILINE]] | OFF |ON %%|%% n | | |
| - | | [[OMNIDEX_DEBUG]] | OFF | | ON %%|%% profile [FILE=filename] | | | + | | [[ NULL_INDICATORS]] | OFF | ON %%|%% string| | |
| - | | [[OPTIMIZATION]] | DEFAULT |options| | | + | | [[ ODXSQL_DEBUG]] | | <PARSE %%|%% FILE %%|%% DEBUG %%|%% ALL> <ON %%|%% OFF> | | |
| - | | [[ODXNET]] | INACTIVE | | | | + | | [[ OMNIDEX_DEBUG]] | OFF | ON %%|%% profile [FILE=filename] | When ON, writes Omnidex debugging to odxdebug.log or to a named file with FILE clause.| |
| - | | [[PAGELENGTH]] | 24 | n | Set the page length before the paging prompt is issued.| | + | | [[ OPTIMIZATION]] | DEFAULT |options| | |
| - | | [[PAGEWIDTH]] | 80 |n|Sets the page width of the display. | | + | | [[ PAGELENGTH]] | 24 | n | Set the page length before the paging prompt is issued.| |
| - | | [[PREPROCESSOR]] | ON |OFF| | | + | | [[PAGEWIDTH]] | 80 | n | Sets the page width of the display. | |
| + | | [[PREPROCESSOR]] | ON |OFF| Can disable the use of the Omnidex SQL Preprocessor. Use only for testing. | | ||
| | [[PROGRESS]] |OFF | ON| | | | [[PROGRESS]] |OFF | ON| | | ||
| - | | [[PROMPT]] | | "> " | "string" [WITH [FILE] [LINE] [COMMAND]] |Sets the OdxSQL command prompt. | | + | | [[PROMPT]] | "> " | "string" [WITH [FILE] [LINE] [COMMAND]] |Sets the OdxSQL command prompt. | |
| | [[PSEUDOCOLUMNS]] |ON | OFF | | | | [[PSEUDOCOLUMNS]] |ON | OFF | | | ||
| | [[QUALIFY_COUNTS]] | PARENT | NOPARENT| | | | [[QUALIFY_COUNTS]] | PARENT | NOPARENT| | | ||
| - | | [[QUALIFY_MODE]] | PARSER | ODXFIND %%|%% OX_FIND|Changes the Qualify Mode to internal routines. | | + | | [[QUALIFY_MODE]] | PARSER | ODXFIND %%|%% OX_FIND | Changes the Qualify Mode to internal routines. | |
| - | | [[REDEFROWIDS]] | ON | OFF| | | + | | [[REDEFROWIDS]] | ON | OFF | | |
| - | | [[REMOTE_HOST | NONE | | | + | |
| | [[REQUIRED_OPTIMIZATION]] | NONE |options| | | | [[REQUIRED_OPTIMIZATION]] | NONE |options| | | ||
| | [[SILENT_MODE]] | OFF | ON | | | | [[SILENT_MODE]] | OFF | ON | | | ||
| | [[SQL_LOGFILE]] | DEFAULT | filename| | | | [[SQL_LOGFILE]] | DEFAULT | filename| | | ||
| | [[SQL_LOGGING]] | OFF | ON [WITH options] | | | | [[SQL_LOGGING]] | OFF | ON [WITH options] | | | ||
| - | | [[STATISTICS]] | OFF | ON %%|%% filename>| | | + | | [[STATISTICS]] | OFF | ON %%|%% filename | | |
| | [[STATISTICS_COMMENT]] | none| "string"| | | | [[STATISTICS_COMMENT]] | none| "string"| | | ||
| | [[STATUSDISPLAY]] | OFF | ON | | | | [[STATUSDISPLAY]] | OFF | ON | | | ||
| | [[TIMEOUT]] | OFF | seconds | | | | [[TIMEOUT]] | OFF | seconds | | | ||
| - | | [[TIMER]] | OFF | ON %%|%% CUMULATIVE ] |Shows the CPU and Elapsed time of SELECT and QUALIFY statements. | | + | | [[TIMER]] | OFF | ON %%|%% CUMULATIVE |Shows the CPU and Elapsed time of statements. | |
| - | ===== OdxSQL Default Settings ===== | ||
| - | |||
| - | <code> | ||
| - | > set | ||
| - | |||
| - | Current settings: | ||
| - | API OA | ||
| - | AUTODISPLAY LIST | ||
| - | AUTOEXPLAIN OFF | ||
| - | AUTOFETCH ON | ||
| - | AUTOPSEUDOCOLUMNS OFF | ||
| - | AUTORECONNECT OFF | ||
| - | AUTOSUBPROCESS NONE | ||
| - | CHAR AUTO | ||
| - | CONTINUATION ON | ||
| - | CURSOR 0 | ||
| - | CURSORDISPLAY OFF | ||
| - | EDITOR DEFAULT | ||
| - | ENDIAN LITTLE | ||
| - | ERRORDISPLAY MESSAGE | ||
| - | ERRORS ABORT | ||
| - | EXPLAIN NOCOUNTS SUMMARY DETAILS ADDIN NOTEXT | ||
| - | FILE_BASELINE OFF | ||
| - | HEADERS ON | ||
| - | HEX OFF | ||
| - | HISTORY 100 | ||
| - | INSTANCE 0 | ||
| - | Press <RETURN> to continue or '/' to stop paging ... | ||
| - | INTERRUPTS ON (currently armed) | ||
| - | MEMORY_BASELINE OFF | ||
| - | MULTILINE OFF | ||
| - | NULL_INDICATORS OFF | ||
| - | ODXNET INACTIVE | ||
| - | OMNIDEX_DEBUG OFF | ||
| - | OPTIMIZATION DEFAULT | ||
| - | PAGELENGTH 24 | ||
| - | PAGEWIDTH 80 | ||
| - | PREPROCESSOR ON | ||
| - | PROGRESS OFF | ||
| - | PROMPT "> " | ||
| - | PSEUDOCOLUMNS ON | ||
| - | QUALIFY_COUNTS PARENT | ||
| - | QUALIFY_MODE PARSER | ||
| - | REDEFROWIDS ON | ||
| - | REMOTE_HOST NONE | ||
| - | REQUIRED_OPTIMIZATION NONE | ||
| - | SILENT_MODE OFF | ||
| - | SQL_LOGFILE DEFAULT | ||
| - | SQL_LOGGING OFF | ||
| - | STATISTICS OFF | ||
| - | STATUSDISPLAY OFF | ||
| - | Press <RETURN> to continue or '/' to stop paging ... | ||
| - | TIMEOUT OFF | ||
| - | TIMER OFF | ||
| - | </code> | ||
| - | |||
| - | ====== OdxSQL SET Commands ====== | ||
| - | ===== Description ===== | ||
| - | OdxSET has settings that govern its operation. The settings can be modified with the SET command. | ||
| - | |||
| - | Note that OdxSQL also allows SET Statements from the Omnidex SQL Language. | ||
| ===== Examples ===== | ===== Examples ===== | ||
| set autoexplain on | set autoexplain on | ||
| - | set explain counts, text, $ox | + | set explain counts, text |
| set pagelength 0 | set pagelength 0 | ||
| set timer on | set timer on | ||
| - | SET STATISTICS | + | SET STATISTICS on |
| - | ET STATISTICS_COMMENT | + | |
| - | + | ||
| - | ===== SET STATISTICS ===== | + | |
| - | + | ||
| - | The SET STATISTICS command in ODXSQL has been expanded to track more information, including the process ID and the thread ID. As well, a new command called SET STATISTICS_COMMENT | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | {{page>:bottom_add&nofooter&noeditbtn}} | + | |