LCConnection Class Methods Summary
The LCConnection class methods are summarized in the following sections.
Connection
The following methods control connection to a data provider. A connection is required before gaining access to most connector metadata and all connector data. Multiple connections may be established to a single connector with multiple connection objects.
| Method |
Description |
|---|---|
| LCConnection.Connect |
Establish a connection to a data provider. |
| LCConnection.Disconnect |
Disconnect from a data provider. |
Create Result Set
Each Connection can have a single active result set. A result set is the data produced by an action, for example, the execution of a Select statement against SQL tables. All of these methods produce a result set, replacing any existing result set. The result set can be produced from a connector-specific language statement, from connector-independent properties and keys or parameters, or from connector metadata. Connector metadata is either an SQL table or view, a Notes® form, and so on.
Once a result set is produced, the data in that result set can be fetched. Under specific circumstances, efficient writeback updates and removes directly back into the result set are also supported.
| Method |
Description |
|---|---|
| LCConnection.Call |
Perform a connector-independent procedure call with parameters. |
| LCConnection.Catalog |
Produce a result set containing a list of servers, databases, tables or views, indexes, or fields in a table, that are available through this connection. Each record in the result set describes one server, database, table, and so on. |
| LCConnection.Execute |
Execute a statement against the data provider. The statement is provided in the data provider's language. |
| LCConnection.Select |
Perform a connector-independent selection controlled by various connector properties. Conditional key inequalities, timestamp, and other control is supported. |
Data Manipulation
These methods allow access to and manipulation of connector data.
| Method |
Description |
|---|---|
| LCConnection.Fetch |
Retrieve records from the current result set. |
| LCConnection.Insert |
Insert new records into the data provider. |
| LCConnection.Update |
Update records in the data provider. Key values and update values are provided. No keys are required for writeback operations. |
| LCConnection.Remove |
Delete records from the data provider. Key values are provided. No keys are required for writeback operations. |
Metadata Manipulation
These methods allow access to and manipulation of connector metadata.
| Method |
Description |
|---|---|
| LCConnection.Create |
Create a new metadata object. |
| LCConnection.Drop |
Drop an existing metadata object. |
Miscellaneous
| Method |
Description |
|---|---|
| LCConnection.Action |
Perform one of a set of predefined actions (for example, commit). Different actions may be available in different connectors. |
| LCConnection.GetProperty |
Fetch a property value for a connection. |
| LCConnection.GetProperty <datatype> |
Fetch a property as a particular data type. |
| LCConnection.ListProperty |
List supported properties and values. |
| LCConnection.LookupProperty |
Verify the support of a property. |
| LCConnection.SetProperty |
Set a property value for a connection. |
| LCConnection.SetProperty <datatype> |
Set a property as a particular data type. |