ConnectionManager Class

Article
03/03/2014

The ConnectionManager class manages the connection to an instance of SQL Server.

Inheritance Hierarchy

Object
  Microsoft.SqlServer.Management.Common.ConnectionSettings
    Microsoft.SqlServer.Management.Common.ConnectionManager
      Microsoft.SqlServer.Management.Common.ServerConnection

Namespace: Microsoft.SqlServer.Management.Common
Assembly: Microsoft.SqlServer.ConnectionInfo (in Microsoft.SqlServer.ConnectionInfo.dll)

Syntax

'Declaration
Public MustInherit Class ConnectionManager _
    Inherits ConnectionSettings
'Usage
Dim instance As ConnectionManager

public abstract class ConnectionManager : ConnectionSettings

public ref class ConnectionManager abstract : public ConnectionSettings

[<AbstractClassAttribute>]
type ConnectionManager =  
    class 
        inherit ConnectionSettings 
    end

public abstract class ConnectionManager extends ConnectionSettings

The ConnectionManager type exposes the following members.

Properties

	Name	Description
	ApplicationName	Gets or sets the name of the application that has established the connection with the server. (Inherited from ConnectionSettings.)
	AutoDisconnectMode	Gets or sets the automatic disconnection mode of the referenced connection to the instance of SQL Server.
	CapturedSql	Gets the Transact-SQL statements that are captured when the connection is running in capture mode.
	ConnectAsUser	Gets or sets the Boolean property value that specifies whether the connection is established using impersonation. (Inherited from ConnectionSettings.)
	ConnectAsUserName	Gets or sets the name of the user when connecting using impersonation. (Inherited from ConnectionSettings.)
	ConnectAsUserPassword	Gets or sets the password for the user when connecting using impersonation. (Inherited from ConnectionSettings.)
	ConnectionString	Gets or sets the connection string used to establish a connection with a specified data source. (Inherited from ConnectionSettings.)
	ConnectTimeout	Gets or sets the connection time-out period in seconds. (Inherited from ConnectionSettings.)
	DatabaseEngineType	Gets the database engine type.
	DatabaseName	Gets or sets the database required by the connection. (Inherited from ConnectionSettings.)
	EncryptConnection	Gets or sets the Boolean property value that specifies whether the connection is encrypted. (Inherited from ConnectionSettings.)
	InUse	Gets or sets the Boolean property value that specifies whether the connection is being used.
	IsForceDisconnected	Gets a Boolean value that specifies whether the connection was forcibly disconnected.
	IsOpen	Gets the Boolean property value that specifies whether the connection is currently open.
	LockTimeout	Gets or sets the time in seconds required for the connection to time out when the current transaction is locked.
	Login	Gets or sets the logon required to establish a connection with the instance of the server. (Inherited from ConnectionSettings.)
	LoginSecure	Gets or sets the Boolean property that specifies whether the connection is established to the server by using Windows Authentication or SQL Server Authentication. (Inherited from ConnectionSettings.)
	MaxPoolSize	Gets or sets the maximum number of connections in a connection pool that the specified connection accepts when establishing a connection with a server. (Inherited from ConnectionSettings.)
	MinPoolSize	Gets or sets the minimum number of connections in a connection pool that the specified connection accepts when establishing a connection with a server. (Inherited from ConnectionSettings.)
	MultipleActiveResultSets	Gets or sets the Boolean property value that specifies whether more than one active result set is permitted. (Inherited from ConnectionSettings.)
	NetworkProtocol	Gets or sets the network protocol used to establish the connection to the server. (Inherited from ConnectionSettings.)
	NonPooledConnection	Gets or sets the Boolean property value that specifies whether the connection may be pooled or nonpooled. (Inherited from ConnectionSettings.)
	PacketSize	Gets or sets the packets of data sent between the client and the server over the network in bytes. (Inherited from ConnectionSettings.)
	Password	Gets or sets the password used with the logon to establish a connection with the server when SQL Server Authentication is used. (Inherited from ConnectionSettings.)
	PooledConnectionLifetime	Gets or sets the lifetime of the pooled connection. (Inherited from ConnectionSettings.)
	ResetConnectionString	Gets or sets a Boolean value that specifies whether a node in the connection string has been changed. (Inherited from ConnectionSettings.)
	SecureConnectionString	Gets or sets an encrypted version of the connection string. (Inherited from ConnectionSettings.)
	SecurePassword	Gets or sets the secure password used with the logon to establish a connection with the server when SQL Server Authentication is used. (Inherited from ConnectionSettings.)
	ServerInstance	Gets or sets the name of the server. (Inherited from ConnectionSettings.)
	ServerVersion	Gets the version of the connected instance of SQL Server.
	SqlConnectionObject	Gets the connection object.
	WorkstationId	Gets or sets the ID value that uniquely identifies the workstation. (Inherited from ConnectionSettings.)

Top

Methods

	Name	Description
	CheckServerVersion	Checks the version of the target instance of SQL Server.
	Connect	Connects to the instance of SQL Server.
	Disconnect	Disconnects from the instance of SQL Server.
	Equals	(Inherited from Object.)
	ExecuteTSql	Executes a Transact-SQL command.
	Finalize	(Inherited from Object.)
	ForceDisconnected	Forces a disconnect from the instance of SQL Server.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	MemberwiseClone	(Inherited from Object.)
	ThrowIfPropertyNotSet(String, String)	Throws an exception if the specified connection property is null or empty. (Inherited from ConnectionSettings.)
	ThrowIfPropertyNotSet(String, String, Boolean)	Throws an exception if the specified connection property is null or, optionally, empty. (Inherited from ConnectionSettings.)
	ToString	Returns the referenced object name as a string. (Inherited from ConnectionSettings.)

Top

Events

	Name	Description
	InfoMessage	The event that occurs when the instance of SQL Server generates an informational message.
	RemoteLoginFailed	This event occurs when a remote login fails to connect to the instance of SQL Server.
	ServerMessage	The event that occurs when SQL Server returns a warning or informational message on the current connection.
	StateChange	The event that occurs when the instance of SQL Server changes state.
	StatementExecuted	The event that occurs when the instance of SQL Server executes a statement on the current connection.

Top

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via