This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
dev:sql:statements:connect:home [2010/07/02 05:10] tdo |
dev:sql:statements:connect: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> | <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. |
| - | Note that when using the Omnidex ODBC and Omnidex JDBC driver, connections are established using ODBC and JDBC calls. | + | When using the Omnidex ODBC and Omnidex JDBC driver, connections are established using ODBC and JDBC calls. |
| - | + | ||
| - | The Omnidex CONNECT Statement is primarily used within OdxSQL. | + | |
| ===== Syntax ===== | ===== Syntax ===== | ||
| - | CONNECT [TO] [ [host:port] ]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] [ [host:port] ]Environment_filespec ==== | + | ==== 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. | ||
| - | Specifies the Omnidex XML Environment containing the Omnidex metadata. | + | When using a //connection_string// the USING <ODBC | JDBC > clause must be specified. |
| + | |||
| + | connect [server1:7555]odx.xml using ODBC; | ||
| + | |||
| + | Under Windows, the //environment_filespec// must have the backslash directory separater escaped. | ||
| + | |||
| + | connect [server1:7555]c:\\dev\\odx\\myenv.xml using odbc | ||
| + | |||
| + | |||
| + | ==== Environment_filespec ==== | ||
| + | The //Environment_filespec// specifies the Omnidex XML Environment containing the Omnidex metadata. The keyword TO is optional. | ||
| connect odx.xml; | connect odx.xml; | ||
| - | ==== [AS [user]/[password]] ==== | + | 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. |
| + | |||
| + | connect [server1:7555]odx.xml; | ||
| + | |||
| + | 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. | ||
| + | |||
| + | connect odx.xml[node1]; | ||
| + | |||
| + | |||
| + | ==== AS [user]/[password] ==== | ||
| Used to specify a username and password if required by the underlying relational database. | Used to specify a username and password if required by the underlying relational database. | ||
| - | ==== [WITH options] ==== | ||
| - | Options specific to the CONNECT command. | + | connect odxoracle.xml as orauser/pass; |
| + | ==== USING api ==== | ||
| - | === MAINTENANCE === | + | Used to specify 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 to an Omnidex Environment in maintenance mode to facilitate Omnidex index maintenance. | + | |
| - | ^Option^Description^ | + | connect [server1:7555]odx.xml using ODBC; |
| - | | 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> | + | ==== WITH options ==== |
| - | DACACHE=<DEFAULT | ON | OFF | MIN | MAX | n> | + | |
| - | IACACHE=<DEFAULT | ON | OFF | MIN | MAX | n> | + | Options specific to the CONNECT command. |
| - | DEFAULT Set threshold to the default value as shown above | + | MAINTENANCE - Accesses the Omnidex Environment exclusively to facilitate changes. |
| - | ON Same as DEFAULT | + | |
| - | OFF Set threshold to 0, forcing resources to be freed as soon as they are released. | + | |
| - | 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). | + | |
| - | ===== Examples ===== | + | connect to odx.xml with maintenance; |
| {{page>:bottom_add&nofooter&noeditbtn}} | {{page>:bottom_add&nofooter&noeditbtn}} | ||