PlanGuide Class
SQL Server 2012
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.SmoObjectBase
Microsoft.SqlServer.Management.Smo.SqlSmoObject
Microsoft.SqlServer.Management.Smo.NamedSmoObject
Microsoft.SqlServer.Management.Smo.PlanGuide
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
The PlanGuide type exposes the following members.
| Name | Description | |
|---|---|---|
 | PlanGuide() | Creates a plan guide object: PlanGuide |
| PlanGuide(Database, String) | Creates a plan guide object: PlanGuide |
| Name | Description | |
|---|---|---|
| ExtendedProperties | Gets a collection of plan guide properties. |
| Hints | Shows the hints that are associated with the plan guide. |
| ID | Gets the identifier of the plan guide. |
| IsDisabled | Indicates whether a plan guide is disabled. |
| Name | Gets or sets the name of the object. (Inherited from NamedSmoObject.) |
| Parameters | Gets a string that lists all the plan guide parameters. |
| Parent | Gets the parent database object. |
| Properties | Gets a collection of Property objects that represent the object properties. (Inherited from 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. (Inherited from SmoObjectBase.) |
| Statement | Gets or sets a plan guide statement (query). |
| Urn | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.) |
| UserData | Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.) |
| Name | Description | |
|---|---|---|
| Alter | Enables or disables a plan guide. |
| Create | Creates a plan guide. |
| Discover | Discovers a list of type Object. (Inherited from SqlSmoObject.) |
| Drop | Drops a plan guide. |
| Equals | (Inherited from Object.) |
| FormatSqlVariant | Formats an object as SqlVariant type. (Inherited from SqlSmoObject.) |
| GetContextDB | Gets the context database that is associated with this object. (Inherited from SqlSmoObject.) |
| GetDBName | Gets the database name that is associated with the object. (Inherited from SqlSmoObject.) |
| GetHashCode | (Inherited from Object.) |
| GetPropValue | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetPropValueOptional | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetPropValueOptionalAllowNull | Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetServerObject | Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.) |
| GetType | (Inherited from Object.) |
| Initialize() | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
| Initialize(Boolean) | Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.) |
| IsObjectInitialized | Verifies whether the object has been initialized. (Inherited from SqlSmoObject.) |
| IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.) |
| Refresh | Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.) |
| Script() | Creates a script object. |
| Script(ScriptingOptions) | Creates a string collection object for a script. |
| SetParentImpl | Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.) |
| ToString | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) |
| Validate | Validates the state of an object. (Inherited from SmoObjectBase.) |
| ValidatePlanGuide() | Indicates whether the plan guide is valid. |
| ValidatePlanGuide(DataRow) | Returns whether the plan guide is valid. |
| Name | Description | |
|---|---|---|
| PropertyChanged | Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.) |
| PropertyMetadataChanged | Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.) |
| Name | Description | |
|---|---|---|
| IAlienObject.Discover | Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
| IAlienObject.GetDomainRoot | Returns the root of the domain. (Inherited from SqlSmoObject.) |
| IAlienObject.GetParent | Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
| IAlienObject.GetPropertyType | Gets the type of the specified property. (Inherited from SqlSmoObject.) |
| IAlienObject.GetPropertyValue | Gets the value of the specified property. (Inherited from SqlSmoObject.) |
| IAlienObject.GetUrn | Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.) |
| IAlienObject.Resolve | Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.) |
| IAlienObject.SetObjectState | Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.) |
| IAlienObject.SetPropertyValue | Sets the property value. (Inherited from SqlSmoObject.) |
| ISfcPropertyProvider.GetPropertySet | Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.) |
