Статья
04/01/2012

Класс PlanGuide

Creates a plan guide object: PlanGuide

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

System. . :: . .Object
  Microsoft.SqlServer.Management.Smo. . :: . .SmoObjectBase
    Microsoft.SqlServer.Management.Smo. . :: . .SqlSmoObject
      Microsoft.SqlServer.Management.Smo. . :: . .NamedSmoObject
        Microsoft.SqlServer.Management.Smo..::..PlanGuide

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

Синтаксис

'Декларация
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class PlanGuide _
    Inherits NamedSmoObject _
    Implements ICreatable, IAlterable, IDroppable, IScriptable,  _
    IExtendedProperties
'Применение
Dim instance As PlanGuide

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class PlanGuide : NamedSmoObject, 
    ICreatable, IAlterable, IDroppable, IScriptable, IExtendedProperties

[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class PlanGuide sealed : public NamedSmoObject, 
    ICreatable, IAlterable, IDroppable, IScriptable, IExtendedProperties

[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type PlanGuide =  
    class
        inherit NamedSmoObject
        interface ICreatable
        interface IAlterable
        interface IDroppable
        interface IScriptable
        interface IExtendedProperties
    end

public final class PlanGuide extends NamedSmoObject implements ICreatable, IAlterable, IDroppable, IScriptable, IExtendedProperties

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

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

	Имя	Описание
	PlanGuide() () () ()	Creates a plan guide object: PlanGuide
	PlanGuide(Database, String)	Creates a plan guide object: PlanGuide

В начало

Свойства

	Имя	Описание
	ExecuteForScalar	Возвращает или задает значение свойства типа Boolean, указывающее, настроен ли объект для выполнения в скалярном режиме. (Производный от SqlSmoObject.)
	ExtendedProperties	Gets a collection of plan guide properties.
	Hints	Shows hints that are associated with the plan guide.
	ID	Gets the plan guide ID as an interger.
	IsDisabled	Indicates whether a plan guide is disabled.
	IsTouched	Возвращает значение свойства типа Boolean, указывающее, были ли свойства объекта обновлены, но еще не сохранены на сервере. (Производный от SqlSmoObject.)
	Name	Gets or sets the name of the object. (Производный от NamedSmoObject.)
	ObjectInSpace	Возвращает значение свойства типа Boolean, указывающее, существует ли объект изолированно или же он явно или неявно подключен к экземпляру SQL Server. (Производный от SqlSmoObject.)
	Parameters	Gets a string that lists all the plan guide parameters.
	Parent	Gets the parent database object.
	Properties	Возвращает коллекцию объектов Property, представляющих свойства объекта. (Производный от SqlSmoObject.)
	ScalarResult	Возвращает скалярный результат для объекта, на который ссылаются. (Производный от SqlSmoObject.)
	ScopeBatch	Gets or sets the scope batch of the plan guide.
	ScopeObjectName	Gets or sets the scope object name.
	ScopeSchemaName	gets or sets the scope schema name.
	ScopeType	Gets or sets the plan guide scope type.
	State	Gets the state of the referenced object. (Производный от SmoObjectBase.)
	Statement	Gets or sets a plan guide statement (query).
	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	Enables or disables a plan guide.
	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.)
	Create	Creates a plan guide.
	CreateImpl	Создает объект с параметрами создания скриптов. (Производный от SqlSmoObject.)
	CreateImplFinish	Метод, вызываемый при завершении события создания. (Производный от SqlSmoObject.)
	CreateImplInit	Метод, вызываемый при инициализации события создания. (Производный от SqlSmoObject.)
	Discover	Находит список типа Object. (Производный от SqlSmoObject.)
	Drop	Drops a plan guide.
	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.)
	RenameImpl	Указано только в ознакомительных целях. Не поддерживается. Совместимость с будущими версиями не гарантируется. (Производный от NamedSmoObject.)
	RenameImplWorker	Указано только в ознакомительных целях. Не поддерживается. Совместимость с будущими версиями не гарантируется. (Производный от NamedSmoObject.)
	Script() () () ()	Creates a string collection object for a script.
	Script(ScriptingOptions)	Creates a string collection object for a script.
	ScriptAlter	Изменяет SqlSmoObject в соответствии с параметрами. (Производный от SqlSmoObject.)
	ScriptChangeOwner	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Производный от NamedSmoObject.)
	ScriptCreate	Изменяет SqlSmoObject в соответствии с параметрами. (Производный от SqlSmoObject.)
	ScriptDdl	Вызывает исключение InvalidSmoOperationException. (Производный от SqlSmoObject.)
	ScriptDrop	Вызывает исключение InvalidSmoOperationException. (Производный от SqlSmoObject.)
	ScriptImpl() () () ()	Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.)
	ScriptImpl(ScriptingOptions)	Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.)
	ScriptImplWorker	Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.)
	ScriptOwner	Alters the script owner authorization. (Производный от NamedSmoObject.)
	ScriptRename	This method supports the SMO infrastructure and is not intended to be used directly from your code. (Производный от NamedSmoObject.)
	SetParentImpl	Устанавливает родительский объект объекта SqlSmoObject в значение параметра newParent. (Производный от SqlSmoObject.)
	SetSchemaOwned	Sets the schema owned value. (Производный от NamedSmoObject.)
	ToString	Возвращает String, представляющее объект, на который ссылаются. (Производный от SqlSmoObject.)
	TouchImpl	Не реализовано. (Производный от SqlSmoObject.)
	UnbindDefaultImpl	Отменяет привязку столбцов по умолчанию для объекта SqlSmoObject. (Производный от SqlSmoObject.)
	UnbindRuleImpl	Отменяет привязку правил для объекта SqlSmoObject. (Производный от SqlSmoObject.)
	Validate	Validates the state of an object. (Производный от SmoObjectBase.)
	ValidatePlanGuide() () () ()	Returns True if a plan guide is valid; othewise, False.
	ValidatePlanGuide(DataRow%)	Returns True if a plan guide is valid; othewise, False. Also returns a data table row that contains error information.

В начало

События

	Имя	Описание
	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.)