Show page
Old revisions

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 [2015/06/10 20:17]
doc 		programs:odxsql:commands [2016/06/28 22:38] (current)
Line 244: Line 244:
 ==== DROP SEGMENT ==== ==== DROP SEGMENT ====
  
-Drop a segment+The DROP SEGMENT command drops a segment ​that was previously created using the CREATE SEGMENT command.
  
 <​code>​ <​code>​
Line 252: Line 252:
 ==== DROP TABLE ==== ==== DROP TABLE ====
  
-Drop a table+The DROP TABLE command drops a table that was previously created using the CREATE TABLE command.
  
 <​code>​ <​code>​
Line 261: Line 261:
 ==== EDIT ==== ==== EDIT ====
  
-Edit a previous ​command ​or file+The EDIT command ​launches an editor with the previously submitted command. ​ Upon exiting the editor, the command will be automatically executed.
  
 <​code>​ <​code>​
Line 269: Line 269:
 ==== ERROR ==== ==== ERROR ====
  
-Display an error message+The ERROR command displays the error message ​associated with an Omnidex error code.
  
 <​code>​ <​code>​
Line 277: Line 277:
 ==== EXIT ==== ==== EXIT ====
  
-Exit Omnidex SQL+The EXIT command exits the OdxSQL program.
  
 <​code>​ <​code>​
Line 285: Line 285:
 ==== EXPLAIN ==== ==== EXPLAIN ====
  
-Explain approach to retrieval+The EXPLAIN command displays the query plan for the previously run query.  ​
  
 <​code>​ <​code>​
Line 293: Line 293:
 ==== EXPORT ==== ==== EXPORT ====
  
-Export records to a file+The EXPORT command exports the result of a SELECT statement into a raw data file or delimited ​file.
  
 <​code>​ <​code>​
Line 301: Line 301:
 ==== EXTRACT ==== ==== EXTRACT ====
  
-Extract SQL statements ​for database+The EXTRACT command extracts various types of statements ​from the currently-connected Omnidex environment file or from the system logs.  ​
  
 <​code>​ <​code>​
Line 317: Line 317:
 ==== FETCH ==== ==== FETCH ====
  
-Explicitly fetch data from a database+The FETCH command fetches individual rows following ​a SELECT statement. ​ The FETCH command is only needed if the SET AUTOFETCH OFF command is issued.
  
 <​code>​ <​code>​
Line 325: Line 325:
 ==== FOR ==== ==== FOR ====
  
-Form a 'FOR n ... END' construct+The FOR contruct provides ​a simple method for repeating one or more statements multiple times.
  
 <​code>​ <​code>​
Line 335: Line 335:
 ==== FORMAT ==== ==== FORMAT ====
  
-Format ​a file of ODXSQL ​statements+The FORMAT command formats ​a file containing Omnidex SQL statements.
  
 <​code>​ <​code>​
Line 343: Line 343:
 ==== HELP ==== ==== HELP ====
  
-Help+The HELP command shows the commands available in OdxSQL.
  
 <​code>​ <​code>​
Line 351: Line 351:
 ==== HISTORY ==== ==== HISTORY ====
  
-Show history of ODXSQL ​commands+The HISTORY command shows a history of the commands ​previously entered in this session of OdxSQL.
  
 <​code>​ <​code>​
Line 359: Line 359:
 ==== IF ==== ==== IF ====
  
-Form an 'IF ELIF ELSE ENDIF' construct+The IF contruct provides a simple method for IF/ELSE logic in OdxSQL.
  
 <​code>​ <​code>​
Line 373: Line 373:
 ==== INSERT ==== ==== INSERT ====
  
-Issue an SQL insert statement+The INSERT command inserts data into a table.
  
 <​code>​ <​code>​
Line 382: Line 382:
 ==== JOIN ==== ==== JOIN ====
  
-Join tables ​using Omnidex+The JOIN command performs an index join between two tables, and must follow a QUALIFY statement.
  
 <​code>​ <​code>​
Line 391: Line 391:
 ==== LOAD OFX ==== ==== LOAD OFX ====
  
-Load indexes ​for a table+The LOAD OFX command loads Offset Indexes (OFX'​s) ​for any delimited files in the Omnidex environment.
  
 <​code>​ <​code>​
Line 400: Line 400:
 ==== OPEN CURSOR ==== ==== OPEN CURSOR ====
  
-Open a cursor+The OPEN CURSOR command opens a suppplemental ​cursor ​for this connection. ​ The CONNECT statement automatically provides an initial cursor, so the OPEN CURSOR command is only needed if multiple cursors are required.
  
 <​code>​ <​code>​
Line 408: Line 408:
 ==== PARTITION ==== ==== PARTITION ====
  
-Partition ​a table+The PARTITION command partitions ​a table into multiple files in preparation for use in Omnidex Grids.
  
 <​code>​ <​code>​
Line 417: Line 417:
 ==== PWD ==== ==== PWD ====
  
-Print current working directory+The PWD command displays the current working directory.
  
 <​code>​ <​code>​
Line 425: Line 425:
 ==== QUALIFY ==== ==== QUALIFY ====
  
-Qualify rows using Omnidex+The QUALIFY command directly queries the Omnidex ​indexes, as a more granular alternative to issuing a SELECT statement.  ​
  
 <​code>​ <​code>​
Line 434: Line 434:
 ==== QUIT ==== ==== QUIT ====
  
-Quit Omnidex SQL+The QUIT command exits the OdxSQL program.
  
 <​code>​ <​code>​
Line 442: Line 442:
 ==== REGISTER LICENSE ==== ==== REGISTER LICENSE ====
  
-Register ​a license code+The REGISTER LICENSE command registers ​a license code that has been received from the Omnidex licensing server.
  
 <​code>​ <​code>​
Line 450: Line 450:
 ==== REGISTER ODBC ==== ==== REGISTER ODBC ====
  
-Register an ODBC driver+The REGISTER ODBC command registers the ODBC driver ​for the current version of Omnidex. ​ This is done automatically when Omnidex is installed on the server.
  
 <​code>​ <​code>​
Line 458: Line 458:
 ==== REQUEST ==== ==== REQUEST ====
  
-Request ​a license ​code+The REQUEST command prompts for and sends a license ​request for this server.
  
 <​code>​ <​code>​
Line 466: Line 466:
 ==== RESET HISTORY ==== ==== RESET HISTORY ====
  
-Reset history of ODXSQL ​commands+The RESET HISTORY command clears the history of commands ​for this OdxSQL session.
  
 <​code>​ <​code>​
Line 474: Line 474:
 ==== RESET TIMER ==== ==== RESET TIMER ====
  
-Reset the cumulative timer+The RESET TIMER command resets ​the cumulative timer that was set using SET TIMER CUMULATIVE.
  
 <​code>​ <​code>​
Line 482: Line 482:
 ==== RESTORE SETTINGS ==== ==== RESTORE SETTINGS ====
  
-Restore ​settings, ​optionally ​from a file+The RESTORE SETTINGS command restores the default ​settings ​for OdxSQL. ​ Alternatively, the RESTORE SETTINGS command loads the saved settings ​from a file created with the SAVE SETTINGS command.
  
 <​code>​ <​code>​
Line 490: Line 490:
 ==== SAVE HISTORY ==== ==== SAVE HISTORY ====
  
-Save commands ​to file+The SAVE HISTORY command saves the history of commands ​from this OdxSQL session into a file.
  
 <​code>​ <​code>​
-SAVE HISTORY [TO] filename] [WITH options]+SAVE HISTORY ​[[TO] filename] [WITH options]
 </​code>​ </​code>​
  
 ==== SAVE SETTINGS ==== ==== SAVE SETTINGS ====
  
-Save settings, optionally ​to a file+The SAVE SETTINGS command saves the current OdxSQL ​settings to a file.
  
 <​code>​ <​code>​
-SAVE SETTINGS [TO] filename] [WITH options]+SAVE SETTINGS ​[[TO] filename] [WITH options]
 </​code>​ </​code>​
  
 ==== SELECT ==== ==== SELECT ====
  
-Issue an SQL select ​statement+The SELECT command processes a SQL SELECT ​statement ​and displays the results.
  
 <​code>​ <​code>​
Line 514: Line 514:
 ==== SET ==== ==== SET ====
  
-Set an option+The SET command sets an OdxSQL ​option.  See the [[programs:​odxsql:​options|Options section]] for a listing of OdxSQL options.
  
 <​code>​ <​code>​
Line 522: Line 522:
 ==== SETENV ==== ==== SETENV ====
  
-Set an environment variable+The SETENV command sets a system ​environment variable ​for the duration of this OdxSQL session.
  
 <​code>​ <​code>​
Line 530: Line 530:
 ==== SHOW ==== ==== SHOW ====
  
-Describe an object+The SHOW command displays information about the current Omnidex environment or the Omnidex system.
  
 <​code>​ <​code>​
Line 546: Line 546:
 ==== TRANSFER LICENSE ==== ==== TRANSFER LICENSE ====
  
-Transfer ​a license to another server+The TRANSFER LICENSE command initiates ​a transfer of this license to another server.
  
 <​code>​ <​code>​
Line 554: Line 554:
 ==== UNREGISTER ODBC ==== ==== UNREGISTER ODBC ====
  
-Unregister an ODBC driver+The UNREGISTER ODBC command unregisters the current ​ODBC driver.  This is not needed unless directed by DISC Technical Support.
  
 <​code>​ <​code>​
Line 562: Line 562:
 ==== UPDATE ==== ==== UPDATE ====
  
-Issue an SQL update statement+The UPDATE command updates a row in a table.
  
 <​code>​ <​code>​
Line 572: Line 572:
 ==== UPDATE INDEXES ==== ==== UPDATE INDEXES ====
  
-Update ​Omnidex indexes+The UPDATE INDEXES command rebuilds the Omnidex indexes ​for the current Omnidex environment.
  
 <​code>​ <​code>​
Line 582: Line 582:
 ==== UPDATE ROLLUP ==== ==== UPDATE ROLLUP ====
  
-Update ​rollup table+The UPDATE ROLLUP command rebuilds an individual ​rollup table declared in the Omnidex environment file.
  
 <​code>​ <​code>​
Line 590: Line 590:
 ==== UPDATE ROLLUPS ==== ==== UPDATE ROLLUPS ====
  
-Update ​rollup tables+The UPDATE ROLLUPS command rebuilds all rollup tables ​declared in the Omnidex environment file.
  
 <​code>​ <​code>​
Line 599: Line 599:
 ==== UPDATE STATISTICS ==== ==== UPDATE STATISTICS ====
  
-Update statistical information+The UPDATE STATISTICS command refreshes the statistics for the current Omnidex environment file.  This step is automatically done within an UPDATE INDEXES command.
  
 <​code>​ <​code>​
Line 609: Line 609:
 ==== UPDATE TEXT ==== ==== UPDATE TEXT ====
  
-Update textual statistics+The UPDATE TEXT command refreshes the PowerSearch dictionaries for the current Omnidex environment file.  This step is automatically done within an UPDATE INDEXES command.
  
 <​code>​ <​code>​
Line 619: Line 619:
 ==== USE ==== ==== USE ====
  
-Execute a file of ODXSQL commands+The USE command executes the statements within the named file.  See the [[programs:​odxsql:​files|Files section]] for more information.
  
 <​code>​ <​code>​
Line 627: Line 627:
 ==== VALIDATE ==== ==== VALIDATE ====
  
-Validate ​an environment+The VALIDATE command runs a series of tests to insure that an Omnidex ​environment ​is properly set up.
  
 <​code>​ <​code>​
Line 637: Line 637:
 ==== ! ==== ==== ! ====
  
-Execute a shell command+The '​!'​ command launches an interactive system ​shell from within OdxSQL. ​ If an operating system ​command ​is provided after the exclamation point, that command is issued without launching an interative system shell.
  
 <​code>​ <​code>​
Line 645: Line 645:
 ==== . ==== ==== . ====
  
-Execute ​last command+The '​.'​ command re-executes the last command.
  
 <​code>​ <​code>​
Line 653: Line 653:
 ==== ; ==== ==== ; ====
  
-Comment line+The semicolon represents a command in OdxSQL.
  
 <​code>​ <​code>​
Line 661: Line 661:
 ==== n ==== ==== n ====
  
-Execute ​numbered command+The '​n'​ command executes the numbered command ​from the OdxSQL history, shown using the HISTORY command.
  
 <​code>​ <​code>​
Line 670: Line 670:
 ===== ===== ===== =====
  
-**[[programs:​odxsql:​home|Prev]]** | **[[programs:​odxsql:​options|Next]]** ​| +**[[programs:​odxsql:​home|Prev]]** | **[[programs:​odxsql:​options|Next]]**
  
 ====== Additional Resources ====== ====== Additional Resources ======
 
Back to top
programs/odxsql/commands.1433967442.txt.gz ยท Last modified: 2016/06/28 22:38 (external edit)
Sitemap Recent Changes