This is an old revision of the document!
| Command Line Options | Description |
|---|---|
| odxsql | Run OdxSQL. Use the CONNECT command to connect to an Omnidex Environment |
| odxsql env_filespec | Run OdxSQL and connect to the env_filespec. |
| odxsql dsn_filespec -odbc | Run OdxSQL and connect to the ODBC File DSN using the Omnidex ODBC driver. |
| odxsql env_filespec -odxnet -jdbc | Run OdxSQL and start an OdxNet background process and connect to the env_filespec using the Omnidex JDBC driver. |
| odxsql -? | Displays OdxSQL command line options |
| odxsql -use scriptfile | Run OdxSQL and read and process the scriptfile of OdxSQL Statements and Commands. |
| Set Command | |
| SET | Shows the current settings. |
| SET ? | Shows the list of available SET options. |
| SET TERMINATION OFF | Will process SQL Statements without requiring a semi-colon terminator. |
| SET TIMER ON | Useful to show how long a statement takes to process. |
| Help/Show | |
| HELP | Shows a list of OdxSQL commands and SQL Statements. |
| HELP <command> | Provides specific help on the specified command or SQL Statement. |
| SHOW <table> | Provides information on the specified table. |
| SHOW ALL | Provides information on all tables. |
| Editing | |
| EDIT | Launch editor and send current SQL Statement to either Windows Notedpad or UNIX/Linux vi or emacs. |
| SET EDITOR <filespec> | Change the default editor. Can also be NOTEPAD, WORDPAD, VI or EMACS. |
| EDIT filespec | Typically used to edit a script file and then use the USE file to run the script. |
| EDIT n | Edits the command in the Command History Stack |
| Other Commands | |
| HISTORY | Shows a numbered list of previously entered commands. |
| <command_number> | Execute the numbered command from the Command History Stack. |
| Period (.) | Execute the last command. |
| Comment (;) | A semi-colon as the first character causes the rest of the line to be a comment. |
| USE <filespec> | Processes the OdxSQL commands in a script file. |
| SET ERRORS | Sets how errors will be handled when processing a USE file. |
| EXPLAIN | Shows the Explain Plan for the previous SELECT Statement. |
| SET AUTOEXPLAIN ON | Automatically show the Explain Plan instead of the SELECT output. |
| SET EXPLAIN | Sets options for the Explain Plan. |
| OdxSQL Settings | |||||
|---|---|---|---|---|---|
| API | AUTODISPLAY | AUTOEXPLAIN | AUTOFETCH | AUTOPSEUDOCOLUMNS | AUTORECONNECT |
| AUTOSUBPROCESS | CHAR | CURSOR | CURSORDISPLAY | DEFAULTS | EDITOR |
| ENDIAN | ERRORDISPLAY | ERRORS | EXPLAIN SET | FILE_BASELINE | HEADERS |
| HEX | HISTORY | 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 |