ISqlIndex Interface

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

Top

Methods

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

Top

See Also

Reference

Microsoft.Data.Schema.Sql.SchemaModel Namespace