Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
programs:odxsql:settings:home [2009/12/03 16:26]
tdo
programs:odxsql:settings:home [2016/06/28 22:38] (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.
  
-^ Setting ^...... Option ...... ​^   ​Description ​  ^  +  > SET ?  
-| [[API]] | <OA %%|%% CLOA %%|%% ODBC %%|%% JDBC>|Sets which API to use. | +===== OdxSQL All Settings in Alphabetical Order ===== 
-| [[AUTODISPLAY]] | <LIST %%|%% FORM>| Sets Columns across (LIST) or Columns stacked (FROM). | + 
-| [[AUTOEXPLAIN]] | <ON %%|%% OFF %%|%% AFTER>| Shows the Explain Plan after each Select ​+^ Setting ^ Default ^ Other Options ​^   ​Description ​  ^  
-| [[AUTOFETCH]] | <ON %%|%% OFF>| | +| [[dev:​odxsql:​settings:​api| ​API]] | OA | ODBC %%|%% JDBC %%|%% CLOA |Sets which API to use before the first CONNECT Statement. | 
-| [[AUTOPSEUDOCOLUMNS]] | <ON %%|%% OFF>| | +| [[[[dev:​odxsql:​settings:​AUTODISPLAY]] | LIST | FORM| Sets Columns across (LIST) or Columns stacked (FROM). | 
-| [[AUTORECONNECT]] | <ON %%|%% OFF>| | +| [[[[dev:​odxsql:​settings:​AUTOEXPLAIN]] | OFF | ON %%|%% AFTER | Shows the Explain Plan for the SELECT statement instead of processing the SELECT. ​
-| [[AUTOSUBPROCESS]] | <%%|%% NONE> ​| | +| [[[[dev:​odxsql:​settings:​AUTOFETCH]] | ON | OFF| Automatically fetch records after a SELECT or QUALIFY. ​
-| [[CHAR]] | <AUTO %%|%% n>| | +| [[AUTOPSEUDOCOLUMNS]] | OFF | ON| | 
-| [[CONTINUATION]] | <ON %%|%% OFF>When ON automatically terminates statements. | +| [[AUTORECONNECT]] | OFF | ON| | 
-| [[CURSOR]] | n| | +| [[AUTOSUBPROCESS]] | NONE | n | | 
-| [[CURSORDISPLAY]] | <ON %%|%% OFF>| +| [[CHAR]] | AUTO | n| | 
-| [[DEFAULTS]] | | +| [[CURSOR]] | last opened ​Sets the default Cursor to use for processing. | 
-| [[EDITOR]] | <NOTEPAD ​%%|%% WORDPAD ​%%|%% VI %%|%% EMACS %%|%% path| | +| [[CURSORDISPLAY]] | OFF ON| The cursor number being used can be set to automatically display. ​
-| [[ENDIAN]] | <LITTLE ​%%|%% BIG %%|%% NATIVE %%|%% OPPOSITE| | +| [[DEFAULTS]] | <none> ​<none> | Resets all settings to their initial defaults. ​
-| [[ERRORDISPLAY]] | <NONE %%|%% MESSAGE ​%%|%% DETAIL %%|%% FULL| | +| [[EDITOR]] | NOTEPAD ​or vi  ​| WORDPAD %%|%% EMACS %%|%% path | Sets which editor to use with the EDIT Command ​
-| [[ERRORS]] | <ABORT %%|%% CONTINUE %%|%% EXIT| | +| [[ENDIAN]] | LITTLE | BIG %%|%% NATIVE %%|%% OPPOSITE | | 
-| [[EXPLAIN]] | <​[NO]COUNTS![NO]SUMMARY! [NO]DETAILS![NO]ADDIN[NO]TEXT | | +| [[ERRORDISPLAY]] | MESSAGE | NONE %%|%% DETAIL %%|%% FULL | | 
-| [[FILE_BASELINE]] | | | +| [[ERRORS]] | ABORT | CONTINUE %%|%% EXIT | Set processing errors of statements from a USE file. 
-| [[HEADERS]] | <ON %%|%% OFF>| | +| [[EXPLAIN]] | SUMMARY DETAILS ADDIN |[NO]COUNTS %%|%% TEXT |Sets the EXPLAIN Command options. ​
-| [[HEX]] | <ON %%|%% OFF %%|%% ONLY>| | +| [[ FILE_BASELINE]] ​| OFF | | | 
-| [[HISTORY]] |n| | +| [[ HEADERS]] | ON | OFF | Turn the Column Headers ON or OFF.s
-| [[INSTANCE]] |n| | +| [[ HEX]] | OFF | ON %%|%% ONLY | Set the display of output values in HEX 
-| [[INTERRUPTS]] |<ON %%|%% OFF %%|%% API>| | +| [[ HISTORY]] ​| 100 | n |Sets the size of the Command History stack. ​
-| [[MEMORY_BASELINE]] | | | +| [[ INSTANCE]] ​| last connection ​| n | Sets the default Instance to use for processing. ​
-| [[MULTILINE]] |<ON %%|%% OFF %%|%% n> | | +| [[ INTERRUPTS]] |ON | OFF %%|%% API| | 
-| [[NULL_INDICATORS]] |<ON %%|%% OFF %%|%% string>| | +| [[ MEMORY_BASELINE]] ​| OFF | | | 
-| [[OMNIDEX_DEBUG]] |<ON %%|%% OFF %%|%% profile> [FILE=filename] ​| | +| [[ MULTICONNECT ​]]| OFF | ONAllows OdxSQL to connect to multiple Environments. ​
-| [[OPTIMIZATION]] |options| | +| [[ MULTILINE]] | OFF |ON %%|%% | | 
-| [[ODXSQL_DEBUG]] ​|<PARSE %%|%% FILE %%|%% DEBUG %%|%% ALL> <ON %%|%% OFF>| | +| [[ NULL_INDICATORS]] | OFF | ON %%|%% string| | 
-| [[PAGELENGTH]] |n| | +| [[ ODXSQL_DEBUG]] | | <PARSE %%|%% FILE %%|%% DEBUG %%|%% ALL> <ON %%|%% OFF> ​| | 
-| [[PAGEWIDTH]] |n| | +| [[ OMNIDEX_DEBUG]] | OFF | ON %%|%% profile [FILE=filename] | When ON, writes Omnidex debugging to odxdebug.log or to a named file with FILE clause.| 
-| [[PREPROCESSOR]] |<ON %%|%% OFF>| | +| [[ OPTIMIZATION]] | DEFAULT |options| |  
-| [[PROGRESS]] |<ON %%|%% OFF>| | +| [[ PAGELENGTH]] ​| 24 | n | Set the page length before the paging prompt is issued.
-| [[PROMPT]] |["​string"​[WITH [FILE] [LINE] [COMMAND] | | +| [[PAGEWIDTH]] ​| 80 | n | Sets the page width of the display. ​
-| [[PSEUDOCOLUMNS]] |<ON %%|%% OFF>| | +| [[PREPROCESSOR]] | ON |OFF| Can disable the use of the Omnidex SQL Preprocessor. Use only for testing. ​
-| [[QUALIFY_COUNTS]] | <PARENT ​%%|%% NOPARENT>| | +| [[PROGRESS]] |OFF ON| | 
-| [[QUALIFY_MODE]] | <PARSER ​%%|%% ODXFIND %%|%% OX_FIND>| | +| [[PROMPT]] | "> " | "​string"​ [WITH [FILE] [LINE] [COMMAND]] |Sets the OdxSQL command prompt. ​
-| [[REDEFROWIDS]] | <ON %%|%% OFF>| | +| [[PSEUDOCOLUMNS]] |ON | OFF | | 
-| [[REQUIRED_OPTIMIZATION]] |options| | +| [[QUALIFY_COUNTS]] | PARENT | NOPARENT| | 
-| [[SILENT_MODE]] |<ON %%|%% OFF>| | +| [[QUALIFY_MODE]] | PARSER | ODXFIND %%|%% OX_FIND | Changes the Qualify Mode to internal routines. ​
-| [[SQL_LOGFILE]] |filename| | +| [[REDEFROWIDS]] | ON | OFF | | 
-| [[SQL_LOGGING]] |<ON %%|%% OFF> ​[WITH options] |  | +| [[REQUIRED_OPTIMIZATION]] ​| NONE |options| | 
-| [[STATISTICS]] |<OFF %%|%% ON %%|%% filename>| | +| [[SILENT_MODE]] | OFF | ON | | 
-| [[STATISTICS_COMMENT]] | "​string"​| | +| [[SQL_LOGFILE]] ​| DEFAULT ​| filename| | 
-| [[STATUSDISPLAY]] |<ON %%|%% OFF>| | +| [[SQL_LOGGING]] | OFF | ON [WITH options] |  | 
-| [[TIMEOUT]] |<seconds ​%%|%% OFF>| | +| [[STATISTICS]] | OFF | ON %%|%% filename | | 
-| [[TIMER]]|<ON %%|%% CUMULATIVE ​%%|%% OFF>​] ​| |+| [[STATISTICS_COMMENT]] ​| none| "​string"​| | 
 +| [[STATUSDISPLAY]] | OFF | ON | | 
 +| [[TIMEOUT]] | OFF | seconds | | 
 +| [[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}}+
 
Back to top
programs/odxsql/settings/home.1259857612.txt.gz · Last modified: 2016/06/28 22:38 (external edit)