Classe Index

The Index object represents a SQL Server index.

Hiérarchie d'héritage

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.Index

Espace de noms :  Microsoft.SqlServer.Management.Smo
Assembly :  Microsoft.SqlServer.Smo (en Microsoft.SqlServer.Smo.dll)

Syntaxe

'Déclaration
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class Index _
    Inherits ScriptNameObjectBase _
    Implements ICreatable, IDroppable, IMarkForDrop, IAlterable,  _
    IRenamable, IExtendedProperties, IScriptable, ISfcSupportsDesignMode
'Utilisation
Dim instance As Index
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class Index : ScriptNameObjectBase, 
    ICreatable, IDroppable, IMarkForDrop, IAlterable, IRenamable, 
    IExtendedProperties, IScriptable, ISfcSupportsDesignMode
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class Index sealed : public ScriptNameObjectBase, 
    ICreatable, IDroppable, IMarkForDrop, IAlterable, IRenamable, 
    IExtendedProperties, IScriptable, ISfcSupportsDesignMode
[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type Index =  
    class 
        inherit ScriptNameObjectBase 
        interface ICreatable 
        interface IDroppable 
        interface IMarkForDrop 
        interface IAlterable 
        interface IRenamable 
        interface IExtendedProperties 
        interface IScriptable 
        interface ISfcSupportsDesignMode 
    end
public final class Index extends ScriptNameObjectBase implements ICreatable, IDroppable, IMarkForDrop, IAlterable, IRenamable, IExtendedProperties, IScriptable, ISfcSupportsDesignMode

Le type Index expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique Index() Initializes a new instance of the Index class.
Méthode publique Index(SqlSmoObject, String) Initializes a new instance of the Index class on the specified parent object and with the specified name.

Haut de la page

Propriétés

  Nom Description
Propriété publique BoundingBoxXMax Specifies the x-coordinate of the upper right corner of a bounding box.
Propriété publique BoundingBoxXMin Specifies the x-coordinate of the lower-left corner of a bounding box.
Propriété publique BoundingBoxYMax Specifies the y-coordinate of upper-right corner of a bounding box.
Propriété publique BoundingBoxYMin Specifies the y-coordinate of the lower-left corner of a bounding box.
Propriété publique CellsPerObject Defines the maximum number of cells that tessellation can count per object.
Propriété publique CompactLargeObjects Gets or sets the Boolean property value that specifies whether to compact the large object (LOB) data in the index.
Propriété publique DisallowPageLocks Gets or sets the Boolean property value that specifies whether the index allows page locks.
Propriété publique DisallowRowLocks Gets or sets the Boolean property value that specifies whether the index allows row locks.
Propriété publique Events Gets the index events supported by the Index object.
Propriété publique ExtendedProperties Represents a collection of ExtendedProperty objects. Each ExtendedProperty object represents an extended property defined on the Index object.
Propriété publique FileGroup Gets or sets the filegroup where the index pages are stored.
Propriété publique FileStreamFileGroup Gets or Sets the file group name for the index.
Propriété publique FileStreamPartitionScheme Gets or Sets the partition scheme name for the index.
Propriété publique FillFactor Gets or sets the percentage of an index page to fill when the index is created or re-created.
Propriété publique FilterDefinition Gets or sets the String value that contains the definition for the filter.
Propriété publique HasCompressedPartitions Gets or sets the Boolean property value that specifies whether the index has compressed partitions.
Propriété publique HasFilter Gets the Boolean property value that specifies whether the index has a filter defined for a range of index values.
Propriété publique ID Gets the index ID value that uniquely identifies the index within the database.
Propriété publique IgnoreDuplicateKeys Gets or sets the Boolean property value that specifies whether the index ignores duplicate keys.
Propriété publique IndexedColumns Gets a collection of IndexedColumn objects that represent all the columns participating in the index.
Propriété publique IndexedXmlPathName Gets or sets the name of the indexed XML path.
Propriété publique IndexedXmlPathNamespaces Gets the collection of indexed XML path namespace.
Propriété publique IndexedXmlPaths Gets or sets the collection of indexed XML paths.
Propriété publique IndexKeyType Gets or sets the index key type.
Propriété publique IndexType Gets or sets the type of index.
Propriété publique IsClustered Gets or sets the Boolean property value that specifies whether the index is clustered.
Propriété publique IsDisabled Gets or sets the Boolean property value that specifies whether the index is disabled.
Propriété publique IsFileTableDefined Gets or sets whether the file table is defined.
Propriété publique IsFullTextKey Gets the Boolean value that specifies whether the index is enabled for row identification in Microsoft Search.
Propriété publique IsIndexOnComputed Gets the Boolean property value that specifies whether the index is based on a computed column.
Propriété publique IsIndexOnTable Gets the Boolean property value that specifies whether the index is defined for a table or a view.
Propriété publique IsPartitioned Gets the Boolean property value that specifies whether the index is stored in a partitioned scheme.
Propriété publique IsSpatialIndex Gets a value that indicates whether an index is a spatial index.
Propriété publique IsSystemNamed Gets the Boolean property value that specifies whether the index was named automatically by the system.
Propriété publique IsSystemObject Gets the Boolean property value that specifies whether the index is a system object.
Propriété publique IsUnique Gets or sets the Boolean property value that specifies whether the index is unique or not.
Propriété publique IsXmlIndex Gets or sets the Boolean property value that specifies whether the index is an XML index.
Propriété publique Level1Grid Gets or sets the first level of decomposition for a geometry data type.
Propriété publique Level2Grid Specifies the second level of decomposition for a geometry data type.
Propriété publique Level3Grid Specifies the third level of decomposition for a geometry data type.
Propriété publique Level4Grid Gets or sets the fourth level of decomposition for a geometry data type.
Propriété publique MaximumDegreeOfParallelism Gets or sets the maximum number of processors that can be used when running a query that uses the index.
Propriété publique Name Gets or sets the name of the index. (remplace NamedSmoObject.Name.)
Propriété publique NoAutomaticRecomputation Gets or sets the Boolean property value that specifies whether statistics are regenerated when an index is created.
Propriété publique OnlineIndexOperation Gets or sets the Boolean property value that specifies whether the index will be kept online during index operations thus allowing access to the data.
Propriété publique PadIndex Gets or sets the Boolean property value that specifies whether space is left open on each page of the intermediate levels of the index.
Propriété publique Parent Gets or sets the SqlSmoObject object that is the parent of the Index object.
Propriété publique ParentXmlIndex Gets or sets the parent of an XML index.
Propriété publique PartitionScheme Gets or sets the partition scheme associated with the index.
Propriété publique PartitionSchemeParameters Represents a collection of PartitionSchemeParameter objects. Each PartitionSchemeParameter object represents a parameter in the partition scheme associated with the index.
Propriété publique PhysicalPartitions Gets a collection of PhysicalPartition objects that represent all the physical partitions on which the index is stored.
Propriété publique Properties Gets a collection of Property objects that represent the object properties. (hérité de SqlSmoObject.)
Propriété publique SecondaryXmlIndexType Gets or sets the secondary XML index type.
Propriété publique SortInTempdb Gets or sets the Boolean property value that specifies whether the index is sorted using the tempdb database for intermediate storage of data.
Propriété publique SpaceUsed Gets or sets the disk space used to store the index data in kilobytes.
Propriété publique SpatialIndexType Gets or sets the Spatial Index Type for a column.
Propriété publique State Gets the state of the referenced object. (hérité de SmoObjectBase.)
Propriété publique Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (hérité de SqlSmoObject.)
Propriété publique UserData Gets or sets user-defined data associated with the referenced object. (hérité de SmoObjectBase.)

Haut de la page

Méthodes

  Nom Description
Méthode publique Alter() Updates any Index object property changes on the instance of SQL Server.
Méthode publique Alter(IndexOperation) Updates any Index object property changes on the instance of SQL Server for a specified index operation.
Méthode publique AlterAllIndexes Updates any Index object property changes for all indexes on the instance of SQL Server for a specified index operation.
Méthode publique CheckIndex Tests the integrity of database pages that store the index.
Méthode publique CheckIndexWithResult Tests the integrity of database pages that store the index.
Méthode publique Create Creates an index on the instance of SQL Server as defined by the Index object.
Méthode publique Disable Disables the index.
Méthode publique Discover Discovers a list of type Object. (hérité de SqlSmoObject.)
Méthode publique Drop Drops the index.
Méthode publique DropAndMove(String) Drops a clustered index and moves the underlying table data to the specified filegroup.
Méthode publique DropAndMove(String, StringCollection) Drops a clustered index and moves the underlying table data to the partition scheme with the specified partition scheme parameters.
Méthode publique Enable Enables the index.
Méthode publique EnumFragmentation() Enumerates a list of fragmentation information for the index using the default fast fragmentation option.
Méthode publique EnumFragmentation(FragmentationOption) Enumerates a list of fragmentation information for the index with the specified fragmentation option.
Méthode publique EnumFragmentation(FragmentationOption, Int32) Enumerates a list of fragmentation information for the index with the specified fragmentation option and partition number.
Méthode publique EnumStatistics Enumerates a list of statistical information for the index.
Méthode publique Equals (hérité de Object.)
Méthode protégée FormatSqlVariant Formats an object as SqlVariant type. (hérité de SqlSmoObject.)
Méthode protégée GetContextDB Gets the context database that is associated with this object. (hérité de SqlSmoObject.)
Méthode protégée GetDBName Gets the database name that is associated with the object. (hérité de SqlSmoObject.)
Méthode publique GetHashCode (hérité de Object.)
Méthode protégée GetPropValue Gets a property value of the SqlSmoObject object. (hérité de SqlSmoObject.)
Méthode protégée GetPropValueOptional Gets a property value of the SqlSmoObject object. (hérité de SqlSmoObject.)
Méthode protégée GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (hérité de SqlSmoObject.)
Méthode protégée GetServerObject Gets the server of the SqlSmoObject object. (hérité de SqlSmoObject.)
Méthode publique GetType (hérité de Object.)
Méthode publique Initialize() Initializes the object and forces the properties be loaded. (hérité de SqlSmoObject.)
Méthode publique Initialize(Boolean) Initializes the object and forces the properties be loaded. (hérité de SqlSmoObject.)
Méthode protégée IsObjectInitialized Verifies whether the object has been initialized. (hérité de SqlSmoObject.)
Méthode protégée IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (hérité de SqlSmoObject.)
Méthode publique MarkForDrop Marks the index to be dropped the next time that the Alter method is run on the Index object's parent object.
Méthode publique Rebuild() Rebuilds the index.
Méthode publique Rebuild(Int32) Rebuilds the index on the partition with the specified partition number.
Méthode publique RebuildAllIndexes Rebuilds all the indexes.
Méthode publique RecalculateSpaceUsage Updates the disk resource usage of the index.
Méthode publique Recreate Re-creates the index.
Méthode publique Refresh Refreshes the Index object and its properties. (remplace ScriptNameObjectBase.Refresh().)
Méthode publique Rename Renames the index.
Méthode publique Reorganize Reorganizes the index based on current property settings.
Méthode publique ReorganizeAllIndexes Reorganizes all the indexes based on current property settings.
Méthode publique Script() Generates a Transact-SQL script that can be used to re-create the index.
Méthode publique Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the index as specified by the script options.
Méthode protégée SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (hérité de SqlSmoObject.)
Méthode publique ToString Returns a String that represents the referenced object. (hérité de SqlSmoObject.)
Méthode publique UpdateStatistics() Updates statistics for the referenced index.
Méthode publique UpdateStatistics(StatisticsScanType) Updates statistics for the referenced index with the specified statistics scan type.
Méthode publique UpdateStatistics(StatisticsScanType, Int32) Updates statistics for the referenced index with the specified statistics scan type and specified sample size.
Méthode publique UpdateStatistics(StatisticsScanType, Int32, Boolean) Updates statistics for the referenced index with the specified statistics scan type and specified sample size and with the option to recompute the statistics.
Méthode publique Validate Validates the state of an object. (hérité de SmoObjectBase.)

Haut de la page

Événements

  Nom Description
Événement public PropertyChanged Represents the event that occurs when a property is changed. (hérité de SqlSmoObject.)
Événement public PropertyMetadataChanged Represents the event that occurs when property metadata changes. (hérité de SqlSmoObject.)

Haut de la page

Implémentations d'interfaces explicites

  Nom Description
Implémentation d'interface expliciteMéthode privée IAlienObject.Discover Discovers any dependencies. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetDomainRoot Returns the root of the domain. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetParent Gets the parent of this object. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetPropertyType Gets the type of the specified property. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetPropertyValue Gets the value of the specified property. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Ne faites pas directement référence à ce membre dans votre code. Il prend en charge l'infrastructure SQL Server. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée IAlienObject.SetPropertyValue Sets the property value. (hérité de SqlSmoObject.)
Implémentation d'interface expliciteMéthode privée ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (hérité de SqlSmoObject.)
Implémentation d'interface explicitePropriété privée ISfcSupportsDesignMode.IsDesignMode Gets a Boolean value that indicates whether the object supports design mode.

Haut de la page

Notes

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

To set Index object properties, create or drop an index, update statistics on an index, or rebuild, reorganize, or re-create an index, users must have one of the following:

  • ALTER permission on the parent table or view

  • Membership of the db_owner or the db_ddladmin fixed database roles

  • Membership of the sysadmin fixed server role

Thread Safety

Tout membre statique public (Partagé dans Microsoft Visual Basic) de ce type est sûr dans le cadre des opérations à plusieurs threads. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Exemples

Création, modification et suppression d'index

Sécurité des threads

Tous les membres publics static (Shared dans Visual Basic) de ce type sont thread-safe. Tous les membres de l'instance ne sont pas garantis comme étant thread-safe.

Voir aussi

Référence

Espace de noms Microsoft.SqlServer.Management.Smo

Autres ressources

Index

CREATE INDEX (Transact-SQL)