This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
programs:odxsql:home [2009/12/07 21:33] tdo |
programs:odxsql:home [2012/10/26 14:51] (current) |
||
|---|---|---|---|
| Line 3: | Line 3: | ||
| ~~NOTOC~~ | ~~NOTOC~~ | ||
| ====== OdxSQL Quick Reference ====== | ====== OdxSQL Quick Reference ====== | ||
| - | {{page>:odxsql_bar&nofooter&noeditbtn}} | + | {{page>:sql_odxsql_bar&nofooter&noeditbtn}} |
| - | + | ^ Command Line Options ^ Description ^ | |
| - | + | ||
| - | ===== OdxSQL Uses ===== | + | |
| - | + | ||
| - | OdxSQL is a console application for manually entering Omnidex SQL Statements and OdxSQL Commands. | + | |
| - | + | ||
| - | Use OdxSQL for processing Data Definition Scripts to create Omnidex Environments and Indexes. | + | |
| - | + | ||
| - | Use OdxSQL to test SQL SELECTs and ODBC, JDBC and Network Services set up. | + | |
| - | + | ||
| - | Use OdxSQL to prototype Omnidex Queries and use the Explain Command to review optimization. | + | |
| - | + | ||
| - | Use OdxSQL on a client computer to access an Omnidex Environment on a remote server via OdxNet to test network response times. | + | |
| - | + | ||
| - | + | ||
| - | ===== Common ways to run OdxSQL ===== | + | |
| - | + | ||
| - | + | ||
| - | os> odxsql | + | |
| - | os> odxsql envfile | + | |
| - | os> odxsql dsnfile -odxnet -odbc | + | |
| - | os> odxsql -? | + | |
| - | os> odxsql -use scriptfile | + | |
| - | + | ||
| - | Running OdxSQL Explained: | + | |
| | odxsql | Run OdxSQL. Use the CONNECT command to connect to an Omnidex Environment | | | odxsql | Run OdxSQL. Use the CONNECT command to connect to an Omnidex Environment | | ||
| - | | odxsql envfile | Run OdxSQL and connect to the 'envfile' | | + | | odxsql env_filespec | Run OdxSQL and connect to the env_filespec. | |
| - | | odxsql dsnfile -odxnet -odbc | Run OdxSQL and an OdxNET background process and connect to the DSN using ODBC | | + | | 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 -? | Displays OdxSQL command line options | | ||
| | odxsql -use scriptfile | Run OdxSQL and read and process the scriptfile of OdxSQL Statements and Commands.| | | 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 Important Information ===== | + | ^ OdxSQL Settings ^ ^ ^ ^ ^ ^ |
| - | + | |API |AUTODISPLAY |AUTOEXPLAIN |AUTOFETCH |AUTOPSEUDOCOLUMNS |AUTORECONNECT| | |
| - | * OdxSQL connects to an Omnidex Environment or ODBC or JDBC Omnidex File Datasource (DSN). | + | |AUTOSUBPROCESS|CHAR|CURSOR|CURSORDISPLAY|DEFAULTS|EDITOR| |
| - | + | |ENDIAN |ERRORDISPLAY|ERRORS|EXPLAIN SET|FILE_BASELINE|HEADERS| | |
| - | * OdxSQL automatically terminates commands and SQL Statements with a return <cr>. | + | |HEX|HISTORY|INTERRUPTS|MEMORY_BASELINE|MULTICONNECT|MULTILINE| |
| - | * Use the backslash %%[ \ ]%% statement continuation character for multi line statements. | + | |NULL_INDICATORS|OMNIDEX_DEBUG|OPTIMIZATION|ODXSQL_DEBUG|PAGELENGTH|PAGEWIDTH| |
| - | * Use SET CONTINUATION OFF to use the semicolon character as the statement terminator. | + | |PREPROCESSOR|PROGRESS|PROMPT|PSEUDOCOLUMNS|QUALIFY_COUNTS|REDEFROWIDS| |
| - | + | |REQUIRED_OPTIMIZATION|SILENT_MODE|SQL_LOGFILE|SQL_LOGGING|SQL_SYNTAX|STATISTICS| | |
| - | * Use HELP <cr> to display a list of commands and SQL Statements. | + | |STATISTICS_COMMENT|STATUSDISPLAY|TERMINATION|TIMEOUT|TIMER| |
| - | * Use HELP <command> to display the syntax for the command. | + | |
| - | + | ||
| - | * Use SET <cr> to show a list of the current OdxSQL settings. | + | |
| - | * 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. | + | |
| - | * Use SHOW ALL to see all tables, including internal system tables. | + | |
| - | + | ||
| - | * Create scripts and process with the USE <scriptfile> command or the OdxSQL -use scriptfile | + | |
| - | + | ||
| - | * Use EDIT to edit the last statement using Windows Notepad or Linux/Unix vi or emacs. | + | |
| - | * Use SET EDIT to change the editor of choice. | + | |
| - | * Use EDIT file to edit a script file without leaving OdxSQL and then USE file to run. | + | |
| - | * Use EDIT n to edit a command in the Command History Stack. | + | |
| - | + | ||
| - | * Edit previous commands by using the UP ARROW and scrolling through the commands. | + | |
| - | * Use the Right and Left Arrow, Insert, Delete, Home, and End keys to edit. | + | |
| - | + | ||
| - | * Use HISTORY to display a numbered list of previous commands. | + | |
| - | * Use the history number to re-execute the numbered command. | + | |
| - | * Use a period ( . ) to execute the last command. | + | |
| - | + | ||
| - | ===== See Also ===== | + | |
| - | + | ||
| - | * [[programs:odxsql:overview | OdxSQL Overview ]] | + | |
| - | * OdxSQL Command Line Options | + | |
| - | * OdxSQL Commands | + | |
| - | * OdxSQL Settings | + | |
| - | * OdxSQL Script Examples | + | |
| - | * SQL SELECT | + | |
| - | * SQL SELECT Examples | + | |
| - | * Omnidex SQL Statements | + | |
| - | {{page>:bottom_add&nofooter&noeditbtn}} | ||