Statistic Class
The Statistic class represents a SQL Server statistic counter.
Inheritance Hierarchy
System.Object
Microsoft.SqlServer.Management.Smo.SmoObjectBase
Microsoft.SqlServer.Management.Smo.SqlSmoObject
Microsoft.SqlServer.Management.Smo.NamedSmoObject
Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
Microsoft.SqlServer.Management.Smo.Statistic
Namespace: Microsoft.SqlServer.Management.Smo
Assembly: Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)
Syntax
'Declaration
<PhysicalFacetAttribute> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class Statistic _
Inherits ScriptNameObjectBase _
Implements ICreatable, IDroppable, IMarkForDrop, IScriptable, _
ISfcSupportsDesignMode
'Usage
Dim instance As Statistic
[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class Statistic : ScriptNameObjectBase,
ICreatable, IDroppable, IMarkForDrop, IScriptable, ISfcSupportsDesignMode
[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class Statistic sealed : public ScriptNameObjectBase,
ICreatable, IDroppable, IMarkForDrop, IScriptable, ISfcSupportsDesignMode
[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type Statistic =
class
inherit ScriptNameObjectBase
interface ICreatable
interface IDroppable
interface IMarkForDrop
interface IScriptable
interface ISfcSupportsDesignMode
end
public final class Statistic extends ScriptNameObjectBase implements ICreatable, IDroppable, IMarkForDrop, IScriptable, ISfcSupportsDesignMode
The Statistic type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Public method") |
Statistic() | Initializes a new instance of the Statistic class. |
|
Statistic(SqlSmoObject, String) | Initializes a new instance of the Statistic class on the specified parent object and with the specified name. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
Events | Gets the events that are associated with the database. |
|
FileGroup | Gets or sets the filegroup in which the statistic counter is stored. |
|
FilterDefinition | Gets or sets the statistic counters filter definition. |
|
HasFilter | Gets a value that indicates whether there is a filter associated with the statistic counter. |
|
ID | Gets the ID value that uniquely identifies the statistic counter. |
|
IsAutoCreated | Gets the Boolean property value that specifies whether the statistic counter is automatically created. |
|
IsFromIndexCreation | Gets the Boolean property value that specifies whether the statistic counter was generated from the creation of an index. |
|
IsTemporary | Gets the Boolean property value that specifies whether the Statistic counter is temporary or permanent. |
|
LastUpdated | Gets the date and time when the statistic counter was last updated. |
|
Name | Gets or sets a String value that specifies the name of the statistic counter. (Overrides NamedSmoObject.Name.) |
|
NoAutomaticRecomputation | Gets or sets the Boolean property value that specifies whether the statistics counter recomputed automatically. |
|
Parent | Gets or sets the SqlSmoObject object that is the parent of the Statistic object. |
|
Properties | Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.) |
|
State | Gets the state of the referenced object. (Inherited from SmoObjectBase.) |
|
StatisticColumns | Represents a collection of StatisticColumn objects. Each StatisticColumn object represents a column defined on the statistic counter. |
|
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.) |
Top
Methods
| Name | Description | |
|---|---|---|
|
Create | Creates a statistics counter on the instance of SQL Server as defined by the Statistic object. |
|
Discover | Discovers a list of type Object. (Inherited from SqlSmoObject.) |
|
Drop | Removes the statistic counter. |
|
Equals | (Inherited from Object.) |
.gif "Protected method") |
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.) |
|
MarkForDrop | Marks the statistics counter to be dropped next time its parent SqlSmoObject object is altered with the ALTER method. |
|
Refresh | Refreshes the script name. (Inherited from ScriptNameObjectBase.) |
|
Script() | Generates a Transact-SQL script that can be used to re-create the database. |
|
Script(ScriptingOptions) | Generates a Transact-SQL script that can be used to re-create the database as specified by the script options. |
|
SetParentImpl | Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.) |
|
SetScanOptions | Sets the scan options for the statistic counter. |
|
ToString | Returns a String that represents the referenced object. (Inherited from SqlSmoObject.) |
|
Update() | Updates the statistics for the referenced object. |
|
Update(StatisticsScanType) | Updates information about the distribution of key values. |
|
Update(StatisticsScanType, Int32) | Updates information about the distribution of key values. |
|
Update(StatisticsScanType, Int32, Boolean) | Updates information about the distribution of key values. |
|
Validate | Validates the state of an object. (Inherited from SmoObjectBase.) |
Top
Events
| Name | Description | |
|---|---|---|
.gif "Public event") |
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.) |
Top
Explicit Interface Implementations
| Name | Description | |
|---|---|---|
.gif "Explicit interface implemetation") .gif "Private method") |
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.) |
.gif "Private property") |
ISfcSupportsDesignMode.IsDesignMode | Gets a value that indicates whether the statistic counter is in design mode. |
Top
Remarks
To get Statistic object properties, users can be a member of the public fixed server role.
To set Statistic object properties, users must have ALTER permission on the parent table or view or be a member of the db_owner fixed database role.
To create or drop a statistics counter, users must have ALTER permission on the parent table or view or be a member of the db_owner fixed database role.
To update statistics, users must have ALTER permission on the parent table or view or be a member of the db_owner fixed database role.
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Examples
Creating and Updating Statistics
Thread Safety
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
See Also
Reference
Microsoft.SqlServer.Management.Smo Namespace