Difference between revisions of "SQLSTRINGCONNECT()"
From Recital Documentation Wiki
Yvonnemilne (Talk | contribs) |
Yvonnemilne (Talk | contribs) |
||
| (8 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
==Purpose== | ==Purpose== | ||
Connect to a data source using a gateway connection string | Connect to a data source using a gateway connection string | ||
| Line 11: | Line 4: | ||
==Syntax== | ==Syntax== | ||
| − | SQLSTRINGCONNECT([<lShared>] | + | SQLSTRINGCONNECT([<lShared>,] [<cConnectString> [, <lShared>]]) |
==See Also== | ==See Also== | ||
| − | [[CREATE CONNECTION]], [[SQLCANCEL()]], [[SQLCOLUMNS()]], [[SQLCOMMIT()]], [[SQLCONNECT()]], [[SQLDISCONNECT()]], [[SQLEXEC()]], [[SQLGETPROP()]], [[SQLMORERESULTS()]], [[SQLPREPARE()]], [[SQLROLLBACK()]], [[SQLSETPROP()]], [[SQLTABLES()]] | + | [[CREATE CONNECTION]], [[SQLCANCEL()]], [[SQLCOLUMNS()]], [[SQLCOMMIT()]], [[SQLCONNECT()]], [[SQLDISCONNECT()]], [[SQLERROR()]], [[SQLEXEC()]], [[SQLGETPROP()]], [[SQLMORERESULTS()]], [[SQLPREPARE()]], [[SQLROLLBACK()]], [[SQLSETPROP()]], [[SQLTABLES()]] |
| − | Description | + | ==Description== |
The SQLSTRINGCONNECT() function is used to connect to a data source using a gateway connection string and return a statement handle for use by other SQL functions. | The SQLSTRINGCONNECT() function is used to connect to a data source using a gateway connection string and return a statement handle for use by other SQL functions. | ||
| Line 32: | Line 25: | ||
|} | |} | ||
| − | + | ||
| + | ====cConnectString:==== | ||
| Line 50: | Line 44: | ||
|Protocol||The network protocol. TCP/IP is assumed. | |Protocol||The network protocol. TCP/IP is assumed. | ||
|- | |- | ||
| − | |Driver:DataSource||ODBC, OLEDB or JDBC server side data source in the format: | + | |Driver:DataSource ||ODBC, OLEDB or JDBC server side data source in the format: |
odbc:odbc_data_source_name_on_server | odbc:odbc_data_source_name_on_server | ||
| + | |||
oledb:oledb_connection_string_on_server | oledb:oledb_connection_string_on_server | ||
| + | |||
jdbc:dbc_driver_path_on_server;jdbc:Recital:args | jdbc:dbc_driver_path_on_server;jdbc:Recital:args | ||
|- | |- | ||
| Line 65: | Line 61: | ||
|> 0||The workarea in which the gateway data source has been opened | |> 0||The workarea in which the gateway data source has been opened | ||
|- | |- | ||
| − | | | + | |–1||Connection creation error |
|- | |- | ||
|} | |} | ||
| Line 88: | Line 84: | ||
==Products== | ==Products== | ||
| − | Recital | + | Recital, Recital Server |
[[Category:Documentation]] | [[Category:Documentation]] | ||
[[Category:Functions]] | [[Category:Functions]] | ||
[[Category:SQL]] | [[Category:SQL]] | ||
| + | [[Category:Remote Data Connectivity Functions]] | ||
Latest revision as of 16:15, 4 July 2011
Contents
Purpose
Connect to a data source using a gateway connection string
Syntax
SQLSTRINGCONNECT([<lShared>,] [<cConnectString> [, <lShared>]])
See Also
CREATE CONNECTION, SQLCANCEL(), SQLCOLUMNS(), SQLCOMMIT(), SQLCONNECT(), SQLDISCONNECT(), SQLERROR(), SQLEXEC(), SQLGETPROP(), SQLMORERESULTS(), SQLPREPARE(), SQLROLLBACK(), SQLSETPROP(), SQLTABLES()
Description
The SQLSTRINGCONNECT() function is used to connect to a data source using a gateway connection string and return a statement handle for use by other SQL functions.
| Keywords | Description |
|---|---|
| lShared | False (.F.) Connection created is not shared (default)
True (.T.) Connection created is shared |
| cConnectString | The data source gateway connection string. The cConnectString gateway connection string format is: server@machinename:username/password-database.protocol. The shortened driver:datasource format can also be used for ODBC, OLEDB or JDBC data sources on the server.
If cConnectString is not specified, the ’Select a Gateway’ dialog is displayed allowing an existing gateway definition file (.gtw) to be selected. Gateway files can be created in Recital Terminal Developer using the CREATE GATEWAY | MODIFY GATEWAY tool or via the CREATE CONNECTION command. |
cConnectString:
| Parameter | Description |
|---|---|
| Server | Database server name or abbreviation, e.g. mys or mysql. |
| Nodename | IP Address or hostname of the machine on which the database resides. |
| Username | Username to log in to the external database. |
| Password | Password for username above. |
| Database | Database to connect to. |
| Protocol | The network protocol. TCP/IP is assumed. |
| Driver:DataSource | ODBC, OLEDB or JDBC server side data source in the format:
odbc:odbc_data_source_name_on_server oledb:oledb_connection_string_on_server jdbc:dbc_driver_path_on_server;jdbc:Recital:args |
Return values:
| Return Value | Description |
|---|---|
| > 0 | The workarea in which the gateway data source has been opened |
| –1 | Connection creation error |
Example
// When cConnectString is omitted, ’Select a Gateway’ dialog is displayed // Specify connection should be shared nStatHand = SQLSTRINGCONNECT(.T.) // Including cConnectString makes the connection // Store the return value to use as the nStatementHandle for subsequent function calls // Specify connection should be shared nStatHand = SQLSTRINGCONNECT("mysql@linux1:user1/pass1-database1.tcpip",.T.) // OLEDB DataSource nStatHand = SQLSTRINGCONNECT ("oledb:Provider=vfpoledb.1;" +; "Data Source=C:Data;Collating Sequence=general",.T.)
Products
Recital, Recital Server
