Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
dev:sql:statements:connect:home [2010/07/02 05:01]
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 Environmentan ODBC datasource fileor 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.  +
- +
-The Omnidex CONNECT Statement is primarily used within OdxSQL.+
  
 +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] 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 Environment.+When using a //​connection_string// ​the USING <ODBC | JDBC > clause must be specified.
  
-==== [AS [user]/​[password] ====+  connect ​[server1:​7555]odx.xml using ODBC;
  
-Optional - Specify username and password if required by the application.+Under Windows, ​the //​environment_filespec//​ must have the backslash directory separater escaped.
  
-==== [WITH options ====+  connect ​[server1:​7555]c:​\\dev\\odx\\myenv.xml using odbc
  
-Options specific to the CONNECT command. 
  
-=== MAINTENANCE ​=== +==== Environment_filespec ==== 
-Connect to an Omnidex Environment ​in maintenance mode to facilitate ​Omnidex ​index maintenance.+The //​Environment_filespec//​ specifies the Omnidex ​XML Environment ​containing the Omnidex ​metadata. ​ The keyword TO is optional.
  
-Options +  connect odx.xml;
-  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> +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.
- DACACHE=<​DEFAULT | ON | OFF | MIN | MAX | n> +
- IACACHE=<​DEFAULT | ON | OFF | MIN | MAX | n>+
  
- DEFAULT Set threshold ​to the default value as shown above +  connect [server1:​7555]odx.xml;​ 
- ON Same as DEFAULT + 
- OFF Set threshold ​to 0, forcing resources to be freed as soon as they are released+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. 
- MIN Same ​as OFF + 
- MAX Set threshold ​to 2.1 Gig (theoretically unreachable number) +  ​connect odx.xml[node1];​  
- 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 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 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}}
 
Back to top
dev/sql/statements/connect/home.txt · Last modified: 2016/06/28 22:38 (external edit)