Поделиться через


Класс 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.
Открытое свойство 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.
Открытый метод 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.
Открытый метод 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.
Открытый метод 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.
Открытый методСтатический элемент 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.
Открытый метод 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

Безопасность многопоточности

Любые открытые статический (Shared в Visual Basic) элементы этого типа потокобезопасны. Потокобезопасность с элементами экземпляров не гарантируется.

См. также

Справочник

Пространство имен Microsoft.SqlServer.Management.Common

Другие ресурсы

Соединение с экземпляром SQL Server

Соединение с экземпляром SQL Server