This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
dev:connections:home [2011/02/08 21:43] deb |
dev:connections:home [2016/06/28 22:38] (current) |
||
|---|---|---|---|
| Line 6: | Line 6: | ||
| ===== Connection Strings ===== | ===== Connection Strings ===== | ||
| - | Omnidex uses connection strings to connect to Omnidex Environment Files. A connection string is a universal syntax that describes the location, network information and options for connecting to the environment file. Connection strings are used throughout the Omnidex product, including ODBC, JDBC, Omnidex Grids, and the Omnidex SQL Engine. | + | Omnidex uses connection strings to connect to Omnidex Environment Files. A connection string is a universal syntax that describes the location, network information, security and options for connecting to the environment file. Connection strings are used throughout the Omnidex product, including ODBC, JDBC, Omnidex Grids, and the Omnidex SQL Engine. |
| Line 13: | Line 13: | ||
| The full syntax of the Omnidex connection string is shown below. It is rare that all portions are needed, though. Any portion of the connection string are optional and can be omitted and replaced with the default settings as long as enough information remains to support the connection. | The full syntax of the Omnidex connection string is shown below. It is rare that all portions are needed, though. Any portion of the connection string are optional and can be omitted and replaced with the default settings as long as enough information remains to support the connection. | ||
| - | [ host : port : pool ] filename [ node ] &options | + | user/password@ [ host : port : pool ] filename [ node ] &options |
| Line 19: | Line 19: | ||
| === Parameters === | === Parameters === | ||
| + | |||
| + | == user == | ||
| + | |||
| + | The user to be used when accessing an underlying relational database. Security can be provided in the connection string or can be recorded directly in the [[dev:sql:statements:create_database|CREATE_DATABASE]] statement. A user and password is not needed for raw data files. | ||
| + | |||
| + | == password == | ||
| + | |||
| + | The password to be used when accessing an underlying relational database. Security can be provided in the connection string or can be recorded directly in the [[dev:sql:statements:create_database|CREATE_DATABASE]] statement. A user and password is not needed for raw data files. | ||
| == host == | == host == | ||
| Line 46: | Line 54: | ||
| === Using Environment Variables and Shell Commands === | === Using Environment Variables and Shell Commands === | ||
| - | Omnidex allows environment variables to replace any or all of the components of a connection string. The syntax for referencing an environment variable on the local host is {$VARIABLE}, where VARIABLE is the name of the environment variable. The syntax for referencing an environment variable on the remote host is {$$VARIABLE}. The entire connection string could be replaced with environment variables using the following syntax. Note that any variable name can be used. | + | Omnidex supports environment variables and shell commands to be used in many places within the product. Omnidex also allows environment variables to replace any or all of the components of a connection string. The syntax used in connection strings is more unique that the [[appendix:reference:envvar:home|general syntax]]. This is because of the need to differentiate whether the environment variable resides on the client or the server. |
| + | |||
| + | The syntax for referencing an environment variable on the local host is {$VARIABLE}, where VARIABLE is the name of the environment variable. The syntax for referencing an environment variable on the remote host is {$$VARIABLE}. The entire connection string could be replaced with environment variables using the following syntax. Note that any variable name can be used. | ||
| Omnidex also allows shell commands to be used in place of environment variables. Shell commands can be used to allow an external process to produce the value, rather than relying on an environment variable. The syntax for referencing a shell command on the local server is {$(command)}, where command is the shell command. The syntax for referencing a shell command on the remote server is {$$(command)}. Note that if the shell command contains spaces or punctuation marks, it should be enclosed in quotation marks. | Omnidex also allows shell commands to be used in place of environment variables. Shell commands can be used to allow an external process to produce the value, rather than relying on an environment variable. The syntax for referencing a shell command on the local server is {$(command)}, where command is the shell command. The syntax for referencing a shell command on the remote server is {$$(command)}. Note that if the shell command contains spaces or punctuation marks, it should be enclosed in quotation marks. | ||
| Line 64: | Line 74: | ||
| simple.xml | simple.xml | ||
| + | |||
| + | == Connection to a local environment with relational database security == | ||
| + | |||
| + | This connection string connects to an environment file on the local machine passing a user and password to be sent to the underlying relational database: | ||
| + | |||
| + | myuser/mypassword@simple.xml | ||
| == Connection to a remote environment file == | == Connection to a remote environment file == | ||
| Line 70: | Line 86: | ||
| [server1:7555]c:\class\simple.xml | [server1:7555]c:\class\simple.xml | ||
| + | |||
| + | == Connection to a remote environment file with relational database security == | ||
| + | |||
| + | This connection string connects to an environment file on a remote machine name 'server1' passing a user and password to be sent to the underlying relational database: | ||
| + | |||
| + | myuser/mypassword@[server1:7555]c:\class\simple.xml | ||
| == Connection to a remote Omnidex Connection Pool == | == Connection to a remote Omnidex Connection Pool == | ||