Differences

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

--- dev:sql:statements:connect:home [2009/11/30 05:57]
127.0.0.1 external edit
+++ dev:sql:statements:connect:home [2016/06/28 22:38] (current)
@@ Line 1: / Line 1: @@
 {{page>:top_add&nofooter&noeditbtn}}
 <html><div align="center"><span style="color:red">DRAFT</span></div></html>
 ====== Omnidex SQL: CONNECT ======
+{{page>:sql_bar&nofooter&noeditbtn}}
 ===== 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 =====
-  CONNECT [TO] filename
+  CONNECT [TO] [ [connection_string] ]environment_filespec[ [node_name] ]
-          [ON host[:port]]
+          [USING < ODBC | JDBC > ]
-          [AS [user]/[password]]
-          [USING api]
           [WITH options]
 ===== 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.
-Options
+  connect odx.xml;
-  read
-  write
+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.
-  exclusive
-  ia
+  connect [server1:7555]odx.xml;
-  da
-  oa
+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.
-  envaccess
-  eapreload
+  connect odx.xml[node1];
-  eacache
-  iacache
-  dacache
+==== AS [user]/[password]  ====
-  iafiles
-  dbdirect
+Used to specify a username and password if required by the underlying relational database.
-  dbinstal
-  dbuser
+  connect odxoracle.xml as orauser/pass;
-  dbaccess
+==== USING api  ====
-  maxfopens
-  maxmemory
+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.
-  cache
-  singledbconnect
+  connect [server1:7555]odx.xml using ODBC;
-  userlocking
-  preprocessor
+==== WITH options  ====
-  interrupts
-  clocks
+Options specific to the CONNECT command.
-  autopseudocolumns
-  setcwd
-===== Examples =====
+MAINTENANCE - Accesses the Omnidex Environment exclusively to facilitate changes.
-==== Simple ====
+  connect to odx.xml with maintenance;
-  connect myenv
 {{page>:bottom_add&nofooter&noeditbtn}}

Back to top

dev/sql/statements/connect/home.1259560638.txt.gz · Last modified: 2016/06/28 22:38 (external edit)

Sitemap Recent Changes