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 18:04]
doc 		programs:odxsql:commands [2016/06/28 22:38] (current)
Line 1: Line 1:
 {{page>:​top_add&​nofooter&​noeditbtn}} {{page>:​top_add&​nofooter&​noeditbtn}}
 +~~NOTOC~~
  
 ====== Programs: OdxSQL ====== ====== Programs: OdxSQL ======
Line 15: Line 15:
  
  
-==== ATTACH DATABASE ​    ​====+==== ATTACH DATABASE ​==== 
 + 
 +The ATTACH DATABASE command attaches a database from one environment into the currently connected environment,​ thereby allowing SQL statements to access both databases. 
 + 
 +<​code>​ 
 +ATTACH DATABASE database [AS alias] FROM filename [ON [INSTANCE] instance] 
 +  [WITH options] 
 +</​code>​ 
 + 
 +==== ATTACH SEGMENT ​====
  
-Attach ​a database+The ATTACH SEGMENT command attaches ​a previously-created segment into the currently connected environment so that it can be referenced in subsequent SQL statements. ​ Segments are created using the CREATE SEGMENT command. ​
  
-ATTACH ​DATABASE database ​[AS alias] FROM filename ​[ON [INSTANCE] instance] [WITH options]+<​code>​ 
 +ATTACH ​<INDEX | DATA> SEGMENT segment ​[PHYSICAL physical] 
 +  ​[ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
-==== ATTACH ​SEGMENT ​     ​====+==== ATTACH ​TABLE ====
  
- * Attach ​a segment+The ATTACH TABLE command attaches ​a raw data file or a delimited file into the currently connected environment,​ thereby allowing SQL statements to access both databases. ​ Note that attached tables are not indexed with Omnidex. ​ For attaching indexed tables, use the ATTACH DATABASE command.
  
- * ATTACH ​<INDEX | DATA> SEGMENT segment ​[PHYSICAL physical] +<code> 
-     ​[ON [INSTANCE] instance] [WITH options]+ATTACH TABLE table [PHYSICAL ​"physical"] (column [, column ...]) 
 +  [ON [INSTANCE] instance>] [WITH options] 
 +  column: column-name datatype (length) 
 +</​code>​
  
-==== ATTACH TABLE        ​====+==== BENCHMARK ​====
  
- * Attach ​a table+The BENCHMARK command provides ​a menu of performance benchmarks that can be performed, focusing on POSIX file I/​O.  ​
  
- * ATTACH TABLE table [PHYSICAL "​physical"​] (column [, column ...]) +<​code>​ 
-     ​[ON [INSTANCE] instance>] [WITH options] +BENCHMARK ​[<table | select-statement>] [WITH options] 
-     column: column-name datatype (length)+</​code>​
  
-==== BENCHMARK ​          ====+==== CALC ====
  
-   ​Perform performance benchmarks+The CALC command provides a very basic calculator, allowing formulas like "CALC (123+456)*789"​.
  
-   ​BENCHMARK [<table | select-statement>] [WITH options]+<code> 
 +CALC expression 
 +</code>
  
-==== CALC                ​====+==== CD ====
  
-   ​Perform basic calculator functions+The CD command changes the current working directory within the OdxSQL session. ​ The current working directory outside of OdxSQL remains unchanged.
  
-   CALC expression+<​code>​ 
 +CD [path] 
 +</​code>​
  
-==== CD                  ​====+==== CLOSE CURSOR ​====
  
-   ​Change directories+The CLOSE CURSOR command closes a cursor that was previously opened using the OPEN CURSOR command.
  
-   ​CD ​[path]+<​code>​ 
 +CLOSE CURSOR ​[[ON] CURSOR] cursor] [WITH options] 
 +</​code>​
  
-==== CLOSE CURSOR ​       ​====+==== CONNECT ​====
  
- * Close a cursor+The CONNECT command connects to an Omnidex environment file.  The USING clause allows the connection to be performed using the ODBC or JDBC client interfaces.
  
- * CLOSE CURSOR ​[[ON] CURSOR] cursor] [WITH options]+<​code>​ 
 +CONNECT ​[TO] connection_string ​[USING api] [WITH options] 
 +  Connection string syntax: 
 +    [ host:​port:​pool ​] filename ​[ node ] &options 
 +  Examples: 
 +    CONNECT example.xml 
 +    CONNECT [server1:​7555]example.xml 
 +    CONNECT [server1:​7555:​pool1] 
 +</​code>​
  
-==== CONNECT ​            ====+==== CONVERT ​====
  
- * Connect ​to an environment file+The CONVERT command allows a SELECT statement ​to be exported while interactively prompting for data conversions of each retrieved column.
  
- * CONNECT ​[TO] connection_string ​[USING api] [WITH options] +<​code>​ 
-     ​Connection string syntax: +CONVERT ​[statement ​TO filename ​[ON [CURSOR] cursor] [WITH options] 
-       [ host:​port:​pool ​] filename ​[ node ] &options +</​code>​
-     ​Examples:​ +
-       ​CONNECT example.xml +
-       ​CONNECT [server1:​7555]example.xml +
-       CONNECT [server1:​7555:​pool1]+
  
-==== CONVERT ​            ====+==== CREATE DATABASE ​====
  
-   ​Export ​a file with data conversions+The CREATE DATABASE command allows ​a database to be declared in an Omnidex environment ​file.  For details on CREATE DATABASE statements for each database type, consult the [[integration:​home|Integration section]] of the documentation.
  
-   ​CONVERT [statement TO filename ​[ON [CURSOR] cursor] ​[WITH options]+<​code>​ 
 +CREATE DATABASE database  
 +  ... 
 +  IN "filename" ​[WITH options] 
 +</​code>​
  
-==== CREATE ​DATABASE ​    ====+==== CREATE ​ENVIRONMENT ​====
  
- * Create ​a database+The CREATE ENVIRONMENT command creates ​a new Omnidex environment file.
  
- ​* ​CREATE ​DATABASE database node [node ...] IN "​filename"​ [WITH options] +<​code>​ 
-     node: [NODE node] TYPE type [attribute [attribute ...]]+CREATE ​ENVIRONMENT environment  
 +  ​[OPTIONS ​options] 
 +  [NODE node_declaration] 
 +  IN "​filename"​ 
 +</​code>​
  
-==== CREATE ​ENVIRONMENT  ​====+==== CREATE ​INDEX ====
  
- * Create ​an environment file+The CREATE INDEX and CREATE INDEX GROUP commands create indexes in an Omnidex ​environment file.  For details on CREATE INDEX and CREATE INDEX GROUP statements, consult the [[admin:​indexing:​creation:​home|Index Creation section]] of the documentation.
  
- ​* ​CREATE ​ENVIRONMENT environment ​[attribute ​[attribute ​...]] +<​code>​ 
-     ​[node [node ...]] IN "​filename"​ [WITH options] +CREATE ​<OMNIDEX | QUICKTEXT | FULLTEXT | CUSTOM | NATIVE> INDEX 
-     node: [NODE node] [attribute [attribute ...]]+  ​[[(owner)]table.]index [ON table] 
 +  (<column | substring>​ [, <column | substring> ​...])] 
 +  [attribute ​[attribute ​...]] IN "​filename"​ [WITH options]
  
-==== CREATE INDEX        ====+CREATE INDEX GROUP [(owner)]group 
 +  (table.index [, table.index ...])] IN "​filename"​ [WITH options] 
 +</​code>​
  
- * Create an index or index group 
  
- ​* ​CREATE ​<OMNIDEX | QUICKTEXT | FULLTEXT | CUSTOM | NATIVE> INDEX +==== CREATE ​SEGMENT ====
-     ​[[(owner)]table.]index [ON table] +
-     ​(<​column | substring>​ [, <column | substring>​ ...])] +
-     ​[attribute [attribute ...]] IN "​filename"​ [WITH options] +
-   ​CREATE INDEX GROUP [(owner)]group +
-     ​(table.index [, table.index ...])] IN "​filename"​ [WITH options]+
  
-==== CREATE SEGMENT ​     ====+The CREATE SEGMENT ​command creates a data segment or an index segment, thereby allowing it to be referenced in subsequent queries.
  
- * Create a segment+<​code>​ 
 +CREATE [<​TEMPORARY | PERMANENT>​] <INDEX | DATA> SEGMENT ​segment 
 +  [PHYSICAL physical] [AS (select)] [ON [CURSOR] cursor] 
 +  [WITH options] 
 +</​code>​
  
- ​* ​CREATE ​[<​TEMPORARY | PERMANENT>​] <INDEX | DATA> SEGMENT segment +==== CREATE ​TABLE ====
-     ​[PHYSICAL physical] [AS (select)] [ON [CURSOR] cursor] +
-   [WITH options]+
  
-==== CREATE TABLE        ====+The CREATE TABLE command creates a table in the current connection. ​ If the IN clause is used, then the CREATE TABLE command creates a table declaration in an Omnidex environment file.  For details on CREATE TABLE statements for each database type, consult the [[integration:​home|Integration section]] of the documentation.
  
- * Create a table+<​code>​ 
 +CREATE [<​[<​GLOBAL | LOCAL>] TEMPORARY | PERMANENT>​] TABLE table 
 +  [PHYSICAL "​physical"​] (column [, column ...]) 
 +  [<IN "​filename"​ | ON [INSTANCE] instance>​] [WITH options] 
 +  column: column-name datatype (length) 
 +</​code>​
  
- * CREATE [<​[<​GLOBAL | LOCAL>] TEMPORARY | PERMANENT>​] TABLE table +column: column-name datatype (length)
-     ​[PHYSICAL "​physical"​] (column [, column ...]) +
-     ​[<​IN "​filename"​ | ON [INSTANCE] instance>​] [WITH options] +
-     column: column-name datatype (length)+
  
-==== DATE                ====+==== DATE ====
  
-   ​Show ​the current date and time+The DATE command shows the current date and time.
  
-   DATE+<​code>​ 
 +DATE 
 +</​code>​
  
-==== DELETE ​             ====+==== DELETE ====
  
- * Issue an SQL delete statement+The DELETE command deletes one or more rows from a table.
  
- ​* ​DELETE FROM table [WHERE < predicate-list | CURRENT>​ +<​code>​ 
-     ​[<ON | OF> [CURSOR] cursor]] [WITH options]+DELETE FROM table [WHERE <​predicate-list | CURRENT>​ 
 +  [<ON | OF> [CURSOR] cursor]] [WITH options] 
 +</​code>​
  
-==== DETACH DATABASE ​    ​====+==== DETACH DATABASE ====
  
- * Detach ​a previously attached ​database+The DETACH DATABASE command detaches ​a database that was previously attached ​using the ATTACH DATABASE command.
  
- ​* ​DETACH DATABASE database [ON [INSTANCE] instance] [WITH options]+<​code>​ 
 +DETACH DATABASE database [ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
-==== DETACH SEGMENT ​     ====+==== DETACH SEGMENT ====
  
- * Detach ​a previously attached ​segment+The DETACH SEGMENT command detaches ​a segment that was previously attached ​using the ATTACH SEGMENT command.
  
- ​* ​DETACH SEGMENT segment [ON [INSTANCE] instance] [WITH options]+<​code>​ 
 +DETACH SEGMENT segment [ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
-==== DETACH TABLE        ====+==== DETACH TABLE ====
  
- * Detach ​a previously attached ​table+The DETACH TABLE command detaches ​a table that was previously attached ​using the ATTACH TABLE command.
  
- ​* ​DETACH TABLE table [ON [INSTANCE] instance] [WITH options]+<​code>​ 
 +DETACH TABLE table [ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
-==== DIR                 ​====+==== DIR ====
  
-   ​Display a directory of files+The DIR command lists the files named in the fileset, optionally showing details for each file.
  
-   DIR fileset [WITH options]+<​code>​ 
 +DIR fileset [WITH options] 
 +</​code>​
  
-==== DISCONNECT ​         ====+==== DISCONNECT ====
  
- * Disconnect ​from an environment file+The DISCONNECT command disconnects ​from the Omnidex ​environment file.
  
- ​* ​DISCONNECT [ALL] [[ON [INSTANCE]] instance] [WITH options]+<​code>​ 
 +DISCONNECT [ALL] [[ON [INSTANCE]] instance] [WITH options] 
 +</​code>​
  
-==== DROP DATABASE ​      ​====+==== DROP DATABASE ====
  
- * Drop a database+The DROP DATABASE command drops a database ​from an Omnidex environment file.
  
- ​* ​DROP DATABASE [IF EXISTS] database IN "​filename"​ [WITH options]+<​code>​ 
 +DROP DATABASE [IF EXISTS] database IN "​filename"​ [WITH options] 
 +</​code>​
  
-==== DROP ENVIRONMENT ​   ====+==== DROP ENVIRONMENT ====
  
- * Drop an environment+The DROP ENVIRONMENT command drops and deletes ​an Omnidex ​environment ​file.
  
- ​* ​DROP ENVIRONMENT [IF EXISTS] [environment] IN "​filename"​ [WITH options]+<​code>​ 
 +DROP ENVIRONMENT [IF EXISTS] [environment] IN "​filename"​ [WITH options] 
 +</​code>​
  
-==== DROP INDEX          ====+==== DROP INDEX ====
  
- * Drop an index or index group+The DROP INDEX and DROP INDEX GROUP commands drop an index or index group from an Omnidex environment file.
  
- ​* ​DROP [<​OMNIDEX | NATIVE>] INDEX [IF EXISTS] [[(owner)]table.]index [ON table] +<​code>​ 
-     ​IN "​filename"​ [WITH options] +DROP [<​OMNIDEX | NATIVE>] INDEX [IF EXISTS] [[(owner)]table.]index [ON table] 
-   DROP INDEX GROUP [IF EXISTS] [(owner)]group IN "​filename"​ [WITH options]+  IN "​filename"​ [WITH options] 
 +</​code>​
  
-==== DROP SEGMENT ​       ====+<​code>​ 
 +DROP INDEX GROUP [IF EXISTS] [(owner)]group IN "​filename"​ [WITH options] 
 +</​code>​
  
- * Drop a segment+==== DROP SEGMENT ====
  
- ​* ​DROP SEGMENT ​[IF EXISTS] ​segment ​[ON [INSTANCE] instance>​] [WITH options]+The DROP SEGMENT ​command drops a segment ​that was previously created using the CREATE SEGMENT command.
  
-==== DROP TABLE          ====+<​code>​ 
 +DROP SEGMENT [IF EXISTS] segment [ON [INSTANCE] instance>​] [WITH options] 
 +</​code>​
  
- * Drop a table+==== DROP TABLE ====
  
- ​* ​DROP [<​TEMPORARY | PERMANENT>​] ​TABLE [IF EXISTS] ​table +The DROP TABLE command drops a table that was previously created using the CREATE TABLE command.
-     ​[<​IN "​filename"​ | ON [INSTANCE] instance>​] [WITH options]+
  
-==== EDIT                ====+<​code>​ 
 +DROP [<​TEMPORARY | PERMANENT>​] TABLE [IF EXISTS] table  
 +  [<IN "​filename"​ | ON [INSTANCE] instance>​] [WITH options] 
 +</​code>​
  
-   Edit a previous command or file+==== EDIT ====
  
-   EDIT [n | filename] [WITH options]+The EDIT command launches an editor with the previously submitted command. ​ Upon exiting the editor, the command will be automatically executed.
  
-==== ERROR               ====+<​code>​ 
 +EDIT [n | filename] [WITH options] 
 +</​code>​
  
-   ​Display an error message+==== ERROR ====
  
-   ERROR error_code+The ERROR command displays the error message associated with an Omnidex error code.
  
-==== EXIT                ====+<​code>​ 
 +ERROR error_code 
 +</​code>​
  
-   Exit Omnidex SQL+==== EXIT ====
  
-   EXIT+The EXIT command exits the OdxSQL program.
  
-==== EXPLAIN ​            ====+<​code>​ 
 +EXIT 
 +</​code>​
  
-   ​Explain approach to retrieval+==== EXPLAIN ====
  
-   EXPLAIN ​[statement] [ON [CURSOR] cursor] [WITH options]+The EXPLAIN ​command displays the query plan for the previously run query.  ​
  
-==== EXPORT ​             ====+<​code>​ 
 +EXPLAIN [statement] [ON [CURSOR] cursor] [WITH options] 
 +</​code>​
  
- * Export records to a file+==== EXPORT ====
  
- ​* ​EXPORT ​[statement] TO filename [ON [CURSOR] cursor] [WITH options]+The EXPORT ​command exports the result of a SELECT ​statement ​into a raw data file or delimited file.
  
-==== EXTRACT ​            ====+<​code>​ 
 +EXPORT [statement] TO filename [ON [CURSOR] cursor] [WITH options] 
 +</​code>​
  
- * Extract SQL statements for database+==== EXTRACT ====
  
- ​* ​EXTRACT ​DDL [FOR <​ENVIRONMENT [environment] | DATABASE database>​] +The EXTRACT ​command extracts various types of statements from the currently-connected Omnidex ​environment ​file or from the system logs.  ​
-     [TO filename] [ON [INSTANCE] instance] [WITH options] +
-   ​EXTRACT DDL FOR <MYSQL | ORACLE | ODBC | SQLSERVER>​ +
-     [TO filename] [ON [INSTANCE] instance] [WITH options] +
-   ​EXTRACT DML FOR table-list [WHERE criteria] +
-     [TO filename] [ON [INSTANCE] instance] [WITH options] +
-   ​EXTRACT [<ALL | n | LONGEST n | ERRORING>​] QUERIES +
-     [BY <​CONNECTION | STATEMENT>​] [WHERE criteria] +
-     [TO filename] [ON [INSTANCE] instance] [WITH options]+
  
-==== FETCH               ====+<​code>​ 
 +EXTRACT DDL [FOR <​ENVIRONMENT [environment] | DATABASE database>​] 
 +  [TO filename] [ON [INSTANCE] instance] [WITH options] 
 +EXTRACT DDL FOR <MYSQL | ORACLE | ODBC | SQLSERVER>​ 
 +  [TO filename] [ON [INSTANCE] instance] [WITH options] 
 +EXTRACT DML FOR table-list [WHERE criteria] 
 +  [TO filename] [ON [INSTANCE] instance] [WITH options] 
 +EXTRACT [<ALL | n | LONGEST n | ERRORING>​] QUERIES 
 +  [BY <​CONNECTION | STATEMENT>​] [WHERE criteria] 
 +  [TO filename] [ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
-   ​Explicitly fetch data from a database+==== FETCH ====
  
-   FETCH [<n | ALL>] [ON [CURSOR] cursor] [WITH options]+The FETCH command fetches individual rows following a SELECT statement. ​ The FETCH command is only needed if the SET AUTOFETCH OFF command is issued.
  
-==== FOR                 ====+<​code>​ 
 +FETCH [<n | ALL>] [ON [CURSOR] cursor] [WITH options] 
 +</​code>​
  
-   Form a 'FOR n ... END' construct+==== FOR ====
  
-   FOR n [WITH options] +The FOR contruct provides a simple method for repeating one or more statements ​multiple times.
-   <statements> +
-   END+
  
-==== FORMAT ​             ====+<​code>​ 
 +FOR n [WITH options] 
 +<​statements>​ 
 +END 
 +</​code>​
  
-   ​Format a file of ODXSQL statements+==== FORMAT ====
  
-   FORMAT ​input-file [INTO output-file] [WITH options]+The FORMAT ​command formats a file containing Omnidex SQL statements.
  
-==== HELP                ====+<​code>​ 
 +FORMAT input-file [INTO output-file] [WITH options] 
 +</​code>​
  
-   Help+==== HELP ====
  
-   HELP [<command ​| SYNTAX | API>]+The HELP command ​shows the commands available in OdxSQL.
  
-==== HISTORY ​            ====+<​code>​ 
 +HELP [<​command | SYNTAX | API>] 
 +</​code>​
  
-   Show history of ODXSQL commands+==== HISTORY ====
  
-   HISTORY+The HISTORY ​command shows a history of the commands previously entered in this session of OdxSQL.
  
-==== IF                  ====+<​code>​ 
 +HISTORY 
 +</​code>​
  
-   Form an 'IF ELIF ELSE ENDIF' construct+==== IF ====
  
-   IF condition +The IF contruct provides a simple method for IF/ELSE logic in OdxSQL.
-     <​statements>​ +
-   ELIF condition +
-     <​statements>​ +
-   ELSE +
-     <​statements>​ +
-   ENDIF+
  
-==== INSERT ​             ====+<​code>​ 
 +IF condition 
 +  <​statements>​ 
 +ELIF condition 
 +  <​statements>​ 
 +ELSE 
 +  <​statements>​ 
 +ENDIF 
 +</​code>​
  
- * Issue an SQL insert statement+==== INSERT ====
  
- ​* ​INSERT ​INTO table [(column-list)] <VALUES (value-list) | select-stmt>​ +The INSERT ​command inserts data into a table.
-     [ON [INSTANCE] instance] [WITH options]+
  
-==== JOIN                ====+<​code>​ 
 +INSERT INTO table [(column-list)] <VALUES (value-list) | select-stmt>​ 
 +  [ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
- * Join tables using Omnidex+==== JOIN ====
  
- ​* ​JOIN [FROM] table USING index TO [(owner)]table USING index +The JOIN command performs an index join between two tables, and must follow a QUALIFY statement.
-     [ON [CURSOR] cursor] [WITH options]+
  
-==== LOAD OFX            ====+<​code>​ 
 +JOIN [FROM] table USING index TO [(owner)]table USING index 
 +  [ON [CURSOR] cursor] [WITH options] 
 +</​code>​
  
- * Load indexes for a table+==== LOAD OFX ====
  
- ​* ​LOAD OFX [FOR <​ENVIRONMENT [environment] | DATABASE database | TABLE table>​] +The LOAD OFX command loads Offset Indexes (OFX'​s) for any delimited files in the Omnidex ​environment.
-     [ON [INSTANCE] instance] [WITH options]+
  
-==== OPEN CURSOR ​        ====+<​code>​ 
 +LOAD OFX [FOR <​ENVIRONMENT [environment] | DATABASE database | TABLE table>​] 
 +  [ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
- * Open a cursor+==== OPEN CURSOR ====
  
- * OPEN CURSOR ​[ON [INSTANCE] instance] [WITH options]+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.
  
-==== PARTITION ​          ====+<​code>​ 
 +OPEN CURSOR [ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
- * Partition a table+==== PARTITION ====
  
- ​* ​PARTITION table [INTO n] [BY <column | expression>​] [IN path] +The PARTITION ​command partitions a table into multiple files in preparation for use in Omnidex Grids.
-     [ON [INSTANCE] instance] [WITH options]+
  
-==== PWD                 ====+<​code>​ 
 +PARTITION table [INTO n] [BY <column | expression>​] [IN path] 
 +  [ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
-   Print current working directory+==== PWD ====
  
-   PWD+The PWD command displays the current working directory.
  
-==== QUALIFY ​            ====+<​code>​ 
 +PWD 
 +</​code>​
  
- * Qualify rows using Omnidex+==== QUALIFY ====
  
- ​* ​QUALIFY ​[(owner)]table WHERE [[$QUALIFIED] <AND | OR> [NOT]] +The QUALIFY ​command directly queries the Omnidex indexes, as a more granular alternative to issuing a SELECT statement.  ​
-     ​predicate [ON [CURSOR] cursor] [WITH options]+
  
-==== QUIT                ====+<​code>​ 
 +QUALIFY [(owner)]table WHERE [[$QUALIFIED] <AND | OR> [NOT]] 
 +  predicate [ON [CURSOR] cursor] [WITH options] 
 +</​code>​
  
-   Quit Omnidex SQL+==== QUIT ====
  
-   QUIT+The QUIT command exits the OdxSQL program.
  
-==== REGISTER LICENSE ​   ====+<​code>​ 
 +QUIT 
 +</​code>​
  
-   ​Register a license code+==== REGISTER LICENSE ====
  
-   REGISTER LICENSE ​license_code [FOR company]+The REGISTER LICENSE ​command registers a license code that has been received from the Omnidex licensing server.
  
-==== REGISTER ​ODBC       ====+<​code>​ 
 +REGISTER ​LICENSE license_code [FOR company] 
 +</​code>​
  
-   ​Register an ODBC driver+==== REGISTER ​ODBC ====
  
-   REGISTER ODBC [dir]+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.
  
-==== REQUEST ​            ====+<​code>​ 
 +REGISTER ODBC [dir] 
 +</​code>​
  
-   ​Request a license code+==== REQUEST ====
  
-   REQUEST ​[<​ENTERPRISE | DEVELOPER | TRIAL>] LICENSE +The REQUEST ​command prompts for and sends a license request for this server.
-     [FOR COMPANY "​company"​ +
-          CONTACT "​contact"​ +
-          PHONE "​phone"​ +
-          EMAIL "​email"​]+
  
-==== RESET HISTORY ​      ====+<​code>​ 
 +REQUEST [<​ENTERPRISE | DEVELOPER | TRIAL>] LICENSE  
 +</​code>​
  
-   Reset history of ODXSQL commands+==== RESET HISTORY ====
  
-   RESET HISTORY+The RESET HISTORY ​command clears the history of commands for this OdxSQL session.
  
-==== RESET TIMER         ====+<​code>​ 
 +RESET HISTORY 
 +</​code>​
  
-   Reset the cumulative timer+==== RESET TIMER ====
  
-   RESET TIMER+The RESET TIMER command resets the cumulative timer that was set using SET TIMER CUMULATIVE.
  
-==== RESTORE SETTINGS ​   ====+<​code>​ 
 +RESET TIMER 
 +</​code>​
  
-   ​Restore settings, optionally from a file+==== RESTORE SETTINGS ====
  
-   RESTORE SETTINGS ​[[FROM] filename] [WITH options]+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.
  
-==== SAVE HISTORY ​       ====+<​code>​ 
 +RESTORE SETTINGS [[FROM] filename] [WITH options] 
 +</​code>​
  
-   Save commands to file+==== SAVE HISTORY ====
  
-   SAVE HISTORY ​[[TO] filename] [WITH options]+The SAVE HISTORY ​command saves the history of commands from this OdxSQL session into a file.
  
-==== SAVE SETTINGS ​      ====+<​code>​ 
 +SAVE HISTORY [[TO] filename] [WITH options] 
 +</​code>​
  
-   Save settings, optionally to a file+==== SAVE SETTINGS ====
  
-   SAVE SETTINGS ​[[TO] filename] [WITH options]+The SAVE SETTINGS ​command saves the current OdxSQL settings to a file.
  
-==== SELECT ​             ====+<​code>​ 
 +SAVE SETTINGS [[TO] filename] [WITH options] 
 +</​code>​
  
- * Issue an SQL select statement+==== SELECT ====
  
- ​* ​SELECT statement ​[ON [CURSOR] cursor] [WITH options]+The SELECT command processes a SQL SELECT statement ​and displays the results.
  
-==== SET                 ====+<​code>​ 
 +SELECT statement [ON [CURSOR] cursor] [WITH options] 
 +</​code>​
  
-   Set an option+==== SET ====
  
-   SET [<​option ​| ?>] [ON <​INSTANCE | CURSOR> n]+The SET command sets an OdxSQL option. ​ See the [[programs:​odxsql:​options|Options section]] for a listing of OdxSQL options.
  
-==== SETENV ​             ====+<​code>​ 
 +SET [<option | ?>] [ON <​INSTANCE | CURSOR> n] 
 +</​code>​
  
- * Set an environment variable+==== SETENV ====
  
- ​* ​SETENV variable ​value+The SETENV ​command sets a system environment ​variable ​for the duration of this OdxSQL session.
  
-==== SHOW                ====+<​code>​ 
 +SETENV variable value 
 +</​code>​
  
-   ​Describe an object+==== SHOW ====
  
-   SHOW <​ENVIRONMENT [environment] | DATABASE database | TABLE table | +The SHOW command displays information about the current Omnidex ​environment ​or the Omnidex system.
-     ​COLUMN column> [ON [INSTANCE] instance] [WITH options] +
-   SHOW [<USER_ | DATA_ | METADATA_ | SYSTEM_ | ALL_>] +
-     <​DATABASES | TABLES | COLUMNS>​ +
-     [ON [INSTANCE] instance] [WITH options] +
-   SHOW ALL [database] [ON [INSTANCE] instance] [WITH options] +
-   SHOW <​INSTANCE | CURSOR> [object] [WITH options] +
-   SHOW LICENSE +
-   SHOW <​CONNECTIONS | STATEMENTS>​+
  
-==== TRANSFER ​LICENSE ​   ====+<​code>​ 
 +SHOW <​ENVIRONMENT [environment] | DATABASE database | TABLE table | 
 +  COLUMN column> [ON [INSTANCE] instance] [WITH options] 
 +SHOW [<USER_ | DATA_ | METADATA_ | SYSTEM_ | ALL_>] 
 +  <​DATABASES | TABLES | COLUMNS>​ 
 +  [ON [INSTANCE] instance] [WITH options] 
 +SHOW ALL [database] [ON [INSTANCE] instance] [WITH options] 
 +SHOW <​INSTANCE | CURSOR> [object] [WITH options] 
 +SHOW LICENSE 
 +SHOW <​CONNECTIONS | STATEMENTS>​ [WITH options] 
 +</​code>​
  
-   ​Transfer a license to another server+==== TRANSFER LICENSE ====
  
-   TRANSFER LICENSE+The TRANSFER LICENSE ​command initiates a transfer of this license to another server.
  
-==== UNREGISTER ODBC     ====+<​code>​ 
 +TRANSFER LICENSE 
 +</​code>​
  
-   ​Unregister an ODBC driver+==== UNREGISTER ​ODBC ====
  
-   UNREGISTER ODBC+The UNREGISTER ODBC command unregisters the current ODBC driver. ​ This is not needed unless directed by DISC Technical Support.
  
-==== UPDATE ​             ====+<​code>​ 
 +UNREGISTER ODBC 
 +</​code>​
  
- * Issue an SQL update statement+==== UPDATE ====
  
- ​* ​UPDATE table SET column-assignments +The UPDATE ​command updates a row in a table.
-     ​[WHERE <​predicate-list | CURRENT> [<ON | OF> [CURSOR] cursor]] +
-     [WITH options]+
  
-==== UPDATE ​INDEXES ​     ====+<​code>​ 
 +UPDATE ​table SET column-assignments 
 +  [WHERE <​predicate-list | CURRENT> [<ON | OF> [CURSOR] cursor]] 
 +  [WITH options] 
 +</​code>​
  
- * Update Omnidex indexes+==== UPDATE INDEXES ====
  
- ​* ​UPDATE INDEXES ​[FOR <​ENVIRONMENT [environment] | DATABASE database | +The UPDATE INDEXES ​command rebuilds the Omnidex indexes for the current Omnidex ​environment.
-     TABLE table | COLUMN table.column | INDEX table.index>​] +
-     [ON [INSTANCE] instance] [WITH options]+
  
-==== UPDATE ​ROLLUP ​      ====+<​code>​ 
 +UPDATE ​INDEXES [FOR <​ENVIRONMENT [environment] | DATABASE database | 
 +  TABLE table | COLUMN table.column | INDEX table.index>​] 
 +  [ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
- * Update rollup table+==== UPDATE ROLLUP ====
  
- ​* ​UPDATE ROLLUP ​TABLE table [ON [INSTANCE] instance] [WITH options]+The UPDATE ROLLUP ​command rebuilds an individual rollup ​table declared in the Omnidex environment file.
  
-==== UPDATE ​ROLLUPS ​     ====+<​code>​ 
 +UPDATE ​ROLLUP TABLE table [ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
- * Update rollup tables+==== UPDATE ROLLUPS ====
  
- ​* ​UPDATE ROLLUPS ​[FOR <​ENVIRONMENT [environment] | DATABASE database | +The UPDATE ROLLUPS ​command rebuilds all rollup tables declared in the Omnidex ​environment ​file.
-      TABLE table>] [ON [INSTANCE] instance] [WITH options]+
  
-==== UPDATE ​STATISTICS ​  ​====+<​code>​ 
 +UPDATE ​ROLLUPS [FOR <​ENVIRONMENT [environment] | DATABASE database | 
 +   ​TABLE table>] [ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
- * Update statistical information+==== UPDATE STATISTICS ====
  
- ​* ​UPDATE STATISTICS ​[FOR <​ENVIRONMENT [environment] | DATABASE database | +The UPDATE STATISTICS ​command refreshes the statistics for the current Omnidex ​environment ​file.  This step is automatically done within an UPDATE INDEXES command.
-     TABLE table | COLUMN table.column | INDEX table.index>​] +
-     [ON [INSTANCE] instance] [WITH options]+
  
-==== UPDATE ​TEXT         ====+<​code>​ 
 +UPDATE ​STATISTICS [FOR <​ENVIRONMENT [environment] | DATABASE database | 
 +  TABLE table | COLUMN table.column | INDEX table.index>​] 
 +  [ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
- * Update textual statistics+==== UPDATE TEXT ====
  
- ​* ​UPDATE TEXT [FOR <​ENVIRONMENT [environment] | DATABASE database | +The UPDATE TEXT command refreshes the PowerSearch dictionaries for the current Omnidex ​environment ​file.  This step is automatically done within an UPDATE INDEXES command.
-     TABLE table | COLUMN table.column | INDEX table.index>​] +
-     [ON [INSTANCE] instance] [WITH options]+
  
-==== USE                 ====+<​code>​ 
 +UPDATE TEXT [FOR <​ENVIRONMENT [environment] | DATABASE database | 
 +  TABLE table | COLUMN table.column | INDEX table.index>​] 
 +  [ON [INSTANCE] instance] [WITH options] 
 +</​code>​
  
-   ​Execute a file of ODXSQL commands+==== USE ====
  
-   USE filename ​[WHERE criteria] ​[WITH options] +The USE command executes the statements within the named file.  See the [[programs:odxsql:​files|Files section]] for more information.
-     ​criteria:  SQL syntax referencing SECTION, TEST and/or LINE+
  
-==== VALIDATE ​           ====+<​code>​ 
 +USE filename [WHERE criteria] [WITH options] 
 +</​code>​
  
-   ​Validate an environment+==== VALIDATE ====
  
-   VALIDATE ​[<​ENVIRONMENT [environment] | DATABASE database | TABLE table>​] +The VALIDATE ​command runs a series of tests to insure that an Omnidex ​environment ​is properly set up.
-     [ON [INSTANCE] instance] [WITH options]+
  
 +<​code>​
 +VALIDATE [<​ENVIRONMENT [environment] | DATABASE database | TABLE table>]
 +  [ON [INSTANCE] instance] [WITH options]
 +</​code>​
  
-==== !                   ==== 
  
-   ​Execute a shell command+==== ! ====
  
-   !<​shell ​command> or ! for interactive shell+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>​ 
 +!<shell command> or ! for interactive shell 
 +</​code>​
  
-   ​Execute last command+==== . ====
  
-   <. | command ​number>+The '.' ​command ​re-executes the last command.
  
-==== ;                   ====+<​code>​ 
 +<. | command number>​ 
 +</​code>​
  
-   ​Comment line+==== ; ====
  
-   ; [<​directive [directive ​...]>] text +The semicolon represents a command in OdxSQL.
-   <​SUSPEND>​ <​RESUME>​ <​VERBOSE>​ <​QUIET>​ +
-   <​COMMON>​ <​END_COMMON>​ <​SECTION>​ <​END_SECTION>​ <​TEST>​ <​END_TEST>​+
  
 +<​code>​
 +; Comment ...
 +</​code>​
    
-==== n                   ​====+==== n ====
  
-   ​Execute ​numbered command+The '​n'​ command executes the numbered command ​from the OdxSQL history, shown using the HISTORY command.
  
 +<​code>​
    n (where n is a number from the command history)    n (where n is a number from the command history)
 +</​code>​
  
  
-=====  =====+===== =====
  
-**[[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.1433959495.txt.gz · Last modified: 2016/06/28 22:38 (external edit)
Sitemap Recent Changes