Класс Settings

Объект Settings представляет группу настраиваемых параметров экземпляра SQL Server.

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

System. . :: . .Object
  Microsoft.SqlServer.Management.Smo. . :: . .SmoObjectBase
    Microsoft.SqlServer.Management.Smo. . :: . .SqlSmoObject
      Microsoft.SqlServer.Management.Smo..::..Settings

Пространство имен:  Microsoft.SqlServer.Management.Smo
Сборка:  Microsoft.SqlServer.Smo (в Microsoft.SqlServer.Smo.dll)

Синтаксис

'Декларация
<SfcElementTypeAttribute("Setting")> _
Public NotInheritable Class Settings _
    Inherits SqlSmoObject _
    Implements IAlterable, IScriptable
'Применение
Dim instance As Settings
[SfcElementTypeAttribute("Setting")]
public sealed class Settings : SqlSmoObject, 
    IAlterable, IScriptable
[SfcElementTypeAttribute(L"Setting")]
public ref class Settings sealed : public SqlSmoObject, 
    IAlterable, IScriptable
[<SealedAttribute>]
[<SfcElementTypeAttribute("Setting")>]
type Settings =  
    class
        inherit SqlSmoObject
        interface IAlterable
        interface IScriptable
    end
public final class Settings extends SqlSmoObject implements IAlterable, IScriptable

Тип Settings обеспечивает доступ к следующим элементам.

Свойства

  Имя Описание
Открытое свойство AuditLevel Возвращает или задает уровень аудита для экземпляра Microsoft SQL Server.
Открытое свойство BackupDirectory Возвращает каталог резервных копий по умолчанию для экземпляра Microsoft SQL Server.
Открытое свойство DefaultFile Возвращает или задает каталог файлов данных по умолчанию для экземпляра MicrosoftSQL Server.
Открытое свойство DefaultLog Возвращает или задает каталог файлов журналов по умолчанию для экземпляра Microsoft SQL Server.
Защищенное свойство ExecuteForScalar Возвращает или задает значение свойства типа Boolean, указывающее, настроен ли объект для выполнения в скалярном режиме. (Производный от SqlSmoObject.)
Защищенное свойство IsTouched Возвращает значение свойства типа Boolean, указывающее, были ли свойства объекта обновлены, но еще не сохранены на сервере. (Производный от SqlSmoObject.)
Открытое свойство LoginMode Возвращает или задает режим входа для SQL Server.
Открытое свойство MailProfile Возвращает или задает профиль электронной почты для экземпляра SQL Server.
Открытое свойство NumberOfLogFiles Возвращает или задает количество файлов журналов, используемых в базах данных на экземпляре SQL Server.
Защищенное свойство ObjectInSpace Возвращает значение свойства типа Boolean, указывающее, существует ли объект изолированно или же он явно или неявно подключен к экземпляру SQL Server. (Производный от SqlSmoObject.)
Открытое свойство OleDbProviderSettings Ссылается на коллекцию объектов OleDbProviderSettings. Каждый объект OleDbProviderSettings представляет параметр поставщика OLE DB.
Открытое свойство Parent Возвращает объект Server, являющийся родительским для объекта Settings.
Открытое свойство PerfMonMode Возвращает поведение опросов системного монитора для экземпляра SQL Server.
Открытое свойство Properties Возвращает коллекцию объектов Property, представляющих свойства объекта. (Производный от SqlSmoObject.)
Защищенное свойство ScalarResult Возвращает скалярный результат для объекта, на который ссылаются. (Производный от SqlSmoObject.)
Открытое свойство State Gets the state of the referenced object. (Производный от SmoObjectBase.)
Открытое свойство TapeLoadWaitTime Возвращает или задает время ожидания загрузки ленты на ленточном устройстве резервного копирования.
Открытое свойство Urn Возвращает значение адреса универсального имени ресурса (URN), которое однозначно идентифицирует объект. (Производный от SqlSmoObject.)
Открытое свойство UserData Gets or sets user-defined data associated with the referenced object. (Производный от SmoObjectBase.)

В начало

Методы

  Имя Описание
Защищенный метод AddDatabaseContext(StringCollection) Добавляет контекст базы данных в коллекцию запросов, определенную параметром queries. (Производный от SqlSmoObject.)
Защищенный метод AddDatabaseContext(StringCollection, ScriptingOptions) Добавляет контекст базы данных в коллекцию запросов, определяемую параметром queries при использовании указанных параметров создания скриптов. (Производный от SqlSmoObject.)
Открытый метод Alter Обновляет изменения свойств всех объектов Settings на экземпляре SQL Server. 
Защищенный метод AlterImpl Активирует событие изменения объекта. (Производный от SqlSmoObject.)
Защищенный метод AlterImplFinish Метод, вызываемый при завершении события изменения объекта. (Производный от SqlSmoObject.)
Защищенный метод AlterImplInit Метод, вызываемый при инициализации события изменения объекта. (Производный от SqlSmoObject.)
Защищенный метод AlterImplWorker Вызывает методы изменения. (Производный от SqlSmoObject.)
Защищенный метод BindDefaultImpl Связывает элементы по умолчанию, определенные параметрами. (Производный от SqlSmoObject.)
Защищенный метод BindRuleImpl Связывает схему правил с правилом и столбцами, определенными параметрами. (Производный от SqlSmoObject.)
Защищенный метод CheckCollation Проверяет порядок параметров создания скриптов в методе сортировки, определенном параметром collationName. (Производный от SqlSmoObject.)
Защищенный метод CheckObjectState() () () () Проверяет состояние связанного объекта. (Производный от SqlSmoObject.)
Защищенный метод CheckObjectState(Boolean) Проверяет состояние связанного объекта с возможностью указать исключение, возникающее, если объект еще не создан. (Производный от SqlSmoObject.)
Защищенный метод CheckObjectStateImpl Проверяет состояние объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод CheckVersion100 Проверяет, является ли SQL Server версией SQL Server 2008. (Производный от SqlSmoObject.)
Защищенный метод CheckVersion80 Проверяет правильность объекта в SQL Server 2000. (Производный от SqlSmoObject.)
Защищенный метод CheckVersion80SP3 Проверяет правильность объекта в SQL Server 2000 с пакетом обновления 3 (SP3). (Производный от SqlSmoObject.)
Защищенный метод CheckVersion90 Проверяет правильность объекта в SQL Server 2005. (Производный от SqlSmoObject.)
Защищенный метод CheckVersionBelow90 Проверяет, является ли SQL Server более ранней версией, чем SQL Server 2005. (Производный от SqlSmoObject.)
Защищенный метод CleanObject Устанавливает объект в неизмененное исходное состояние. (Производный от SqlSmoObject.)
Защищенный метод CreateImpl Создает объект с параметрами создания скриптов. (Производный от SqlSmoObject.)
Защищенный метод CreateImplFinish Метод, вызываемый при завершении события создания. (Производный от SqlSmoObject.)
Защищенный метод CreateImplInit Метод, вызываемый при инициализации события создания. (Производный от SqlSmoObject.)
Открытый метод Discover Находит список типа Object. (Производный от SqlSmoObject.)
Защищенный метод DropImpl Удаляет объект SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод DropImplWorker Вызывает методы удаления. (Производный от SqlSmoObject.)
Защищенный метод EnumScriptImpl Перечисляет сценарии, заданные параметром so. (Производный от SqlSmoObject.)
Защищенный метод EnumScriptImplWorker Вызывает методы, перечисляющие заданные параметром so сценарии. (Производный от SqlSmoObject.)
Защищенный метод EnumScriptImplWorkerSOChanged Возвращает строку IEnumerable, описывающую параметры создания скриптов объекта. (Производный от SqlSmoObject.)
Открытый метод Equals (Производный от Object.)
Защищенный метод ExecuteNonQuery (Производный от SqlSmoObject.)
Защищенный метод Finalize (Производный от Object.)
Защищенный метод FormatSqlVariant Форматирует объект как имеющий тип SqlVariant. (Производный от SqlSmoObject.)
Защищенный метод GenerateDataSpaceFileStreamScript Формирует скрипт, создающий файл данных. (Производный от SqlSmoObject.)
Защищенный метод GenerateDataSpaceScript Формирует скрипт, выделяющий пространство в файле данных. (Производный от SqlSmoObject.)
Защищенный метод GetBindDefaultScript Возвращает скрипт, привязывающий значения по умолчанию, определенные параметрами defSchema и defName. (Производный от SqlSmoObject.)
Защищенный метод GetBindRuleScript Возвращает скрипт, указывающий правила привязки. (Производный от SqlSmoObject.)
Защищенный метод GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Назначает параметр типа boolean объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Назначает свойство типа boolean объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetDateTimeParameter Назначает свойство типа datetime объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetDateTimeParameterAsInt Назначает свойство типа datetime объекта SqlSmoObject в виде целочисленного значения, если свойство типа datetime не равно NULL. (Производный от SqlSmoObject.)
Защищенный метод GetDBName Возвращает имя базы данных, связанной с объектом. (Производный от SqlSmoObject.)
Защищенный метод GetEnumParameter Назначает свойство перечисления SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetFragOptionString Возвращает объект FragmentationOption в виде строкового значения. (Производный от SqlSmoObject.)
Защищенный метод GetGuidParameter Назначает свойство Guid объекта SqlSmoObject. (Производный от SqlSmoObject.)
Открытый метод GetHashCode (Производный от Object.)
Защищенный метод GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Назначает параметр объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Назначает параметр объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetPropValue Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetPropValueOptional Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetPropValueOptionalAllowNull Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetRealValue Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetScriptingOptionsForCreate Возвращает параметры ScriptingOptions объектаSqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetServerName Возвращает имя экземпляра SQL Server, с которым связан объект. (Производный от SqlSmoObject.)
Защищенный метод GetServerObject Возвращает сервер объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetSqlServerVersionName Возвращает имя версии экземпляра SQL Server, с которым связан объект. (Производный от SqlSmoObject.)
Защищенный метод GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) Назначает параметр типа string объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) Назначает параметр типа string объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetTimeSpanParameterAsInt Назначает параметр временного диапазона объекта SqlSmoObject. (Производный от SqlSmoObject.)
Открытый метод GetType (Производный от Object.)
Защищенный метод GetUrnRecursive(StringBuilder) Присваивает объект Urn объекту SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод GetUrnRecursive(StringBuilder, UrnIdOption) Присваивает объект Urn объекту SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод ImplInitialize Инициализирует поля объекта SqlSmoObject. (Производный от SqlSmoObject.)
Открытый метод Initialize() () () () Инициализирует объект и инициирует загрузку свойств. (Производный от SqlSmoObject.)
Открытый метод Initialize(Boolean) Инициализирует объект и инициирует загрузку свойств. (Производный от SqlSmoObject.)
Защищенный метод IsObjectDirty Проверяет, было ли изменено свойство объекта, еще не сохраненное в экземпляре SQL Server. (Производный от SqlSmoObject.)
Защищенный метод IsObjectInitialized Проверяет, был ли объект инициализирован. (Производный от SqlSmoObject.)
Защищенный метод IsObjectInSpace Проверяет, является ли объект изолированным или подключенным к экземпляру SQL Server. (Производный от SqlSmoObject.)
Защищенный метод IsVersion80SP3 Определяет, является ли SQL Server версией SQL Server 2000 с пакетом обновления 3 (SP3). (Производный от SqlSmoObject.)
Защищенный метод IsVersion90AndAbove Определяет, является ли SQL Server версией SQL Server 2005 или более поздней. (Производный от SqlSmoObject.)
Защищенный метод MarkDropped Устанавливает состояние SqlSmoState для удаления. (Производный от SqlSmoObject.)
Защищенный метод MarkForDropImpl Устанавливает состояние SqlSmoState для удаления. (Производный от SqlSmoObject.)
Защищенный метод MemberwiseClone (Производный от Object.)
Защищенный метод PostAlter Метод, активируемый после изменения SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод PostCreate Метод, активируемый после создания SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод PostDrop Метод, активируемый после удаления SqlSmoObject. (Производный от SqlSmoObject.)
Открытый метод Refresh Обновляет объект и извлекает свойства объекта при следующем обращении. (Производный от SqlSmoObject.)
Открытый метод Script() () () () Формирует скрипт Transact-SQL, который может быть использован для повторного создания параметров SQL Server.
Открытый метод Script(ScriptingOptions) Формирует скрипт Transact-SQL, который может быть использован для повторной настройки SQL Server в соответствии с параметрами создания скриптов.
Защищенный метод ScriptAlter Изменяет SqlSmoObject в соответствии с параметрами. (Производный от SqlSmoObject.)
Защищенный метод ScriptCreate Изменяет SqlSmoObject в соответствии с параметрами. (Производный от SqlSmoObject.)
Защищенный метод ScriptDdl Вызывает исключение InvalidSmoOperationException. (Производный от SqlSmoObject.)
Защищенный метод ScriptDrop Вызывает исключение InvalidSmoOperationException. (Производный от SqlSmoObject.)
Защищенный метод ScriptImpl() () () () Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод ScriptImpl(ScriptingOptions) Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод ScriptImplWorker Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод SetParentImpl Устанавливает родительский объект объекта SqlSmoObject в значение параметра newParent. (Производный от SqlSmoObject.)
Открытый метод ToString Возвращает String, представляющее объект, на который ссылаются. (Производный от SqlSmoObject.)
Защищенный метод TouchImpl Не реализовано. (Производный от SqlSmoObject.)
Защищенный метод UnbindDefaultImpl Отменяет привязку столбцов по умолчанию для объекта SqlSmoObject. (Производный от SqlSmoObject.)
Защищенный метод UnbindRuleImpl Отменяет привязку правил для объекта SqlSmoObject. (Производный от SqlSmoObject.)
Открытый метод Validate Validates the state of an object. (Производный от SmoObjectBase.)

В начало

События

  Имя Описание
Открытое событие PropertyChanged Представляет событие, возникающее при изменении свойства. (Производный от SqlSmoObject.)
Открытое событие PropertyMetadataChanged Представляет событие, возникающее при изменении метаданных свойства. (Производный от SqlSmoObject.)

В начало

Поля

  Имя Описание
Защищенное поле m_ExtendedProperties Представляет свойство, определенное для расширения свойств, предоставляемых объектом SqlSmoObject. (Производный от SqlSmoObject.)
Защищенное поле singletonParent Представляет единственного родителя. (Производный от SqlSmoObject.)

В начало

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

  Имя Описание
Явная реализация интерфейсаЗакрытый метод IAlienObject. . :: . .Discover Находит любые зависимости. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject. . :: . .GetDomainRoot Возвращает корневой элемент домена. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject. . :: . .GetParent Возвращает родительский объект для данного объекта. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject. . :: . .GetPropertyType Возвращает тип указанного свойства. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject. . :: . .GetPropertyValue Возвращает значение указанного свойства. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject. . :: . .GetUrn Возвращает универсальное имя ресурса для объекта. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject. . :: . .Resolve Возвращает экземпляр, содержащий данные об объекте из универсального имени ресурса для объекта. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject. . :: . .SetObjectState Задает состоянию объекта указанное значение SfcObjectState. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод IAlienObject. . :: . .SetPropertyValue Устанавливает значение свойства. (Производный от SqlSmoObject.)
Явная реализация интерфейсаЗакрытый метод ISfcPropertyProvider. . :: . .GetPropertySet Возвращает ссылку на интерфейс для набора свойств данного объекта. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.)

В начало

Замечания

В будущей версии Microsoft SQL Server эта возможность будет удалена. Избегайте использования этой возможности в новых разработках и запланируйте изменение существующих приложений, в которых она применяется.

To get Settings object properties, users can be a member of the public fixed server role.

To set Settings object properties, users must be a member of the sysadmin fixed server role.

Thread Safety

Все общие статические члены этого типа (Shared в Microsoft Visual Basic) можно использовать в многопоточных операциях. Безопасная многопоточная работа с членами экземпляров типа не гарантируется.

Примеры

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Display information about the instance of SQL Server in Information and Settings.
Console.WriteLine("OS Version = " & srv.Information.OSVersion)
Console.WriteLine("State = " & srv.Settings.State.ToString)
'Display information specific to the current user in UserOptions.
Console.WriteLine("Quoted Identifier support = " & srv.UserOptions.QuotedIdentifier)
'Modify server settings in Settings.

srv.Settings.LoginMode = ServerLoginMode.Integrated
'Modify settings specific to the current connection in UserOptions.
srv.UserOptions.AbortOnArithmeticErrors = True
'Run the Alter method to make the changes on the instance of SQL Server.
srv.Alter()

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

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