ServerConnection 类

The ServerConnection object represents a connection to a server.

继承层次结构

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

命名空间：  Microsoft.SqlServer.Management.Common
程序集：  Microsoft.SqlServer.ConnectionInfo（在 Microsoft.SqlServer.ConnectionInfo.dll 中）

语法

声明
Public NotInheritable Class ServerConnection _
    Inherits ConnectionManager _
    Implements ISfcConnection
用法
Dim instance As ServerConnection

public sealed class ServerConnection : ConnectionManager, 
    ISfcConnection

public ref class ServerConnection sealed : public ConnectionManager, 
    ISfcConnection

[<SealedAttribute>]
type ServerConnection =  
    class 
        inherit ConnectionManager 
        interface ISfcConnection 
    end

public final class ServerConnection extends ConnectionManager implements ISfcConnection

ServerConnection 类型公开以下成员。

构造函数

	名称	说明
	ServerConnection()	Initializes a new instance of the ServerConnection class.
	ServerConnection(SqlConnection)	Initializes a new instance of the ServerConnection class with the specified connection parameters.
	ServerConnection(String)	Initializes a new instance of the ServerConnection class with the specified server instance.
	ServerConnection(SqlConnectionInfo)	Initializes a new instance of the ServerConnection class with the specified connection information.
	ServerConnection(String, String, SecureString)	Initializes a new instance of the ServerConnection class with the specified server instance and logon credentials.
	ServerConnection(String, String, String)	Initializes a new instance of the ServerConnection class with the specified server instance and logon credentials.

页首

属性

	名称	说明
	ApplicationName	Gets or sets the name of the application that has established the connection with the server. （从 ConnectionSettings 继承。）
	AutoDisconnectMode	Gets or sets the automatic disconnection mode of the referenced connection to the instance of SQL Server. （从 ConnectionManager 继承。）
	BatchSeparator	Gets or sets the string value used to separate batches in the referenced connection.
	CapturedSql	Gets the Transact-SQL statements that are captured when the connection is running in capture mode. （从 ConnectionManager 继承。）
	ConnectAsUser	Gets or sets the Boolean property value that specifies whether the connection is established using impersonation. （从 ConnectionSettings 继承。）
	ConnectAsUserName	Gets or sets the name of the user when connecting using impersonation. （从 ConnectionSettings 继承。）
	ConnectAsUserPassword	Gets or sets the password for the user when connecting using impersonation. （从 ConnectionSettings 继承。）
	ConnectionString	Gets or sets the connection string used to establish a connection with a specified data source. （从 ConnectionSettings 继承。）
	ConnectionType	Gets the type of connection to use in the server.
	ConnectTimeout	Gets or sets the connection time-out period in seconds. （从 ConnectionSettings 继承。）
	DatabaseEngineType	Gets the database engine type. （从 ConnectionManager 继承。）
	DatabaseName	Gets or sets the database required by the connection. （从 ConnectionSettings 继承。）
	EncryptConnection	Gets or sets the Boolean property value that specifies whether the connection is encrypted. （从 ConnectionSettings 继承。）
	FixedServerRoles	Gets the fixed server role associated with the referenced connection.
	InUse	Gets or sets the Boolean property value that specifies whether the connection is being used. （从 ConnectionManager 继承。）
	IsForceDisconnected	Gets a Boolean value that specifies whether the connection was forcibly disconnected. （从 ConnectionManager 继承。）
	IsOpen	Gets the Boolean property value that specifies whether the connection is currently open. （从 ConnectionManager 继承。）
	LockTimeout	Gets or sets the time in seconds required for the connection to time out when the current transaction is locked. （从 ConnectionManager 继承。）
	Login	Gets or sets the logon required to establish a connection with the instance of the server. （从 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. （从 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. （从 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. （从 ConnectionSettings 继承。）
	MultipleActiveResultSets	Gets or sets the Boolean property value that specifies whether more than one active result set is permitted. （从 ConnectionSettings 继承。）
	NetworkProtocol	Gets or sets the network protocol used to establish the connection to the server. （从 ConnectionSettings 继承。）
	NonPooledConnection	Gets or sets the Boolean property value that specifies whether the connection may be pooled or nonpooled. （从 ConnectionSettings 继承。）
	PacketSize	Gets or sets the packets of data sent between the client and the server over the network in bytes. （从 ConnectionSettings 继承。）
	ParameterizationMode	Gets or sets the parameterization mode for the server connection.
	Password	Gets or sets the password used with the logon to establish a connection with the server when SQL Server Authentication is used. （从 ConnectionSettings 继承。）
	PooledConnectionLifetime	Gets or sets the lifetime of the pooled connection. （从 ConnectionSettings 继承。）
	ProcessID	Gets the ID value that uniquely identifies the process associated with the referenced connection to the server.
	SecureConnectionString	Gets or sets an encrypted version of the connection string. （从 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. （从 ConnectionSettings 继承。）
	ServerInstance	Gets or sets the name of the server. （从 ConnectionSettings 继承。）
	ServerVersion	Gets the version of the connected instance of SQL Server. （从 ConnectionManager 继承。）
	SqlConnectionObject	Gets the connection object. （从 ConnectionManager 继承。）
	SqlExecutionModes	Gets or sets the execution mode associated with the referenced connection to the server.
	StatementTimeout	Gets or sets the number of seconds a statement is given to run before failing with a time-out error.
	TransactionDepth	Gets the current transaction depth for the referenced connection.
	TrueLogin	Gets the current logon record name used by the referenced connection.
	TrueName	Gets the name of the server.
	UseMode	Gets or sets the server connection using a specified mode.
	UserProfile	Gets the user profile associated with the referenced connection.
	WorkstationId	Gets or sets the ID value that uniquely identifies the workstation. （从 ConnectionSettings 继承。）

页首

方法

	名称	说明
	BeginTransaction	Starts a transaction on the referenced connection.
	Cancel	Cancels the connection.
	ChangePassword(SecureString)	Changes the login password that is used with standard authentication.
	ChangePassword(String)	Changes the logon password that is used with standard authentication.
	CommitTransaction	Commits the current transaction on the referenced connection.
	Connect	Connects to the instance of SQL Server. （从 ConnectionManager 继承。）
	Copy	Returns a copy of the ServerConnection object.
	Disconnect	Disconnects from the instance of SQL Server. （从 ConnectionManager 继承。）
	Equals	（从 Object 继承。）
	ExecuteNonQuery(StringCollection)	Executes a batch of statements that do not return a result set.
	ExecuteNonQuery(String)	Executes a statement that does not return a result set.
	ExecuteNonQuery(StringCollection, ExecutionTypes)	Executes a batch of statements with the specified execution options that does not return a result set.
	ExecuteNonQuery(String, ExecutionTypes)	Executes a statement with the specified execution options that does not return a result set.
	ExecuteReader(String)	Executes Transact-SQL statements that return one or multiple result sets.
	ExecuteReader(String, SqlCommand%)	Executes a reader using a SqlDataReader object value that contains one or more result sets.
	ExecuteScalar(StringCollection)	Executes a batch of Transact-SQL statements and returns the first column of the first row as an object value.
	ExecuteScalar(String)	Executes a Transact-SQL statement and returns the first column of the first row as an object value.
	ExecuteWithResults(StringCollection)	Executes a batch of Transact-SQL statements that return multiple result sets.
	ExecuteWithResults(String)	Executes a Transact-SQL statement that returns a result set.
	ForceDisconnected	Forces a disconnect from the instance of SQL Server. （从 ConnectionManager 继承。）
	GetHashCode	（从 Object 继承。）
	GetType	（从 Object 继承。）
	IsInFixedServerRole	Tests whether the logon associated with the referenced connection is a member of the specified fixed server role.
	NormalizeQuery(String)	Uses a string input that represents the query text.
	NormalizeQuery(String, Boolean)	Normalizes the query that controls the server connection.
	RollBackTransaction	Rolls back the current transaction.
	ToString	Returns the referenced object name as a string. （从 ConnectionSettings 继承。）

页首

事件

	名称	说明
	InfoMessage	The event that occurs when the instance of SQL Server generates an informational message.  （从 ConnectionManager 继承。）
	RemoteLoginFailed	This event occurs when a remote login fails to connect to the instance of SQL Server. （从 ConnectionManager 继承。）
	ServerMessage	The event that occurs when SQL Server returns a warning or informational message on the current connection. （从 ConnectionManager 继承。）
	StateChange	The event that occurs when the instance of SQL Server changes state.  （从 ConnectionManager 继承。）
	StatementExecuted	The event that occurs when the instance of SQL Server executes a statement on the current connection.  （从 ConnectionManager 继承。）

页首

显式接口实现

	名称	说明
	ISfcConnection.Connect	Returns a value that indicates the server to connect using an SFC connection.
	ISfcConnection.Copy	Uses the SFC connection to copy the server connection.
	ISfcConnection.Disconnect	Disconnects the connection.
	ISfcConnection.ServerVersion	Gets the version of the server.
	ISfcConnection.ToEnumeratorObject	Renders an enumerator object for the server connection.

页首

注释

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.

示例

For another example of this method with the Database object, see [M:Microsoft.SqlServer.Management.Smo.Database.ExecuteNonQuery(System.String].

VB

'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.

PowerShell

$conn = new-object Microsoft.SqlServer.Management.Common.ServerConnection
$conn.LoginSecure = $FALSE
$conn.Login = vlogin
$conn.Password = vpassword
#Connect to the local, default instance of SQL Server
$srv = new-object Microsoft.SqlServer.Management.Smo.Server($conn)
Write-Host $srv.Information.Version

线程安全

此类型的任何公共 static（在 Visual Basic 中为 Shared） 成员都是线程安全的。不保证所有实例成员都是线程安全的。

请参阅

参考

Microsoft.SqlServer.Management.Common 命名空间

其他资源

连接到 SQL Server 实例

连接到 SQL Server 实例