Język

IConventionIndex Interfejs

Definicja

Reprezentuje indeks na zestawie właściwości.

public interface IConventionIndex : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IReadOnlyIndex
public interface IConventionIndex : Microsoft.EntityFrameworkCore.Metadata.IConventionAnnotatable, Microsoft.EntityFrameworkCore.Metadata.IIndex
type IConventionIndex = interface
    interface IReadOnlyIndex
    interface IReadOnlyAnnotatable
    interface IConventionAnnotatable
type IConventionIndex = interface
    interface IIndex
    interface IAnnotatable
    interface IConventionAnnotatable
Public Interface IConventionIndex
Implements IConventionAnnotatable, IReadOnlyIndex
Public Interface IConventionIndex
Implements IConventionAnnotatable, IIndex
Implementuje

Uwagi

Ten interfejs jest używany podczas tworzenia modelu i umożliwia modyfikowanie metadanych. Gdy model zostanie skompilowany, IIndex reprezentuje widok tylko do odczytu tych samych metadanych.

Aby uzyskać więcej informacji i przykładów, zobacz Konwencje tworzenia modeli .

Właściwości

Nazwisko Opis
Builder

Pobiera konstruktora, którego można użyć do skonfigurowania tego indeksu.

CollectionIndices

Pobiera indeksy kolekcji złożonej przechodzące w celu uzyskania dostępu do każdej indeksowanej właściwości.

(Odziedziczone po IReadOnlyIndex)
DeclaringEntityType

Pobiera typ jednostki zdefiniowany przez indeks. Może to różnić się od typu Properties zdefiniowanego w przypadku, gdy indeks jest zdefiniowany typ pochodny w hierarchii dziedziczenia (ponieważ właściwości mogą być zdefiniowane w typie podstawowym).

IsDescending

Zestaw wartości wskazujący, czy każda odpowiadająca kolumna indeksu ma kolejność sortowania malejącego.

(Odziedziczone po IReadOnlyIndex)
IsInModel

Wskazuje, czy ten obiekt znajduje się w modelu, tj. nie został usunięty z jednego.

(Odziedziczone po IConventionAnnotatable)
IsUnique

Pobiera wartość wskazującą, czy wartości przypisane do właściwości indeksowanych są unikatowe.

(Odziedziczone po IIndex)
Item[String]

Pobiera adnotację wartości z daną nazwą, zwracając null ją, jeśli nie istnieje.

(Odziedziczone po IAnnotatable)
Name

Pobiera nazwę tego indeksu.

(Odziedziczone po IIndex)
Properties

Pobiera właściwości zdefiniowane przez ten indeks.

Metody

Nazwisko Opis
AddAnnotation(String, Object, Boolean)

Dodaje adnotację do tego obiektu. Zgłasza, czy adnotacja o określonej nazwie już istnieje.

(Odziedziczone po IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)

Dodaje adnotacje do obiektu.

(Odziedziczone po IConventionAnnotatable)
AddRuntimeAnnotation(String, Object)

Dodaje adnotację środowiska uruchomieniowego do tego obiektu. Zgłasza, czy adnotacja o określonej nazwie już istnieje.

(Odziedziczone po IAnnotatable)
AnnotationsToDebugString(Int32)

Pobiera ciąg debugowania dla wszystkich adnotacji zadeklarowanych w obiekcie.

(Odziedziczone po IReadOnlyAnnotatable)
DisplayName()

Pobiera przyjazną nazwę wyświetlaną dla danego IReadOnlyIndexelementu , zwracając jej Name wartość , jeśli jest zdefiniowana, lub reprezentacja Properties ciągu, jeśli jest to indeks nienazwany.

(Odziedziczone po IReadOnlyIndex)
FindAnnotation(String)

Pobiera adnotację o podanej nazwie, zwracając null ją, jeśli nie istnieje.

(Odziedziczone po IAnnotatable)
FindRuntimeAnnotation(String)

Pobiera adnotację środowiska uruchomieniowego o podanej nazwie, zwracając null ją, jeśli nie istnieje.

(Odziedziczone po IAnnotatable)
FindRuntimeAnnotationValue(String)

Pobiera wartość adnotacji środowiska uruchomieniowego o podanej nazwie, zwracając null ją, jeśli nie istnieje.

(Odziedziczone po IAnnotatable)
GetAnnotation(String)

Pobiera adnotację o podanej nazwie, zgłaszając ją, jeśli nie istnieje.

(Odziedziczone po IConventionAnnotatable)
GetAnnotations()

Pobiera wszystkie adnotacje w bieżącym obiekcie.

(Odziedziczone po IAnnotatable)
GetConfigurationSource()

Zwraca źródło konfiguracji dla tego indeksu.

GetIsDescendingConfigurationSource()

Zwraca źródło konfiguracji dla elementu IsDescending.

GetIsUniqueConfigurationSource()

Zwraca źródło konfiguracji dla elementu IsUnique.

GetNullableValueFactory<TKey>()

Pobiera fabrykę wartości kluczy na podstawie wartości klucza indeksu pobranych z różnych form danych jednostki.

Ta metoda jest zwykle używana przez dostawców baz danych (i innych rozszerzeń). Zwykle nie jest używany w kodzie aplikacji.

(Odziedziczone po IIndex)
GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg)

Pobiera wartość adnotacji środowiska uruchomieniowego o podanej nazwie, dodając ją, jeśli nie istnieje.

(Odziedziczone po IAnnotatable)
GetRuntimeAnnotations()

Pobiera wszystkie adnotacje środowiska uruchomieniowego w bieżącym obiekcie.

(Odziedziczone po IAnnotatable)
RemoveAnnotation(String)

Usuwa adnotację o podanej nazwie z tego obiektu.

(Odziedziczone po IConventionAnnotatable)
RemoveRuntimeAnnotation(String)

Usuwa daną adnotację środowiska uruchomieniowego z tego obiektu.

(Odziedziczone po IAnnotatable)
SetAnnotation(String, Object, Boolean)

Ustawia adnotację przechowywaną pod daną nazwą. Zastępuje istniejącą adnotację, jeśli adnotacja o określonej nazwie już istnieje.

(Odziedziczone po IConventionAnnotatable)
SetIsDescending(IReadOnlyList<Boolean>, Boolean)

Ustawia kolejność sortowania dla tego indeksu (rosnąco lub malejąco).

SetIsUnique(Nullable<Boolean>, Boolean)

Ustawia wartość wskazującą, czy wartości przypisane do właściwości indeksu są unikatowe.

SetOrRemoveAnnotation(String, Object, Boolean)

Ustawia adnotację przechowywaną pod daną nazwą. Zastępuje istniejącą adnotację, jeśli adnotacja o określonej nazwie już istnieje. Usuwa istniejącą adnotację, jeśli null jest podana.

(Odziedziczone po IConventionAnnotatable)
SetRuntimeAnnotation(String, Object)

Ustawia adnotację środowiska uruchomieniowego przechowywaną w ramach danego klucza. Zastępuje istniejącą adnotację, jeśli adnotacja o określonej nazwie już istnieje.

(Odziedziczone po IAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)

Tworzy czytelną dla człowieka reprezentację podanych metadanych.

Ostrzeżenie: nie należy polegać na formacie zwracanego ciągu. Jest przeznaczony tylko do debugowania i może zmieniać się dowolnie między wydaniami.

(Odziedziczone po IReadOnlyIndex)

Metody rozszerzania

Nazwisko Opis
AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean)

Dodaje adnotacje do obiektu.

AnnotationsToDebugString(IAnnotatable, Int32)

Pobiera ciąg debugowania dla wszystkich adnotacji zadeklarowanych w obiekcie.

FindSharedObjectRootIndex(IConventionIndex, StoreObjectIdentifier)

Znajduje pierwszy IConventionIndex zamapowany na ten sam indeks w udostępnionym obiekcie przypominającym tabelę.

Ta metoda jest zwykle używana przez dostawców baz danych (i innych rozszerzeń). Zwykle nie jest używany w kodzie aplikacji.

FindSharedObjectRootIndex(IIndex, StoreObjectIdentifier)

Znajduje pierwszy IConventionIndex zamapowany na ten sam indeks w udostępnionym obiekcie przypominającym tabelę.

Ta metoda jest zwykle używana przez dostawców baz danych (i innych rozszerzeń). Zwykle nie jest używany w kodzie aplikacji.

FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier)

Znajduje pierwszy IIndex zamapowany na ten sam indeks w udostępnionym obiekcie przypominającym tabelę.

Ta metoda jest zwykle używana przez dostawców baz danych (i innych rozszerzeń). Zwykle nie jest używany w kodzie aplikacji.

GetAnnotation(IAnnotatable, String)

Pobiera adnotację o podanej nazwie, zgłaszając ją, jeśli nie istnieje.

GetAnnotation(IConventionAnnotatable, String)

Pobiera adnotację o podanej nazwie, zgłaszając ją, jeśli nie istnieje.

GetDatabaseName(IIndex, StoreObjectIdentifier)

Zwraca nazwę indeksu w bazie danych.

GetDatabaseName(IIndex)

Zwraca nazwę indeksu w bazie danych.

GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca nazwę indeksu w bazie danych.

GetDatabaseName(IReadOnlyIndex)

Zwraca nazwę indeksu w bazie danych.

GetDatabaseNameConfigurationSource(IConventionIndex)

ConfigurationSource Pobiera nazwę indeksu w bazie danych.

GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca kompresję danych używaną przez indeks.

GetDataCompression(IReadOnlyIndex)

Zwraca kompresję danych używaną przez indeks.

GetDataCompressionConfigurationSource(IConventionIndex)

Zwraca wartość ConfigurationSource dla kompresji danych używanej przez indeks.

GetDefaultDatabaseName(IIndex, StoreObjectIdentifier)

Zwraca nazwę domyślną, która będzie używana dla tego indeksu.

GetDefaultDatabaseName(IIndex)

Zwraca nazwę domyślną, która będzie używana dla tego indeksu.

GetDefaultDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca nazwę domyślną, która będzie używana dla tego indeksu.

GetDefaultDatabaseName(IReadOnlyIndex)

Zwraca nazwę domyślną, która będzie używana dla tego indeksu.

GetDefaultName(IIndex)
Przestarzałe.

Zwraca nazwę domyślną, która będzie używana dla tego indeksu.

GetFillFactor(IIndex)

Zwraca wartość wskazującą, czy indeks używa współczynnika wypełnienia.

GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca współczynnik wypełnienia używany przez indeks.

GetFillFactor(IReadOnlyIndex)

Zwraca współczynnik wypełnienia używany przez indeks.

GetFillFactorConfigurationSource(IConventionIndex)

Zwraca wartość ConfigurationSource dla tego, czy indeks używa współczynnika wypełnienia.

GetFilter(IIndex, StoreObjectIdentifier)

Zwraca wyrażenie filtru indeksu.

GetFilter(IIndex)

Zwraca wyrażenie filtru indeksu.

GetFilter(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca wyrażenie filtru indeksu.

GetFilter(IReadOnlyIndex)

Zwraca wyrażenie filtru indeksu.

GetFilterConfigurationSource(IConventionIndex)

Pobiera wartość ConfigurationSource dla wyrażenia filtru indeksu.

GetFullTextCatalog(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca nazwę wykazu pełnotekstowego dla indeksu pełnotekstowego.

GetFullTextCatalog(IReadOnlyIndex)

Zwraca nazwę wykazu pełnotekstowego dla indeksu pełnotekstowego.

GetFullTextCatalogConfigurationSource(IConventionIndex)

ConfigurationSource Zwraca wartość dla wykazu pełnotekstowego indeksu pełnotekstowego.

GetFullTextChangeTracking(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca tryb śledzenia zmian dla indeksu pełnotekstowego.

GetFullTextChangeTracking(IReadOnlyIndex)

Zwraca tryb śledzenia zmian dla indeksu pełnotekstowego.

GetFullTextChangeTrackingConfigurationSource(IConventionIndex)

ConfigurationSource Zwraca wartość dla trybu śledzenia zmian indeksu pełnotekstowego.

GetFullTextKeyIndex(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca nazwę INDEKSU KLUCZA dla indeksu pełnotekstowego.

GetFullTextKeyIndex(IReadOnlyIndex)

Zwraca nazwę INDEKSU KLUCZA dla indeksu pełnotekstowego.

GetFullTextKeyIndexConfigurationSource(IConventionIndex)

Zwraca wartość ConfigurationSource dla indeksu KEY indeksu pełnotekstowego.

GetFullTextLanguage(IReadOnlyIndex, String)

Zwraca język pełnotekstowy dla określonej właściwości w indeksie pełnotekstowym.

GetFullTextLanguages(IReadOnlyIndex)

Zwraca wszystkie języki pełnotekstowe skonfigurowane dla indeksu pełnotekstowego.

GetFullTextLanguagesConfigurationSource(IConventionIndex)

Zwraca wartość ConfigurationSource dla języków pełnotekstowych indeksu pełnotekstowego.

GetIncludeProperties(IIndex)

Zwraca nazwy uwzględnionych właściwości lub null jeśli nie zostały określone.

GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca nazwy uwzględnionych właściwości lub null jeśli nie zostały określone.

GetIncludeProperties(IReadOnlyIndex)

Zwraca nazwy uwzględnionych właściwości lub null jeśli nie zostały określone.

GetIncludePropertiesConfigurationSource(IConventionIndex)

Zwraca wartość ConfigurationSource dla uwzględnionych nazw właściwości.

GetIsClusteredConfigurationSource(IConventionIndex)

Zwraca wartość ConfigurationSource dla tego, czy indeks jest klasterowany.

GetIsCreatedOnlineConfigurationSource(IConventionIndex)

Zwraca wartość ConfigurationSource dla tego, czy indeks jest w trybie online.

GetIsFullTextIndexConfigurationSource(IConventionIndex)

Zwraca wartość ConfigurationSource dla , czy wartość IsFullTextIndex(IReadOnlyIndex).

GetMappedTableIndexes(IIndex)

Pobiera indeksy tabeli, do których indeks jest mapowany.

GetName(IIndex)
Przestarzałe.

Zwraca nazwę indeksu w bazie danych.

GetNameConfigurationSource(IConventionIndex)
Przestarzałe.

ConfigurationSource Pobiera nazwę indeksu w bazie danych.

GetNullableValueFactory<TKey>(IIndex)

Pobiera fabrykę wartości kluczy na podstawie wartości klucza indeksu pobranych z różnych form danych jednostki.

Ta metoda jest zwykle używana przez dostawców baz danych (i innych rozszerzeń). Zwykle nie jest używany w kodzie aplikacji.

GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca wartość wskazującą, czy indeks jest sortowany w bazie danych tempdb.

GetSortInTempDb(IReadOnlyIndex)

Zwraca wartość wskazującą, czy indeks jest sortowany w bazie danych tempdb.

GetSortInTempDbConfigurationSource(IConventionIndex)

Zwraca wartość ConfigurationSource dla tego, czy indeks jest sortowany w bazie danych tempdb.

GetVectorIndexType(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca typ indeksu wektorowego.

GetVectorIndexType(IReadOnlyIndex)

Zwraca typ indeksu wektorowego do użycia, taki jak "flat", "diskANN" lub "quantizedFlat". Aby NoSQL uzyskać więcej informacji, zobacz Wyszukiwanie wektorów w Azure Cosmos DB, aby uzyskać więcej informacji.

GetVectorIndexType(IReadOnlyIndex)

Zwraca typ indeksu wektorowego.

GetVectorIndexTypeConfigurationSource(IConventionIndex)

Zwraca wartość ConfigurationSource dla , czy wartość GetVectorIndexType(IReadOnlyIndex).

GetVectorIndexTypeConfigurationSource(IConventionIndex)

Zwraca wartość ConfigurationSource dla typu indeksu wektorowego.

GetVectorMetric(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca metryki podobieństwa dla indeksu wektorowego.

GetVectorMetric(IReadOnlyIndex)

Zwraca metryki podobieństwa dla indeksu wektorowego.

GetVectorMetricConfigurationSource(IConventionIndex)

Zwraca wartość ConfigurationSource dla metryki podobieństwa indeksu wektora.

IsClustered(IIndex, StoreObjectIdentifier)

Zwraca wartość wskazującą, czy indeks jest klasterowany.

IsClustered(IIndex)

Zwraca wartość wskazującą, czy indeks jest klasterowany.

IsClustered(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca wartość wskazującą, czy indeks jest klasterowany.

IsClustered(IReadOnlyIndex)

Zwraca wartość wskazującą, czy indeks jest klasterowany.

IsCreatedOnline(IIndex)

Zwraca wartość wskazującą, czy indeks jest w trybie online.

IsCreatedOnline(IReadOnlyIndex, StoreObjectIdentifier)

Zwraca wartość wskazującą, czy indeks jest w trybie online.

IsCreatedOnline(IReadOnlyIndex)

Zwraca wartość wskazującą, czy indeks jest w trybie online.

IsFullTextIndex(IReadOnlyIndex)

Zwraca wartość wskazującą, czy indeks jest skonfigurowany do wyszukiwania pełnotekstowego. Aby NoSQL uzyskać więcej informacji, zobacz Wyszukiwanie pełnotekstowe w Azure Cosmos DB, aby uzyskać więcej informacji.

IsFullTextIndex(IReadOnlyIndex)

Zwraca, czy indeks jest indeksem pełnotekstowym.

IsVectorIndex(IReadOnlyIndex)

Zwraca, czy indeks jest indeksem wektorowym.

SetDatabaseName(IConventionIndex, String, Boolean)

Ustawia nazwę indeksu w bazie danych.

SetDataCompression(IConventionIndex, Nullable<DataCompressionType>, Boolean)

Ustawia wartość wskazującą kompresję danych używaną przez indeks.

SetFillFactor(IConventionIndex, Nullable<Int32>, Boolean)

Definiuje wartość wskazującą, czy indeks używa współczynnika wypełnienia.

SetFilter(IConventionIndex, String, Boolean)

Ustawia wyrażenie filtru indeksu.

SetFullTextCatalog(IConventionIndex, String, Boolean)

Ustawia nazwę wykazu pełnotekstowego dla indeksu pełnotekstowego.

SetFullTextChangeTracking(IConventionIndex, Nullable<FullTextChangeTracking>, Boolean)

Ustawia tryb śledzenia zmian dla indeksu pełnotekstowego.

SetFullTextKeyIndex(IConventionIndex, String, Boolean)

Ustawia nazwę INDEKSU KLUCZY dla indeksu pełnotekstowego. Ustawienie wartości innej niż null oznacza ten indeks jako indeks pełnotekstowy.

SetFullTextLanguage(IConventionIndex, String, String, Boolean)

Ustawia język pełnotekstowy dla określonej właściwości w indeksie pełnotekstowym.

SetFullTextLanguages(IConventionIndex, IReadOnlyDictionary<String,String>, Boolean)

Ustawia języki pełnotekstowe dla wszystkich właściwości w indeksie pełnotekstowym.

SetIncludeProperties(IConventionIndex, IReadOnlyList<String>, Boolean)

Zestawy zawierały nazwy właściwości.

SetIsClustered(IConventionIndex, Nullable<Boolean>, Boolean)

Ustawia wartość wskazującą, czy indeks jest klastrowany.

SetIsCreatedOnline(IConventionIndex, Nullable<Boolean>, Boolean)

Ustawia wartość wskazującą, czy indeks jest w trybie online.

SetIsFullTextIndex(IConventionIndex, Nullable<Boolean>, Boolean)

Konfiguruje indeks na potrzeby wyszukiwania pełnotekstowego. Aby NoSQL uzyskać więcej informacji, zobacz Wyszukiwanie pełnotekstowe w Azure Cosmos DB, aby uzyskać więcej informacji.

SetName(IConventionIndex, String, Boolean)
Przestarzałe.

Ustawia nazwę indeksu w bazie danych.

SetOrRemoveAnnotation(IConventionAnnotatable, String, Object, Boolean)

Ustawia adnotację przechowywaną pod daną nazwą. Zastępuje istniejącą adnotację, jeśli adnotacja o określonej nazwie już istnieje. Usuwa istniejącą adnotację, jeśli null jest podana.

SetSortInTempDb(IConventionIndex, Nullable<Boolean>, Boolean)

Ustawia wartość wskazującą, czy indeks jest sortowany w bazie danych tempdb.

SetVectorIndexType(IConventionIndex, Nullable<VectorIndexType>, Boolean)

Ustawia typ indeksu wektorowego do użycia, taki jak "flat", "diskANN" lub "quantizedFlat". Aby NoSQL uzyskać więcej informacji, zobacz Wyszukiwanie wektorów w Azure Cosmos DB, aby uzyskać więcej informacji.

SetVectorIndexType(IConventionIndex, Nullable<VectorIndexType>, Nullable<Boolean>, Boolean)

Ustawia typ indeksu wektorowego do użycia, taki jak "flat", "diskANN" lub "quantizedFlat". Aby NoSQL uzyskać więcej informacji, zobacz Wyszukiwanie wektorów w Azure Cosmos DB, aby uzyskać więcej informacji.

SetVectorIndexType(IConventionIndex, String, Boolean)

Ustawia typ indeksu wektora.

SetVectorMetric(IConventionIndex, String, Boolean)

Ustawia metryki podobieństwa dla indeksu wektorowego.

ToDebugString(IIndex, MetadataDebugStringOptions, Int32)

Tworzy czytelną dla człowieka reprezentację podanych metadanych.

Ostrzeżenie: nie należy polegać na formacie zwracanego ciągu. Jest przeznaczony tylko do debugowania i może zmieniać się dowolnie między wydaniami.

Dotyczy