This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
|
dev:sql:statements:connect:home [2010/07/02 04:58] tdo |
dev:sql:statements:connect:home [2010/07/29 20:40] tdo |
||
|---|---|---|---|
| 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> | <html><div align="center"><span style="color:red">DRAFT</span></div></html> | ||
| - | |||
| ====== Omnidex SQL: CONNECT ====== | ====== Omnidex SQL: CONNECT ====== | ||
| + | {{page>:sql_bar&nofooter&noeditbtn}} | ||
| + | |||
| ===== Description ===== | ===== Description ===== | ||
| + | A connection must be established to a specific Omnidex Environment before any Omnidex retrievals can be peformed. | ||
| - | CONNECT establishes a connection to an Omnidex Environment. Before any Omnidex operations can be performed on an Omindex enhanced data store, a connection must be established. | + | For testing with OdxSQL the CONNECT command is used to establish a connection. A connection can be established to an Omnidex Environment, an ODBC datasource file, or a remote Omnidex environment using a connection string. |
| - | FIXME - Connects with ODBC and JDBC | + | When using the Omnidex ODBC and Omnidex JDBC driver, connections are established using ODBC and JDBC calls. |
| ===== Syntax ===== | ===== Syntax ===== | ||
| - | CONNECT [TO] environment_filespec[ [node_name] ] | + | CONNECT [TO] [ [connection_string] ]environment_filespec[ [node_name] ] |
| - | [ON host[:port]] | + | [USING < ODBC | JDBC > ] |
| - | [AS [user]/[password]] | + | |
| - | [USING < ODBC | JDBC | CLOA > ] | + | |
| [WITH options] | [WITH options] | ||
| ===== Discussion ===== | ===== Discussion ===== | ||
| + | ==== TO ==== | ||
| + | TO is optional and is only included for readability. | ||
| + | ==== connection_string ==== | ||
| + | //Connection_string// is a bracketed server name and optional port that directs the connection through the Omnidex Network services. | ||
| - | ==== [TO] filespec ==== | + | When using a //connection_string// the USING <ODBC | JDBC > clause must be specified. |
| - | Specifies the Omnidex Environment. | + | connect [server1:7555]odx.xml using ODBC; |
| - | ==== [AS [user]/[password]] ==== | + | Under Windows, the //environment_filespec// must have the backslash directory separater escaped. |
| - | Optional - Specify username and password if required by the application. | + | connect [server1:7555]c:\\dev\\odx\\myenv.xml using odbc |
| - | ==== [WITH options] ==== | ||
| - | Options specific to the CONNECT command. | + | ==== Environment_filespec ==== |
| + | The //Environment_filespec// specifies the Omnidex XML Environment containing the Omnidex metadata. The keyword TO is optional. | ||
| - | === MAINTENANCE === | + | connect odx.xml; |
| - | Connect to an Omnidex Environment in maintenance mode to facilitate Omnidex index maintenance. | + | |
| - | Options | + | A connection string enclosed in brackets can prefix the //environment_filespec// to specify a host and port which will then route the calls to an Omnidex Network Services OdxNet process running on the specified remote server. |
| - | read | + | |
| - | write | + | |
| - | exclusive | + | |
| - | ia | + | |
| - | da | + | |
| - | oa | + | |
| - | envaccess | + | |
| - | eapreload | + | |
| - | eacache | + | |
| - | iacache | + | |
| - | dacache | + | |
| - | iafiles | + | |
| - | dbdirect | + | |
| - | dbinstal | + | |
| - | dbuser | + | |
| - | dbaccess | + | |
| - | maxfopens | + | |
| - | maxmemory | + | |
| - | cache | + | |
| - | singledbconnect | + | |
| - | userlocking | + | |
| - | preprocessor | + | |
| - | interrupts | + | |
| - | clocks | + | |
| - | autopseudocolumns | + | |
| - | setcwd | + | |
| - | EACACHE=<DEFAULT | ON | OFF | MIN | MAX | n> | + | connect [server1:7555]odx.xml; |
| - | DACACHE=<DEFAULT | ON | OFF | MIN | MAX | n> | + | |
| - | IACACHE=<DEFAULT | ON | OFF | MIN | MAX | n> | + | |
| - | DEFAULT Set threshold to the default value as shown above | + | A specific //node_name// can be enclosed in brackets and appended to the //environment_filespec// to connect to a specific node. This is useful in a test situation where the performance of a specific node is being reviewed. |
| - | ON Same as DEFAULT | + | |
| - | OFF Set threshold to 0, forcing resources to be freed as soon as they are released. | + | connect odx.xml[node1]; |
| - | MIN Same as OFF | + | |
| - | MAX Set threshold to 2.1 Gig (a theoretically unreachable number) | + | |
| - | n Set threshold to the specified number, measured in kilobytes (1024 bytes). | + | ==== AS [user]/[password] ==== |
| + | |||
| + | Used to specify a username and password if required by the underlying relational database. | ||
| + | |||
| + | connect odxoracle.xml as orauser/pass; | ||
| + | ==== USING api ==== | ||
| + | |||
| + | Used to specify the either the ODBC or JDBC api to use for access. This is primarily used to test ODBC and JDBC access using OdxSQL. This clause must be specified if using a connection string. | ||
| + | |||
| + | connect [server1:7555]odx.xml using ODBC; | ||
| + | |||
| + | ==== WITH options ==== | ||
| + | |||
| + | Options specific to the CONNECT command. | ||
| - | ===== Examples ===== | + | MAINTENANCE - Accesses the Omnidex Environment exclusively to facilitate changes. |
| - | ==== Simple ==== | + | connect to odx.xml with maintenance; |
| - | + | ||
| - | connect myenv | + | |
| {{page>:bottom_add&nofooter&noeditbtn}} | {{page>:bottom_add&nofooter&noeditbtn}} | ||