This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
programs:odxsql:home [2009/12/01 20:30] tdo |
programs:odxsql:home [2012/10/26 15:28] 127.0.0.1 external edit |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== OdxSQL Quick Notes ====== | + | {{page>:top_add&nofooter&noeditbtn}} |
| - | + | <html><div align="center"><span style="color:red">DRAFT</span></div></html> | |
| - | ^[[programs:odxsql:overview|Overview]]^Commands^Odx SQL^ | + | ~~NOTOC~~ |
| - | + | ====== OdxSQL Quick Reference ====== | |
| - | OdxSQL is a console application for manually entering SQL Statements and OdxSQL Commands. | + | {{page>:sql_odxsql_bar&nofooter&noeditbtn}} |
| - | + | ^ Command Line Options ^ Description ^ | |
| - | Use OdxSQL for processing Data Definition Scripts to create Omnidex Environments and Indexes. | + | | odxsql | Run OdxSQL. Use the CONNECT command to connect to an Omnidex Environment | |
| - | + | | odxsql env_filespec | Run OdxSQL and connect to the env_filespec. | | |
| - | Use OdxSQL to test SQL SELECTs and ODBC, JDBC and Network Services set up. | + | | 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.| | |
| - | Common ways to run OdxSQL | + | |
| - | + | ||
| - | os> odxsql | + | |
| - | os> odxsql envfile | + | |
| - | os> odxsql dsnfile -odxnet -odbc | + | |
| - | os> odxsql -? | + | |
| - | + | ||
| - | Explained: | + | |
| - | | odxsql | Run OdxSQL. Use the CONNECT command to connect to an Environment | | + | |
| - | | odxsql dsnfile -odxnet -odbc | Run OdxSQL and an OdxNET background process and connect to the DSN using ODBC | | + | |
| - | | odxsql envfile | Run OdxSQL and connect to the 'envfile' | | + | |
| | odxsql -? | Displays OdxSQL command line options | | | 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 connects to an Omnidex Environment or ODBC or JDBC Omnidex File Datasource (DSN). | + | ^ OdxSQL Settings ^ ^ ^ ^ ^ ^ |
| - | + | |API |AUTODISPLAY |AUTOEXPLAIN |AUTOFETCH |AUTOPSEUDOCOLUMNS |AUTORECONNECT| | |
| - | * OdxSQL automatically terminates commands and SQL Statements with a <cr>. | + | |AUTOSUBPROCESS|CHAR|CURSOR|CURSORDISPLAY|DEFAULTS|EDITOR| |
| - | * Use the backslash [ \ ]statement continuation character for multi line statements. | + | |ENDIAN |ERRORDISPLAY|ERRORS|EXPLAIN SET|FILE_BASELINE|HEADERS| |
| - | * Use SET CONTINUATION OFF to use the semi-colon command and statement terminator. | + | |HEX|HISTORY|INTERRUPTS|MEMORY_BASELINE|MULTICONNECT|MULTILINE| |
| - | + | |NULL_INDICATORS|OMNIDEX_DEBUG|OPTIMIZATION|ODXSQL_DEBUG|PAGELENGTH|PAGEWIDTH| | |
| - | * Use HELP <cr> to display a list of commands and SQL Statements. | + | |PREPROCESSOR|PROGRESS|PROMPT|PSEUDOCOLUMNS|QUALIFY_COUNTS|REDEFROWIDS| |
| - | * Use HELP <command> to display the syntax for the command. | + | |REQUIRED_OPTIMIZATION|SILENT_MODE|SQL_LOGFILE|SQL_LOGGING|SQL_SYNTAX|STATISTICS| |
| - | + | |STATISTICS_COMMENT|STATUSDISPLAY|TERMINATION|TIMEOUT|TIMER| | |
| - | * Use SET ? to get a list of OdxSQL Set options. | + | |
| - | + | ||
| - | * Use Show <table> to show information on a table with the tables's column layout. | + | |
| - | + | ||
| - | * Create scripts | + | |
| - | + | ||
| - | * [[programs:odxsql:overview | OdxSQL Overview ]] | + | |
| - | * OdxSQL Command Line Options | + | |
| - | * OdxSQL Commands | + | |
| - | * OdxSQL Settings | + | |
| - | * OdxSQL Script Examples | + | |
| - | * SQL SELECT | + | |
| - | * SQL SELECT Examples | + | |
| - | * Omnidex SQL Statements | + | |