IConventionIndex Schnittstelle
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Stellt einen Index für eine Reihe von Eigenschaften dar.
public interface IConventionIndex : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndexpublic interface IConventionIndex : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IIndextype IConventionIndex = interface
interface IReadOnlyIndex
interface IReadOnlyAnnotatable
interface IConventionAnnotatabletype IConventionIndex = interface
interface IIndex
interface IAnnotatable
interface IConventionAnnotatablePublic Interface IConventionIndex
Implements IConventionAnnotatable, IReadOnlyIndexPublic Interface IConventionIndex
Implements IConventionAnnotatable, IIndex- Implementiert
Hinweise
Diese Schnittstelle wird während der Modellerstellung verwendet und ermöglicht die Änderung der Metadaten. Nachdem das Modell erstellt wurde, IIndex stellt sie eine schreibgeschützte Ansicht der gleichen Metadaten dar.
Weitere Informationen und Beispiele finden Sie unter Modellbaukonventionen .
Eigenschaften
| Name | Beschreibung |
|---|---|
| Builder |
Ruft den Generator ab, der zum Konfigurieren dieses Indexes verwendet werden kann. |
| CollectionIndices |
Ruft die komplexen Auflistungsindizes ab, die durchlaufen werden, um jede indizierte Eigenschaft zu erreichen. (Geerbt von IReadOnlyIndex) |
| DeclaringEntityType |
Ruft den Entitätstyp ab, für den der Index definiert ist. Dies kann sich von dem Typ unterscheiden, Properties der definiert wird, wenn der Index einen abgeleiteten Typ in einer Vererbungshierarchie definiert hat (da die Eigenschaften möglicherweise für einen Basistyp definiert werden). |
| IsDescending |
Eine Gruppe von Werten, die angeben, 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 Objekt entfernt wurde. (Geerbt von IConventionAnnotatable) |
| IsUnique |
Ruft einen Wert ab, der angibt, ob die Den indizierten Eigenschaften zugewiesenen Werte eindeutig sind. (Geerbt von IIndex) |
| Item[String] |
Ruft die Wertanmerkung mit dem angegebenen Namen ab, die zurückgegeben wird |
| Name |
Ruft den Namen dieses Indexes ab. (Geerbt von IIndex) |
| Properties |
Ruft die Eigenschaften ab, für die dieser Index definiert ist. |
Methoden
| Name | Beschreibung |
|---|---|
| AddAnnotation(String, Object, Boolean) |
Fügt diesem Objekt eine Anmerkung hinzu. Löst aus, 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) |
| AddRuntimeAnnotation(String, Object) |
Fügt diesem Objekt eine Laufzeitanmerkung hinzu. Löst aus, wenn bereits eine Anmerkung mit dem angegebenen Namen vorhanden ist. (Geerbt von IAnnotatable) |
| AnnotationsToDebugString(Int32) |
Ruft die Debugzeichenfolge für alle Anmerkungen ab, die für das Objekt deklariert sind. (Geerbt von IReadOnlyAnnotatable) |
| DisplayName() |
Ruft den anzeigenden Anzeigenamen für den angegebenen IReadOnlyIndex, wenn Name eine definiert ist, oder eine Zeichenfolgendarstellung des Properties Anzeigenamens ab, wenn dies ein nicht benannter Index ist. (Geerbt von IReadOnlyIndex) |
| FindAnnotation(String) |
Ruft die Anmerkung mit dem angegebenen Namen ab, die zurückgegeben wird |
| FindRuntimeAnnotation(String) |
Ruft die Laufzeitanmerkung mit dem angegebenen Namen ab, die zurückgegeben wird |
| FindRuntimeAnnotationValue(String) |
Ruft den Wert der Laufzeitanmerkung mit dem angegebenen Namen ab, der zurückgegeben wird |
| GetAnnotation(String) |
Ruft die Anmerkung mit dem angegebenen Namen ab, die ausgelöst wird, wenn sie nicht vorhanden ist. (Geerbt von IConventionAnnotatable) |
| GetAnnotations() |
Ruft alle Anmerkungen für das aktuelle Objekt ab. (Geerbt von IAnnotatable) |
| GetConfigurationSource() |
Gibt die Konfigurationsquelle für diesen Index zurück. |
| GetIsDescendingConfigurationSource() |
Gibt die Konfigurationsquelle für IsDescending. |
| GetIsUniqueConfigurationSource() |
Gibt die Konfigurationsquelle für IsUnique. |
| GetNullableValueFactory<TKey>() |
Ruft eine Factory für Schlüsselwerte basierend auf den Indexschlüsselwerten ab, die aus verschiedenen Formen von Entitätsdaten stammen. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Sie wird in der Regel nicht im Anwendungscode verwendet. (Geerbt von IIndex) |
| GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg) |
Ruft den Wert der Laufzeitanmerkung mit dem angegebenen Namen ab, und fügt ihn hinzu, wenn keine vorhanden ist. (Geerbt von IAnnotatable) |
| GetRuntimeAnnotations() |
Ruft alle Laufzeitanmerkungen für das aktuelle Objekt ab. (Geerbt von IAnnotatable) |
| RemoveAnnotation(String) |
Entfernt die Anmerkung mit dem angegebenen Namen aus diesem Objekt. (Geerbt von IConventionAnnotatable) |
| RemoveRuntimeAnnotation(String) |
Entfernt die angegebene Laufzeitanmerkung aus diesem Objekt. (Geerbt von IAnnotatable) |
| 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(n) für diesen Index (aufsteigend oder absteigend) fest. |
| 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, falls |
| SetRuntimeAnnotation(String, Object) |
Legt die unter dem angegebenen Schlüssel gespeicherte Laufzeitanmerkung fest. Überschreibt die vorhandene Anmerkung, wenn bereits eine Anmerkung mit dem angegebenen Namen vorhanden ist. (Geerbt von IAnnotatable) |
| ToDebugString(MetadataDebugStringOptions, Int32) |
Erstellt eine lesbare Darstellung der angegebenen Metadaten. Warnung: Verlassen Sie sich nicht auf das Format der zurückgegebenen Zeichenfolge. Sie wurde nur für das Debuggen entwickelt und kann sich willkürlich zwischen Versionen ändern. (Geerbt von IReadOnlyIndex) |
Erweiterungsmethoden
| Name | Beschreibung |
|---|---|
| AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean) |
Fügt einem Objekt Anmerkungen hinzu. |
| AnnotationsToDebugString(IAnnotatable, Int32) |
Ruft die Debugzeichenfolge für alle Anmerkungen ab, die für das Objekt deklariert sind. |
| FindSharedObjectRootIndex(IConventionIndex, StoreObjectIdentifier) |
Sucht den ersten IConventionIndex , der demselben Index in einem freigegebenen Tabellen-ähnlichen Objekt zugeordnet ist. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Sie wird in der Regel nicht im Anwendungscode verwendet. |
| FindSharedObjectRootIndex(IIndex, StoreObjectIdentifier) |
Sucht den ersten IConventionIndex , der demselben Index in einem freigegebenen Tabellen-ähnlichen Objekt zugeordnet ist. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Sie wird in der Regel nicht im Anwendungscode verwendet. |
| FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier) |
Sucht den ersten IIndex , der demselben Index in einem freigegebenen Tabellen-ähnlichen Objekt zugeordnet ist. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Sie wird in der Regel nicht im Anwendungscode verwendet. |
| GetAnnotation(IAnnotatable, String) |
Ruft die Anmerkung mit dem angegebenen Namen ab, die ausgelöst wird, wenn sie nicht vorhanden ist. |
| GetAnnotation(IConventionAnnotatable, String) |
Ruft die Anmerkung mit dem angegebenen Namen ab, die ausgelöst wird, wenn sie nicht vorhanden ist. |
| GetDatabaseName(IIndex, StoreObjectIdentifier) |
Gibt den Namen des Indexes in der Datenbank zurück. |
| GetDatabaseName(IIndex) |
Gibt den Namen des Indexes in der Datenbank zurück. |
| GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier) |
Gibt den Namen des Indexes in der Datenbank zurück. |
| GetDatabaseName(IReadOnlyIndex) |
Gibt den Namen des Indexes in der Datenbank zurück. |
| GetDatabaseNameConfigurationSource(IConventionIndex) |
Ruft den ConfigurationSource Namen des Indexes in der Datenbank ab. |
| GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier) |
Gibt die Datenkomprimierung zurück, die der Index verwendet. |
| GetDataCompression(IReadOnlyIndex) |
Gibt die Datenkomprimierung zurück, die der Index verwendet. |
| GetDataCompressionConfigurationSource(IConventionIndex) |
Gibt die ConfigurationSource Für die Datenkomprimierung zurück, die der Index verwendet. |
| GetDefaultDatabaseName(IIndex, StoreObjectIdentifier) |
Gibt den Standardnamen zurück, der für diesen Index verwendet werden würde. |
| GetDefaultDatabaseName(IIndex) |
Gibt den Standardnamen zurück, der für diesen Index verwendet werden würde. |
| GetDefaultDatabaseName(IReadOnlyIndex, StoreObjectIdentifier) |
Gibt den Standardnamen zurück, der für diesen Index verwendet werden würde. |
| GetDefaultDatabaseName(IReadOnlyIndex) |
Gibt den Standardnamen zurück, der für diesen Index verwendet werden würde. |
| GetDefaultName(IIndex) |
Veraltet.
Gibt den Standardnamen zurück, der für diesen Index verwendet werden würde. |
| GetFillFactor(IIndex) |
Gibt einen Wert zurück, der angibt, ob der Index den Füllfaktor verwendet. |
| GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier) |
Gibt den Füllfaktor zurück, den der Index verwendet. |
| GetFillFactor(IReadOnlyIndex) |
Gibt den Füllfaktor zurück, den der Index verwendet. |
| GetFillFactorConfigurationSource(IConventionIndex) |
Gibt zurück, ConfigurationSource ob der Index den Füllfaktor verwendet. |
| GetFilter(IIndex, StoreObjectIdentifier) |
Gibt den Indexfilterausdruck zurück. |
| GetFilter(IIndex) |
Gibt den Indexfilterausdruck zurück. |
| GetFilter(IReadOnlyIndex, StoreObjectIdentifier) |
Gibt den Indexfilterausdruck zurück. |
| GetFilter(IReadOnlyIndex) |
Gibt den Indexfilterausdruck zurück. |
| GetFilterConfigurationSource(IConventionIndex) |
Ruft den ConfigurationSource Indexfilterausdruck ab. |
| GetFullTextCatalog(IReadOnlyIndex, StoreObjectIdentifier) |
Gibt den Volltextkatalognamen für den Volltextindex zurück. |
| GetFullTextCatalog(IReadOnlyIndex) |
Gibt den Volltextkatalognamen für den Volltextindex zurück. |
| GetFullTextCatalogConfigurationSource(IConventionIndex) |
Gibt den ConfigurationSource Volltextkatalog des Volltextindexes zurück. |
| GetFullTextChangeTracking(IReadOnlyIndex, StoreObjectIdentifier) |
Gibt den Änderungsnachverfolgungsmodus für den Volltextindex zurück. |
| GetFullTextChangeTracking(IReadOnlyIndex) |
Gibt den Änderungsnachverfolgungsmodus für den Volltextindex zurück. |
| GetFullTextChangeTrackingConfigurationSource(IConventionIndex) |
Gibt den ConfigurationSource Änderungsnachverfolgungsmodus des Volltextindexes zurück. |
| GetFullTextKeyIndex(IReadOnlyIndex, StoreObjectIdentifier) |
Gibt den KEY INDEX-Namen für den Volltextindex zurück. |
| GetFullTextKeyIndex(IReadOnlyIndex) |
Gibt den KEY INDEX-Namen für den Volltextindex zurück. |
| GetFullTextKeyIndexConfigurationSource(IConventionIndex) |
Gibt den ConfigurationSource SCHLÜSSELINDEX des Volltextindexes zurück. |
| GetFullTextLanguage(IReadOnlyIndex, String) |
Gibt die Volltextsprache für eine bestimmte Eigenschaft im Volltextindex zurück. |
| GetFullTextLanguages(IReadOnlyIndex) |
Gibt alle Volltextsprachen zurück, die für den Volltextindex konfiguriert sind. |
| GetFullTextLanguagesConfigurationSource(IConventionIndex) |
Gibt die ConfigurationSource Volltextsprachen des Volltextindexes zurück. |
| GetIncludeProperties(IIndex) |
Gibt enthaltene Eigenschaftsnamen zurück oder |
| GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier) |
Gibt enthaltene Eigenschaftsnamen zurück oder |
| GetIncludeProperties(IReadOnlyIndex) |
Gibt enthaltene Eigenschaftsnamen zurück oder |
| GetIncludePropertiesConfigurationSource(IConventionIndex) |
Gibt die ConfigurationSource Namen der enthaltenen Eigenschaften zurück. |
| GetIsClusteredConfigurationSource(IConventionIndex) |
Gibt den ConfigurationSource Wert zurück, für den der Index gruppiert ist. |
| GetIsCreatedOnlineConfigurationSource(IConventionIndex) |
Gibt die ConfigurationSource Angabe zurück, ob der Index online ist. |
| GetIsFullTextIndexConfigurationSource(IConventionIndex) |
Gibt den Wert für die Angabe zurück ConfigurationSource , ob die IsFullTextIndex(IReadOnlyIndex). |
| GetMappedTableIndexes(IIndex) |
Ruft die Tabellenindizes ab, denen der Index zugeordnet ist. |
| GetName(IIndex) |
Veraltet.
Gibt den Namen des Indexes in der Datenbank zurück. |
| GetNameConfigurationSource(IConventionIndex) |
Veraltet.
Ruft den ConfigurationSource Namen des Indexes in der Datenbank ab. |
| GetNullableValueFactory<TKey>(IIndex) |
Ruft eine Factory für Schlüsselwerte basierend auf den Indexschlüsselwerten ab, die aus verschiedenen Formen von Entitätsdaten stammen. Diese Methode wird in der Regel von Datenbankanbietern (und anderen Erweiterungen) verwendet. Sie wird in der Regel nicht im Anwendungscode verwendet. |
| GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier) |
Gibt einen Wert zurück, der angibt, ob der Index in tempdb sortiert ist. |
| GetSortInTempDb(IReadOnlyIndex) |
Gibt einen Wert zurück, der angibt, ob der Index in tempdb sortiert ist. |
| GetSortInTempDbConfigurationSource(IConventionIndex) |
Gibt die ConfigurationSource Angabe zurück, ob der Index in tempdb sortiert ist. |
| GetVectorIndexType(IReadOnlyIndex, StoreObjectIdentifier) |
Gibt den Typ des Vektorindexes zurück. |
| GetVectorIndexType(IReadOnlyIndex) |
Gibt den zu verwendenden Vektorindextyp zurück, z. B. "flat", "diskANN" oder "quantizedFlat". Weitere Informationen finden Sie unter Vektorsuche in Azure Cosmos DB für NoSQL. |
| GetVectorIndexType(IReadOnlyIndex) |
Gibt den Typ des Vektorindexes zurück. |
| GetVectorIndexTypeConfigurationSource(IConventionIndex) |
Gibt den Wert für die Angabe zurück ConfigurationSource , ob die GetVectorIndexType(IReadOnlyIndex). |
| GetVectorIndexTypeConfigurationSource(IConventionIndex) |
Gibt den ConfigurationSource Typ des Vektorindexes zurück. |
| GetVectorMetric(IReadOnlyIndex, StoreObjectIdentifier) |
Gibt die Ähnlichkeitsmetrik für den Vektorindex zurück. |
| GetVectorMetric(IReadOnlyIndex) |
Gibt die Ähnlichkeitsmetrik für den Vektorindex zurück. |
| GetVectorMetricConfigurationSource(IConventionIndex) |
Gibt die ConfigurationSource Ähnlichkeitsmetrik des Vektorindexes zurück. |
| IsClustered(IIndex, StoreObjectIdentifier) |
Gibt einen Wert zurück, der angibt, ob der Index gruppiert ist. |
| IsClustered(IIndex) |
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. |
| IsClustered(IReadOnlyIndex) |
Gibt einen Wert zurück, der angibt, ob der Index gruppiert ist. |
| IsCreatedOnline(IIndex) |
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. |
| IsCreatedOnline(IReadOnlyIndex) |
Gibt einen Wert zurück, der angibt, ob der Index online ist. |
| IsFullTextIndex(IReadOnlyIndex) |
Gibt den Wert zurück, der angibt, ob der Index für die Volltextsuche konfiguriert ist. Weitere Informationen finden Sie unter Volltextsuche in Azure Cosmos DB für NoSQL. |
| IsFullTextIndex(IReadOnlyIndex) |
Gibt zurück, ob der Index ein Volltextindex ist. |
| IsVectorIndex(IReadOnlyIndex) |
Gibt zurück, ob der Index ein Vektorindex ist. |
| SetDatabaseName(IConventionIndex, String, Boolean) |
Legt den Namen des Indexes in der Datenbank fest. |
| SetDataCompression(IConventionIndex, Nullable<DataCompressionType>, Boolean) |
Legt einen Wert fest, der die Datenkomprimierung angibt, die der Index verwendet. |
| SetFillFactor(IConventionIndex, Nullable<Int32>, Boolean) |
Definiert einen Wert, der angibt, ob der Index den Füllfaktor verwendet. |
| SetFilter(IConventionIndex, String, Boolean) |
Legt den Indexfilterausdruck fest. |
| SetFullTextCatalog(IConventionIndex, String, Boolean) |
Legt den Volltextkatalognamen für den Volltextindex fest. |
| SetFullTextChangeTracking(IConventionIndex, Nullable<FullTextChangeTracking>, Boolean) |
Legt den Änderungsnachverfolgungsmodus für den Volltextindex fest. |
| SetFullTextKeyIndex(IConventionIndex, String, Boolean) |
Legt den KEY INDEX-Namen für den Volltextindex fest. Durch Festlegen eines Werts ohne Null wird dieser Index als Volltextindex markiert. |
| SetFullTextLanguage(IConventionIndex, String, String, Boolean) |
Legt die Volltextsprache für eine bestimmte Eigenschaft im Volltextindex fest. |
| SetFullTextLanguages(IConventionIndex, IReadOnlyDictionary<String,String>, Boolean) |
Legt die Volltextsprachen für alle Eigenschaften im Volltextindex fest. |
| SetIncludeProperties(IConventionIndex, IReadOnlyList<String>, Boolean) |
Legt eingeschlossene Eigenschaftennamen 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. |
| SetIsFullTextIndex(IConventionIndex, Nullable<Boolean>, Boolean) |
Konfiguriert den Index für die Volltextsuche. Weitere Informationen finden Sie unter Volltextsuche in Azure Cosmos DB für NoSQL. |
| SetName(IConventionIndex, String, Boolean) |
Veraltet.
Legt den Namen des Indexes in der Datenbank fest. |
| SetOrRemoveAnnotation(IConventionAnnotatable, 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, falls |
| SetSortInTempDb(IConventionIndex, Nullable<Boolean>, Boolean) |
Legt einen Wert fest, der angibt, ob der Index in tempdb sortiert ist. |
| SetVectorIndexType(IConventionIndex, Nullable<VectorIndexType>, Boolean) |
Legt den zu verwendenden Vektorindextyp fest, z. B. "flat", "diskANN" oder "quantizedFlat". Weitere Informationen finden Sie unter Vektorsuche in Azure Cosmos DB für NoSQL. |
| SetVectorIndexType(IConventionIndex, Nullable<VectorIndexType>, Nullable<Boolean>, Boolean) |
Legt den zu verwendenden Vektorindextyp fest, z. B. "flat", "diskANN" oder "quantizedFlat". Weitere Informationen finden Sie unter Vektorsuche in Azure Cosmos DB für NoSQL. |
| SetVectorIndexType(IConventionIndex, String, Boolean) |
Legt den Typ des Vektorindex fest. |
| SetVectorMetric(IConventionIndex, String, Boolean) |
Legt die Ähnlichkeitsmetrik für den Vektorindex fest. |
| ToDebugString(IIndex, MetadataDebugStringOptions, Int32) |
Erstellt eine lesbare Darstellung der angegebenen Metadaten. Warnung: Verlassen Sie sich nicht auf das Format der zurückgegebenen Zeichenfolge. Sie wurde nur für das Debuggen entwickelt und kann sich willkürlich zwischen Versionen ändern. |
