IConventionIndex Schnittstelle

Definition

Namespace:

Microsoft.EntityFrameworkCore.Metadata

Assembly:

Microsoft.EntityFrameworkCore.dll

Paket:

Microsoft.EntityFrameworkCore v8.0.0

Stellt einen Index für eine Reihe von Eigenschaften dar.

public interface IConventionIndex : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex

type IConventionIndex = interface
    interface IReadOnlyIndex
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable

Public Interface IConventionIndex
Implements IConventionAnnotatable, IReadOnlyIndex

Implementiert

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyIndex

Hinweise

Diese Schnittstelle wird während der Modellerstellung verwendet und ermöglicht das Ändern der Metadaten. Sobald das Modell erstellt wurde, IIndex stellt eine schreibgeschützte Ansicht der gleichen Metadaten dar.

Weitere Informationen und Beispiele finden Sie unter Modellerstellungskonventionen .

Eigenschaften

Builder	Ruft den Generator ab, der zum Konfigurieren dieses Indexes verwendet werden kann.
DeclaringEntityType	Ruft den Entitätstyp ab, für den der Index definiert ist. Dies kann sich von dem Typ unterscheiden, für den definiert wird, Properties wenn der Index als abgeleiteter Typ in einer Vererbungshierarchie definiert wird (da die Eigenschaften möglicherweise für einen Basistyp definiert werden).
IsDescending	Ein Satz von Werten, der angibt, ob jede entsprechende Indexspalte absteigende Sortierreihenfolge aufweist. (Geerbt von IReadOnlyIndex)
IsInModel	Gibt an, ob sich dieses Objekt in einem Modell befindet, d. h. nicht aus einem Modell entfernt wurde. (Geerbt von IConventionAnnotatable)
IsUnique	Ruft einen Wert ab, der angibt, ob die den indizierten Eigenschaften zugewiesenen Werte eindeutig sind. (Geerbt von IReadOnlyIndex)
Item[String]	Ruft den Wert der Anmerkung mit dem angegebenen Namen ab und gibt null zurück, wenn sie nicht vorhanden ist. (Geerbt von IReadOnlyAnnotatable)
Name	Ruft den Namen dieses Indexes ab. (Geerbt von IReadOnlyIndex)
Properties	Ruft die Eigenschaften ab, für die dieser Index definiert ist.

Methoden

AddAnnotation(String, Object, Boolean)	Fügt diesem Objekt eine Anmerkung hinzu. Wird ausgelöst, wenn bereits eine Anmerkung mit dem angegebenen Namen vorhanden ist. (Geerbt von IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Fügt einem Objekt Anmerkungen hinzu. (Geerbt von IConventionAnnotatable)
AnnotationsToDebugString(Int32)	Ruft die Debugzeichenfolge für alle Anmerkungen ab, die für das -Objekt deklariert wurden. (Geerbt von IReadOnlyAnnotatable)
DisplayName()	Ruft den Anzeigenamen für den angegebenen IReadOnlyIndexab, und gibt seinen Name zurück, wenn einer definiert ist, oder eine Zeichenfolgendarstellung dessen Properties , wenn es sich um einen unbenannten Index handelt. (Geerbt von IReadOnlyIndex)
FindAnnotation(String)	Ruft die Anmerkung mit dem angegebenen Namen ab und gibt zurück null , wenn sie nicht vorhanden ist. (Geerbt von IReadOnlyAnnotatable)
GetAnnotation(String)	Ruft die Anmerkung mit dem angegebenen Namen ab und löst aus, wenn sie nicht vorhanden ist. (Geerbt von IReadOnlyAnnotatable)
GetAnnotations()	Ruft alle Anmerkungen für das aktuelle Objekt ab. (Geerbt von IReadOnlyAnnotatable)
GetConfigurationSource()	Gibt die Konfigurationsquelle für diesen Index zurück.
GetIsDescendingConfigurationSource()	Gibt die Konfigurationsquelle für IsDescendingzurück.
GetIsUniqueConfigurationSource()	Gibt die Konfigurationsquelle für IsUniquezurück.
RemoveAnnotation(String)	Entfernt die Anmerkung mit dem angegebenen Namen aus diesem Objekt. (Geerbt von IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)	Legt die Unter dem angegebenen Namen gespeicherte Anmerkung fest. Überschreibt die vorhandene Anmerkung, wenn bereits eine Anmerkung mit dem angegebenen Namen vorhanden ist. (Geerbt von IConventionAnnotatable)
SetIsDescending(IReadOnlyList<Boolean>, Boolean)	Legt die Sortierreihenfolge(en) für diesen Index fest (aufsteigend oder absteigend).
SetIsUnique(Nullable<Boolean>, Boolean)	Legt einen Wert fest, der angibt, ob die den Indexeigenschaften zugewiesenen Werte eindeutig sind.
SetOrRemoveAnnotation(String, Object, Boolean)	Legt die Unter dem angegebenen Namen gespeicherte Anmerkung fest. Überschreibt die vorhandene Anmerkung, wenn bereits eine Anmerkung mit dem angegebenen Namen vorhanden ist. Entfernt die vorhandene Anmerkung, sofern null angegeben. (Geerbt von IConventionAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Erstellt eine lesbare Darstellung der angegebenen Metadaten. Warnung: Verlassen Sie sich nicht auf das Format der zurückgegebenen Zeichenfolge. Es ist nur für das Debuggen konzipiert und kann sich zwischen Releases beliebig ändern. (Geerbt von IReadOnlyIndex)

Erweiterungsmethoden

FindSharedObjectRootIndex(IConventionIndex, StoreObjectIdentifier)	Sucht die erste IConventionIndex , die demselben Index in einem freigegebenen tabellenähnlichen Objekt zugeordnet ist. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Es wird im Allgemeinen nicht im Anwendungscode verwendet.
FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier)	Sucht die erste IIndex , die demselben Index in einem freigegebenen tabellenähnlichen Objekt zugeordnet ist. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Es wird im Allgemeinen nicht im Anwendungscode verwendet.
GetDatabaseName(IReadOnlyIndex)	Gibt den Namen des Indexes in der Datenbank zurück.
GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	Gibt den Namen des Indexes in der Datenbank zurück.
GetDatabaseNameConfigurationSource(IConventionIndex)	Ruft den ConfigurationSource für den Namen des Indexes in der Datenbank ab.
GetDefaultDatabaseName(IReadOnlyIndex)	Gibt den Standardnamen zurück, der für diesen Index verwendet wird.
GetDefaultDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	Gibt den Standardnamen zurück, der für diesen Index verwendet wird.
GetFilter(IReadOnlyIndex)	Gibt den Indexfilterausdruck zurück.
GetFilter(IReadOnlyIndex, StoreObjectIdentifier)	Gibt den Indexfilterausdruck zurück.
GetFilterConfigurationSource(IConventionIndex)	Ruft den ConfigurationSource für den Indexfilterausdruck ab.
SetDatabaseName(IConventionIndex, String, Boolean)	Legt den Namen des Indexes in der Datenbank fest.
SetFilter(IConventionIndex, String, Boolean)	Legt den Indexfilterausdruck fest.
GetDataCompression(IReadOnlyIndex)	Gibt die Datenkomprimierung zurück, die der Index verwendet.
GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier)	Gibt die Datenkomprimierung zurück, die der Index verwendet.
GetDataCompressionConfigurationSource(IConventionIndex)	Gibt den ConfigurationSource für die Vom Index verwendete Datenkomprimierung zurück.
GetFillFactor(IReadOnlyIndex)	Gibt den Füllfaktor zurück, den der Index verwendet.
GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier)	Gibt den Füllfaktor zurück, den der Index verwendet.
GetFillFactorConfigurationSource(IConventionIndex)	Gibt zurück, ConfigurationSource ob der Index den Füllfaktor verwendet.
GetIncludeProperties(IReadOnlyIndex)	Gibt enthaltene Eigenschaftsnamen zurück, oder null , wenn sie nicht angegeben wurden.
GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier)	Gibt enthaltene Eigenschaftsnamen zurück, oder null , wenn sie nicht angegeben wurden.
GetIncludePropertiesConfigurationSource(IConventionIndex)	Gibt den ConfigurationSource für die eingeschlossenen Eigenschaftennamen zurück.
GetIsClusteredConfigurationSource(IConventionIndex)	Gibt zurück, ConfigurationSource ob der Index gruppiert ist.
GetIsCreatedOnlineConfigurationSource(IConventionIndex)	Gibt zurück, ConfigurationSource ob der Index online ist.
GetSortInTempDb(IReadOnlyIndex)	Gibt einen Wert zurück, der angibt, ob der Index in tempdb sortiert ist.
GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier)	Gibt einen Wert zurück, der angibt, ob der Index in tempdb sortiert ist.
GetSortInTempDbConfigurationSource(IConventionIndex)	Gibt zurück, ConfigurationSource ob der Index in tempdb sortiert ist.
IsClustered(IReadOnlyIndex)	Gibt einen Wert zurück, der angibt, ob der Index gruppiert ist.
IsClustered(IReadOnlyIndex, StoreObjectIdentifier)	Gibt einen Wert zurück, der angibt, ob der Index gruppiert ist.
IsCreatedOnline(IReadOnlyIndex)	Gibt einen Wert zurück, der angibt, ob der Index online ist.
IsCreatedOnline(IReadOnlyIndex, StoreObjectIdentifier)	Gibt einen Wert zurück, der angibt, ob der Index online ist.
SetDataCompression(IConventionIndex, Nullable<DataCompressionType>, Boolean)	Legt einen Wert fest, der die Vom Index verwendete Datenkomprimierung angibt.
SetFillFactor(IConventionIndex, Nullable<Int32>, Boolean)	Definiert einen Wert, der angibt, ob der Index den Füllfaktor verwendet.
SetIncludeProperties(IConventionIndex, IReadOnlyList<String>, Boolean)	Legt eingeschlossene Eigenschaftsnamen fest.
SetIsClustered(IConventionIndex, Nullable<Boolean>, Boolean)	Legt einen Wert fest, der angibt, ob der Index gruppiert ist.
SetIsCreatedOnline(IConventionIndex, Nullable<Boolean>, Boolean)	Legt einen Wert fest, der angibt, ob der Index online ist.
SetSortInTempDb(IConventionIndex, Nullable<Boolean>, Boolean)	Legt einen Wert fest, der angibt, ob der Index in tempdb sortiert ist.