Connecting from Code

The CData ADO.NET Provider for API implements a standard DbConnection object in APIConnection. You can also use the APIConnectionStringBuilder to programmatically build, parse, and rebuild connection strings.

Creating Connection Objects

See Establishing a Connection for guides to defining the connection string and authenticating. Below is a typical invocation to create APIConnection objects.

using (APIConnection connection =   
  new APIConnection("Profile=<Path to Profile>;ProfileSettings=<Profile Configuration Settings>"))  
{  
  connection.Open();  
}

VB.NET

Using connection As New APIConnection("Profile=<Path to Profile>;ProfileSettings=<Profile Configuration Settings>")
  connection.Open
End Using

Using APIConnectionStringBuilder

The following code example shows how to use an ADO.NET connection string builder to parse a connection string.

APIConnectionStringBuilder builder =
  new APIConnectionStringBuilder("Profile=<Path to Profile>;ProfileSettings=<Profile Configuration Settings>");
  //Pass the connection string builder an existing connection string, and you can get and set any of the elements as strongly typed properties.
  builder.ConnectionString = "Profile=<Path to Profile>;ProfileSettings=<Profile Configuration Settings>";
  //Now that the connection string has been parsed,
  // you can work with individual items:
  builder.MyString = "new property";
  builder.MyBoolean = true;

  // You can refer to connection keys using strings, 
  // as well. 
  builder["Logfile"] = "test.log";
  builder["Verbosity"] = 5;

VB.NET

Dim builder As APIConnectionStringBuilder = New APIConnectionStringBuilder("Profile=<Path to Profile>;ProfileSettings=<Profile Configuration Settings>")
'Pass the connection string builder an existing connection string, and you can get and set any of the elements using strongly typed properties.
builder.ConnectionString = Profile=<Path to Profile>;ProfileSettings=<Profile Configuration Settings>"
'Now that the connection string has been parsed,
' you can work with individual items:
builder.MyString = "new property"
builder.MyBoolean = True
  
' You can refer to connection keys using strings, 
' as well. 
builder("Logfile") = "test.log"
builder("Verbosity") = 5