Overview | Commands | Options | Command-line | Command Files

The following commands are available in OdxSQL:

The ATTACH DATABASE command attaches a database from one environment into the currently connected environment, thereby allowing SQL statements to access both databases.

ATTACH DATABASE database [AS alias] FROM filename [ON [INSTANCE] instance]
  [WITH options]

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 <INDEX | DATA> SEGMENT segment [PHYSICAL physical]
  [ON [INSTANCE] instance] [WITH options]

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 TABLE table [PHYSICAL "physical"] (column [, column ...])
  [ON [INSTANCE] instance>] [WITH options]
  column: column-name datatype (length)

The BENCHMARK command provides a menu of performance benchmarks that can be performed, focusing on POSIX file I/O.

BENCHMARK [<table | select-statement>] [WITH options]

The CALC command provides a very basic calculator, allowing formulas like “CALC (123+456)*789”.

CALC expression

The CD command changes the current working directory within the OdxSQL session. The current working directory outside of OdxSQL remains unchanged.

CD [path]

The CLOSE CURSOR command closes a cursor that was previously opened using the OPEN CURSOR command.

CLOSE CURSOR [[ON] CURSOR] cursor] [WITH options]

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.

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]

The CONVERT command allows a SELECT statement to be exported while interactively prompting for data conversions of each retrieved column.

CONVERT [statement TO filename [ON [CURSOR] cursor] [WITH options]

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 section of the documentation.

CREATE DATABASE database 
  ...
  IN "filename" [WITH options]

The CREATE ENVIRONMENT command creates a new Omnidex environment file.

CREATE ENVIRONMENT environment 
  [OPTIONS options]
  [NODE node_declaration]
  IN "filename"

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 Index Creation section of the documentation.

CREATE <OMNIDEX | QUICKTEXT | FULLTEXT | CUSTOM | NATIVE> INDEX
  [[(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]

The CREATE SEGMENT command creates a data segment or an index segment, thereby allowing it to be referenced in subsequent queries.

CREATE [<TEMPORARY | PERMANENT>] <INDEX | DATA> SEGMENT segment
  [PHYSICAL physical] [AS (select)] [ON [CURSOR] cursor]
  [WITH options]

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 section of the documentation.

CREATE [<[<GLOBAL | LOCAL>] TEMPORARY | PERMANENT>] TABLE table
  [PHYSICAL "physical"] (column [, column ...])
  [<IN "filename" | ON [INSTANCE] instance>] [WITH options]
  column: column-name datatype (length)

column: column-name datatype (length)

The DATE command shows the current date and time.

DATE

The DELETE command deletes one or more rows from a table.

DELETE FROM table [WHERE <predicate-list | CURRENT>
  [<ON | OF> [CURSOR] cursor]] [WITH options]

The DETACH DATABASE command detaches a database that was previously attached using the ATTACH DATABASE command.

DETACH DATABASE database [ON [INSTANCE] instance] [WITH options]

The DETACH SEGMENT command detaches a segment that was previously attached using the ATTACH SEGMENT command.

DETACH SEGMENT segment [ON [INSTANCE] instance] [WITH options]

The DETACH TABLE command detaches a table that was previously attached using the ATTACH TABLE command.

DETACH TABLE table [ON [INSTANCE] instance] [WITH options]

The DIR command lists the files named in the fileset, optionally showing details for each file.

DIR fileset [WITH options]

The DISCONNECT command disconnects from the Omnidex environment file.

DISCONNECT [ALL] [[ON [INSTANCE]] instance] [WITH options]

The DROP DATABASE command drops a database from an Omnidex environment file.

DROP DATABASE [IF EXISTS] database IN "filename" [WITH options]

The DROP ENVIRONMENT command drops and deletes an Omnidex environment file.

DROP ENVIRONMENT [IF EXISTS] [environment] IN "filename" [WITH options]

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]
  IN "filename" [WITH options]

DROP INDEX GROUP [IF EXISTS] [(owner)]group IN "filename" [WITH options]

The DROP SEGMENT command drops a segment that was previously created using the CREATE SEGMENT command.

DROP SEGMENT [IF EXISTS] segment [ON [INSTANCE] instance>] [WITH options]

The DROP TABLE command drops a table that was previously created using the CREATE TABLE command.

DROP [<TEMPORARY | PERMANENT>] TABLE [IF EXISTS] table 
  [<IN "filename" | ON [INSTANCE] instance>] [WITH options]

The EDIT command launches an editor with the previously submitted command. Upon exiting the editor, the command will be automatically executed.

EDIT [n | filename] [WITH options]

The ERROR command displays the error message associated with an Omnidex error code.

ERROR error_code

The EXIT command exits the OdxSQL program.

EXIT

The EXPLAIN command displays the query plan for the previously run query.

EXPLAIN [statement] [ON [CURSOR] cursor] [WITH options]

The EXPORT command exports the result of a SELECT statement into a raw data file or delimited file.

EXPORT [statement] TO filename [ON [CURSOR] cursor] [WITH options]

The EXTRACT command extracts various types of statements from the currently-connected Omnidex environment file or from the system logs.

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]

The FETCH command fetches individual rows following a SELECT statement. The FETCH command is only needed if the SET AUTOFETCH OFF command is issued.

FETCH [<n | ALL>] [ON [CURSOR] cursor] [WITH options]

The FOR contruct provides a simple method for repeating one or more statements multiple times.

FOR n [WITH options]
<statements>
END

The FORMAT command formats a file containing Omnidex SQL statements.

FORMAT input-file [INTO output-file] [WITH options]

The HELP command shows the commands available in OdxSQL.

HELP [<command | SYNTAX | API>]

The HISTORY command shows a history of the commands previously entered in this session of OdxSQL.

HISTORY

The IF contruct provides a simple method for IF/ELSE logic in OdxSQL.

IF condition
  <statements>
ELIF condition
  <statements>
ELSE
  <statements>
ENDIF

The INSERT command inserts data into a table.

INSERT INTO table [(column-list)] <VALUES (value-list) | select-stmt>
  [ON [INSTANCE] instance] [WITH options]

The JOIN command performs an index join between two tables, and must follow a QUALIFY statement.

JOIN [FROM] table USING index TO [(owner)]table USING index
  [ON [CURSOR] cursor] [WITH options]

The LOAD OFX command loads Offset Indexes (OFX's) for any delimited files in the Omnidex environment.

LOAD OFX [FOR <ENVIRONMENT [environment] | DATABASE database | TABLE table>]
  [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.

OPEN CURSOR [ON [INSTANCE] instance] [WITH options]

The PARTITION command partitions a table into multiple files in preparation for use in Omnidex Grids.

PARTITION table [INTO n] [BY <column | expression>] [IN path]
  [ON [INSTANCE] instance] [WITH options]

The PWD command displays the current working directory.

PWD

The QUALIFY command directly queries the Omnidex indexes, as a more granular alternative to issuing a SELECT statement.

QUALIFY [(owner)]table WHERE [[$QUALIFIED] <AND | OR> [NOT]]
  predicate [ON [CURSOR] cursor] [WITH options]

The QUIT command exits the OdxSQL program.

QUIT

The REGISTER LICENSE command registers a license code that has been received from the Omnidex licensing server.

REGISTER LICENSE license_code [FOR company]

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.

REGISTER ODBC [dir]

The REQUEST command prompts for and sends a license request for this server.

REQUEST [<ENTERPRISE | DEVELOPER | TRIAL>] LICENSE 

The RESET HISTORY command clears the history of commands for this OdxSQL session.

RESET HISTORY

The RESET TIMER command resets the cumulative timer that was set using SET TIMER CUMULATIVE.

RESET TIMER

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.

RESTORE SETTINGS [[FROM] filename] [WITH options]

The SAVE HISTORY command saves the history of commands from this OdxSQL session into a file.

SAVE HISTORY [[TO] filename] [WITH options]

The SAVE SETTINGS command saves the current OdxSQL settings to a file.

SAVE SETTINGS [[TO] filename] [WITH options]

The SELECT command processes a SQL SELECT statement and displays the results.

SELECT statement [ON [CURSOR] cursor] [WITH options]

The SET command sets an OdxSQL option. See the Options section for a listing of OdxSQL options.

SET [<option | ?>] [ON <INSTANCE | CURSOR> n]

The SETENV command sets a system environment variable for the duration of this OdxSQL session.

SETENV variable value

The SHOW command displays information about the current Omnidex environment or the Omnidex system.

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]

The TRANSFER LICENSE command initiates a transfer of this license to another server.

TRANSFER LICENSE

The UNREGISTER ODBC command unregisters the current ODBC driver. This is not needed unless directed by DISC Technical Support.

UNREGISTER ODBC

The UPDATE command updates a row in a table.

UPDATE table SET column-assignments
  [WHERE <predicate-list | CURRENT> [<ON | OF> [CURSOR] cursor]]
  [WITH options]

The UPDATE INDEXES command rebuilds the Omnidex indexes for the current Omnidex environment.

UPDATE INDEXES [FOR <ENVIRONMENT [environment] | DATABASE database |
  TABLE table | COLUMN table.column | INDEX table.index>]
  [ON [INSTANCE] instance] [WITH options]

The UPDATE ROLLUP command rebuilds an individual rollup table declared in the Omnidex environment file.

UPDATE ROLLUP TABLE table [ON [INSTANCE] instance] [WITH options]

The UPDATE ROLLUPS command rebuilds all rollup tables declared in the Omnidex environment file.

UPDATE ROLLUPS [FOR <ENVIRONMENT [environment] | DATABASE database |
   TABLE table>] [ON [INSTANCE] instance] [WITH options]

The UPDATE STATISTICS command refreshes the statistics for the current Omnidex environment file. This step is automatically done within an UPDATE INDEXES command.

UPDATE STATISTICS [FOR <ENVIRONMENT [environment] | DATABASE database |
  TABLE table | COLUMN table.column | INDEX table.index>]
  [ON [INSTANCE] instance] [WITH options]

The UPDATE TEXT command refreshes the PowerSearch dictionaries for the current Omnidex environment file. This step is automatically done within an UPDATE INDEXES command.

UPDATE TEXT [FOR <ENVIRONMENT [environment] | DATABASE database |
  TABLE table | COLUMN table.column | INDEX table.index>]
  [ON [INSTANCE] instance] [WITH options]

The USE command executes the statements within the named file. See the Files section for more information.

USE filename [WHERE criteria] [WITH options]

The VALIDATE command runs a series of tests to insure that an Omnidex environment is properly set up.

VALIDATE [<ENVIRONMENT [environment] | DATABASE database | TABLE table>]
  [ON [INSTANCE] instance] [WITH options]

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.

!<shell command> or ! for interactive shell

The '.' command re-executes the last command.

<. | command number>

The semicolon represents a command in OdxSQL.

; Comment ...

The 'n' command executes the numbered command from the OdxSQL history, shown using the HISTORY command.

   n (where n is a number from the command history)

Prev | Next

See also: