Classe ServerConnection

  • Article

L'objet ServerConnection représente une connexion à un serveur.

Hiérarchie d'héritage

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() Initialise une nouvelle instance de la classe ServerConnection.
Méthode publique ServerConnection(SqlConnection) Initialise une nouvelle instance de la classe ServerConnection avec les paramètres de connexion spécifiés.
Méthode publique ServerConnection(String) Initialise une nouvelle instance de la classe ServerConnection avec l'instance de serveur spécifiée.
Méthode publique ServerConnection(SqlConnectionInfo) Initialise une nouvelle instance de la classe ServerConnection avec les informations de connexion spécifiées.
Méthode publique ServerConnection(String, String, SecureString) Initialise une nouvelle instance de la classe ServerConnection avec l'instance de serveur et les informations d'identification d'ouverture de session spécifiées.
Méthode publique ServerConnection(String, String, String) Initialise une nouvelle instance de la classe ServerConnection avec l'instance de serveur et les informations d'identification d'ouverture de session spécifiées.

Haut

Propriétés

  Nom Description
Propriété publique ApplicationName Obtient ou définit le nom de l'application qui a établi la connexion avec le serveur. (hérité de ConnectionSettings.)
Propriété publique AutoDisconnectMode Obtient ou définit le mode de déconnexion automatique de la connexion référencée sur l'instance de SQL Server. (hérité de ConnectionManager.)
Propriété publique BatchSeparator Obtient ou définit la valeur de chaîne utilisée pour séparer les lots dans la connexion référencée.
Propriété publique CapturedSql Obtient les instructions Transact-SQL capturées lorsque la connexion s'exécute en mode de capture. (hérité de ConnectionManager.)
Propriété publique ConnectAsUser Obtient ou définit la valeur de propriété Boolean qui spécifie si la connexion est établie à l'aide de l'emprunt d'identité. (hérité de ConnectionSettings.)
Propriété publique ConnectAsUserName Obtient ou définit le nom de l'utilisateur lors de la connexion à l'aide de l'emprunt d'identité. (hérité de ConnectionSettings.)
Propriété publique ConnectAsUserPassword Obtient ou définit le mot de passe de l'utilisateur lors de la connexion à l'aide de l'emprunt d'identité. (hérité de ConnectionSettings.)
Propriété publique ConnectionString Obtient ou définit la chaîne de connexion utilisée pour établir une connexion avec une source de données spécifiée. (hérité de ConnectionSettings.)
Propriété publique ConnectionType Obtient le type de connexion à utiliser sur le serveur.
Propriété publique ConnectTimeout Obtient ou définit le délai d'attente de la connexion, en secondes. (hérité de ConnectionSettings.)
Propriété publique DatabaseEngineType Obtient le type de moteur de base de données. (hérité de ConnectionManager.)
Propriété publique DatabaseName Obtient ou définit la base de données requise par la connexion. (hérité de ConnectionSettings.)
Propriété publique EncryptConnection Obtient ou définit la valeur de propriété Boolean qui spécifie si la connexion est chiffrée. (hérité de ConnectionSettings.)
Propriété publique FixedServerRoles Obtient le rôle serveur fixe associé à la connexion référencée.
Propriété publique InUse Obtient ou définit la valeur de la propriété Boolean qui spécifie si la connexion est utilisée. (hérité de ConnectionManager.)
Propriété publique IsForceDisconnected Obtient une valeur Boolean qui spécifie si la connexion a été déconnectée de force. (hérité de ConnectionManager.)
Propriété publique IsOpen Obtient la valeur de la propriété Boolean qui spécifie si la connexion est actuellement ouverte. (hérité de ConnectionManager.)
Propriété publique LockTimeout Obtient ou définit la durée, en secondes, nécessaire pour l'expiration du délai d'attente de la connexion lorsque la transaction actuelle est verrouillée. (hérité de ConnectionManager.)
Propriété publique Login Obtient ou définit l'ouverture de session requise pour établir une connexion avec l'instance du serveur. (hérité de ConnectionSettings.)
Propriété publique LoginSecure Obtient ou définit la propriété Boolean qui spécifie si la connexion est établie au serveur à l'aide de l'authentification Windows ou de l'authentification SQL Server. (hérité de ConnectionSettings.)
Propriété publique MaxPoolSize Obtient ou définit le nombre maximal de connexions d'un pool que la connexion spécifiée accepte lors de l'établissement d'une connexion avec un serveur. (hérité de ConnectionSettings.)
Propriété publique MinPoolSize Obtient ou définit le nombre minimal de connexions d'un pool que la connexion spécifiée accepte lors de l'établissement d'une connexion avec un serveur. (hérité de ConnectionSettings.)
Propriété publique MultipleActiveResultSets Obtient ou définit la valeur de propriété Boolean qui spécifie si plusieurs jeux de résultats actifs sont autorisés. (hérité de ConnectionSettings.)
Propriété publique NetworkProtocol Obtient ou définit le protocole réseau utilisé pour établir la connexion au serveur. (hérité de ConnectionSettings.)
Propriété publique NonPooledConnection Obtient ou définit la valeur de propriété Boolean qui spécifie si la connexion peut être regroupée ou non. (hérité de ConnectionSettings.)
Propriété publique PacketSize Obtient ou définit la taille, en octets, des paquets de données envoyés entre le client et le serveur sur le réseau. (hérité de ConnectionSettings.)
Propriété publiqueMembre statique ParameterizationMode Obtient ou définit le mode de paramétrage pour la connexion de serveur.
Propriété publique Password Obtient ou définit le mot de passe utilisé avec l'ouverture de session pour établir une connexion avec le serveur lorsque l'authentification SQL Server est utilisée. (hérité de ConnectionSettings.)
Propriété publique PooledConnectionLifetime Obtient ou définit la durée de vie de la connexion regroupée. (hérité de ConnectionSettings.)
Propriété publique ProcessID Obtient la valeur d'ID qui identifie de façon unique le processus associé à la connexion référencée au serveur.
Propriété publique SecureConnectionString Obtient ou définit une version chiffrée de la chaîne de connexion. (hérité de ConnectionSettings.)
Propriété publique SecurePassword Obtient ou définit le mot de passe sécurisé utilisé avec l'ouverture de session pour établir une connexion avec le serveur lorsque l'authentification SQL Server est utilisée. (hérité de ConnectionSettings.)
Propriété publique ServerInstance Obtient ou définit le nom du serveur. (hérité de ConnectionSettings.)
Propriété publique ServerVersion Obtient la version de l'instance connectée de SQL Server. (hérité de ConnectionManager.)
Propriété publique SqlConnectionObject Obtient l'objet de connexion. (hérité de ConnectionManager.)
Propriété publique SqlExecutionModes Obtient ou définit le mode d'exécution associé à la connexion référencée au serveur.
Propriété publique StatementTimeout Obtient ou définit le nombre de secondes accordées à une instruction pour s'exécuter avant de se solder par un échec avec une erreur de temporisation.
Propriété publique TransactionDepth Obtient la profondeur de la transaction actuelle pour la connexion référencée.
Propriété publique TrueLogin Obtient le nom de l'enregistrement d'ouverture de session actuel utilisé par la connexion référencée.
Propriété publique TrueName Obtient le nom du serveur.
Propriété publiqueMembre statique UseMode Obtient ou définit la connexion de serveur à l'aide d'un mode spécifié.
Propriété publique UserProfile Obtient le profil utilisateur associé à la connexion référencée.
Propriété publique WorkstationId Obtient ou définit la valeur d'ID qui identifie la station de travail de façon unique. (hérité de ConnectionSettings.)

Haut

Méthodes

  Nom Description
Méthode publique BeginTransaction Démarre une transaction sur la connexion référencée.
Méthode publique Cancel Annule la connexion.
Méthode publique ChangePassword(SecureString) Remplace le mot de passe de connexion utilisé par l'authentification standard.
Méthode publique ChangePassword(String) Modifie le mot de passe d'ouverture de session utilisé avec l'authentification standard.
Méthode publique CommitTransaction Valide la transaction actuelle sur la connexion référencée.
Méthode publique Connect Établit une connexion à l'instance de SQL Server. (hérité de ConnectionManager.)
Méthode publique Copy Retourne une copie de l'objet ServerConnection.
Méthode publique Disconnect Se déconnecte de l'instance de SQL Server. (hérité de ConnectionManager.)
Méthode publique Equals (hérité de Object.)
Méthode publique ExecuteNonQuery(StringCollection) Exécute un lot d'instructions qui ne retournent pas de jeu de résultats.
Méthode publique ExecuteNonQuery(String) Exécute une instruction qui ne retourne pas de jeu de résultats.
Méthode publique ExecuteNonQuery(StringCollection, ExecutionTypes) Exécute un lot d'instructions avec les options d'exécution spécifiées qui ne retourne pas de jeu de résultats.
Méthode publique ExecuteNonQuery(String, ExecutionTypes) Exécute une instruction avec les options d'exécution spécifiées qui ne retourne pas de jeu de résultats.
Méthode publique ExecuteReader(String) Exécute des instructions Transact-SQL qui retournent un ou plusieurs jeux de résultats.
Méthode publique ExecuteReader(String, SqlCommand%) Exécute un lecteur à l'aide d'une valeur d'objet SqlDataReader qui contient un ou plusieurs jeux de résultats.
Méthode publique ExecuteScalar(StringCollection) Exécute un lot d'instructions Transact-SQL et retourne la première colonne de la première ligne comme valeur d'objet.
Méthode publique ExecuteScalar(String) Exécute une instruction Transact-SQL et retourne la première colonne de la première ligne comme valeur d'objet.
Méthode publique ExecuteWithResults(StringCollection) Exécute un lot d'instructions Transact-SQL qui retournent plusieurs jeux de résultats.
Méthode publique ExecuteWithResults(String) Exécute une instruction Transact-SQL qui retourne un jeu de résultats.
Méthode publique ForceDisconnected Force une déconnexion de l'instance de 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 Teste si l'ouverture de session associée à la connexion référencée est membre du rôle serveur fixe spécifié.
Méthode publiqueMembre statique NormalizeQuery(String) Utilise une entrée de chaîne qui représente le texte de la requête.
Méthode publiqueMembre statique NormalizeQuery(String, Boolean) Normalise la requête qui contrôle la connexion de serveur.
Méthode publique RollBackTransaction Restaure la transaction actuelle.
Méthode publique ToString Retourne le nom de l'objet référencé sous forme de chaîne. (hérité de ConnectionSettings.)

Haut

Événements

  Nom Description
Événement public InfoMessage Événement qui se produit lorsque l'instance de SQL Server génère un message d'information.  (hérité de ConnectionManager.)
Événement public RemoteLoginFailed Cet événement se produit lorsqu'une connexion distante ne parvient pas à se connecter à l'instance de SQL Server. (hérité de ConnectionManager.)
Événement public ServerMessage Événement qui se produit lorsque SQL Server retourne un avertissement ou un message d'information sur la connexion actuelle. (hérité de ConnectionManager.)
Événement public StateChange Événement qui se produit lorsque l'instance de SQL Server change d'état.  (hérité de ConnectionManager.)
Événement public StatementExecuted Événement qui se produit lorsque l'instance de SQL Server exécute une instruction sur la connexion actuelle.  (hérité de ConnectionManager.)

Haut

Implémentations d'interfaces explicites

  Nom Description
Implémentation d'interface expliciteMéthode privée ISfcConnection.Connect Retourne une valeur qui indique le serveur auquel se connecter à l'aide d'une connexion SFC.
Implémentation d'interface expliciteMéthode privée ISfcConnection.Copy Utilise la connexion SFC pour copier la connexion de serveur.
Implémentation d'interface expliciteMéthode privée ISfcConnection.Disconnect Met fin à la connexion.
Implémentation d'interface explicitePropriété privée ISfcConnection.ServerVersion Obtient la version du serveur.
Implémentation d'interface expliciteMéthode privée ISfcConnection.ToEnumeratorObject Effectue le rendu d'un objet énumérateur pour la connexion de serveur.

Haut

Notes

La classe d'ServerConnection est servie par la classe d'Server les classes de réplication par exemple classent ReplicationServer.

En règle générale, vous devez ne pas une instance état de l'objet ServerConnection de car il est créé automatiquement avec l'objet Server. Déclarer une variable d'objet ServerConnection si vous voulez stocker les paramètres de connexion pour le réutiliser. La propriété d'ConnectionContext les points d'objet Server en objet de ServerConnection. L'objet de ServerConnection contient les propriétés qui font référence à la connexion entre l'objet Server et l'instance de SQL Server. Vous pouvez utiliser pour l'afficher ou modifier certains aspects de la connexion, tels que l'ID de processus, le traitement des transactions, le mode d'authentification, mode d'exécution, et réexécuter même des commandes de directement. Transact-SQL

En utilisant aide de l'objet de ServerConnection, vous pouvez procéder comme suit :

  • Exécuter les instructions d'Transact-SQL directement sur la connexion à l'instance de SQL Server.

  • Modifiez les paramètres de connexion, tels que la méthode d'authentification.

  • Démarrer, roulez et validez les transactions validées.

  • Capturez les instructions d'Transact-SQL générées par l'application SMO.

Exemples

Pour un autre exemple de cette méthode avec l'objet d'Database, [M:Microsoft.SqlServer.Management.Smo.Database.ExecuteNonQuery(System.String]l'afficher.

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.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Management.Common

Autres ressources

Connexion à une instance de SQL Server

Connexion à une instance de SQL Server