ServerConnection Class

Article
12/03/2008

The ServerConnection object represents a connection to a server.

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

Syntax

'Declaration
Public NotInheritable Class ServerConnection
    Inherits ConnectionManager

public sealed class ServerConnection : ConnectionManager

public ref class ServerConnection sealed : public ConnectionManager

public final class ServerConnection extends ConnectionManager

public final class ServerConnection extends ConnectionManager

Remarks

Updated text:

The ServerConnection class is served by the Server class and replication classes such as the ReplicationServer class.

Typically, you don't have to declare an instance of the ServerConnection object because it is created automatically with the Server object. Declare a ServerConnection object variable if you want to store the connection settings for re-use. The ConnectionContext property of the Server object points to a ServerConnection object. The ServerConnection object contains properties that relate to the connection between the Server object and the instance of SQL Server. You can use it to view or modify certain aspects of the connection, such as the process ID, processing transactions, the authentication mode, execution mode, and even to run Transact-SQL commands directly.

By using the ServerConnection object, you can do the following:

Run Transact-SQL statements directly over the connection to the instance of SQL Server.
Change the connection settings, such as the authentication method.
Begin, commit and roll back transactions.
Capture the Transact-SQL statements generated by the SMO application.

This namespace, class, or member is supported only in version 2.0 of the Microsoft .NET Framework.

Inheritance Hierarchy

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

Example

For another example of this method with the Database object, see ExecuteNonQuery.

'Declare a ServerConnection object variable to specify SQL authentication, login and password.
Dim conn As New ServerConnection
conn.LoginSecure = False
conn.Login = vlogin
conn.Password = vpassword
'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server(conn)
'The actual connection is made when a property is retrieved.
Console.WriteLine(srv.Information.Version)
'The connection is automatically disconnected when the Server variable goes out of scope.

Thread Safety

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

Platforms

Development Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Target Platforms

For a list of the supported platforms, see Hardware and Software Requirements for Installing SQL Server 2005.

Change History

Release	History
	Changed content: Added to the description of the ServerConnection class. Added a code example to the Example section. Added overloads to the ExecuteNonQuery and ChangePassword methods.