Класс ServerConnection

Объект ServerConnection представляет соединение с сервером.

Иерархия наследования

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()	Инициализирует новый экземпляр класса ServerConnection.
	ServerConnection(SqlConnection)	Инициализирует новый экземпляр класса ServerConnection с заданными параметрами соединения.
	ServerConnection(String)	Инициализирует новый экземпляр класса ServerConnection с заданным экземпляром сервера.
	ServerConnection(SqlConnectionInfo)	Инициализирует новый экземпляр класса ServerConnection с заданными сведениями о соединении.
	ServerConnection(String, String, SecureString)	Инициализирует новый экземпляр класса ServerConnection с заданным экземпляром сервера и учетными данными входа.
	ServerConnection(String, String, String)	Инициализирует новый экземпляр класса ServerConnection с заданным экземпляром сервера и учетными данными входа.

В начало

Свойства

	Имя	Описание
	ApplicationName	Возвращает или задает имя приложения, установившего соединение с сервером. (Производный от ConnectionSettings.)
	AutoDisconnectMode	Возвращает или задает режим автоматического отключения указанного ссылкой соединения с экземпляром SQL Server. (Производный от ConnectionManager.)
	BatchSeparator	Возвращает или задает строковое значение, используемое для разделения пакетов в указанном соединении.
	CapturedSql	Возвращает инструкции Transact-SQL, затрагиваемые при работе соединения в режиме сбора команд. (Производный от ConnectionManager.)
	ConnectAsUser	Возвращает или задает значение свойства Boolean, показывающее, установлено ли соединение с помощью олицетворения. (Производный от ConnectionSettings.)
	ConnectAsUserName	Возвращает или задает имя пользователя при установке соединения с помощью олицетворения. (Производный от ConnectionSettings.)
	ConnectAsUserPassword	Возвращает или задает пароль для пользователя при установке соединения с помощью олицетворения. (Производный от ConnectionSettings.)
	ConnectionString	Возвращает или задает строку подключения, используемую для установки соединения с указанным источником данных. (Производный от ConnectionSettings.)
	ConnectionType	Возвращает тип соединения для использования на сервере.
	ConnectTimeout	Возвращает или задает время ожидания для соединения в секундах. (Производный от ConnectionSettings.)
	DatabaseEngineType	Возвращает тип компонента Database Engine. (Производный от ConnectionManager.)
	DatabaseName	Возвращает или задает базу данных, необходимую для соединения. (Производный от ConnectionSettings.)
	EncryptConnection	Возвращает или задает значение свойства Boolean, показывающее, является ли соединение зашифрованным. (Производный от ConnectionSettings.)
	FixedServerRoles	Возвращает предопределенную роль сервера, связанную с указанным соединением.
	InUse	Возвращает или задает значение свойства Boolean, показывающее, используется ли соединение. (Производный от ConnectionManager.)
	IsForceDisconnected	Возвращает значение типа Boolean, показывающее, было ли соединение отключено принудительно. (Производный от ConnectionManager.)
	IsOpen	Возвращает или задает значение свойства Boolean, показывающее, открыто ли в настоящий момент соединение. (Производный от ConnectionManager.)
	LockTimeout	Возвращает или задает время, в секундах, которое требуется для истечения времени ожидания соединения, когда текущая транзакция заблокирована. (Производный от ConnectionManager.)
	Login	Возвращает или задает имя входа, необходимое, чтобы установить соединение с экземпляром сервера. (Производный от ConnectionSettings.)
	LoginSecure	Возвращает или задает значение свойства Boolean, показывающее, установлено ли соединение с помощью проверки подлинности Windows или проверки подлинности SQL Server. (Производный от ConnectionSettings.)
	MaxPoolSize	Возвращает или задает максимальное количество соединений в пуле, которое принимает указанное соединение при установке соединения с сервером. (Производный от ConnectionSettings.)
	MinPoolSize	Возвращает или задает минимальное количество соединений в пуле, которое принимает указанное соединение при установке соединения с сервером. (Производный от ConnectionSettings.)
	MultipleActiveResultSets	Возвращает или задает значение свойства Boolean, показывающее, разрешено ли несколько активных результирующих наборов. (Производный от ConnectionSettings.)
	NetworkProtocol	Возвращает или задает сетевой протокол, используемый для установки соединения с сервером. (Производный от ConnectionSettings.)
	NonPooledConnection	Возвращает или задает значение свойства Boolean, показывающее, может ли соединение входить или не входить в пул. (Производный от ConnectionSettings.)
	PacketSize	Возвращает или задает пакеты данных в байтах, пересылаемые между клиентом и сервером по сети. (Производный от ConnectionSettings.)
	ParameterizationMode	Возвращает или задает режим параметризации для соединения с сервером.
	Password	Возвращает или задает пароль, используемый с именем входа для установления соединения с сервером при применении проверки подлинности SQL Server. (Производный от ConnectionSettings.)
	PooledConnectionLifetime	Возвращает или задает время существования помещенного в пул соединения. (Производный от ConnectionSettings.)
	ProcessID	Возвращаемое значение идентификатора однозначно идентифицирует процесс, связанный с указанным соединением с сервером.
	SecureConnectionString	Возвращает или задает зашифрованную версию строки подключения. (Производный от ConnectionSettings.)
	SecurePassword	Возвращает или задает надежный пароль, используемый с именем входа для установления соединения с сервером при применении проверки подлинности SQL Server. (Производный от ConnectionSettings.)
	ServerInstance	Возвращает или задает имя сервера. (Производный от ConnectionSettings.)
	ServerVersion	Возвращает номер версии подключенного экземпляра SQL Server. (Производный от ConnectionManager.)
	SqlConnectionObject	Возвращает объект соединения. (Производный от ConnectionManager.)
	SqlExecutionModes	Возвращает или задает режим выполнения, связанный с указанным соединением с сервером.
	StatementTimeout	Возвращает или задает число секунд, выделенных для выполнения инструкции до появления ошибки истечения времени ожидания.
	TransactionDepth	Возвращает глубину текущей транзакции для указанного соединения.
	TrueLogin	Возвращает текущее имя записи входа в систему, используемое указанным соединением.
	TrueName	Возвращает имя сервера.
	UseMode	Возвращает или задает соединение с сервером, использующее указанный режим.
	UserProfile	Возвращает профиль пользователя, связанный с указанным соединением.
	WorkstationId	Возвращает или задает значение, которое является уникальным идентификатором рабочей станции. (Производный от ConnectionSettings.)

В начало

Методы

	Имя	Описание
	BeginTransaction	Запускает транзакцию для указанного ссылкой соединения.
	Cancel	Отменяет соединение.
	ChangePassword(SecureString)	Изменяет пароль имени входа, используемый при стандартной проверке подлинности.
	ChangePassword(String)	Изменяет пароль имени входа, используемый для стандартной проверки подлинности.
	CommitTransaction	Подтверждает текущую транзакцию для указанного ссылкой соединения.
	Connect	Соединяет с экземпляром SQL Server. (Производный от ConnectionManager.)
	Copy	Возвращает копию объекта ServerConnection.
	Disconnect	Отключает от экземпляра SQL Server. (Производный от ConnectionManager.)
	Equals	(Производный от Object.)
	ExecuteNonQuery(StringCollection)	Выполняет пакет инструкций, который не возвращает результирующий набор.
	ExecuteNonQuery(String)	Выполняет инструкцию, не возвращающую результирующий набор.
	ExecuteNonQuery(StringCollection, ExecutionTypes)	Выполняет пакет инструкций с заданными параметрами выполнения, которые не возвращают результирующего набора.
	ExecuteNonQuery(String, ExecutionTypes)	Выполняет инструкцию с заданными параметрами выполнения, которая не возвращает результирующего набора.
	ExecuteReader(String)	Выполняет инструкции Transact-SQL, возвращающие один или несколько результирующих наборов.
	ExecuteReader(String, SqlCommand%)	Выполняет модуль чтения, используя значение объекта SqlDataReader, который содержит один или несколько результирующих наборов.
	ExecuteScalar(StringCollection)	Выполняет пакет инструкций Transact-SQL и возвращает первый столбец первой строки в качестве значения объекта.
	ExecuteScalar(String)	Выполняет инструкцию Transact-SQL и возвращает первый столбец первой строки в качестве значения объекта.
	ExecuteWithResults(StringCollection)	Выполняет пакет инструкций Transact-SQL, которые возвращают несколько результирующих наборов.
	ExecuteWithResults(String)	Выполняет инструкцию Transact-SQL, которая возвращает результирующий набор.
	ForceDisconnected	Принудительно отключает от экземпляра SQL Server. (Производный от ConnectionManager.)
	GetHashCode	(Производный от Object.)
	GetType	(Производный от Object.)
	IsInFixedServerRole	Проверяет, является ли имя входа, связанное с указанным соединением, членом заданной предопределенной роли сервера.
	NormalizeQuery(String)	Использует входную строку, представляющую текст запроса.
	NormalizeQuery(String, Boolean)	Выполняет нормализацию запроса, который управляет соединением с сервером.
	RollBackTransaction	Откатывает текущую транзакцию.
	ToString	Возвращает имя объекта, на который ссылаются, в виде строки. (Производный от ConnectionSettings.)

В начало

События

	Имя	Описание
	InfoMessage	Событие, возникающее, когда экземпляр SQL Server формирует информационное сообщение.  (Производный от ConnectionManager.)
	RemoteLoginFailed	Это событие возникает, когда удаленно не удается соединиться с экземпляром SQL Server. (Производный от ConnectionManager.)
	ServerMessage	Событие, возникающее, когда SQL Server возвращает для текущего соединения информационное сообщение или предупреждение. (Производный от ConnectionManager.)
	StateChange	Это событие возникает при изменении состояния экземпляра SQL Server.  (Производный от ConnectionManager.)
	StatementExecuted	Событие, которое возникает, когда экземпляр SQL Server выполняет инструкцию в текущем соединении.  (Производный от ConnectionManager.)

В начало

Явные реализации интерфейса

	Имя	Описание
	ISfcConnection.Connect	Возвращает значение, которое указывает сервер, с которым устанавливается соединение SFC.
	ISfcConnection.Copy	Использует соединение SFC для копирования соединения с сервером.
	ISfcConnection.Disconnect	Разрывает соединение.
	ISfcConnection.ServerVersion	Возвращает версию сервера.
	ISfcConnection.ToEnumeratorObject	Возвращает объект перечислителя для соединения с сервером.

В начало

Замечания

Класс ServerConnection послужен классами репликации и класса Server, например класс ReplicationServer.

Обычно не нужно объявить экземпляр объекта ServerConnection, поскольку он создается автоматически с объектом сервера. Объявите переменную объекта ServerConnection при необходимости хранить параметры соединения для повторного использования. Свойство ConnectionContext указывает объекта сервера объекта ServerConnection. Объект ServerConnection содержит свойства, относящиеся к связи между объектом сервера и экземпляра SQL Server. С его помощью можно просматривать или изменять некоторые аспекты соединения, например идентификатор процесса, обработке транзакций, режим проверки подлинности, режим выполнения, а также выполнять команды Transact-SQL.

С помощью объекта ServerConnection можно выполнить следующие действия.

• Выполните инструкции Transact-SQL непосредственно через соединение с экземпляром SQL Server.

• Измените параметры соединения, например метод проверки подлинности.

• Начните преобразуйте и откат транзакции.

• Сбор инструкций Transact-SQL, созданные приложением SMO.

Примеры

Другой пример этого метода с объектом Database см. в разделе [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