This is an old revision of the document!


DRAFT

OdxSQL Quick Reference

Command Line Options Description
odxsql Run OdxSQL. Use the CONNECT command to connect to an Omnidex Environment
odxsql env_filespec Run OdxSQL and connect to the env_filespec.
odxsql dsn_filespec -odbc Run OdxSQL and connect to the ODBC File DSN using the Omnidex ODBC driver.
odxsql env_filespec -odxnet -jdbc Run OdxSQL and start an OdxNet background process and connect to the env_filespec using the Omnidex JDBC driver.
odxsql -? Displays OdxSQL command line options
odxsql -use scriptfile Run OdxSQL and read and process the scriptfile of OdxSQL Statements and Commands.
Set Command Description
SET Shows the current settings.
SET ? Shows the list of available SET options.
SET TERMINATION OFFWill Automatically terminate SQL Statements.
Help/Show Description
HELPShows a list of OdxSQL commands and SQL Statements.
HELP <COMMAND>Provides specific help on the specified command or SQL Statement.
SHOW <table>Provides information on the specified table.
SHOW ALLProvides information on all tables.
Editing
EDIT
SET EDITChange the default editor.
EDIT filespecTypically used to edit a script file and then use the USE file to run the script.
EDIT nEdits the command in the Command History Stack
Other Commands
HISTORYShows a numbered list of previously entered commands.
numberExecute the numbered command from the Command History Stack.
Period(.)Execute the last command.

OdxSQL Uses

OdxSQL is a console application for manually entering Omnidex SQL Statements and OdxSQL Commands or for processing scripts of Omnidex SQL statements.

Use OdxSQL for processing Omnidex SQL Data Definition Scripts to create Omnidex Environments and Indexes.

Use OdxSQL to test Omnidex SQL SELECTs and ODBC, JDBC and Network Services set up.

Use OdxSQL to prototype Omnidex Queries and use the Explain Command to review optimization.

Use OdxSQL on a client computer to access an Omnidex Environment on a remote server via OdxNet to test network response times.

Common ways to run OdxSQL

os> odxsql
os> odxsql envfile
os> odxsql dsnfile -odxnet -odbc
os> odxsql -?
os> odxsql -use scriptfile

Running OdxSQL Explained:

odxsql Run OdxSQL. Use the CONNECT command to connect to an Omnidex Environment
odxsql envfile Run OdxSQL and connect to the 'envfile'
odxsql dsnfile -odxnet -odbc Run OdxSQL and an OdxNET background process and connect to the DSN using ODBC
odxsql -? Displays OdxSQL command line options
odxsql -use scriptfile Run OdxSQL and read and process the scriptfile of OdxSQL Statements and Commands.

OdxSQL Important Information

  • OdxSQL connects to an Omnidex Environment or ODBC or JDBC Omnidex File Datasource (DSN).
    • connect myenv.xml
    • connect mydsn.dsn using odbc (needs OdxNet running)
    • connect mydsn.dsn using jdbc (needs OdxNet running)
  • OdxSQL requires a semicolon terminator for SQL Statements and will prompt for additional statement information until a semicolon is found.
  • Use SET TERMINATION OFF and OdxSQL will not required the semicolon termination character and will end the statement automatically.
  • With SET TERMINATION OFF, use the backslash [ \ ] statement continuation character for multi line statements.
  • Use HELP <cr> to display a list of commands and SQL Statements.
  • Use HELP <command> to display the syntax for the command.
  • Use SHOW <table> to show information on a table with the tables's column layout.
    • Use SHOW ALL to see all tables, including internal system tables.
  • Create scripts with an editor and process with the USE <scriptfile> command or the OdxSQL -use scriptfile
  • Use EDIT to edit the last statement using Windows Notepad or Linux/Unix vi or emacs.
  • Use SET EDIT to change the editor of choice.
  • Use EDIT file to edit a script file without leaving OdxSQL and then USE file to run.
  • Use EDIT n to edit a command in the Command History Stack.
  • Edit previous commands by using the UP ARROW and scrolling through the commands.
    • Use the Right and Left Arrow, Insert, Delete, Home, and End keys to edit.
  • Use HISTORY to display a numbered list of previous commands.
    • Use the history number to re-execute the numbered command.
    • Use a period ( . ) to execute the last command.

See Also

OdxSQL Internal SET Commands

Internal
x [AUTOPSEUDOCOLUMNS <ON | OFF>]
x [AUTORECONNECT <ON | OFF>]
x [AUTOSUBPROCESS <n | NONE>
x [STATISTICS_COMMENT "string"]
x [PREPROCESSOR <ON | OFF>]
x [PROGRESS <ON | OFF>]
x [MEMORY_BASELINE]
x [FILE_BASELINE]

Level 2 Headline

        SET DEBUG …
	SET OPTIMIZATION …
	SET REQUIRED_OPTIMIZATION
	SET CHAR …
	SET TIMEOUT …
	SET REDEFROWIDS …	
	SET PSEUDOCOLUMNS …
	SET QUALIFY_MODE <ODXFIND | PARSER >
	SET AUTOPSEUDOCOLUMNS …
	SET PREPROCESSOR …
	SET SQL_LOGGING …
	SET SQL_LOGFILE …

The syntaxes of the SQL Logging SET commands are shown below:

  set sql_logging <on | off> 

This command activates SQL Logging for this process. By default, statements are logged to the $SQL_STATEMENTS file along with statistics about the execution of the command. The $SQL_STATEMENTS file is named “sqllog.tdf”, and is located in the same directory as the compiled environment file. This file is a standard tab-delimited file, and may be easily imported into other applications. The file may be flushed by simply removing the file; the file will be automatically recreated the next time logging is activated.

  set sql_logfile <filename>

This command redirects the SQL logging for this process to a text file that only contains the statement, and does not contain any statistical information. If the file already exists, it will be appended to rather than overwritten.

 
Back to top
programs/odxsql/home.1278199579.txt.gz · Last modified: 2016/06/28 22:38 (external edit)