Class Index

Namespace

Microsoft.EntityFrameworkCore.Metadata.Internal

Assembly

Microsoft.EntityFrameworkCore.dll

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public class Index : ConventionAnnotatable, IMutableIndex, IMutableAnnotatable, IConventionIndex, IConventionAnnotatable, IIndex, IReadOnlyIndex, IAnnotatable, IReadOnlyAnnotatable

Inheritance

object

AnnotatableBase

Annotatable

ConventionAnnotatable

Index

Implements

IMutableIndex

IMutableAnnotatable

IConventionIndex

IConventionAnnotatable

IIndex

IReadOnlyIndex

IAnnotatable

IReadOnlyAnnotatable

Inherited Members

ConventionAnnotatable.GetAnnotations()

ConventionAnnotatable.AddAnnotation(string, object, ConfigurationSource)

ConventionAnnotatable.SetAnnotation(string, object)

ConventionAnnotatable.SetAnnotation(string, object, ConfigurationSource)

ConventionAnnotatable.SetOrRemoveAnnotation(string, object, ConfigurationSource)

ConventionAnnotatable.OnAnnotationSet(string, Annotation, Annotation)

ConventionAnnotatable.FindAnnotation(string)

ConventionAnnotatable.CreateAnnotation(string, object)

Annotatable.EnsureReadOnly()

Annotatable.EnsureMutable()

AnnotatableBase.AddAnnotation(string, object)

AnnotatableBase.AddAnnotation(string, Annotation)

AnnotatableBase.AddAnnotations(IEnumerable<IAnnotation>)

AnnotatableBase.AddAnnotations(IReadOnlyDictionary<string, object>)

AnnotatableBase.SetAnnotation(string, Annotation, Annotation)

AnnotatableBase.GetAnnotation(string)

AnnotatableBase.RemoveAnnotation(string)

AnnotatableBase.GetRuntimeAnnotations()

AnnotatableBase.AddRuntimeAnnotation(string, object)

AnnotatableBase.AddRuntimeAnnotation(string, Annotation)

AnnotatableBase.AddRuntimeAnnotations(IEnumerable<Annotation>)

AnnotatableBase.AddRuntimeAnnotations(IReadOnlyDictionary<string, object>)

AnnotatableBase.SetRuntimeAnnotation(string, object)

AnnotatableBase.SetRuntimeAnnotation(string, Annotation, Annotation)

AnnotatableBase.GetOrAddRuntimeAnnotationValue<TValue, TArg>(string, Func<TArg, TValue>, TArg)

AnnotatableBase.FindRuntimeAnnotation(string)

AnnotatableBase.RemoveRuntimeAnnotation(string)

AnnotatableBase.CreateRuntimeAnnotation(string, object)

AnnotatableBase.this[string]

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

Index(IReadOnlyList<Property>, EntityType, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public Index(IReadOnlyList<Property> properties, EntityType declaringEntityType, ConfigurationSource configurationSource)

Parameters

properties IReadOnlyList<Property>

declaringEntityType EntityType

configurationSource ConfigurationSource

Index(IReadOnlyList<Property>, string, EntityType, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public Index(IReadOnlyList<Property> properties, string name, EntityType declaringEntityType, ConfigurationSource configurationSource)

Parameters

properties IReadOnlyList<Property>

name string

declaringEntityType EntityType

configurationSource ConfigurationSource

Properties

Builder

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual InternalIndexBuilder Builder { get; }

Property Value

InternalIndexBuilder

DebugView

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual DebugView DebugView { get; }

Property Value

DebugView

DeclaringEntityType

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual EntityType DeclaringEntityType { get; }

Property Value

EntityType

IsDescending

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual IReadOnlyList<bool>? IsDescending { get; set; }

Property Value

IReadOnlyList<bool>

IsInModel

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual bool IsInModel { get; }

Property Value

bool

IsReadOnly

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public override bool IsReadOnly { get; }

Property Value

bool

IsUnique

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual bool IsUnique { get; set; }

Property Value

bool

Name

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual string? Name { get; }

Property Value

string

Properties

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual IReadOnlyList<Property> Properties { get; }

Property Value

IReadOnlyList<Property>

Methods

DisplayName()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual string DisplayName()

Returns

string

GetConfigurationSource()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual ConfigurationSource GetConfigurationSource()

Returns

ConfigurationSource

GetIsDescendingConfigurationSource()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual ConfigurationSource? GetIsDescendingConfigurationSource()

Returns

ConfigurationSource?

GetIsUniqueConfigurationSource()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual ConfigurationSource? GetIsUniqueConfigurationSource()

Returns

ConfigurationSource?

GetNullableValueFactory<TKey>()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual IDependentKeyValueFactory<TKey> GetNullableValueFactory<TKey>()

Returns

IDependentKeyValueFactory<TKey>

Type Parameters

TKey

OnAnnotationSet(string, IConventionAnnotation?, IConventionAnnotation?)

Runs the conventions when an annotation was set or removed.

protected override IConventionAnnotation? OnAnnotationSet(string name, IConventionAnnotation? annotation, IConventionAnnotation? oldAnnotation)

Parameters

name string

The key of the set annotation.

annotation IConventionAnnotation

The annotation set.

oldAnnotation IConventionAnnotation

The old annotation.

Returns

IConventionAnnotation

The annotation that was set.

SetIsDescending(IReadOnlyList<bool>?, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual IReadOnlyList<bool>? SetIsDescending(IReadOnlyList<bool>? descending, ConfigurationSource configurationSource)

Parameters

descending IReadOnlyList<bool>

configurationSource ConfigurationSource

Returns

IReadOnlyList<bool>

SetIsUnique(bool?, ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual bool? SetIsUnique(bool? unique, ConfigurationSource configurationSource)

Parameters

unique bool?

configurationSource ConfigurationSource

Returns

bool?

SetRemovedFromModel()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual void SetRemovedFromModel()

ToString()

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public override string ToString()

Returns

string

UpdateConfigurationSource(ConfigurationSource)

This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

public virtual void UpdateConfigurationSource(ConfigurationSource configurationSource)

Parameters

configurationSource ConfigurationSource