Compartir a través de

Clase ServerConnection

  • Artículo

The ServerConnection object represents a connection to a server.

Jerarquía de herencia

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

Espacio de nombres:  Microsoft.SqlServer.Management.Common
Ensamblado:  Microsoft.SqlServer.ConnectionInfo (en Microsoft.SqlServer.ConnectionInfo.dll)

Sintaxis

'Declaración
Public NotInheritable Class ServerConnection _
    Inherits ConnectionManager _
    Implements ISfcConnection
'Uso
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

El tipo ServerConnection expone los siguientes miembros.

Constructores

  Nombre Descripción
Método público ServerConnection() Initializes a new instance of the ServerConnection class.
Método público ServerConnection(SqlConnection) Initializes a new instance of the ServerConnection class with the specified connection parameters.
Método público ServerConnection(String) Initializes a new instance of the ServerConnection class with the specified server instance.
Método público ServerConnection(SqlConnectionInfo) Initializes a new instance of the ServerConnection class with the specified connection information.
Método público ServerConnection(String, String, SecureString) Initializes a new instance of the ServerConnection class with the specified server instance and logon credentials.
Método público ServerConnection(String, String, String) Initializes a new instance of the ServerConnection class with the specified server instance and logon credentials.

Arriba

Propiedades

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

Arriba

Métodos

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

Arriba

Eventos

  Nombre Descripción
Evento público InfoMessage The event that occurs when the instance of SQL Server generates an informational message.  (Se hereda de ConnectionManager.)
Evento público RemoteLoginFailed This event occurs when a remote login fails to connect to the instance of SQL Server. (Se hereda de ConnectionManager.)
Evento público ServerMessage The event that occurs when SQL Server returns a warning or informational message on the current connection. (Se hereda de ConnectionManager.)
Evento público StateChange The event that occurs when the instance of SQL Server changes state.  (Se hereda de ConnectionManager.)
Evento público StatementExecuted The event that occurs when the instance of SQL Server executes a statement on the current connection.  (Se hereda de ConnectionManager.)

Arriba

Implementaciones de interfaces explícitas

  Nombre Descripción
Implementación de interfaces explícitasMétodo privado ISfcConnection.Connect Returns a value that indicates the server to connect using an SFC connection.
Implementación de interfaces explícitasMétodo privado ISfcConnection.Copy Uses the SFC connection to copy the server connection.
Implementación de interfaces explícitasMétodo privado ISfcConnection.Disconnect Disconnects the connection.
Implementación de interfaces explícitasPropiedad privada ISfcConnection.ServerVersion Gets the version of the server.
Implementación de interfaces explícitasMétodo privado ISfcConnection.ToEnumeratorObject Renders an enumerator object for the server connection.

Arriba

Comentarios

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.

Ejemplos

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

Seguridad para subprocesos

Cualquier miembro público static (Shared en Visual Basic) de este tipo es seguro para subprocesos. No se garantiza que los miembros de instancia sean seguros para subprocesos.

Vea también

Referencia

Espacio de nombres Microsoft.SqlServer.Management.Common

Otros recursos

Conectarse a una instancia de SQL Server

Conectarse a una instancia de SQL Server