ConnectionManager Class

  • Article

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

Inheritance Hierarchy

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

Top

Methods

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

Top

Events

  Name Description
Public event InfoMessage The event that occurs when the instance of SQL Server generates an informational message. 
Public event RemoteLoginFailed This event occurs when a remote login fails to connect to the instance of SQL Server.
Public event ServerMessage The event that occurs when SQL Server returns a warning or informational message on the current connection.
Public event StateChange The event that occurs when the instance of SQL Server changes state. 
Public event 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.

See Also

Reference

Microsoft.SqlServer.Management.Common Namespace