ISqlIndex Interface

  • Article

Models an index.

Namespace:  Microsoft.Data.Schema.Sql.SchemaModel
Assembly:  Microsoft.Data.Schema.Sql (in Microsoft.Data.Schema.Sql.dll)

Syntax

'Declaration
Public Interface ISqlIndex _
    Inherits ISqlIndexBase, IDatabaseIndex, IModelNamed, ISqlExtendedPropertyHost,  _
    ISqlSpecifiesIndex, ISqlSpecifiesStorage, ISqlModelElement, IScriptSourcedModelElement, IModelElement,  _
    IModelPropertyContainer, IModelEntity, IModelAnnotationHolder

public interface ISqlIndex : ISqlIndexBase, 
    IDatabaseIndex, IModelNamed, ISqlExtendedPropertyHost, ISqlSpecifiesIndex, ISqlSpecifiesStorage, 
    ISqlModelElement, IScriptSourcedModelElement, IModelElement, IModelPropertyContainer, IModelEntity, 
    IModelAnnotationHolder

public interface class ISqlIndex : ISqlIndexBase, 
    IDatabaseIndex, IModelNamed, ISqlExtendedPropertyHost, ISqlSpecifiesIndex, ISqlSpecifiesStorage, 
    ISqlModelElement, IScriptSourcedModelElement, IModelElement, IModelPropertyContainer, IModelEntity, 
    IModelAnnotationHolder

type ISqlIndex =  
    interface
        interface ISqlIndexBase
        interface IDatabaseIndex
        interface IModelNamed
        interface ISqlExtendedPropertyHost
        interface ISqlSpecifiesIndex
        interface ISqlSpecifiesStorage
        interface ISqlModelElement
        interface IScriptSourcedModelElement
        interface IModelElement
        interface IModelPropertyContainer
        interface IModelEntity
        interface IModelAnnotationHolder
    end

public interface ISqlIndex extends ISqlIndexBase, IDatabaseIndex, IModelNamed, ISqlExtendedPropertyHost, ISqlSpecifiesIndex, ISqlSpecifiesStorage, ISqlModelElement, IScriptSourcedModelElement, IModelElement, IModelPropertyContainer, IModelEntity, IModelAnnotationHolder

The ISqlIndex type exposes the following members.

Properties

  Name Description
Public property ColumnSpecifications Gets a list of the columns that are indexed. (Inherited from ISqlSpecifiesIndex.)
Public property DoAllowPageLocks Gets or sets a value that indicates whether page-level locks are permitted.
Public property DoAllowRowLocks Gets or sets a value that indicates whether row locks should be permitted.
Public property DoDropExisting Gets or sets a value that models the DROP_EXISTING option.
Public property DoIgnoreDuplicateKey Gets or sets a value that indicates whether duplicate keys should be ignored.
Public property DoRecomputeStatistics Gets or sets a value that indicates whether statistics should be recomputed.
Public property DoSortInTempDB Gets or sets a value that indicates whether sorting should occur in the TempDB database.
Public property ElementClass Gets the metadata class for an element. (Inherited from IModelElement.)
Public property ExtendedProperties Gets the list of extended properties for this object. (Inherited from ISqlExtendedPropertyHost.)
Public property Filegroup Gets or sets the filegroup on which the object is stored. (Inherited from ISqlSpecifiesStorage.)
Public property FillFactor Gets or sets the fill factor of the index. (Inherited from ISqlSpecifiesIndex.)
Public property IndexedObject The object that is indexed. (Inherited from IDatabaseIndex.)
Public property IndexedObject Gets or sets the indexed object.
Public property IsClustered Gets or sets a value that indicates whether this is a clustered index. (Inherited from ISqlSpecifiesIndex.)
Public property IsDisabled Gets or sets a value that indicates whether the index is disabled. (Inherited from ISqlIndexBase.)
Public property IsPadded Gets or sets a value that indicates whether the index is padded.
Public property IsUnique Gets or sets a value that indicates whether the index is a unique index.
Public property Model Gets the model reference. (Inherited from IModelEntity.)
Public property Name Gets or sets the name of the element. (Inherited from IModelElement.)
Public property PrimarySource Gets information about the primary source for the element. (Inherited from IScriptSourcedModelElement.)
Public property ResolutionStatus Gets or sets the value of the model element resolution status. (Inherited from IModelElement.)
Public property SecondarySources Gets a list of secondary sources for the element. (Inherited from IScriptSourcedModelElement.)
Public property SourceCodePositions Gets the list of sources that define this element. (Inherited from IModelElement.)
Public property ValidationStatus Gets or sets the value of the model element validation status. (Inherited from IModelElement.)

Top

Methods

  Name Description
Public method AddAnnotation Adds the given annotation to this element. (Inherited from IModelAnnotationHolder.)
Public method Delete Deletes this instance from the model. (Inherited from IModelElement.)
Public method GetAnnotations() Returns a list of annotations attached to this element. (Inherited from IModelAnnotationHolder.)
Public method GetAnnotations(Type) Returns a list of attached annotations of the given type. (Inherited from IModelAnnotationHolder.)
Public method GetAnnotations(ModelIdentifier) Returns a list of attached annotations that have the given identifier. (Inherited from IModelAnnotationHolder.)
Public method GetAnnotations(ModelIdentifier, Type) (Inherited from IModelAnnotationHolder.)
Public method GetAnnotations<TType>() Returns all attached model annotations that implement the given annotation type and have the specified model identifier. (Inherited from IModelAnnotationHolder.)
Public method GetAnnotations<TType>(ModelIdentifier) (Inherited from IModelAnnotationHolder.)
Public method GetColumnSpecificationsRelationship Returns an IModelMultiRelationship between this and the associated ISqlIndexedColumnSpecification. (Inherited from ISqlSpecifiesIndex.)
Public method GetComposingChildren Returns a list of composing children for this element. (Inherited from IModelElement.)
Public method GetExtendedPropertiesRelationship Returns an IModelReverseMultiRelationship between this and the associated ISqlExtendedProperty. (Inherited from ISqlExtendedPropertyHost.)
Public method GetFilegroupRelationship Returns an IModelSingleRelationship between this and the associated ISqlFilegroup. (Inherited from ISqlSpecifiesStorage.)
Public method GetHierarchicalChildren Returns a list of hierarchical children for this element. (Inherited from IModelElement.)
Public method GetIndexedObjectRelationship() Returns the IModelSingleRelationship between this IDatabaseIndex and the corresponding IDatabaseColumnSource. (Inherited from IDatabaseIndex.)
Public method GetIndexedObjectRelationship() Returns an IModelSingleRelationship between this and the associated ISqlColumnSource.
Public method GetOwnerInfo Returns information about the element owner. (Inherited from IModelElement.)
Public method GetProperty<TProperty> Gets the specified property. (Inherited from IModelPropertyContainer.)
Public method GetReferencedDanglingRelationshipEntries Returns a list of the relationship entries, where this element is on the left side and there is either no element on the right side of the relationship, or the element on the right does not exist in the model. (Inherited from IModelElement.)
Public method GetReferencedElements Returns a list of the elements that are in a relationship with this element, where this element is on the left side of the relationship. (Inherited from IModelElement.)
Public method GetReferencedRelationshipEntries Returns a list of the relationship entries, where this element is on the left side. (Inherited from IModelElement.)
Public method GetReferencingElements Returns a list of the elements that are in a relationship with this element, where this element is on the right side. (Inherited from IModelElement.)
Public method GetReferencingRelationshipEntries Returns a list of the relationship entries, where this element is on the right side. (Inherited from IModelElement.)
Public method GetRelationship(ModelRelationshipClass) Returns the requested relationship by using the provided metadata. (Inherited from IModelElement.)
Public method GetRelationship<TFrom, TTo>(ModelRelationshipClass) Returns a relationship where the two related elements are of the specified types. (Inherited from IModelElement.)
Public method GetRelationshipEntrySources Returns a collection of source information about the given relationship. (Inherited from IScriptSourcedModelElement.)
Public method GetRelationships Returns a list of the relationships in this element. (Inherited from IModelElement.)
Public method IsDeleted Specifies whether the object is deleted. (Inherited from IModelElement.)
Public method IsExternal Returns a value that indicates whether the object was loaded from an external source and is not a part of the schema model. (Inherited from IModelElement.)
Public method RemoveAnnotation Removes the specified annotation from this model element. (Inherited from IModelAnnotationHolder.)
Public method SetProperty<TProperty> Sets the specified property. (Inherited from IModelPropertyContainer.)

Top

See Also

Reference

Microsoft.Data.Schema.Sql.SchemaModel Namespace