This shows you the differences between two versions of the page.
Both sides previous revision Previous revision Next revision | Previous revision | ||
programs:odxsql:overview [2009/12/08 02:57] tdo |
programs:odxsql:overview [2016/06/28 22:38] (current) |
||
---|---|---|---|
Line 175: | Line 175: | ||
set ODXSQLINIT="init_file.txt" | set ODXSQLINIT="init_file.txt" | ||
+ | |||
+ | |||
+ | |||
+ | |||
+ | ===== 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 ===== | ||
+ | |||
+ | * [[programs:odxsql:overview | OdxSQL Overview ]] | ||
+ | * [[programs:odxsql:commands:home |OdxSQL Commands ]] | ||
+ | * [[programs:odxsql:settings:home |OdxSQL Settings ]] | ||
+ | * [[programs:odxsql:commandline |OdxSQL Command Line Options ]] | ||
+ | * OdxSQL Script Examples | ||
+ | * [[ dev:sql:statements:select:home | SQL SELECT ]] | ||
+ | * SQL SELECT Examples | ||
+ | * [[ dev:sql:statements:home | Omnidex SQL Statements ]] | ||
+ | |||
+ | ===== OdxSQL Internal SET Commands ===== | ||
+ | |||
+ | <code> | ||
+ | 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] | ||
+ | </code> | ||
+ | |||
+ | ===== Level 2 Headline ===== | ||
+ | |||
+ | <code> | ||
+ | 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 … | ||
+ | </code> | ||
+ | |||
+ | |||
+ | 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. | ||
+ | |||
+ | |||