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/04 06:07] tdo |
programs:odxsql:home [2015/06/10 17:39] doc |
||
|---|---|---|---|
| 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> | ||
| - | ~~NOTOC~~ | ||
| - | ====== OdxSQL Quick Reference ====== | ||
| - | {{page>:odxsql_bar&nofooter&noeditbtn}} | ||
| - | ===== OdxSQL Uses ===== | + | ====== Programs: OdxSQL ====== |
| - | OdxSQL is a console application for manually entering Omnidex SQL Statements and OdxSQL Commands. | + | **[[programs:odxsql:home|Overview]]** | [[programs:odxsql:commands|Commands]] | [[programs:odxsql:options|Options]] | [[programs:odxsql:cmdline|Command-line]] | [[programs:odxsql:files|Command Files]] |
| - | 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. | + | ===== Overview ===== |
| - | + | The OdxSQL program is a console-based utility for issuing Omnidex statements and viewing their results. OdxSQL allows customers to test or execute nearly every capability in Omnidex. Furthermore, OdxSQL can be easily integrated into shell scripts for use in automated batch operations. | |
| - | ===== Common ways to run OdxSQL ===== | + | By default, OdxSQL executes statements against an Omnidex environment; however, OdxSQL can also be run as an ODBC or JDBC client tool. In this scenario, the commands entered in OdxSQL are redirected to either the ODBC client interface or the JDBC client interface, which in turn a executed through Omnidex Network Services to the Omnidex server. This allows a wide range of tests to be performed against these interfaces. Note that two other programs, OdbcSQL and JdbcSQL, also provide similar capabilities. |
| + | ===== Running OdxSQL ===== | ||
| - | os> odxsql | + | On Microsoft Windows, OdxSQL is run from the Start menu or from the CMD shell, as shown below. |
| - | os> odxsql envfile | + | |
| - | os> odxsql dsnfile -odxnet -odbc | + | |
| - | os> odxsql -? | + | |
| - | os> odxsql -use scriptfile | + | |
| - | Running OdxSQL Explained: | + | <code> |
| - | | odxsql | Run OdxSQL. Use the CONNECT command to connect to an Omnidex Environment | | + | D:\db\simple>odxsql |
| - | | odxsql dsnfile -odxnet -odbc | Run OdxSQL and an OdxNET background process and connect to the DSN using ODBC | | + | ODXSQL - Omnidex SQL Wed, Jun 10, 2015 11:28am |
| - | | odxsql envfile | Run OdxSQL and connect to the 'envfile' | | + | (c) Dynamic Information Systems Corp. 1981-2015 Enterprise 5.3.09C |
| - | | odxsql -? | Displays OdxSQL command line options | | + | Microsoft Windows Server 2012 R2 Standard WIN2 / administrator |
| - | | odxsql -use scriptfile | Run OdxSQL and read and process the scriptfile of OdxSQL Statements and Commands.| | + | Dynamic Information Systems Corp |
| - | ===== OdxSQL Important Information ===== | + | |
| - | * OdxSQL connects to an Omnidex Environment or ODBC or JDBC Omnidex File Datasource (DSN). | ||
| - | | ||
| - | * OdxSQL automatically terminates commands and SQL Statements with a return <cr>. | ||
| - | * Use the backslash %%[ \ ]%% statement continuation character for multi line statements. | ||
| - | * Use SET CONTINUATION OFF to use the semicolon character as the statement terminator. | ||
| - | * Use HELP <cr> to display a list of commands and SQL Statements. | + | > |
| - | * Use HELP <command> to display the syntax for the command. | + | </code> |
| - | * Use SET <cr> to show a list of the current OdxSQL settings. | + | On Linux, OdxSQL is run from your preferred shell, whether bash, korn, or some other shell. |
| - | * 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. | + | <code> |
| - | * 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 | + | lnx3> [/home/db]$ odxsql |
| - | + | ODXSQL - Omnidex SQL Wed, Jun 10, 2015 11:37am | |
| - | * Use EDIT to edit the last statement using Windows Notepad or Linux/Unix vi or emacs. | + | (c) Dynamic Information Systems Corp. 1981-2015 Enterprise 5.3.09C |
| - | * Use SET EDIT to change the editor of choice. | + | Linux 2.6.32-431.20.3.el6.x86_64 lnx3 / oadev |
| - | * Use EDIT file to edit a script file without leaving OdxSQL and then USE file to run. | + | Dynamic Information Systems Corp |
| - | * 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. | + | </code> |
| - | * Use a period ( . ) to execute the last command. | + | |
| - | + | ||
| - | ===== See Also ===== | + | ===== ===== |
| - | * [[programs:odxsql:overview | OdxSQL Overview ]] | + | **[[programs:odxsql:commands|Next]]** |
| - | * OdxSQL Command Line Options | + | |
| - | * OdxSQL Commands | + | |
| - | * OdxSQL Settings | + | |
| - | * OdxSQL Script Examples | + | |
| - | * SQL SELECT | + | |
| - | * SQL SELECT Examples | + | |
| - | * Omnidex SQL Statements | + | |
| - | ^[[programs:odxsql:overview|OdxSQL Overview]]^ [[programs:odxsql:commands:home|OdxSQL Commands]] ^OdxSQL Settings^OdxSQL Scripts^SQL SELECT^ Omnidex SQL ^ | + | ====== Additional Resources ====== |
| + | See also: | ||
| + | |||
| + | {{page>:programs:see_also&nofooter&noeditbtn}} | ||
| {{page>:bottom_add&nofooter&noeditbtn}} | {{page>:bottom_add&nofooter&noeditbtn}} | ||
| + | |||
| + | |||
| + | |||