共用方式為


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.
受保護的屬性 ResetConnectionString Gets or sets a Boolean value that specifies whether a node in the connection string has been changed. (繼承自 ConnectionSettings。)
公用屬性 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.
受保護的方法 CheckServerVersion Checks the version of the target instance of SQL Server. (繼承自 ConnectionManager。)
公用方法 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.
受保護的方法 ExecuteTSql Executes a Transact-SQL command. (繼承自 ConnectionManager。)
公用方法 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.
受保護的方法 Finalize (繼承自 Object。)
公用方法 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.
受保護的方法 MemberwiseClone (繼承自 Object。)
公用方法靜態成員 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.
受保護的方法 ThrowIfPropertyNotSet(String, String) Throws an exception if the specified connection property is null or empty. (繼承自 ConnectionSettings。)
受保護的方法 ThrowIfPropertyNotSet(String, String, Boolean) Throws an exception if the specified connection property is null or, optionally, empty. (繼承自 ConnectionSettings。)
公用方法 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) 成員都是執行緒安全的。並不是所有的執行個體成員都保證可以用於所有的執行緒。