OdxSQL is a console based program used for testing installations, prototyping queries, and exporting data. OdxSQL supports many functions designed to assist in creating fully optimized installations and queries including benchmarking and for executing explain plans to determine query performance.

OdxSQL allows the interactive specification of Omnidex SQL statements as well as OdxSQL specific commands.

Run OdxSQL from the command line with the following syntax:

   odxsql [XML Catalog or Environment Catalog] | [-use=use_file]

Run time arguments:

XML Catalog or Environment Catalog The environment_name parameter is the environment catalog filespec that OdxSql will connect to. OdxSql will try to connect to the specified environment. If this filespec is not passed as a program argument, then a CONNECT statement must be performed to establish a connection to the environment catalog.

-use=use_file The -use=use_file parameter instructs OdxSql to process all the commands contained within the specified use file. The right hand side of the parameter, use_file, is the filespec of the file containing the commands.

Example

odxsql

or

odxsql orders.env

or

odxsql -use=commands.txt

Getting Help

Type help at the command prompt with no arguments to see an alphabetical list of ODXSQL commands.

help

…

Type help with the argument 'syntax' at the command prompt to see a list of commands with their syntax.

help syntax

…

Type help followed by a specific command to see additional information about that command.

help connect

CONNECT Connect to an environment file Syntax: Connect [TO] filename [AS [user]/[password]] [WITH options]

See HELP in the ODXSQL Commands section for more information.

© Copyright Dynamic Information Systems - This document was last updated July 15, 2009.