This shows you the differences between two versions of the page.
|
programs:odxsql:overview [2009/11/28 22:10] tdo |
programs:odxsql:overview [2016/06/28 22:38] |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | ====== OdxSQL ====== | ||
| - | ===== OdxSQL Overview ===== | ||
| - | OdxSQL is a console program used for creating and maintaining Omnidex environments, 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 or script processing of OdxSQL commands and Omnidex SQL Statements. | ||
| - | |||
| - | OdxSQL allows the interactive specification of Omnidex SQL statements as well as OdxSQL specific commands. OdxSQL is primarily used to: | ||
| - | |||
| - | * Create and maintain Omnidex Environments. | ||
| - | * Test query results from a newly created Omnidex indexes with SELECT statements. | ||
| - | * Profile performance of queries using the timer functions. | ||
| - | * Run Explain Plans to determine usage of Omnidex indexes. | ||
| - | * Perform data utility functions such as partitioning or analyzing data. | ||
| - | * Test ODBC performance using OdxSQL's ODBC interface either on the server or across the network. | ||
| - | * Test JDBC performance using OdxSQL's JDBC interface either on the server or across the network. | ||
| - | * Exporting data using SELECT statement operations. | ||
| - | |||
| - | OdxSQL connects to either an Omnidex Environment which can either be specified as a run time argument or via the CONNECT command once OdxSQL is running. | ||
| - | |||
| - | ===== Program Operation ===== | ||
| - | |||
| - | Run OdxSQL from the command line with the following syntax: | ||
| - | |||
| - | os>odxsql [Omnidex_Environment_filespec] | | ||
| - | [-help | -? ] | ||
| - | [ -version ] | ||
| - | [ -use=filespec ] | ||
| - | [ -cmd='cmd1;cmd2' ] | ||
| - | [ -where='criteria' ] | ||
| - | [ -exit ] | ||
| - | [ -exit_on_error ] | ||
| - | [ -nobanner ] | ||
| - | [ -cloa ] | ||
| - | [ -odbc ] | ||
| - | [ -jdbc ] | ||
| - | [ -odxnet | ||
| - | [=port] ] | ||
| - | |||
| - | |||
| - | ==== Run Time Arguments ==== | ||
| - | |||
| - | | Omnidex_Environment_filespec | | ||
| - | | -? | Help | | ||
| - | | -help | Help | | ||
| - | | -version | Program version | | ||
| - | | -use=filespec | Execute statements in named file | | ||
| - | | -cmd='cmd1;cmd2' | Execute specified OdxSQl commands | | ||
| - | | -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 | | ||
| - | |||
| - | 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. | ||
| - | |||
| - | |||
| - | Examples: | ||
| - | |||
| - | Running OdxSQL without command line arguments - use the CONNECT command to connect to an XML or Environment Catalog. | ||
| - | os> odxsql | ||
| - | |||
| - | Running OdxSQL with in Environment Catalog. | ||
| - | os> odxsql orders.env | ||
| - | |||
| - | Running OdxSQL with a command file of OdxSQL commands. | ||
| - | os> 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. | ||
| - | ===== Commands ===== | ||
| - | |||
| - | |||
| - | Commands with an * (asterisk) before the description are also available for use in oaexecsql, ODBC and JDBC applications. All others are available for use ONLY in ODXSQL. | ||
| - | ^Command ^ Description ^ | ||
| - | | ! (Exclamation Point) | Execute an operating system command | | ||
| - | | . (Period) | Re-Execute the last command | | ||
| - | | ;(Semi-Colon) | Comment - any text on the line will be ignored | | ||
| - | | ABORT | Cause OdxSQL to terminate | | ||
| - | | [[programs:odxsql:commands:assignvalues|ASSIGNVALUES]] | * Assign values for a $VALUES clause | | ||
| - | | ATTACH | * Attach an OST file as a table | | ||
| - | | BENCHMARK |Perform performance benchmarks | | ||
| - | | BIND | Bind a SELECT statement | | ||
| - | | CALC | Perform basic calculator functions | | ||
| - | | CD | Change directories | | ||
| - | | CLOSE CURSOR | * Close a previously opened cursor | | ||
| - | | COMMAND | * Execute a shell command via $COMMAND table | | ||
| - | | CONNECT | * Connect to an XML or an Environment Catalog | | ||
| - | | CONVERT | Export a file with data conversions | | ||
| - | | COPY | Copy a fileset | | ||
| - | | CREATE DIRECTORY | * Create an operating system directory | | ||
| - | | CREATE DATABASE | * Create a database within an Omnidex Environment | | ||
| - | | CREATE ENVIRONMENT | * Create an Omnidex Environment | | ||
| - | | CREATE FILE | * Create an operating system file | | ||
| - | | CREATE INDEX | * Create an index or a column or group of columsn | | ||
| - | | CREATE TABLE | * Create a table | | ||
| - | | DATE | Show the current date and time | | ||
| - | | DELETE | * Issue an SQL delete statement | | ||
| - | | DELETEINDEX |* Delete values directly from Omnidex indexes | | ||
| - | | DESCRIBE | Describe a SELECT statement | | ||
| - | | DETACH |* Detach a previously attached OST file | | ||
| - | | DIR | Display a directory of files from the operating system | | ||
| - | | DISCONNECT | * Disconnect from an XML or Environment Catalog | | ||
| - | | DROP DATABASE | | | ||
| - | | DROP ENVIRONMENT | | | ||
| - | | DROP INDEX | | | ||
| - | | DROP TABLE | | | ||
| - | | DROP | * Drop a table | | ||
| - | | DUMP | Dump files, memory or caches | | ||
| - | | EDIT | Edit a previous command or file | | ||
| - | | ERROR | Display an error message | | ||
| - | | EVAL | Evaluate a condition | | ||
| - | | EXECDB | Execute an RDBMS statement using the execdb() | | ||
| - | | EXIT | Exit Omnidex SQL | | ||
| - | | EXPLAIN | Shows an Explain Plan on the retrieval | | ||
| - | | EXPORT | * Export records using SELECT statement syntax to a file | | ||
| - | | EXTRACT | Extract SQL statements from database | | ||
| - | | FETCH | Explicitly fetch data from a database | | ||
| - | | FETCHKEYS | Explicitly fetch keys from the indexes | | ||
| - | | FLIP | Flip bindary data from one endian to another | | ||
| - | | FOR | Form a 'FOR n ... END' construct | | ||
| - | | FORMAT | Format a file of OdxSQL statements | | ||
| - | | GETENV | Display an environment variable | | ||
| - | | HELP | Help on OdxSQL commands | | ||
| - | | HISTORY | Show history of OdxSQL commands | | ||
| - | | IF | Form an 'IF ELIF ELSE ENDIF' construct | | ||
| - | | INSERT | * Issue an SQL insert statement to insert data | | ||
| - | | INSERTINDEX | * Insert values directly into Omnidex indexes | | ||
| - | | IS | Check database conditions | | ||
| - | | JOIN | * Join tables using Omnidex | | ||
| - | | LOAD | Load indexes for TDF files | | ||
| - | | OPEN CURSOR | * Open a cursor | | ||
| - | | OXKERNEL | Execute an Omnidex kernel command | | ||
| - | | PARSE | Parse a SQL statement | | ||
| - | | PARTITION | Partition a table | | ||
| - | | PWD | Print or show the current working directory | | ||
| - | | QUALIFY |* Qualify rows using the Omnidex QUALIFY statement| | ||
| - | | QUIT | Quit Omnidex OdxSQL | | ||
| - | | REMOVE | Remove one or more files from the operating system | | ||
| - | | RENAME | Rename a file or fileset | | ||
| - | | RESET HISTORY | Reset history of ODXSQL commands | | ||
| - | | RESET TIMER | Reset the cumulative timer used to verify performance of queries | | ||
| - | | RESTORE SETTINGS | Restore settings, optionally from a file | | ||
| - | | SAVE HISTORY | Save previously entered OdxSQL commands to a file | | ||
| - | | SAVE SETTINGS | Save settings, optionally to a file | | ||
| - | | SELECT | * Issue an Omnidex SQL SELECT statement | | ||
| - | | SET command | Set an OdxSQL option | | ||
| - | | SET statement | Set and Omnidex SQL setting | | ||
| - | | SETENV | Set an operating system environment variable | | ||
| - | | SHOW | Show information on databases, tables, and columns | | ||
| - | | SIGNAL | Send an operating system signal to a process | | ||
| - | | SORTMERGE | Sort/merge test system | | ||
| - | | UPDATE | * Issue an Omnidex SQL UPDATE statement | | ||
| - | | UPDATE STATISTICS | Update statistics for a database or table | | ||
| - | | UPDATE TEXT | Enable misspelling searches on Text, FullText or MDK indexed columns. | | ||
| - | | UPDATEINDEX | * Update values directly in Omnidex indexes | | ||
| - | | USE | Execute a file of OdxSQL commands | | ||
| - | | VALIDATE | Validate an Omnidex Environment to determine correct mapping to an underlying database or file and verify index retrievals are working | | ||
| - | | VERSION | * Display current software version information | | ||
| - | | VIEW | View an external text file | | ||
| - | | n | Execute numbered command from the OdxSQL History stack | | ||
| - | | n: | Send command to OdxSQL subprocess identified by relative number of the process | | ||
| - | |||
| - | ===== Settings ===== | ||
| - | |||
| - | ^ Setting ^ Option ^ Description ^ | ||
| - | | CURSORDISPLAY | ON/OFF | | | ||
| - | |||
| - | >SET CURSORDISPLAY ON | ||
| - | |||
| - | >connect /users/garment.env | ||
| - | Connected to /users/garment.env on instance 1, cursor 1 | ||
| - | |||
| - | >connect / users/orders.env | ||
| - | Connected to /users/orders.env on instance 2, cursor 2 | ||
| - | |||
| - | SELECT COMPANY, CONTACT, PHONE FROM CUSTOMERS WHERE STATE='CO' ON CURSOR 2 | ||
| - | ... | ||
| - | INSERT INTO CUSTOMERS (COMPANY, CONTACT) VALUES ('New Wave', 'Mr. Smith') ON CURSOR 1 | ||
| - | ... | ||
| - | ===== OdxSQL Environment Variables ===== | ||
| - | |||
| - | Certain aspects of OdxSQL can be controlled through OS environment variables. | ||
| - | ^ Environment Variable ^ Description ^ | ||
| - | | ODXSQL_API | Specifies which API to use: OA (default), ODBC or JDBC. | | ||
| - | | OSXSQLHIST | Specifies a different history file for saving OdxSQL history. | | ||
| - | | ODXSQLINIT | Specifies a text file of OdxSQL initialization commands. | | ||
| - | |||
| - | == ODXSQL_API == | ||
| - | |||
| - | ODXSQL_API specifies which API to use, OA (default) or ODBC during this ODXSQL session. | ||
| - | |||
| - | If running ODXSQL on a client machine where the Omnidex server software has not been installed, this variable MUST be set to ODBC, since the OA API does not exist on the client. | ||
| - | |||
| - | Unix | ||
| - | |||
| - | export ODXSQL_API="OA" | ||
| - | |||
| - | Windows | ||
| - | |||
| - | set ODXSQL_API="ODBC" | ||
| - | |||
| - | == ODXSQLHIST == | ||
| - | |||
| - | ODXSQL_HIST_FILE points to an ODXSQL History File. By default, the ODXSQL command history is written to .odxsql_history. Use this variable to write the history to a different file. | ||
| - | |||
| - | Unix | ||
| - | |||
| - | export ODXSQLHIST="myhistoryfile.txt" | ||
| - | |||
| - | Windows | ||
| - | | ||
| - | set ODXSQLHIST="myhistoryfile.txt" | ||
| - | |||
| - | == ODXSQLINIT == | ||
| - | |||
| - | ODXSQLINIT points to an OdxSQL Init File. This file can contain initialization settings that will be set when OdxSQL starts. This is very useful for set options. | ||
| - | |||
| - | Unix | ||
| - | |||
| - | export ODXSQLINIT="init_file.txt" | ||
| - | |||
| - | Windows | ||
| - | |||
| - | set ODXSQLINIT="init_file.txt" | ||