Classe ServerConnection

The ServerConnection object represents a connection to a server.

Hiérarchie d'héritage

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

Espace de noms :  Microsoft.SqlServer.Management.Common
Assembly :  Microsoft.SqlServer.ConnectionInfo (en Microsoft.SqlServer.ConnectionInfo.dll)

Syntaxe

'Déclaration
Public NotInheritable Class ServerConnection _
    Inherits ConnectionManager _
    Implements ISfcConnection
'Utilisation
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

Le type ServerConnection expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique ServerConnection() () () () Initializes a new instance of the ServerConnection class.
Méthode publique ServerConnection(SqlConnection) Initializes a new instance of the ServerConnection class with the specified connection parameters.
Méthode publique ServerConnection(String) Initializes a new instance of the ServerConnection class with the specified server instance.
Méthode publique ServerConnection(SqlConnectionInfo) Initializes a new instance of the ServerConnection class with the specified connection information.
Méthode publique ServerConnection(String, String, SecureString) Initializes a new instance of the ServerConnection class with the specified server instance and logon credentials.
Méthode publique ServerConnection(String, String, String) Initializes a new instance of the ServerConnection class with the specified server instance and logon credentials.

Haut de la page

Propriétés

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

Haut de la page

Méthodes

  Nom Description
Méthode publique BeginTransaction Starts a transaction on the referenced connection.
Méthode publique Cancel Cancels the connection.
Méthode publique ChangePassword(SecureString) Changes the login password that is used with standard authentication.
Méthode publique ChangePassword(String) Changes the logon password that is used with standard authentication.
Méthode protégée CheckServerVersion Checks the version of the target instance of SQL Server. (hérité de ConnectionManager.)
Méthode publique CommitTransaction Commits the current transaction on the referenced connection.
Méthode publique Connect Connects to the instance of SQL Server. (hérité de ConnectionManager.)
Méthode publique Copy Returns a copy of the ServerConnection object.
Méthode publique Disconnect Disconnects from the instance of SQL Server. (hérité de ConnectionManager.)
Méthode publique Equals (hérité de Object.)
Méthode publique ExecuteNonQuery(StringCollection) Executes a batch of statements that do not return a result set.
Méthode publique ExecuteNonQuery(String) Executes a statement that does not return a result set.
Méthode publique ExecuteNonQuery(StringCollection, ExecutionTypes) Executes a batch of statements with the specified execution options that does not return a result set.
Méthode publique ExecuteNonQuery(String, ExecutionTypes) Executes a statement with the specified execution options that does not return a result set.
Méthode publique ExecuteReader(String) Executes Transact-SQL statements that return one or multiple result sets.
Méthode publique ExecuteReader(String, SqlCommand%) Executes a reader using a SqlDataReader object value that contains one or more result sets.
Méthode publique ExecuteScalar(StringCollection) Executes a batch of Transact-SQL statements and returns the first column of the first row as an object value.
Méthode publique ExecuteScalar(String) Executes a Transact-SQL statement and returns the first column of the first row as an object value.
Méthode protégée ExecuteTSql Executes a Transact-SQL command. (hérité de ConnectionManager.)
Méthode publique ExecuteWithResults(StringCollection) Executes a batch of Transact-SQL statements that return multiple result sets.
Méthode publique ExecuteWithResults(String) Executes a Transact-SQL statement that returns a result set.
Méthode protégée Finalize (hérité de Object.)
Méthode publique ForceDisconnected Forces a disconnect from the instance of SQL Server. (hérité de ConnectionManager.)
Méthode publique GetHashCode (hérité de Object.)
Méthode publique GetType (hérité de Object.)
Méthode publique IsInFixedServerRole Tests whether the logon associated with the referenced connection is a member of the specified fixed server role.
Méthode protégée MemberwiseClone (hérité de Object.)
Méthode publiqueMembre statique NormalizeQuery(String) Uses a string input that represents the query text.
Méthode publiqueMembre statique NormalizeQuery(String, Boolean) Normalizes the query that controls the server connection.
Méthode publique RollBackTransaction Rolls back the current transaction.
Méthode protégée ThrowIfPropertyNotSet(String, String) Throws an exception if the specified connection property is null or empty. (hérité de ConnectionSettings.)
Méthode protégée ThrowIfPropertyNotSet(String, String, Boolean) Throws an exception if the specified connection property is null or, optionally, empty. (hérité de ConnectionSettings.)
Méthode publique ToString Returns the referenced object name as a string. (hérité de ConnectionSettings.)

Haut de la page

Événements

  Nom Description
Événement public InfoMessage The event that occurs when the instance of SQL Server generates an informational message.  (hérité de ConnectionManager.)
Événement public RemoteLoginFailed This event occurs when a remote login fails to connect to the instance of SQL Server. (hérité de ConnectionManager.)
Événement public ServerMessage The event that occurs when SQL Server returns a warning or informational message on the current connection. (hérité de ConnectionManager.)
Événement public StateChange The event that occurs when the instance of SQL Server changes state.  (hérité de ConnectionManager.)
Événement public StatementExecuted The event that occurs when the instance of SQL Server executes a statement on the current connection.  (hérité de ConnectionManager.)

Haut de la page

Implémentations d'interfaces explicites

  Nom Description
Implémentation d'interface expliciteMéthode privée ISfcConnection. . :: . .Connect Returns a value that indicates the server to connect using an SFC connection.
Implémentation d'interface expliciteMéthode privée ISfcConnection. . :: . .Copy Uses the SFC connection to copy the server connection.
Implémentation d'interface expliciteMéthode privée ISfcConnection. . :: . .Disconnect Disconnects the connection.
Implémentation d'interface explicitePropriété privée ISfcConnection. . :: . .ServerVersion Gets the version of the server.
Implémentation d'interface expliciteMéthode privée ISfcConnection. . :: . .ToEnumeratorObject Renders an enumerator object for the server connection.

Haut de la page

Notes

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.

Exemples

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

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.