Condividi tramite


Classe ServerConnection

The ServerConnection object represents a connection to a server.

Gerarchia di ereditarietà

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

Spazio dei nomi  Microsoft.SqlServer.Management.Common
Assembly:  Microsoft.SqlServer.ConnectionInfo (in Microsoft.SqlServer.ConnectionInfo.dll)

Sintassi

'Dichiarazione
Public NotInheritable Class ServerConnection _
    Inherits ConnectionManager _
    Implements ISfcConnection
'Utilizzo
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

Nel tipo ServerConnection sono esposti i membri seguenti.

Costruttori

  Nome Descrizione
Metodo pubblico ServerConnection() () () () Initializes a new instance of the ServerConnection class.
Metodo pubblico ServerConnection(SqlConnection) Initializes a new instance of the ServerConnection class with the specified connection parameters.
Metodo pubblico ServerConnection(String) Initializes a new instance of the ServerConnection class with the specified server instance.
Metodo pubblico ServerConnection(SqlConnectionInfo) Initializes a new instance of the ServerConnection class with the specified connection information.
Metodo pubblico ServerConnection(String, String, SecureString) Initializes a new instance of the ServerConnection class with the specified server instance and logon credentials.
Metodo pubblico ServerConnection(String, String, String) Initializes a new instance of the ServerConnection class with the specified server instance and logon credentials.

In alto

Proprietà

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

In alto

Metodi

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

In alto

Eventi

  Nome Descrizione
Evento pubblico InfoMessage The event that occurs when the instance of SQL Server generates an informational message.  Ereditato da ConnectionManager.
Evento pubblico RemoteLoginFailed This event occurs when a remote login fails to connect to the instance of SQL Server. Ereditato da ConnectionManager.
Evento pubblico ServerMessage The event that occurs when SQL Server returns a warning or informational message on the current connection. Ereditato da ConnectionManager.
Evento pubblico StateChange The event that occurs when the instance of SQL Server changes state.  Ereditato da ConnectionManager.
Evento pubblico StatementExecuted The event that occurs when the instance of SQL Server executes a statement on the current connection.  Ereditato da ConnectionManager.

In alto

Implementazioni esplicite dell'interfaccia

  Nome Descrizione
Implementazione esplicita dell'interfacciaMetodo privato ISfcConnection. . :: . .Connect Returns a value that indicates the server to connect using an SFC connection.
Implementazione esplicita dell'interfacciaMetodo privato ISfcConnection. . :: . .Copy Uses the SFC connection to copy the server connection.
Implementazione esplicita dell'interfacciaMetodo privato ISfcConnection. . :: . .Disconnect Disconnects the connection.
Implementazione esplicita dell'interfacciaProprietà privata ISfcConnection. . :: . .ServerVersion Gets the version of the server.
Implementazione esplicita dell'interfacciaMetodo privato ISfcConnection. . :: . .ToEnumeratorObject Renders an enumerator object for the server connection.

In alto

Osservazioni

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.

Esempi

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

Protezione dei thread

I membri static (Shared in Visual Basic) pubblici di questo tipo sono affidabili. Non è invece garantita la sicurezza dei membri dell'istanza.