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 03:07] 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}} | ||
| - | ^ Setting ^ Option ^ Description ^ | | + | 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. |
| - | | [[API | <OA ! CLOA ! ODBC ! JDBC>| | | + | |
| - | | [[AUTODISPLAY | <LIST ! FORM>| | | + | |
| - | | [[AUTOEXPLAIN | <ON ! OFF ! AFTER>| | | + | |
| - | | [[AUTOFETCH | <ON ! OFF>| | | + | |
| - | | [[AUTOPSEUDOCOLUMNS | <ON ! OFF>| | | + | |
| - | | [[AUTORECONNECT | <ON ! OFF>| | | + | |
| - | | [[AUTOSUBPROCESS | <n ! NONE> | | + | |
| - | | [[CHAR | <AUTO ! n>| | | + | |
| - | | [[CONTINUATION | <ON ! OFF>| | | + | |
| - | | [[CURSOR | n| | | + | |
| - | | [[CURSORDISPLAY | <ON ! OFF>| | | + | |
| - | | [[DEFAULTS| | | | + | |
| - | | [[EDITOR | <NOTEPAD ! WORDPAD ! VI ! EMACS ! path> | | | + | |
| - | | [[ENDIAN | <LITTLE ! BIG ! NATIVE ! OPPOSITE> | | | + | |
| - | | [[ERRORDISPLAY | <NONE ! MESSAGE ! DETAIL ! FULL> | | | + | |
| - | | [[ERRORS | <ABORT ! CONTINUE ! EXIT> | | | + | |
| - | | [[EXPLAIN | <[NO]COUNTS![NO]SUMMARY![NO]DETAILS![NO]ADDIN![NO]TEXT | | | + | |
| - | | [[FILE_BASELINE|| | | + | |
| - | | [[HEADERS | <ON ! OFF>| | | + | |
| - | | [[HEX | <ON ! OFF ! ONLY>| | | + | |
| - | | [[HISTORY |n| | | + | |
| - | | [[INSTANCE |n| | | + | |
| - | | [[INTERRUPTS |<ON ! OFF ! API>| | | + | |
| - | | [[MEMORY_BASELINE|| | | + | |
| - | | [[MULTILINE] |<ON ! OFF ! n> | | + | |
| - | | [[NULL_INDICATORS |<ON ! OFF ! string>| | | + | |
| - | | [[OMNIDEX_DEBUG |<ON ! OFF ! profile> [FILE=filename|] | | + | |
| - | | [[OPTIMIZATION |options| | | + | |
| - | | [[ODXSQL_DEBUG |<PARSE ! FILE ! DEBUG ! ALL> <ON ! OFF>| | | + | |
| - | | [[PAGELENGTH |n| | | + | |
| - | | [[PAGEWIDTH |n| | | + | |
| - | | [[PREPROCESSOR |<ON ! OFF>| | | + | |
| - | | [[PROGRESS |<ON ! OFF>| | | + | |
| - | | [[PROMPT |["string"] [WITH [FILE] [LINE] [COMMAND|| | | + | |
| - | | [[PSEUDOCOLUMNS |<ON ! OFF>| | | + | |
| - | | [[QUALIFY_COUNTS | <PARENT ! NOPARENT>| | | + | |
| - | | [[QUALIFY_MODE | <PARSER ! ODXFIND ! OX_FIND>| | | + | |
| - | | [[REDEFROWIDS | <ON ! OFF>| | | + | |
| - | | [[REQUIRED_OPTIMIZATION |options| | | + | |
| - | | [[SILENT_MODE |<ON ! OFF>| | | + | |
| - | | [[SQL_LOGFILE |filename| | | + | |
| - | | [[SQL_LOGGING |<ON ! OFF> [WITH options|] | | + | |
| - | | [[STATISTICS |<ON ! OFF ! filename>| | | + | |
| - | | [[STATISTICS_COMMENT "string"| | | + | |
| - | | [[STATUSDISPLAY |<ON ! OFF>| | | + | |
| - | | [[TIMEOUT |<seconds ! OFF>| | | + | |
| - | | [[TIMER |<ON ! CUMULATIVE ! OFF>] | | | + | |
| - | + | ||
| + | ^ 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. | ||
| - | ===== OdxSQL Default Settings ===== | + | > SET |
| - | <code> | + | To see OdxSQL's a list of all the settings and the available setting values issue the SET ? command. |
| - | > set | + | |
| - | Current settings: | + | > SET ? |
| - | API OA | + | ===== OdxSQL All Settings in Alphabetical Order ===== |
| - | 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 ====== | + | ^ Setting ^ Default ^ Other Options ^ Description ^ |
| - | ===== Description ===== | + | | [[dev:odxsql:settings:api| API]] | OA | ODBC %%|%% JDBC %%|%% CLOA |Sets which API to use before the first CONNECT Statement. | |
| - | OdxSET has settings that govern its operation. The settings can be modified with the SET command. | + | | [[[[dev:odxsql:settings:AUTODISPLAY]] | LIST | FORM| Sets Columns across (LIST) or Columns stacked (FROM). | |
| + | | [[[[dev:odxsql:settings:AUTOEXPLAIN]] | OFF | ON %%|%% AFTER | Shows the Explain Plan for the SELECT statement instead of processing the SELECT. | | ||
| + | | [[[[dev:odxsql:settings:AUTOFETCH]] | ON | OFF| Automatically fetch records after a SELECT or QUALIFY. | | ||
| + | | [[AUTOPSEUDOCOLUMNS]] | OFF | ON| | | ||
| + | | [[AUTORECONNECT]] | OFF | ON| | | ||
| + | | [[AUTOSUBPROCESS]] | NONE | n | | | ||
| + | | [[CHAR]] | AUTO | n| | | ||
| + | | [[CURSOR]] | last opened | n | Sets the default Cursor to use for processing. | | ||
| + | | [[CURSORDISPLAY]] | OFF | ON| The cursor number being used can be set to automatically display. | | ||
| + | | [[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 | | ||
| + | | [[ENDIAN]] | LITTLE | BIG %%|%% NATIVE %%|%% OPPOSITE | | | ||
| + | | [[ERRORDISPLAY]] | MESSAGE | NONE %%|%% DETAIL %%|%% FULL | | | ||
| + | | [[ERRORS]] | ABORT | CONTINUE %%|%% EXIT | Set processing errors of statements from a USE file. | | ||
| + | | [[EXPLAIN]] | SUMMARY DETAILS ADDIN |[NO]COUNTS %%|%% TEXT |Sets the EXPLAIN Command options. | | ||
| + | | [[ FILE_BASELINE]] | OFF | | | | ||
| + | | [[ HEADERS]] | ON | OFF | Turn the Column Headers ON or OFF.s| | ||
| + | | [[ HEX]] | OFF | ON %%|%% ONLY | Set the display of output values in HEX | | ||
| + | | [[ HISTORY]] | 100 | n |Sets the size of the Command History stack. | | ||
| + | | [[ INSTANCE]] | last connection | n | Sets the default Instance to use for processing. | | ||
| + | | [[ INTERRUPTS]] |ON | OFF %%|%% API| | | ||
| + | | [[ MEMORY_BASELINE]] | OFF | | | | ||
| + | | [[ MULTICONNECT ]]| OFF | ON| Allows OdxSQL to connect to multiple Environments. | | ||
| + | | [[ MULTILINE]] | OFF |ON %%|%% n | | | ||
| + | | [[ NULL_INDICATORS]] | OFF | ON %%|%% string| | | ||
| + | | [[ ODXSQL_DEBUG]] | | <PARSE %%|%% FILE %%|%% DEBUG %%|%% ALL> <ON %%|%% OFF> | | | ||
| + | | [[ OMNIDEX_DEBUG]] | OFF | ON %%|%% profile [FILE=filename] | When ON, writes Omnidex debugging to odxdebug.log or to a named file with FILE clause.| | ||
| + | | [[ OPTIMIZATION]] | DEFAULT |options| | | ||
| + | | [[ PAGELENGTH]] | 24 | n | Set the page length before the paging prompt is issued.| | ||
| + | | [[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| | | ||
| + | | [[PROMPT]] | "> " | "string" [WITH [FILE] [LINE] [COMMAND]] |Sets the OdxSQL command prompt. | | ||
| + | | [[PSEUDOCOLUMNS]] |ON | OFF | | | ||
| + | | [[QUALIFY_COUNTS]] | PARENT | NOPARENT| | | ||
| + | | [[QUALIFY_MODE]] | PARSER | ODXFIND %%|%% OX_FIND | Changes the Qualify Mode to internal routines. | | ||
| + | | [[REDEFROWIDS]] | ON | OFF | | | ||
| + | | [[REQUIRED_OPTIMIZATION]] | NONE |options| | | ||
| + | | [[SILENT_MODE]] | OFF | ON | | | ||
| + | | [[SQL_LOGFILE]] | DEFAULT | filename| | | ||
| + | | [[SQL_LOGGING]] | OFF | ON [WITH options] | | | ||
| + | | [[STATISTICS]] | OFF | ON %%|%% filename | | | ||
| + | | [[STATISTICS_COMMENT]] | none| "string"| | | ||
| + | | [[STATUSDISPLAY]] | OFF | ON | | | ||
| + | | [[TIMEOUT]] | OFF | seconds | | | ||
| + | | [[TIMER]] | OFF | ON %%|%% CUMULATIVE |Shows the CPU and Elapsed time of statements. | | ||
| + | |||
| + | |||
| - | 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}} | + | |