OdxSQL can accept the Omnidex Environment as well as several other options.
If the Omnidex Environment is specified, OdxSQL will automatically attempt to connect to the specified Environment.
odxsql [Omnidex_Environment_Filespec]
[options]
If specified, OdxSQL will automatically attempt to connect to the Omnidex Environment Filespec. If the Omnidex Environment Filespec is not passed as a program argument, then a CONNECT statement must be performed to establish a connection to the Omnidex Environment. -
Command line options can be specified in either upper or lower case.
The following is a lits of available command line options for OdxSQL.
| Option | Option Description |
|---|---|
| Omnidex_Environment_Filespec | Omnidex Environment Filespec used by OdxSQL to automatically connect. |
| -help | -? | Display the list cf command line options |
| -version | Display the OdxSQL Program version. |
| -use=filespec | Execute statements in the named filespec. |
| -cmd='cmd1;cmd2' | Execute specified OdxSQl commands. |
| -where='criteria' | Apply criteria to use statement. |
| -exit | Exit after completion of processing the commands in the Use File. |
| -exit_on_error | Exit if an error occurs. |
| -nobanner | Suppress the display the OdxSQL banner. |
| -cloa | Run OdxSQL using the CLOA client interface. |
| -odbc | Run OdxSQL using the ODBC client interface. |
| -jdbc | Run OdxSQL using the JDBC client interface. |
| -odxnet[=port] | Launch an OdxNet listener for this OdxSQL session. |
Displays a short description of OdxSQL along with a list of the command line options.
The following is a display of the -? option that displays a list of available options.
C:\Program Files\Omnidex 5.0\demo\orders>odxsql -?
ODXSQL - Omnidex SQL Sun Nov 29 20:05:38 2009
(c) Dynamic Information Systems Corp. 1981-2009 5.0 Build 1H
Microsoft Windows XP Professional SP 3 (2600) TDO830/TDO
** Trial Copy **
Syntax: odxsql [environment] [options]
Description: Console program supporting interactive Omnidex SQL statements
Options: -help | -? Help
-version Program version
-use=filename Execute statements in named file
-cmd='cmd1;cmd2' Execute specified statements
-where='criteria' Apply criteria to use statement
-exit Exit after completion of use file
-exit_on_error Exit if an error occurs
-nobanner Do not print banner
-cloa Run odxsql using the CLOA client interface
-odbc Run odxsql using the ODBC client interface
-jdbc Run odxsql using the JDBC client interface
-odxnet[=port] Launch an OdxNet listener for this session
C:\Program Files\Omnidex 5.0\demo\orders>
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.
The -version option will display the OdxSQL version. Because OdxSQL displays the Omnidex version in the OdxSQL banner and the OdxSQL command displays Omnidex detailed information, use the -version option to verify the particular version of OdxSQL.
Exit after completion of processing the commands in the Use File. This option is typically used in creating operating system batch processing scripts so that OdxSQL automatically terminates.
Exit if an error occurs.
OdxSQL will normally continue processing OdxSQL commands from a Use file even when a command or syntax error occurs. Seeting the -exit_on_error option will cause OdxSQL to terminate when an error is encountered.
Suppress the display the OdxSQL banner.
Run OdxSQL using the CLOA client interface.
This option allows the testing of the OmniAccess CLOA API. Although DISC recommends that new applications are developed using the Omnidex ODBC or JDBC drivers, the CLOA API is supported for backward compatibility. When using the CLOA option, the OdxSQL Connect command connects to an Omnidex Client DataSource created with the DSEDIT Windows Client program.
The ODBC option directs OdxSQL to use ODBC calls to connect and interact with SQL statements.
This option allows OdxSQL to test ODBC Connections.
When using this option, the OdxSQL Connect command is used to connect to an ODBC Datasource.
The JDBC option directs OdxSQL to use JDBC calls to connect and interact with SQL statements.
This option allows OdxSQL to test JDBC Connections.
When using this option, the OdxSQL Connect command is used to connect to a JDBC Datasource.
os> odxsql
Use the OdxSQL CONNECT command to connect to an Omnidex Evironment from within OdxSQL.
os> odxsql myenv.xml
os> odxsql -use = mycmds.txt