Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
programs:odxsql:commands:home [2009/12/08 02:53]
tdo
programs:odxsql:commands:home [2016/06/28 22:38] (current)
Line 2: Line 2:
 <​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~~ ~~NOTOC~~
-====== OdxSQL Commands ======+====== OdxSQL Commands ​and Omnidex SQL Statements ​======
 {{page>:​odxsql_bar&​nofooter&​noeditbtn}} {{page>:​odxsql_bar&​nofooter&​noeditbtn}}
-===== Overview ===== 
  
-OdxSQL ​is used to process a wide range of Omnidex SQL Statements ​and OdxSQL specific commands.+OdxSQL ​processes ​Omnidex SQL statements ​and OdxSQL specific commands ​either interactively or in batch oriented script files via the USE command
  
-The OdxSQL Commands and Omnidex SQL Statements ​are organized ​for quick review as follows:+The following is a list of Omnidex SQL Statements ​and OdxSQL commands ​organized ​by type with a complete alphabetic list shown below.
  
-  * [[#​Connecting and Disconnecting ]] 
-  * [[#Omnidex SQL Data Definition Language (DDL) Statements ]] 
-  * [[#Omnidex SQL Data Manipulation Language (DML) Statements ]] 
-  * [[#Omnidex Environment Operation Commands ]] 
-  * [[#OdxSQl and Omnidex SQL Data Export and Manipulation ]] 
-  * [[#OdxSQL Program Operation Commands ]] 
-  * [[#OdxSQL Testing and Performance Commands ]] 
-  * [[#OdxSQL Operating System Commands ]] 
-  * [[#Omnidex Index Direct Maintenance Routines ]] 
-  * [[#​Alphabetical List of OdxSQL Commands and Omnidex SQL Statements ]] 
- 
-OdxSQL Commands and Omnidex SQL Statements can be entered into OdxSQL in ether upper or lower case. 
- 
-  > connect myenv 
- 
-  > CONNECT myenv 
- 
-The syntax for Omnidex SQL Statements entered into OdxSQL or processed in a script file is typically the exact same syntax and returns the exact same results. 
- 
-There are a few exceptions such as CONNECT and VERSION. 
- 
-In OdxSQL, CONNECT has two additional options of ON host:port and USING api that are not available in the Omnidex SQL CONNECT Statement. ​ The api is not necessary has it is already known depending on the application type (ODBC or JDBC) and ON  ​ 
- 
-In OdxSQL, the VERSION command displays the OdxSQL header and multiple lines of version information where the Omnidex SQL VERSION statement returns a single line. 
- 
-The OdxSQL EXECSQL command can be used to verify if an Omnidex SQL Statement is processed exactly the same by OdxSQL as the Omnidex SQL parser. 
- 
-<​code>​ 
-> VERSION 
-ODXSQL - Omnidex SQL                                   Wed Dec 02 09:20:41 200 
-... 
-Omnidex Version ​                 5.0 Build 2B 
-Compilation Timestamp ​           Oct 13 2009  08:57:09 
-Earliest Compatible ODBC Client ​ 4.3 Build 4B 
-Earliest Compatible JDBC Client ​ 4.3 Build 4B 
-Earliest Compatible Odx Kernel ​  5.0 Build 1B 
- 
-> EXECSQL VERSION 
-OmniAccess version 50002 
- 
-</​code>​ 
 ===== Connecting and Disconnecting ===== ===== Connecting and Disconnecting =====
  
Line 70: Line 28:
 | [[dev:​sql:​statements:​update:​home |UPDATE]] | Issue an Omnidex SQL UPDATE Statement. | | [[dev:​sql:​statements:​update:​home |UPDATE]] | Issue an Omnidex SQL UPDATE Statement. |
 | [[dev:​sql:​statements:​delete:​home | DELETE]] | Issue the SQL DELETE Statement. | | [[dev:​sql:​statements:​delete:​home | DELETE]] | Issue the SQL DELETE Statement. |
- 
 ===== Omnidex SQL Data Definition Language (DDL) Statements ===== ===== Omnidex SQL Data Definition Language (DDL) Statements =====
 ^ DDL Statement ^  Description ​ ^ ^ DDL Statement ^  Description ​ ^
Line 84: Line 41:
 | [[programs:​odxsql:​commands:​drop_index|DROP INDEX]] | Drop Index. | | [[programs:​odxsql:​commands:​drop_index|DROP INDEX]] | Drop Index. |
 | [[programs:​odxsql:​commands:​drop_indexes|DROP INDEXES]] | Drop Indexes. | | [[programs:​odxsql:​commands:​drop_indexes|DROP INDEXES]] | Drop Indexes. |
 +| [[programs:​odxsql:​commands:​show_ddl|SHOW DDL]] | Show Data Definition Statements. |
 +
 ===== Additional Omnidex SQL DML Statements ===== ===== Additional Omnidex SQL DML Statements =====
  
 ^ DML Statement ^  Description ​ ^ ^ DML Statement ^  Description ​ ^
-| [[programs:​odxsql:​commands:​join|JOIN]] ​| Statement ​| Join tables using Omnidex Indexes. | +| [[programs:​odxsql:​commands:​join|JOIN]] | Join tables using Omnidex Indexes. | 
-| [[programs:​odxsql:​commands:​qualify|QUALIFY]] ​| Statement ​| Qualify rows using Omnidex criteria. | +| [[programs:​odxsql:​commands:​qualify|QUALIFY]] | Qualify rows using Omnidex criteria. | 
-| [[programs:​odxsql:​commands:​fetch|FETCH]] ​| Statement ​| Explicitly fetch data from the database. | +| [[programs:​odxsql:​commands:​fetch|FETCH]] | Explicitly fetch data from the database. | 
-| [[programs:​odxsql:​commands:​fetchkeys|FETCHKEYS]] ​| Statement ​| Explicitly fetch keys from the Omnidex Indexes. | +| [[programs:​odxsql:​commands:​fetchkeys|FETCHKEYS]] | Explicitly fetch keys from the Omnidex Indexes. | 
-| [[programs:​odxsql:​commands:​open_cursor|OPEN CURSOR]] ​| Statement ​| Open a Cursor. | +| [[programs:​odxsql:​commands:​open_cursor|OPEN CURSOR]] | Open a Cursor. | 
-| [[programs:​odxsql:​commands:​close_cursor|CLOSE CURSOR]] ​| Statement ​| Close a previously opened cursor. |+| [[programs:​odxsql:​commands:​close_cursor|CLOSE CURSOR]] | Close a previously opened cursor. | 
 ===== Omnidex SQL Operational Statements ===== ===== Omnidex SQL Operational Statements =====
  
Line 139: Line 99:
 | Comment ( ; ) | Use a semicolon as the first character of a line for a comment line. | | Comment ( ; ) | Use a semicolon as the first character of a line for a comment line. |
 | [[programs:​odxsql:​commands:​version|VERSION]] | Display current Omnidex Software versions. | | [[programs:​odxsql:​commands:​version|VERSION]] | Display current Omnidex Software versions. |
- 
 ===== OdxSQL Testing and Performance Commands ===== ===== OdxSQL Testing and Performance Commands =====
  
 OdxSQL contains several commands that facilitate the testing and optimization of an Omnidex Environment. OdxSQL contains several commands that facilitate the testing and optimization of an Omnidex Environment.
  
 +^ Command ^  Description ​ ^
 | [[programs:​odxsql:​commands:​explain|EXPLAIN]] | Explain the optimization approach to a previous retrieval. | | [[programs:​odxsql:​commands:​explain|EXPLAIN]] | Explain the optimization approach to a previous retrieval. |
 | [[programs:​odxsql:​commands:​reset_timer|RESET TIMER]] | Reset the OdxSQL Cummulative Timer. | | [[programs:​odxsql:​commands:​reset_timer|RESET TIMER]] | Reset the OdxSQL Cummulative Timer. |
Line 150: Line 110:
 | [[programs:​odxsql:​commands:​error|ERROR]] | Display the text of an error message from the Omnidex Error Message file. | | [[programs:​odxsql:​commands:​error|ERROR]] | Display the text of an error message from the Omnidex Error Message file. |
 | [[programs:​odxsql:​commands:​execsql|EXECSQL]] | Execute an Omnidex SQL Statement directly with the oaexecsql routine without OdxSQL doing any processing. | | [[programs:​odxsql:​commands:​execsql|EXECSQL]] | Execute an Omnidex SQL Statement directly with the oaexecsql routine without OdxSQL doing any processing. |
-| [[programs:​odxsql:​commands:​sleep|SLEEP]] | Sleep for a specified number of seconds. |+
 ===== OdxSQL Operating System Commands ===== ===== OdxSQL Operating System Commands =====
  
 OdxSQL contains several commands that access the underlying operating to facilitate the Omnidex Administrator or Developer staying inside of OdxSQL for many tasks. OdxSQL contains several commands that access the underlying operating to facilitate the Omnidex Administrator or Developer staying inside of OdxSQL for many tasks.
  
 +^ Command ^  Description ​ ^
 | [[programs:​odxsql:​commands:​exclamationpoint|! <shell command> ]] |Run an OS command in the OS Shell and return or just an ( ! ) for an interactive shell. | | [[programs:​odxsql:​commands:​exclamationpoint|! <shell command> ]] |Run an OS command in the OS Shell and return or just an ( ! ) for an interactive shell. |
 | [[programs:​odxsql:​commands:​command|COMMAND]] | Execute a shell command via the $COMMAND table. | | [[programs:​odxsql:​commands:​command|COMMAND]] | Execute a shell command via the $COMMAND table. |
Line 167: Line 128:
 | [[programs:​odxsql:​commands:​rename|RENAME]] | Rename a file or fileset in the underlying Operating System. | | [[programs:​odxsql:​commands:​rename|RENAME]] | Rename a file or fileset in the underlying Operating System. |
 | [[programs:​odxsql:​commands:​view |VIEW]] | View a text file. | | [[programs:​odxsql:​commands:​view |VIEW]] | View a text file. |
- 
 ===== Alphabetical List of OdxSQL Commands and Omnidex SQL Statements ===== ===== Alphabetical List of OdxSQL Commands and Omnidex SQL Statements =====
  
Line 234: Line 194:
 | [[programs:​odxsql:​commands:​set|SET]] | Both | Set an OdxSQL setting. | | [[programs:​odxsql:​commands:​set|SET]] | Both | Set an OdxSQL setting. |
 | [[programs:​odxsql:​commands:​show|SHOW]] | Command |Show Omnidex Environment information including Databases, Tables, Column layouts, Query Statistics, etc. | | [[programs:​odxsql:​commands:​show|SHOW]] | Command |Show Omnidex Environment information including Databases, Tables, Column layouts, Query Statistics, etc. |
 +| [[programs:​odxsql:​commands:​show_ddl|SHOW DDL]] | Show Data Definition Statements. |
 | [[programs:​odxsql:​commands:​signal|SIGNAL]] | Command | Sends a Signal to a process. | | [[programs:​odxsql:​commands:​signal|SIGNAL]] | Command | Sends a Signal to a process. |
-| [[programs:​odxsql:​commands:​sleep|SLEEP]] | Command | Sleep for a specified number of seconds. | 
 | [[programs:​odxsql:​commands:​update|UPDATE]] | Statement | Issue an Omnidex SQL UPDATE Statement. | | [[programs:​odxsql:​commands:​update|UPDATE]] | Statement | Issue an Omnidex SQL UPDATE Statement. |
 | [[programs:​odxsql:​commands:​update_indexes|UPDATE INDEXES]] |Statement | Update Omnidex Indexes | | [[programs:​odxsql:​commands:​update_indexes|UPDATE INDEXES]] |Statement | Update Omnidex Indexes |
Line 244: Line 204:
 | [[programs:​odxsql:​commands:​use|USE]] | Command | Read and process a file of OdxSQL Commands and Omnidex SQL Statements, optionally with WHERE criteria. | | [[programs:​odxsql:​commands:​use|USE]] | Command | Read and process a file of OdxSQL Commands and Omnidex SQL Statements, optionally with WHERE criteria. |
 | [[programs:​odxsql:​commands:​validate|VALIDATE]] | Command | Validate the Omnidex Environment'​s view of the underlying data. To be removed in 5.1 | | [[programs:​odxsql:​commands:​validate|VALIDATE]] | Command | Validate the Omnidex Environment'​s view of the underlying data. To be removed in 5.1 |
-| [[programs:​odxsql:​commands:​version|VERSION]] | Both | Display current Omnidex Software versions. |+| [[programs:​odxsql:​commands:​version|VERSION]] | Command ​| Display current Omnidex Software versions. |
 | [[programs:​odxsql:​commands:​view | VIEW]] | Command | View a text file. | | [[programs:​odxsql:​commands:​view | VIEW]] | Command | View a text file. |
  
 
Back to top
programs/odxsql/commands/home.1260240824.txt.gz · Last modified: 2016/06/28 22:38 (external edit)