ServerConnection Класс

Определение

Пространство имен:

Microsoft.SqlServer.Management.Common

Сборка:

Microsoft.SqlServer.ConnectionInfo.dll

Пакет:

Microsoft.SqlServer.SqlManagementObjects v172.64.0

public sealed class ServerConnection : Microsoft.SqlServer.Management.Common.ConnectionManager, Microsoft.SqlServer.Management.Common.ISfcConnection

type ServerConnection = class
    inherit ConnectionManager
    interface ISfcConnection

Public NotInheritable Class ServerConnection
Inherits ConnectionManager
Implements ISfcConnection

Наследование

Object

ConnectionSettings

ConnectionManager

ServerConnection

Реализации

ISfcConnection

Конструкторы

Имя	Описание
ServerConnection()
ServerConnection(IRenewableToken)	Создает объект ServerConnection, принимаюющий маркер. Дополнительное логическое значение используется для перегрузки этого конструктора в качестве другого конструктора со строкой.
ServerConnection(SqlConnection, IRenewableToken)	Создает новый объект ServerConnection
ServerConnection(SqlConnection)	Создает новый объект ServerConnection из заданного sqlConnection
ServerConnection(SqlConnectionInfo)
ServerConnection(String, String, SecureString)
ServerConnection(String, String, String)
ServerConnection(String)

Поля

Имя	Описание
NoConnectionTimeout	Бесконечное ожидание (Унаследовано от ConnectionSettings)

Свойства

Имя	Описание
AcceptsLogin	Возвращает значение true, если текущие значения для LoginSecure и Authentication используют свойство Login (Унаследовано от ConnectionSettings)
AccessToken	(Унаследовано от ConnectionSettings)
ApplicationIntent	Намерение приложения допустимых значений подключения : ReadWrite и ReadOnly (Унаследовано от ConnectionSettings)
ApplicationName	Имя приложения. "Управление SQL", если имя приложения не указано. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException (Унаследовано от ConnectionSettings)
Authentication	Тип проверки подлинности подключения (Унаследовано от ConnectionSettings)
AutoDisconnectMode	(Унаследовано от ConnectionManager)
BatchSeparator	Определяет разделитель пакетной службы, используемый методами ExecuteNonQuery. Значение по умолчанию — GO. Разделитель пакетной службы не учитывает регистр.
CachedQueries	Возвращает или задает значение, указывающее, должны ли экземпляры ServerConnection кэшировать результаты запроса.
CapturedSql	(Унаследовано от ConnectionManager)
ConnectAsUser	Если задано значение true, подключение будет выполнено с учетными данными указанного пользователя. При этом предполагается олицетворение, однако не будут затронуты флаги LoginSecure и поля входа и пароля. Этот параметр доступен только в Windows. (Унаследовано от ConnectionSettings)
ConnectAsUserName	Указывает Windows пользователя, который используется при создании олицетворенного подключения. У пользователя должны быть права интерактивного входа. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException (Унаследовано от ConnectionSettings)
ConnectAsUserPassword	Указывает пароль пользователя Windows, который используется при создании олицетворенного подключения. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException (Унаследовано от ConnectionSettings)
ConnectionProtocol	Протокол подключения. (Унаследовано от ConnectionManager)
ConnectionString	Свойство вернет либо пользователь, указанный строка подключения, либо возвращает вычисляемый строка подключения на основе параметров объекта. Если явно задано, все свойства объекта ServerConnection будут заполнены, чтобы отразить переданный в строка подключения. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException (Унаследовано от ConnectionSettings)
ConnectionType
ConnectTimeout	Длительность времени (в секундах) ожидает подключения к серверу, прежде чем завершать попытку и вызывать исключение. Значение по умолчанию — 30 секунд (то же самое, что и Shiloh). Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException (Унаследовано от ConnectionSettings)
CurrentDatabase	Возвращает текущий контекст базы данных. (Унаследовано от ConnectionManager)
DatabaseEngineEdition	Выпуск ядро СУБД (Унаследовано от ConnectionManager)
DatabaseEngineType	Возвращает тип ядра СУБД SQL Server. Исключения: ConnectionFailureException (Унаследовано от ConnectionManager)
DatabaseName	TBD (Унаследовано от ConnectionSettings)
EncryptConnection	Значение "encrypt=true" указано в строка подключения (Унаследовано от ConnectionSettings)
FixedServerRoles	Возвращает перечисление, указывающее предопределенную роль сервера, из которой входит имя входа.
HostNameInCertificate	Имя узла, предоставленное в сертификате для проверки сертификатов. (Унаследовано от ConnectionSettings)
HostPlatform	Хост-платформа сервера (Linux/Windows/etc) (Унаследовано от ConnectionManager)
InUse	Возвращает значение true, если объект подключен к серверу по крайней мере один раз. Если значение true, изменения свойств больше не допускаются, и при изменении свойства будет возникать исключение ConnectionCannotBeChangedException. (Унаследовано от ConnectionManager)
IsContainedAuthentication	Возвращает значение true, если ядро СУБД проходит проверку подлинности с помощью автономной проверки подлинности. Исключения: ConnectionFailureException (Унаследовано от ConnectionManager)
IsForceDisconnected	Указывает, что подключение было принудительно отключено (Унаследовано от ConnectionManager)
IsOpen	Возвращает значение true, если объект SqlConnection подключен к серверу. Это может возвращать значение true только для неуклюционных подключений, так как пуловые подключения всегда закрываются непосредственно после операции. (Унаследовано от ConnectionManager)
LockTimeout	LockTimeout — это время ожидания блокировки в секундах. -1 по умолчанию — на неопределенный срок. InvalidPropertyValueException вызывается для всех остальных отрицательных чисел. Положительное значение LockTimeout умножается на 1000, а затем используется для параметра SET LOCK_TIMEOUT. (Унаследовано от ConnectionManager)
Login	Имя входа SQL Server, используемое для подключения к серверу. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException (Унаследовано от ConnectionSettings)
LoginSecure	Если задано значение true, используется Windows встроенная безопасность, а имя входа и пароль игнорируются. Если не задано, используется проверка подлинности Sql Server. Исключения: ConnectionCannotBeChangedException (Унаследовано от ConnectionSettings)
MaxPoolSize	Максимальное разрешенное количество соединений в пуле. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException (Унаследовано от ConnectionSettings)
MinPoolSize	Минимальное число поддерживаемых соединений в пуле. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException (Унаследовано от ConnectionSettings)
MultipleActiveResultSets	Включите MARS из подключения. По умолчанию — false. (Унаследовано от ConnectionSettings)
NetworkProtocol	Определяет протокол клиентской сети, используемый для подключения к SQL Server. Если вы не указываете сеть и используете локальный сервер, используется общая память. Если вы не указываете сеть и используете удаленный сервер, используется один из настроенных клиентских протоколов. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException (Унаследовано от ConnectionSettings)
NonPooledConnection	По умолчанию все подключения к SQL Server взяты из пула подключений ADO.NET. Если задано значение true, это позволяет пользователям создавать подключение, отличное от пула (не будет повторно использоваться при закрытии). Исключения: ConnectionCannotBeChangedException (Унаследовано от ConnectionSettings)
PacketSize	Размер в байтах сетевых пакетов, используемых для взаимодействия с экземпляром SQL Server. Значение по умолчанию — 8192. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException (Унаследовано от ConnectionSettings)
ParameterizationMode	Возвращает или задает значение, указывающее использование QueryParameterizationMode QueryParameterizationMode всех экземпляров ServerConnection
Password	Пароль, используемый для входа для подключения к серверу. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException (Унаследовано от ConnectionSettings)
PooledConnectionLifetime	Когда соединение возвращается в пул, время его создания сравнивается с текущим временем, а соединение уничтожается, если этот интервал времени (в секундах) превышает значение, указанное в течение времени существования подключения. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException (Унаследовано от ConnectionSettings)
ProcessID	Свойство ProcessID возвращает идентификатор процесса SQL Server для соединения, используемого объектом ServerConnection.
ProductVersion	Возвращает свойство сервера ProductVersion для этого подключения. (Унаследовано от ConnectionManager)
RequiresLogin	Возвращает значение true, если текущие значения для LoginSecure и authentication требуют задания свойства Login (Унаследовано от ConnectionSettings)
ResetConnectionString	Сообщает нам, нужно ли сбросить ConnectionString в свойстве SqlConnectionObject ConnectionManager или нет. (Унаследовано от ConnectionSettings)
SecureConnectionString	Свойство возвращает версию SecureString пользователя, указанного строка подключения, или возвращает вычисляемый строка подключения на основе параметров объекта. Если явно задано, все свойства объекта ServerConnection будут заполнены, чтобы отразить переданный в строка подключения. Исключения: ConnectionCannotBeChangedException (Унаследовано от ConnectionSettings)
SecurePassword	Пароль, используемый для входа для подключения к серверу. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException PropertyNotSetException (Унаследовано от ConnectionSettings)
ServerCertificate	Путь к сертификату сервера, который будет использоваться для проверки сертификатов. (Унаследовано от ConnectionSettings)
ServerInstance	Имя SQL Server объект будет подключаться. Если этот параметр не задан, то подразумевается локальный сервер. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException (Унаследовано от ConnectionSettings)
ServerVersion	Возвращает основной номер версии SQL Server. Т.е. 8 для SQL Server 2000. Исключения: ConnectionFailureException (Унаследовано от ConnectionManager)
SqlConnectionObject	Возвращает ссылку на объект SqlConnection, используемый объектом ConnectionContext. Это всегда должно возвращать допустимый объект sqlConnection с последним допустимым набором ConnectionString. Исключения: PropertyNotAvailableException (Унаследовано от ConnectionManager)
SqlExecutionModes	Определяет, фиксируются ли инструкции SQL или отправляются на сервер.
StatementTimeout	Это количество секунд, которые инструкция пытается отправить на сервер до сбоя. Значение по умолчанию — 600 секунд (то же самое, что и Shiloh). Исключения: InvalidPropertyValueException
StrictEncryption	Указывает ли значение encrypt=strict в строка подключения. Если значение true, значение EncryptConnection игнорируется. (Унаследовано от ConnectionSettings)
TransactionDepth	Предоставляет глубину транзакции, которая учитывается объектной моделью. Это не включает в себя какие-либо транзакции, которые могли быть запущены на сервере, или путем выдачи BEGIN TRAN с помощью метода ExecuteNonQuery.
TrueLogin	Свойство TrueLogin возвращает имя записи входа, используемое текущим подключением.
TrueName	Свойство TrueName возвращает результирующий набор Microsoft ® SQL Server глобальной функции @@INSTANCENAME.
TrustServerCertificate	Указывает, доверяет ли клиент сертификату сервера. (Унаследовано от ConnectionSettings)
UseMode	Возвращает или задает DeferredUseMode использование useMode всех экземпляров ServerConnection
UserProfile	Свойство UserProfile возвращает высокоуровневое описание роли для имени входа Microsoft SQL Server, используемого текущим подключением.
WorkstationId	Имя рабочей станции, подключающейся к SQL Server. Исключения: ConnectionCannotBeChangedException InvalidPropertyValueException (Унаследовано от ConnectionSettings)

Методы

Имя	Описание
BeginTransaction()	Запускает новую транзакцию. Если CaptureMode имеет значение true, инструкция транзакции будет добавлена в буфер записи. Можно вложить транзакции. Это ответственность пользователя за фиксацию или откат каждой открытой транзакции. Не гарантируется, что все T-SQL, созданные объектной моделью, могут быть инкапсулированы транзакцией. Кроме того, состояние измененных объектов не будет отражать фактическое состояние базы данных до тех пор, пока транзакция не будет зафиксирована или после отката транзакции. Это ответственность пользователя за обновление затронутых объектов. Используйте с осторожностью.
Cancel()
ChangePassword(SecureString)
ChangePassword(String)
CheckServerVersion(ServerVersion)	Проверьте, подключается ли мы к поддерживаемой версии сервера. блокировать <= 7.0 в ServerConnection. (Унаследовано от ConnectionManager)
CommitTransaction()	Фиксирует транзакцию. Если CaptureMode имеет значение true, команда транзакции будет добавлена в буфер записи. Исключения: NotInTransactionException
Connect()	Создает фактическое подключение к SQL Server. Игнорируется, если подключение уже подключено. Это необязательно для вызова этого метода, так как подключение будет открыто при необходимости. Исключения: ConnectionFailureException (Унаследовано от ConnectionManager)
Copy()	Эта функция выполняет глубокое копирование
Disconnect()	Закрывает подключение с помощью SQL Server. Игнорируется, если он уже отключен. Исключения: ConnectionFailureException (Унаследовано от ConnectionManager)
ExecuteNonQuery(String, ExecutionTypes, Boolean)	Выполняет инструкцию T-SQL. Терминатор команды ('GO') распознается ExecuteNonQuery. Пакеты будут отправляться и выполняться по отдельности. Оператор записывается и не выполняется, если для CaptureMode задано значение true. Возвращается значение int, содержащее количество затронутых строк. Если выполняется несколько пакетов, возвращается общее количество затронутых строк всех пакетов. Метод Connect() будет вызываться, если соединение с сервером не открыто. Исключения: ConnectionFailureException ExecutionFailureExeception
ExecuteNonQuery(String, ExecutionTypes)	Выполняет инструкцию T-SQL. Терминатор команды ('GO') распознается ExecuteNonQuery. Пакеты будут отправляться и выполняться по отдельности. Оператор записывается и не выполняется, если для CaptureMode задано значение true. Возвращается значение int, содержащее количество затронутых строк. Если выполняется несколько пакетов, возвращается общее количество затронутых строк всех пакетов. Метод Connect() будет вызываться, если соединение с сервером не открыто. Исключения: ConnectionFailureException ExecutionFailureExeception
ExecuteNonQuery(String)
ExecuteNonQuery(StringCollection, ExecutionTypes, Boolean)	Выполняет инструкции T-SQL в StringCollection. Терминатор команды ('GO') распознается ExecuteNonQuery. Пакеты, разделенные инструкцией GO, будут отправляться и выполняться по отдельности. Оператор записывается и не выполняется, если для CaptureMode задано значение true. Возвращается массив значений int, содержащий числа строк, затронутых для каждой инструкции в StringCollection. Если выполняется несколько пакетов, возвращается общее количество затронутых строк всех пакетов. Метод Connect() будет вызываться, если соединение с сервером не открыто. Исключения: ConnectionFailureException ExecutionFailureExeception
ExecuteNonQuery(StringCollection, ExecutionTypes)	Выполняет инструкции T-SQL в StringCollection. Терминатор команды ('GO') распознается ExecuteNonQuery. Пакеты, разделенные инструкцией GO, будут отправляться и выполняться по отдельности. Оператор записывается и не выполняется, если для CaptureMode задано значение true. Возвращается массив значений int, содержащий числа строк, затронутых для каждой инструкции в StringCollection. Если выполняется несколько пакетов, возвращается общее количество затронутых строк всех пакетов. Метод Connect() будет вызываться, если соединение с сервером не открыто. Исключения: ConnectionFailureException ExecutionFailureExeception
ExecuteNonQuery(StringCollection)
ExecuteReader(String, SqlCommand)	Выполняет инструкции T-SQL. Возвращается объект SqlDataReader, который можно использовать для чтения потока строк, возвращаемых SQL Server. Объект SqlCommand также возвращается, который можно использовать для отмены канала чтения данных, если требуется прерывание длительного запроса. Он не автоматически отключает исключения: ConnectionFailureException ExecutionFailureExeception
ExecuteReader(String)	Выполняет инструкции T-SQL. Возвращается объект SqlDataReader, который можно использовать для чтения потока строк, возвращаемых SQL Server. Метод Connect() будет вызываться, если соединение с сервером не открыто. Он не автоматически отключает исключения: ConnectionFailureException ExecutionFailureExeception
ExecuteScalar(String)	Выполняет инструкцию T-SQL. Возвращается объект, содержащий первый столбец первой строки результирующий набор. Метод Connect() будет вызываться, если соединение с сервером не открыто. Исключения: ConnectionFailureException ExecutionFailureExeception
ExecuteScalar(StringCollection)	Выполняет инструкции T-SQL в StringCollection. Возвращается массив объектов, каждый из которых содержит первый столбец первой строки результирующий набор каждой выполняемой инструкции. Метод Connect() будет вызываться, если соединение с сервером не открыто. Исключения: ConnectionFailureException ExecutionFailureExeception
ExecuteTSql(ConnectionManager+ExecuteTSqlAction, Object, DataSet, Boolean)	Выполняет T-SQL с помощью соответствующих методов в зависимости от сведений о действии, передаваемых в качестве параметра. (Унаследовано от ConnectionManager)
ExecuteWithResults(String, Boolean)	Выполняет инструкции T-SQL в sqlCommand. Возвращается набор данных, содержащий результаты. Метод Connect() будет вызываться, если соединение с сервером не открыто. Исключения: ConnectionFailureException ExecutionFailureExeception
ExecuteWithResults(String)	Выполняет инструкции T-SQL в sqlCommand. Возвращается набор данных, содержащий результаты. Метод Connect() будет вызываться, если соединение с сервером не открыто. Исключения: ConnectionFailureException ExecutionFailureExeception
ExecuteWithResults(StringCollection)	Выполняет инструкции T-SQL в StringCollection. Массив наборов данных возвращается, содержащий результаты для каждой инструкции в StringCollection. Метод Connect() будет вызываться, если соединение с сервером не открыто. Исключения: ConnectionFailureException ExecutionFailureExeception
ForceDisconnected()	Принудительное отключение и гарантирует повторное открытие подключения (Унаследовано от ConnectionManager)
GetDatabaseConnection(String, Boolean, IRenewableToken)	Возвращает соединение с указанным именем базы данных в строка подключения Если текущее соединение уже ссылается на указанную базу данных, возвращается текущее соединение.
GetDatabaseConnection(String, Boolean)	Возвращает соединение с указанным именем базы данных в строка подключения. Если текущее подключение уже ссылается на указанную базу данных, возвращается текущее подключение.
IsInFixedServerRole(FixedServerRoles)	Проверяет, является ли имя входа членом любой из указанных ролей сервера.
NormalizeQuery(String, Boolean)	Перевод запроса с внедренными литералами в нормализованную форму (все литералы, замененные стандартным маркером)
NormalizeQuery(String)	Перегрузка для приведенной выше функции — дополнительные сведения см. в этой статье.
RollBackTransaction()	Прервана транзакция (все внесенные изменения не будут сохранены в базе данных). Если CaptureMode имеет значение true, команда транзакции будет добавлена в буфер записи. Исключения: NotInTransactionException
ThrowIfPropertyNotSet(String, String, Boolean)	(Унаследовано от ConnectionSettings)
ThrowIfPropertyNotSet(String, String)	(Унаследовано от ConnectionSettings)
ToString()	(Унаследовано от ConnectionSettings)

События

Имя	Описание
InfoMessage	Происходит, когда SQL Server возвращает предупреждение или информационное сообщение. Использует SqlClient.SqlInfoMessageEventHandler. (Унаследовано от ConnectionManager)
RemoteLoginFailed	Вызывается, когда серверу необходимо подключиться к удаленным серверам, а имя входа завершается ошибкой (Унаследовано от ConnectionManager)
ServerMessage	Происходит, когда SQL Server возвращает предупреждение или информационное сообщение. Использует SqlClient.SqlInfoMessageEventHandler. (Унаследовано от ConnectionManager)
StateChange	Происходит при изменении состояния подключения. Использует System.Data.StateChangeEventHandler. (Унаследовано от ConnectionManager)
StatementExecuted	(Унаследовано от ConnectionManager)

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

Имя	Описание
ISfcConnection.Connect()
ISfcConnection.Copy()
ISfcConnection.Disconnect()
ISfcConnection.ServerVersion
ISfcConnection.ToEnumeratorObject()