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
Next revision Both sides next revision
programs:odxsql:commands [2015/06/10 18:24]
doc 		programs:odxsql:commands [2015/06/10 20:49]
doc
Line 1: Line 1:
 {{page>:​top_add&​nofooter&​noeditbtn}} {{page>:​top_add&​nofooter&​noeditbtn}}
 +~~NOTOC~~
  
 ====== Programs: OdxSQL ====== ====== Programs: OdxSQL ======
Line 17: Line 17:
 ==== ATTACH DATABASE ==== ==== ATTACH DATABASE ====
  
-Attach ​a database+The ATTACH DATABASE command attaches ​a database ​from one environment into the currently connected environment,​ thereby allowing SQL statements to access both databases.
  
-<nowiki> +<code> 
-ATTACH DATABASE database [AS alias] FROM filename [ON [INSTANCE] instance] [WITH options] +ATTACH DATABASE database [AS alias] FROM filename [ON [INSTANCE] instance] 
-</nowiki>+  ​[WITH options] 
 +</code>
  
 ==== ATTACH SEGMENT ==== ==== ATTACH SEGMENT ====
  
-Attach ​a segment+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. ​
  
-<nowiki> +<code> 
-ATTACH <INDEX | DATA> SEGMENT segment [PHYSICAL physical] [ON [INSTANCE] instance] [WITH options] +ATTACH <INDEX | DATA> SEGMENT segment [PHYSICAL physical] 
-</nowiki>+  ​[ON [INSTANCE] instance] [WITH options] 
 +</code>
  
 ==== ATTACH TABLE ==== ==== ATTACH TABLE ====
  
-Attach ​a table+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.
  
-<nowiki> +<code> 
-ATTACH TABLE table [PHYSICAL "​physical"​] (column [, column ...]) [ON [INSTANCE] instance>​] [WITH options] +ATTACH TABLE table [PHYSICAL "​physical"​] (column [, column ...]) 
-column: column-name datatype (length) +  ​[ON [INSTANCE] instance>​] [WITH options] 
-</nowiki>+  column: column-name datatype (length) 
 +</code>
  
 ==== BENCHMARK ==== ==== BENCHMARK ====
  
-Perform ​performance benchmarks+The BENCHMARK command provides a menu of performance benchmarks ​that can be performed, focusing on POSIX file I/​O.  ​
  
-<nowiki>+<code>
 BENCHMARK [<table | select-statement>​] [WITH options] BENCHMARK [<table | select-statement>​] [WITH options]
-</nowiki>+</code>
  
 ==== CALC ==== ==== CALC ====
  
-Perform ​basic calculator ​functions+The CALC command provides a very basic calculator, allowing formulas like "CALC (123+456)*789"​.
  
-<nowiki>+<code>
 CALC expression CALC expression
-</nowiki>+</code>
  
 ==== CD ==== ==== CD ====
  
-Change directories+The CD command changes the current working directory within the OdxSQL session. ​ The current working directory outside of OdxSQL remains unchanged.
  
-<nowiki>+<code>
 CD [path] CD [path]
-</nowiki>+</code>
  
 ==== CLOSE CURSOR ==== ==== CLOSE CURSOR ====
  
-Close a cursor+The CLOSE CURSOR command closes ​a cursor ​that was previously opened using the OPEN CURSOR command.
  
-<nowiki>+<code>
 CLOSE CURSOR [[ON] CURSOR] cursor] [WITH options] CLOSE CURSOR [[ON] CURSOR] cursor] [WITH options]
-</nowiki>+</code>
  
 ==== CONNECT ==== ==== CONNECT ====
  
-Connect ​to an environment file+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.
  
-<nowiki>+<code>
 CONNECT [TO] connection_string [USING api] [WITH options] CONNECT [TO] connection_string [USING api] [WITH options]
-</nowiki>+  Connection string syntax: 
 +    [ host:​port:​pool ] filename [ node ] &​options 
 +  Examples: 
 +    CONNECT example.xml 
 +    CONNECT [server1:​7555]example.xml 
 +    CONNECT [server1:​7555:​pool1] 
 +</code>
  
-=== Connection string syntax === 
- 
-<​nowiki>​ 
-[ host:​port:​pool ] filename [ node ] &​options 
- 
-Examples: 
-CONNECT example.xml 
-CONNECT [server1:​7555]example.xml 
-CONNECT [server1:​7555:​pool1] 
- 
-</​nowiki>​ 
 ==== CONVERT ==== ==== CONVERT ====
  
-Export ​a file with data conversions+The CONVERT command allows ​a SELECT statement to be exported while interactively prompting for data conversions ​of each retrieved column.
  
-<nowiki>+<code>
 CONVERT [statement TO filename [ON [CURSOR] cursor] [WITH options] CONVERT [statement TO filename [ON [CURSOR] cursor] [WITH options]
-</nowiki>+</code>
  
 ==== CREATE DATABASE ==== ==== CREATE DATABASE ====
  
-Create ​a database+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.
  
-<nowiki> +<code> 
-CREATE DATABASE database ​node [node ...] IN "​filename"​ [WITH options] +CREATE DATABASE database ​ 
-</nowiki>+  ​... 
 +  ​IN "​filename"​ [WITH options] 
 +</code>
  
 ==== CREATE ENVIRONMENT ==== ==== CREATE ENVIRONMENT ====
  
-Create an environment file+The CREATE ENVIRONMENT command creates a new Omnidex ​environment file.
  
-<nowiki> +<code> 
-CREATE ENVIRONMENT environment [attribute ​[attribute ...]] +CREATE ENVIRONMENT environment ​ 
-</nowiki>+  ​[OPTIONS options] 
 +  ​[NODE node_declaration] 
 +  IN "​filename"​ 
 +</code>
  
 ==== CREATE INDEX ==== ==== CREATE INDEX ====
  
-Create ​an index or index group+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. 
 + 
 +<​code>​ 
 +CREATE <OMNIDEX | QUICKTEXT | FULLTEXT | CUSTOM | NATIVE> INDEX 
 +  [[(owner)]table.]index [ON table] 
 +  (<column | substring>​ [, <column | substring>​ ...])] 
 +  [attribute [attribute ...]] IN "​filename"​ [WITH options]
  
-<​nowiki>​ +CREATE INDEX GROUP [(owner)]group 
-CREATE ​<OMNIDEX | QUICKTEXT | FULLTEXT | CUSTOM | NATIVE> ​INDEX [[(owner)]table.]index [ON table] (<column | substring>​ [, <column | substring> ​...])] [attribute [attribute ...]] IN "​filename"​ [WITH options] +  (table.index [, table.index ​...])] IN "​filename"​ [WITH options] 
-</nowiki>+</code>
  
-<​nowiki>​ 
-CREATE INDEX GROUP [(owner)]group (table.index [, table.index ...])] IN "​filename"​ [WITH options] 
-</​nowiki>​ 
  
 ==== CREATE SEGMENT ==== ==== CREATE SEGMENT ====
  
-Create ​a segment+The CREATE SEGMENT command creates ​a data segment ​or an index segment, thereby allowing it to be referenced in subsequent queries.
  
-<nowiki> +<code> 
-CREATE [<​TEMPORARY | PERMANENT>​] <INDEX | DATA> SEGMENT segment [PHYSICAL physical] [AS (select)] [ON [CURSOR] cursor] [WITH options] +CREATE [<​TEMPORARY | PERMANENT>​] <INDEX | DATA> SEGMENT segment 
-</nowiki>+  ​[PHYSICAL physical] [AS (select)] [ON [CURSOR] cursor] 
 +  ​[WITH options] 
 +</code>
  
 ==== CREATE TABLE ==== ==== CREATE TABLE ====
  
-Create ​a 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.
  
-<nowiki> +<code> 
-CREATE [<​[<​GLOBAL | LOCAL>] TEMPORARY | PERMANENT>​] TABLE table [PHYSICAL "​physical"​] (column [, column ...]) [<IN "​filename"​ | ON [INSTANCE] instance>​] [WITH options] +CREATE [<​[<​GLOBAL | LOCAL>] TEMPORARY | PERMANENT>​] TABLE table 
-</nowiki>+  ​[PHYSICAL "​physical"​] (column [, column ...]) 
 +  ​[<IN "​filename"​ | ON [INSTANCE] instance>​] [WITH options] 
 +  column: column-name datatype (length) 
 +</code>
  
 column: column-name datatype (length) column: column-name datatype (length)
Line 147: Line 158:
 ==== DATE ==== ==== DATE ====
  
-Show the current date and time+The DATE command shows the current date and time.
  
-<nowiki>+<code>
 DATE DATE
-</nowiki>+</code>
  
 ==== DELETE ==== ==== DELETE ====
  
-Issue an SQL delete statement+The DELETE command deletes one or more rows from a table.
  
-<nowiki> +<code> 
-DELETE FROM table [WHERE < predicate-list | CURRENT> [<ON | OF> [CURSOR] cursor]] [WITH options] +DELETE FROM table [WHERE <​predicate-list | CURRENT> 
-</nowiki>+  ​[<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.
  
-<nowiki>+<code>
 DETACH DATABASE database [ON [INSTANCE] instance] [WITH options] DETACH DATABASE database [ON [INSTANCE] instance] [WITH options]
-</nowiki>+</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.
  
-<nowiki>+<code>
 DETACH SEGMENT segment [ON [INSTANCE] instance] [WITH options] DETACH SEGMENT segment [ON [INSTANCE] instance] [WITH options]
-</nowiki>+</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.
  
-<nowiki>+<code>
 DETACH TABLE table [ON [INSTANCE] instance] [WITH options] DETACH TABLE table [ON [INSTANCE] instance] [WITH options]
-</nowiki>+</code>
  
 ==== DIR ==== ==== DIR ====
  
-Display a directory of files+The DIR command lists the files named in the fileset, optionally showing details for each file.
  
-<nowiki>+<code>
 DIR fileset [WITH options] DIR fileset [WITH options]
-</nowiki>+</code>
  
 ==== DISCONNECT ==== ==== DISCONNECT ====
  
-Disconnect ​from an environment file+The DISCONNECT command disconnects ​from the Omnidex ​environment file.
  
-<nowiki>+<code>
 DISCONNECT [ALL] [[ON [INSTANCE]] instance] [WITH options] DISCONNECT [ALL] [[ON [INSTANCE]] instance] [WITH options]
-</nowiki>+</code>
  
 ==== DROP DATABASE ==== ==== DROP DATABASE ====
  
-Drop a database+The DROP DATABASE command drops a database ​from an Omnidex environment file.
  
-<nowiki>+<code>
 DROP DATABASE [IF EXISTS] database IN "​filename"​ [WITH options] DROP DATABASE [IF EXISTS] database IN "​filename"​ [WITH options]
-</nowiki>+</code>
  
 ==== DROP ENVIRONMENT ==== ==== DROP ENVIRONMENT ====
  
-Drop an environment+The DROP ENVIRONMENT command drops and deletes ​an Omnidex ​environment ​file.
  
-<nowiki>+<code>
 DROP ENVIRONMENT [IF EXISTS] [environment] IN "​filename"​ [WITH options] DROP ENVIRONMENT [IF EXISTS] [environment] IN "​filename"​ [WITH options]
-</nowiki>+</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.
  
-<nowiki> +<code> 
-DROP [<​OMNIDEX | NATIVE>] INDEX [IF EXISTS] [[(owner)]table.]index [ON table] IN "​filename"​ [WITH options] +DROP [<​OMNIDEX | NATIVE>] INDEX [IF EXISTS] [[(owner)]table.]index [ON table] 
-</nowiki>+  ​IN "​filename"​ [WITH options] 
 +</code>
  
-<nowiki>+<code>
 DROP INDEX GROUP [IF EXISTS] [(owner)]group IN "​filename"​ [WITH options] DROP INDEX GROUP [IF EXISTS] [(owner)]group IN "​filename"​ [WITH options]
-</nowiki>+</code>
  
 ==== DROP SEGMENT ==== ==== DROP SEGMENT ====
  
-Drop a segment+The DROP SEGMENT command drops a segment ​that was previously created using the CREATE SEGMENT command.
  
-<nowiki>+<code>
 DROP SEGMENT [IF EXISTS] segment [ON [INSTANCE] instance>​] [WITH options] DROP SEGMENT [IF EXISTS] segment [ON [INSTANCE] instance>​] [WITH options]
-</nowiki>+</code>
  
 ==== DROP TABLE ==== ==== DROP TABLE ====
  
-Drop a table+The DROP TABLE command drops a table that was previously created using the CREATE TABLE command.
  
-<nowiki> +<code> 
-DROP [<​TEMPORARY | PERMANENT>​] TABLE [IF EXISTS] table [<IN "​filename"​ | ON [INSTANCE] instance>​] [WITH options] +DROP [<​TEMPORARY | PERMANENT>​] TABLE [IF EXISTS] table  
-</nowiki>+  ​[<IN "​filename"​ | ON [INSTANCE] instance>​] [WITH options] 
 +</code>
  
 ==== 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.
  
-<nowiki>+<code>
 EDIT [n | filename] [WITH options] EDIT [n | filename] [WITH options]
-</nowiki>+</code>
  
 ==== ERROR ==== ==== ERROR ====
  
-Display an error message+The ERROR command displays the error message ​associated with an Omnidex error code.
  
-<nowiki>+<code>
 ERROR error_code ERROR error_code
-</nowiki>+</code>
  
 ==== EXIT ==== ==== EXIT ====
  
-Exit Omnidex SQL+The EXIT command exits the OdxSQL program.
  
-<nowiki>+<code>
 EXIT EXIT
-</nowiki>+</code>
  
 ==== EXPLAIN ==== ==== EXPLAIN ====
  
-Explain approach to retrieval+The EXPLAIN command displays the query plan for the previously run query.  ​
  
-<nowiki>+<code>
 EXPLAIN [statement] [ON [CURSOR] cursor] [WITH options] EXPLAIN [statement] [ON [CURSOR] cursor] [WITH options]
-</nowiki>+</code>
  
 ==== 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.
  
-<nowiki>+<code>
 EXPORT [statement] TO filename [ON [CURSOR] cursor] [WITH options] EXPORT [statement] TO filename [ON [CURSOR] cursor] [WITH options]
-</nowiki>+</code>
  
 ==== 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.  ​
  
-<nowiki> +<code> 
-EXTRACT DDL [FOR <​ENVIRONMENT [environment] | DATABASE database>​] [TO filename] [ON [INSTANCE] instance] [WITH options] +EXTRACT DDL [FOR <​ENVIRONMENT [environment] | DATABASE database>​] 
-</​nowiki>​ +  ​[TO filename] [ON [INSTANCE] instance] [WITH options] 
- +EXTRACT DDL FOR <MYSQL | ORACLE | ODBC | SQLSERVER>​ 
-<​nowiki>​ +  ​[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] 
-</​nowiki>​ +  ​[TO filename] [ON [INSTANCE] instance] [WITH options] 
- +EXTRACT [<ALL | n | LONGEST n | ERRORING>​] QUERIES 
-<​nowiki>​ +  ​[BY <​CONNECTION | STATEMENT>​] [WHERE criteria] 
-EXTRACT DML FOR table-list [WHERE criteria] [TO filename] [ON [INSTANCE] instance] [WITH options] +  ​[TO filename] [ON [INSTANCE] instance] [WITH options] 
-</​nowiki>​ +</code>
- +
-<​nowiki>​ +
-EXTRACT [<ALL | n | LONGEST n | ERRORING>​] QUERIES [BY <​CONNECTION | STATEMENT>​] [WHERE criteria] [TO filename] [ON [INSTANCE] instance] [WITH options] +
-</nowiki>+
  
 ==== 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.
  
-<nowiki>+<code>
 FETCH [<n | ALL>] [ON [CURSOR] cursor] [WITH options] FETCH [<n | ALL>] [ON [CURSOR] cursor] [WITH options]
-</nowiki>+</code>
  
 ==== FOR ==== ==== FOR ====
  
-Form a 'FOR n ... END' construct+The FOR contruct provides ​a simple method for repeating one or more statements multiple times.
  
-<nowiki>+<code>
 FOR n [WITH options] FOR n [WITH options]
 <​statements>​ <​statements>​
 END END
-</nowiki>+</code>
  
 ==== FORMAT ==== ==== FORMAT ====
  
-Format ​a file of ODXSQL ​statements+The FORMAT command formats ​a file containing Omnidex SQL statements.
  
-<nowiki>+<code>
 FORMAT input-file [INTO output-file] [WITH options] FORMAT input-file [INTO output-file] [WITH options]
-</nowiki>+</code>
  
 ==== HELP ==== ==== HELP ====
  
-Help+The HELP command shows the commands available in OdxSQL.
  
-<nowiki>+<code>
 HELP [<​command | SYNTAX | API>] HELP [<​command | SYNTAX | API>]
-</nowiki>+</code>
  
 ==== HISTORY ==== ==== HISTORY ====
  
-Show history of ODXSQL ​commands+The HISTORY command shows a history of the commands ​previously entered in this session of OdxSQL.
  
-<nowiki>+<code>
 HISTORY HISTORY
-</nowiki>+</code>
  
 ==== IF ==== ==== IF ====
  
-Form an 'IF ELIF ELSE ENDIF' construct+The IF contruct provides a simple method for IF/ELSE logic in OdxSQL.
  
-<nowiki>+<code>
 IF condition IF condition
-<​statements>​+  ​<​statements>​
 ELIF condition ELIF condition
-<​statements>​+  ​<​statements>​
 ELSE ELSE
-<​statements>​+  ​<​statements>​
 ENDIF ENDIF
-</nowiki>+</code>
  
 ==== INSERT ==== ==== INSERT ====
  
-Issue an SQL insert statement+The INSERT command inserts data into a table.
  
-<nowiki> +<code> 
-INSERT INTO table [(column-list)] <VALUES (value-list) | select-stmt>​ [ON [INSTANCE] instance] [WITH options] +INSERT INTO table [(column-list)] <VALUES (value-list) | select-stmt>​ 
-</nowiki>+  ​[ON [INSTANCE] instance] [WITH options] 
 +</code>
  
 ==== JOIN ==== ==== JOIN ====
  
-Join tables ​using Omnidex+The JOIN command performs an index join between two tables, and must follow a QUALIFY statement.
  
-<nowiki> +<code> 
-JOIN [FROM] table USING index TO [(owner)]table USING index [ON [CURSOR] cursor] [WITH options] +JOIN [FROM] table USING index TO [(owner)]table USING index 
-</nowiki>+  ​[ON [CURSOR] cursor] [WITH options] 
 +</code>
  
 ==== 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.
  
-<nowiki> +<code> 
-LOAD OFX [FOR <​ENVIRONMENT [environment] | DATABASE database | TABLE table>] [ON [INSTANCE] instance] [WITH options] +LOAD OFX [FOR <​ENVIRONMENT [environment] | DATABASE database | TABLE table>] 
-</nowiki>+  ​[ON [INSTANCE] instance] [WITH options] 
 +</code>
  
 ==== 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.
  
-<nowiki>+<code>
 OPEN CURSOR [ON [INSTANCE] instance] [WITH options] OPEN CURSOR [ON [INSTANCE] instance] [WITH options]
-</nowiki>+</code>
  
 ==== PARTITION ==== ==== PARTITION ====
  
-Partition ​a table+The PARTITION command partitions ​a table into multiple files in preparation for use in Omnidex Grids.
  
-<nowiki> +<code> 
-PARTITION table [INTO n] [BY <column | expression>​] [IN path] [ON [INSTANCE] instance] [WITH options] +PARTITION table [INTO n] [BY <column | expression>​] [IN path] 
-</nowiki>+  ​[ON [INSTANCE] instance] [WITH options] 
 +</code>
  
 ==== PWD ==== ==== PWD ====
  
-Print current working directory+The PWD command displays the current working directory.
  
-<nowiki>+<code>
 PWD PWD
-</nowiki>+</code>
  
 ==== QUALIFY ==== ==== QUALIFY ====
  
-Qualify rows using Omnidex+The QUALIFY command directly queries the Omnidex ​indexes, as a more granular alternative to issuing a SELECT statement.  ​
  
-<nowiki> +<code> 
-QUALIFY [(owner)]table WHERE [[$QUALIFIED] <AND | OR> [NOT]] predicate [ON [CURSOR] cursor] [WITH options] +QUALIFY [(owner)]table WHERE [[$QUALIFIED] <AND | OR> [NOT]] 
-</nowiki>+  ​predicate [ON [CURSOR] cursor] [WITH options] 
 +</code>
  
 ==== QUIT ==== ==== QUIT ====
  
-Quit Omnidex SQL+The QUIT command exits the OdxSQL program.
  
-<nowiki>+<code>
 QUIT QUIT
-</nowiki>+</code>
  
 ==== 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.
  
-<nowiki>+<code>
 REGISTER LICENSE license_code [FOR company] REGISTER LICENSE license_code [FOR company]
-</nowiki>+</code>
  
 ==== 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.
  
-<nowiki>+<code>
 REGISTER ODBC [dir] REGISTER ODBC [dir]
-</nowiki>+</code>
  
 ==== REQUEST ==== ==== REQUEST ====
  
-Request ​a license ​code+The REQUEST command prompts for and sends a license ​request for this server.
  
-<nowiki> +<code> 
-REQUEST [<​ENTERPRISE | DEVELOPER | TRIAL>] LICENSE ​[FOR COMPANY "​company"​ CONTACT "​contact"​ PHONE "​phone"​ EMAIL "​email"​] +REQUEST [<​ENTERPRISE | DEVELOPER | TRIAL>] LICENSE  
-</nowiki>+</code>
  
 ==== RESET HISTORY ==== ==== RESET HISTORY ====
  
-Reset history of ODXSQL ​commands+The RESET HISTORY command clears the history of commands ​for this OdxSQL session.
  
-<nowiki>+<code>
 RESET HISTORY RESET HISTORY
-</nowiki>+</code>
  
 ==== RESET TIMER ==== ==== RESET TIMER ====
  
-Reset the cumulative timer+The RESET TIMER command resets ​the cumulative timer that was set using SET TIMER CUMULATIVE.
  
-<nowiki>+<code>
 RESET TIMER RESET TIMER
-</nowiki>+</code>
  
 ==== 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.
  
-<nowiki>+<code>
 RESTORE SETTINGS [[FROM] filename] [WITH options] RESTORE SETTINGS [[FROM] filename] [WITH options]
-</nowiki>+</code>
  
 ==== SAVE HISTORY ==== ==== SAVE HISTORY ====
  
-Save commands ​to file+The SAVE HISTORY command saves the history of commands ​from this OdxSQL session into a file.
  
-<nowiki>+<code>
 SAVE HISTORY [[TO] filename] [WITH options] SAVE HISTORY [[TO] filename] [WITH options]
-</nowiki>+</code>
  
 ==== SAVE SETTINGS ==== ==== SAVE SETTINGS ====
  
-Save settings, optionally ​to a file+The SAVE SETTINGS command saves the current OdxSQL ​settings to a file.
  
-<nowiki>+<code>
 SAVE SETTINGS [[TO] filename] [WITH options] SAVE SETTINGS [[TO] filename] [WITH options]
-</nowiki>+</code>
  
 ==== SELECT ==== ==== SELECT ====
  
-Issue an SQL select ​statement+The SELECT command processes a SQL SELECT ​statement ​and displays the results.
  
-<nowiki>+<code>
 SELECT statement [ON [CURSOR] cursor] [WITH options] SELECT statement [ON [CURSOR] cursor] [WITH options]
-</nowiki>+</code>
  
 ==== 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.
  
-<nowiki>+<code>
 SET [<option | ?>] [ON <​INSTANCE | CURSOR> n] SET [<option | ?>] [ON <​INSTANCE | CURSOR> n]
-</nowiki>+</code>
  
 ==== SETENV ==== ==== SETENV ====
  
-Set an environment variable+The SETENV command sets a system ​environment variable ​for the duration of this OdxSQL session.
  
-<nowiki>+<code>
 SETENV variable value SETENV variable value
-</nowiki>+</code>
  
 ==== SHOW ==== ==== SHOW ====
  
-Describe an object+The SHOW command displays information about the current Omnidex environment or the Omnidex system.
  
-<nowiki> +<code> 
-SHOW <​ENVIRONMENT [environment] | DATABASE database | TABLE table | COLUMN column> [ON [INSTANCE] instance] [WITH options] +SHOW <​ENVIRONMENT [environment] | DATABASE database | TABLE table | 
-</​nowiki>​ +  ​COLUMN column> [ON [INSTANCE] instance] [WITH options] 
- +SHOW [<USER_ | DATA_ | METADATA_ | SYSTEM_ | ALL_>] 
-<​nowiki>​ +  ​<​DATABASES | TABLES | COLUMNS> 
-SHOW [<USER_ | DATA_ | METADATA_ | SYSTEM_ | ALL_>] <​DATABASES | TABLES | COLUMNS> [ON [INSTANCE] instance] [WITH options] +  ​[ON [INSTANCE] instance] [WITH options] 
-</​nowiki>​ +SHOW ALL [database] [ON [INSTANCE] instance] [WITH options]
- +
-<​nowiki>​ +
-SHOW ALL [database] [ON [INSTANCE] instance] [WITH options] ​ +
-</​nowiki>​ +
- +
-<​nowiki>​+
 SHOW <​INSTANCE | CURSOR> [object] [WITH options] SHOW <​INSTANCE | CURSOR> [object] [WITH options]
-</​nowiki>​ 
- 
-<​nowiki>​ 
 SHOW LICENSE SHOW LICENSE
-</​nowiki>​ +SHOW <​CONNECTIONS | STATEMENTS> ​[WITH options] 
- +</code>
-<​nowiki>​ +
-SHOW <​CONNECTIONS | STATEMENTS>​ +
-</nowiki>+
  
 ==== TRANSFER LICENSE ==== ==== TRANSFER LICENSE ====
  
-Transfer ​a license to another server+The TRANSFER LICENSE command initiates ​a transfer of this license to another server.
  
-<nowiki>+<code>
 TRANSFER LICENSE TRANSFER LICENSE
-</nowiki>+</code>
  
 ==== 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.
  
-<nowiki>+<code>
 UNREGISTER ODBC UNREGISTER ODBC
-</nowiki>+</code>
  
 ==== UPDATE ==== ==== UPDATE ====
  
-Issue an SQL update statement+The UPDATE command updates a row in a table.
  
-<nowiki> +<code> 
-UPDATE table SET column-assignments [WHERE <​predicate-list | CURRENT> [<ON | OF> [CURSOR] cursor]] [WITH options] +UPDATE table SET column-assignments 
-</nowiki>+  ​[WHERE <​predicate-list | CURRENT> [<ON | OF> [CURSOR] cursor]] 
 +  ​[WITH options] 
 +</code>
  
 ==== UPDATE INDEXES ==== ==== UPDATE INDEXES ====
  
-Update ​Omnidex indexes+The UPDATE INDEXES command rebuilds the Omnidex indexes ​for the current Omnidex environment.
  
-<nowiki> +<code> 
-UPDATE INDEXES [FOR <​ENVIRONMENT [environment] | DATABASE database | TABLE table | COLUMN table.column | INDEX table.index>​] [ON [INSTANCE] instance] [WITH options] +UPDATE INDEXES [FOR <​ENVIRONMENT [environment] | DATABASE database | 
-</nowiki>+  ​TABLE table | COLUMN table.column | INDEX table.index>​] 
 +  ​[ON [INSTANCE] instance] [WITH options] 
 +</code>
  
 ==== UPDATE ROLLUP ==== ==== UPDATE ROLLUP ====
  
-Update ​rollup table+The UPDATE ROLLUP command rebuilds an individual ​rollup table declared in the Omnidex environment file.
  
-<nowiki>+<code>
 UPDATE ROLLUP TABLE table [ON [INSTANCE] instance] [WITH options] UPDATE ROLLUP TABLE table [ON [INSTANCE] instance] [WITH options]
-</nowiki>+</code>
  
 ==== UPDATE ROLLUPS ==== ==== UPDATE ROLLUPS ====
  
-Update ​rollup tables+The UPDATE ROLLUPS command rebuilds all rollup tables ​declared in the Omnidex environment file.
  
-<nowiki> +<code> 
-UPDATE ROLLUPS [FOR <​ENVIRONMENT [environment] | DATABASE database | TABLE table>] [ON [INSTANCE] instance] [WITH options] +UPDATE ROLLUPS [FOR <​ENVIRONMENT [environment] | DATABASE database | 
-</nowiki>+   TABLE table>] [ON [INSTANCE] instance] [WITH options] 
 +</code>
  
 ==== 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.
  
-<nowiki> +<code> 
-UPDATE STATISTICS [FOR <​ENVIRONMENT [environment] | DATABASE database | TABLE table | COLUMN table.column | INDEX table.index>​] [ON [INSTANCE] instance] [WITH options] +UPDATE STATISTICS [FOR <​ENVIRONMENT [environment] | DATABASE database | 
-</nowiki>+  ​TABLE table | COLUMN table.column | INDEX table.index>​] 
 +  ​[ON [INSTANCE] instance] [WITH options] 
 +</code>
  
 ==== 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.
  
-<nowiki> +<code> 
-UPDATE TEXT [FOR <​ENVIRONMENT [environment] | DATABASE database | TABLE table | COLUMN table.column | INDEX table.index>​] [ON [INSTANCE] instance] [WITH options] +UPDATE TEXT [FOR <​ENVIRONMENT [environment] | DATABASE database | 
-</nowiki>+  ​TABLE table | COLUMN table.column | INDEX table.index>​] 
 +  ​[ON [INSTANCE] instance] [WITH options] 
 +</code>
  
 ==== 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.
  
-<nowiki>+<code>
 USE filename [WHERE criteria] [WITH options] USE filename [WHERE criteria] [WITH options]
-</nowiki>+</code>
  
 ==== VALIDATE ==== ==== VALIDATE ====
  
-Validate ​an environment+The VALIDATE command runs a series of tests to insure that an Omnidex ​environment ​is properly set up.
  
-<nowiki> +<code> 
-VALIDATE [<​ENVIRONMENT [environment] | DATABASE database | TABLE table>] [ON [INSTANCE] instance] [WITH options] +VALIDATE [<​ENVIRONMENT [environment] | DATABASE database | TABLE table>] 
-</nowiki>+  ​[ON [INSTANCE] instance] [WITH options] 
 +</code>
  
  
 ==== ! ==== ==== ! ====
  
-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.
  
-<nowiki>+<code>
 !<shell command> or ! for interactive shell !<shell command> or ! for interactive shell
-</nowiki>+</code>
  
 ==== . ==== ==== . ====
  
-Execute ​last command+The '​.'​ command re-executes the last command.
  
-<nowiki>+<code>
 <. | command number> <. | command number>
-</nowiki>+</code>
  
 ==== ; ==== ==== ; ====
  
-Comment line+The semicolon represents a command in OdxSQL.
  
 +<​code>​
 +; Comment ...
 +</​code>​
    
 ==== n ==== ==== n ====
  
-   ​Execute ​numbered command+The '​n'​ command executes the numbered command ​from the OdxSQL history, shown using the HISTORY command.
  
-<nowiki>+<code>
    n (where n is a number from the command history)    n (where n is a number from the command history)
-   </nowiki>+</code>
  
  
 
Back to top
programs/odxsql/commands.txt · Last modified: 2016/06/28 22:38 (external edit)
Sitemap Recent Changes