Share via

IDatabaseIndex Interface

  • Article

Models a database index.

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

Syntax

'Declaration
Public Interface IDatabaseIndex _
    Inherits IModelElement, IModelPropertyContainer, IModelEntity, IModelAnnotationHolder

public interface IDatabaseIndex : IModelElement, 
    IModelPropertyContainer, IModelEntity, IModelAnnotationHolder

public interface class IDatabaseIndex : IModelElement, 
    IModelPropertyContainer, IModelEntity, IModelAnnotationHolder

type IDatabaseIndex =  
    interface
        interface IModelElement
        interface IModelPropertyContainer
        interface IModelEntity
        interface IModelAnnotationHolder
    end

public interface IDatabaseIndex extends IModelElement, IModelPropertyContainer, IModelEntity, IModelAnnotationHolder

The IDatabaseIndex type exposes the following members.

Properties

  Name Description
Public property ElementClass Gets the metadata class for an element. (Inherited from IModelElement.)
Public property IndexedObject The object that is indexed.
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 ResolutionStatus Gets or sets the value of the model element resolution status. (Inherited from IModelElement.)
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 GetComposingChildren Returns a list of composing children for this element. (Inherited from IModelElement.)
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.
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 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.SchemaModel.Abstract Namespace