This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
programs:odxsql:home [2010/07/03 23:12] tdo |
programs:odxsql:home [2016/06/28 22:38] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| {{page>:top_add&nofooter&noeditbtn}} | {{page>:top_add&nofooter&noeditbtn}} | ||
| - | <html><div align="center"><span style="color:red">DRAFT</span></div></html> | ||
| - | ~~NOTOC~~ | ||
| - | ====== OdxSQL Quick Reference ====== | ||
| - | {{page>:odxsql_bar&nofooter&noeditbtn}} | ||
| - | ^ 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 -odxnet -odbc | Run OdxSQL and an OdxNET background process and connect to the ODBC File 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 Uses ===== | ||
| - | OdxSQL is a console application for manually entering Omnidex SQL Statements and OdxSQL Commands or for processing scripts of Omnidex SQL statements. | + | ====== Programs: OdxSQL ====== |
| - | Use OdxSQL for processing Omnidex SQL Data Definition Scripts to create Omnidex Environments and Indexes. | + | **[[programs:odxsql:home|Overview]]** | [[programs:odxsql:commands|Commands]] | [[programs:odxsql:options|Options]] | [[programs:odxsql:cmdline|Command-line]] | [[programs:odxsql:files|Command Files]] |
| - | 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. | ||
| - | + | ===== Overview ===== | |
| - | ===== Common ways to run OdxSQL ===== | + | The OdxSQL program is a console-based utility for issuing Omnidex statements and viewing their results. OdxSQL allows customers to test or execute nearly every capability in Omnidex. Furthermore, OdxSQL can be easily integrated into shell scripts for use in automated batch operations. |
| + | By default, OdxSQL executes statements against an Omnidex environment; however, OdxSQL can also be run as an ODBC or JDBC client tool. In this scenario, the commands entered in OdxSQL are redirected to either the ODBC client interface or the JDBC client interface, which in turn a executed through Omnidex Network Services to the Omnidex server. This allows a wide range of tests to be performed against these interfaces. Note that two other programs, OdbcSQL and JdbcSQL, also provide similar capabilities. | ||
| - | os> odxsql | + | ===== Running OdxSQL ===== |
| - | os> odxsql envfile | + | |
| - | os> odxsql dsnfile -odxnet -odbc | + | |
| - | os> odxsql -? | + | |
| - | os> odxsql -use scriptfile | + | |
| - | Running OdxSQL Explained: | + | On Microsoft Windows, OdxSQL is run from the Start menu or from the CMD shell, as shown below. |
| - | | 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.| | + | |
| - | ^Set Command ^Description ^ | + | |
| - | |SET| Shows the current settings. | | + | |
| - | |SET ? | Shows the list of available SET options. | | + | |
| - | |SET TERMINATION OFF|Will Automatically terminate SQL Statements.| | + | |
| - | ^ Help/Show ^Description^ | + | <code> |
| - | |HELP|Shows a list of OdxSQL commands and SQL Statements.| | + | D:\db\simple>odxsql |
| - | |HELP <COMMAND>|Provides specific help on the specified command or SQL Statement.| | + | ODXSQL - Omnidex SQL Wed, Jun 10, 2015 11:28am |
| - | |SHOW <table>|Provides information on the specified table.| | + | (c) Dynamic Information Systems Corp. 1981-2015 Enterprise 5.3.09C |
| - | |SHOW ALL|Provides information on all tables.| | + | Microsoft Windows Server 2012 R2 Standard WIN2 / administrator |
| + | Dynamic Information Systems Corp | ||
| - | ===== OdxSQL Important Information ===== | + | > |
| + | </code> | ||
| - | * OdxSQL connects to an Omnidex Environment or ODBC or JDBC Omnidex File Datasource (DSN). | + | On Linux, OdxSQL is run from your preferred shell, whether bash, korn, or some other shell. |
| - | * 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. | + | <code> |
| - | * 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. | + | |
| - | + | lnx3> [/home/db]$ odxsql | |
| - | * Use SHOW <table> to show information on a table with the tables's column layout. | + | ODXSQL - Omnidex SQL Wed, Jun 10, 2015 11:37am |
| - | * Use SHOW ALL to see all tables, including internal system tables. | + | (c) Dynamic Information Systems Corp. 1981-2015 Enterprise 5.3.09C |
| + | Linux 2.6.32-431.20.3.el6.x86_64 lnx3 / oadev | ||
| + | Dynamic Information Systems Corp | ||
| - | * 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> | </code> | ||
| - | ===== Level 2 Headline ===== | + | ===== ===== |
| - | <code> | + | **[[programs:odxsql:commands|Next]]** |
| - | 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> | + | |
| + | ====== Additional Resources ====== | ||
| - | The syntaxes of the SQL Logging SET commands are shown below: | + | See also: |
| - | set sql_logging <on | off> | + | {{page>:programs:see_also&nofooter&noeditbtn}} |
| - | 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. | + | {{page>:bottom_add&nofooter&noeditbtn}} |
| - | 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. | ||
| - | |||
| - | |||
| - | {{page>:bottom_add&nofooter&noeditbtn}} | ||