Share via

Statistic Class

  • Article

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
Public method Statistic() Initializes a new instance of the Statistic class.
Public method 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
Public property Events Gets the events that are associated with the database.
Public property FileGroup Gets or sets the filegroup in which the statistic counter is stored.
Public property FilterDefinition Gets or sets the statistic counters filter definition.
Public property HasFilter Gets a value that indicates whether there is a filter associated with the statistic counter.
Public property ID Gets the ID value that uniquely identifies the statistic counter.
Public property IsAutoCreated Gets the Boolean property value that specifies whether the statistic counter is automatically created.
Public property IsFromIndexCreation Gets the Boolean property value that specifies whether the statistic counter was generated from the creation of an index.
Public property IsTemporary Gets the Boolean property value that specifies whether the Statistic counter is temporary or permanent.
Public property LastUpdated Gets the date and time when the statistic counter was last updated.
Public property Name Gets or sets a String value that specifies the name of the statistic counter. (Overrides NamedSmoObject.Name.)
Public property NoAutomaticRecomputation Gets or sets the Boolean property value that specifies whether the statistics counter recomputed automatically.
Public property Parent Gets or sets the SqlSmoObject object that is the parent of the Statistic object.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property StatisticColumns Represents a collection of StatisticColumn objects. Each StatisticColumn object represents a column defined on the statistic counter.
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)

Top

Methods

  Name Description
Public method Create Creates a statistics counter on the instance of SQL Server as defined by the Statistic object.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop Removes the statistic counter.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method MarkForDrop Marks the statistics counter to be dropped next time its parent SqlSmoObject object is altered with the ALTER method.
Public method Refresh Refreshes the script name. (Inherited from ScriptNameObjectBase.)
Public method Script() Generates a Transact-SQL script that can be used to re-create the database.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the database as specified by the script options.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method SetScanOptions Sets the scan options for the statistic counter.
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Update() Updates the statistics for the referenced object.
Public method Update(StatisticsScanType) Updates information about the distribution of key values.
Public method Update(StatisticsScanType, Int32) Updates information about the distribution of key values.
Public method Update(StatisticsScanType, Int32, Boolean) Updates information about the distribution of key values.
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method 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.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate 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

Other Resources

Creating and Updating Statistics

CREATE STATISTICS (Transact-SQL)