Connecting from Code
The CData ADO.NET Provider for Confluence implements a standard DbConnection object in ConfluenceConnection. You can also use the ConfluenceConnectionStringBuilder 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 ConfluenceConnection objects.
C#
using (ConfluenceConnection connection =
new ConfluenceConnection("User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;"))
{
connection.Open();
}
VB.NET
Using connection As New ConfluenceConnection("User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;")
connection.Open
End Using
Using ConfluenceConnectionStringBuilder
The following code example shows how to use an ADO.NET connection string builder to parse a connection string.
C#
ConfluenceConnectionStringBuilder builder =
new ConfluenceConnectionStringBuilder("User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;");
//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 = "User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;";
//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 ConfluenceConnectionStringBuilder = New ConfluenceConnectionStringBuilder("User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;")
'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 = User=admin;APIToken=myApiToken;Url=https://yoursitename.atlassian.net;Timezone=America/New_York;"
'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