ConnectionManager ConnectionManager ConnectionManager Class

Definition

Provides the information that you must have to connect to a data source. All classes that inherit from the ConnectionManager contain the same properties and methods. The ConnectionManager class isolates the implementation details of the different connection types from the runtime. This enables the runtime to interact with each connection manager in a consistent and predictable manner. Connection managers contain a set of stock properties that all connections have in common, such as the Name, ID, Description, and ConnectionString. However, each connection type has additional properties that are specific to that connection type. These can be accessed through the Properties collection.This class cannot be inherited.

public ref class ConnectionManager sealed : Microsoft::SqlServer::Dts::Runtime::DtsObject, IDisposable, Microsoft::SqlServer::Dts::Runtime::IDTSExecutionPath, Microsoft::SqlServer::Dts::Runtime::IDTSName, Microsoft::SqlServer::Dts::Runtime::IDTSObjectHost, Microsoft::SqlServer::Dts::Runtime::IDTSPackagePath, Microsoft::SqlServer::Dts::Runtime::IDTSPersist, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProvider, Microsoft::SqlServer::Dts::Runtime::IDTSPropertiesProviderEx, System::ComponentModel::IComponent
public sealed class ConnectionManager : Microsoft.SqlServer.Dts.Runtime.DtsObject, IDisposable, Microsoft.SqlServer.Dts.Runtime.IDTSExecutionPath, Microsoft.SqlServer.Dts.Runtime.IDTSName, Microsoft.SqlServer.Dts.Runtime.IDTSObjectHost, Microsoft.SqlServer.Dts.Runtime.IDTSPackagePath, Microsoft.SqlServer.Dts.Runtime.IDTSPersist, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProvider, Microsoft.SqlServer.Dts.Runtime.IDTSPropertiesProviderEx, System.ComponentModel.IComponent
Public NotInheritable Class ConnectionManager
Inherits DtsObject
Implements IComponent, IDisposable, IDTSExecutionPath, IDTSName, IDTSObjectHost, IDTSPackagePath, IDTSPersist, IDTSPropertiesProvider, IDTSPropertiesProviderEx
Inheritance
ConnectionManagerConnectionManagerConnectionManager
Implements

Remarks

A connection manager is a logical representation of a connection. At design time, in the graphical user interface, you use a connection manager to describe the physical connection that the runtime creates when the package runs. Integration Services provides different types of connection managers that enable packages to connect to a variety of data sources. For example, there is an ActiveX Data Objects (ADO) connection manager, an ADO.NET connection manager, an ODBC connection manager, and so on. For more information, see Extending Packages with Custom Objects.

Properties

ConnectionString ConnectionString ConnectionString

Gets or sets the connection string used to establish a connection to a data source.

CreationName CreationName CreationName

Returns the string that is used by the runtime to create an instance of the ConnectionManager object and to add the object to the Connections collection. This property is read-only.

DelayValidation DelayValidation DelayValidation

Gets or sets a Boolean that indicates whether package validation is delayed until the package runs.

Description Description Description

Gets or sets the description of the ConnectionManager object.

HasExpressions HasExpressions HasExpressions

Gets a value that indicates whether the connection manager has properties set through expressions.

HostType HostType HostType

Gets an enumeration that describes the type of host that the connection is being used by. This property is read-only.

ID ID ID

Gets the ID of the ConnectionManager. This property is read-only.

InnerObject InnerObject InnerObject

Returns the specific connection type that was created. This property is read-only.

Name Name Name

Gets or sets the name of the ConnectionManager object.

OfflineMode OfflineMode OfflineMode

Gets or sets a value that indicates whether the connection manager is in offline mode.

Properties Properties Properties

Gets a collection of property objects for the ConnectionManager. This is the method of accessing the properties of the specific connection that is being hosted by the connection manager. This property is read-only.

ProtectionLevel ProtectionLevel ProtectionLevel

Gets or sets the level of encryption performed on sensitive data that is contained in the package.

Qualifier Qualifier Qualifier

Gets or sets the qualifier for the connection manager.

Scope Scope Scope

Gets the scope of the connection manager.

Site Site Site

Gets or sets the site of the connection manager.

SupportsDTCTransactions SupportsDTCTransactions SupportsDTCTransactions

Returns a Boolean that indicates if the connection supports Microsoft Distributed Transaction Coordinator (MS DTC) transactions.

VariableDispenser VariableDispenser VariableDispenser

Gets the dispenser of the variables in the connection manager.

Variables Variables Variables

Gets the collection of variables in the connection manager.

Methods

AcquireConnection(Object) AcquireConnection(Object) AcquireConnection(Object)

Creates an instance of the connection type.

Dispose() Dispose() Dispose()

Releases the resources used by the ConnectionManager.

Equals(Object) Equals(Object) Equals(Object)

Determines whether two object instances are equal.

(Inherited from DtsObject)
GetExecutionPath() GetExecutionPath() GetExecutionPath()

Returns the execution path of the connection manager.

GetExpression(String) GetExpression(String) GetExpression(String)

Returns a String that contains the expression for the specified property. Null means that no expression has been assigned.

GetHashCode() GetHashCode() GetHashCode()

Returns the hash code for this instance.

(Inherited from DtsObject)
GetPackagePath() GetPackagePath() GetPackagePath()

Gets or sets the path of the package that the connection applies to.

LoadFromXML(String, IDTSEvents) LoadFromXML(String, IDTSEvents) LoadFromXML(String, IDTSEvents)

This method is not callable by your application code. To load a package that has been saved as .xml, use the LoadPackage(String, IDTSEvents) method.

LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents) LoadFromXML(XmlNode, IDTSEvents)

This method is not callable by your application code. To load a package that has been saved as .xml, use the LoadPackage(String, IDTSEvents) method.

ReleaseConnection(Object) ReleaseConnection(Object) ReleaseConnection(Object)

Frees the connection established during AcquireConnection(Object). Called at design time and runtime.

SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents) SaveToXML(XmlDocument, XmlNode, IDTSEvents)

This method is not callable by your application code. To save a package as .xml, use the SaveToXml(String, Package, IDTSEvents) method.

SetExpression(String, String) SetExpression(String, String) SetExpression(String, String)

Assigns the specified expression to the property. Specify null to remove an existing expression from the property.

SetQualifier(String) SetQualifier(String) SetQualifier(String)

Changes a qualifier on the connection manager after the connection manager has been created but before it is used in a running package.

Events

Disposed Disposed Disposed

Adds an event handler to listen to the Disposed event on the ConnectionManager.

Applies to