IConventionIndex Interfejs

Definicja

Przestrzeń nazw:

Microsoft.EntityFrameworkCore.Metadata

Zestaw:

Microsoft.EntityFrameworkCore.dll

Pakiet:

Microsoft.EntityFrameworkCore v8.0.0

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

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

Implementuje

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyIndex

Uwagi

Ten interfejs jest używany podczas tworzenia modelu i umożliwia modyfikowanie metadanych. Po skompilowania IIndex modelu reprezentuje widok tylko do odczytu tych samych metadanych.

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

Właściwości

Builder	Pobiera konstruktora, którego można użyć do skonfigurowania tego indeksu.
DeclaringEntityType	Pobiera typ jednostki zdefiniowany przez indeks. Może to różnić się od typu Properties zdefiniowanego podczas definiowania typu pochodnego 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 obiektu. (Odziedziczone po IConventionAnnotatable)
IsUnique	Pobiera wartość wskazującą, czy wartości przypisane do indeksowanych właściwości są unikatowe. (Odziedziczone po IReadOnlyIndex)
Item[String]	Pobiera wartość adnotacji o podanej nazwie, zwracając null ją, jeśli nie istnieje. (Odziedziczone po IReadOnlyAnnotatable)
Name	Pobiera nazwę tego indeksu. (Odziedziczone po IReadOnlyIndex)
Properties	Pobiera właściwości zdefiniowane przez ten indeks.

Metody

AddAnnotation(String, Object, Boolean)	Dodaje adnotację do tego obiektu. Zgłasza, jeśli adnotacja o określonej nazwie już istnieje. (Odziedziczone po IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Dodaje adnotacje do obiektu. (Odziedziczone po IConventionAnnotatable)
AnnotationsToDebugString(Int32)	Pobiera ciąg debugowania dla wszystkich adnotacji zadeklarowanych w obiekcie. (Odziedziczone po IReadOnlyAnnotatable)
DisplayName()	Pobiera przyjazną nazwę wyświetlaną dla danego IReadOnlyIndexobiektu , zwracając wartość Name , jeśli jest zdefiniowana, lub reprezentację Properties ciągu, jeśli jest to indeks nienazwany. (Odziedziczone po IReadOnlyIndex)
FindAnnotation(String)	Pobiera adnotację o podanej nazwie, zwracając null , jeśli nie istnieje. (Odziedziczone po IReadOnlyAnnotatable)
GetAnnotation(String)	Pobiera adnotację o podanej nazwie, zgłaszając, jeśli nie istnieje. (Odziedziczone po IReadOnlyAnnotatable)
GetAnnotations()	Pobiera wszystkie adnotacje w bieżącym obiekcie. (Odziedziczone po IReadOnlyAnnotatable)
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.
RemoveAnnotation(String)	Usuwa adnotację o podanej nazwie z tego obiektu. (Odziedziczone po IConventionAnnotatable)
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 zostanie dostarczona. (Odziedziczone po IConventionAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Tworzy czytelną dla człowieka reprezentację podanych metadanych. Ostrzeżenie: nie polegaj na formacie zwracanego ciągu. Jest przeznaczony tylko do debugowania i może zmieniać się dowolnie między wydaniami. (Odziedziczone po IReadOnlyIndex)

Metody rozszerzania

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 on 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 on używany w kodzie aplikacji.
GetDatabaseName(IReadOnlyIndex)	Zwraca nazwę indeksu w bazie danych.
GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	Zwraca nazwę indeksu w bazie danych.
GetDatabaseNameConfigurationSource(IConventionIndex)	Pobiera nazwę ConfigurationSource indeksu w bazie danych.
GetDefaultDatabaseName(IReadOnlyIndex)	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.
GetFilter(IReadOnlyIndex)	Zwraca wyrażenie filtru indeksu.
GetFilter(IReadOnlyIndex, StoreObjectIdentifier)	Zwraca wyrażenie filtru indeksu.
GetFilterConfigurationSource(IConventionIndex)	Pobiera wyrażenie ConfigurationSource filtru indeksu.
SetDatabaseName(IConventionIndex, String, Boolean)	Ustawia nazwę indeksu w bazie danych.
SetFilter(IConventionIndex, String, Boolean)	Ustawia wyrażenie filtru indeksu.
GetDataCompression(IReadOnlyIndex)	Zwraca kompresję danych używaną przez indeks.
GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier)	Zwraca kompresję danych używaną przez indeks.
GetDataCompressionConfigurationSource(IConventionIndex)	Zwraca wartość ConfigurationSource dla kompresji danych używanej przez indeks.
GetFillFactor(IReadOnlyIndex)	Zwraca współczynnik wypełnienia używany przez indeks.
GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier)	Zwraca współczynnik wypełnienia używany przez indeks.
GetFillFactorConfigurationSource(IConventionIndex)	Zwraca wartość ConfigurationSource dla tego, czy indeks używa współczynnika wypełnienia.
GetIncludeProperties(IReadOnlyIndex)	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.
GetIncludePropertiesConfigurationSource(IConventionIndex)	Zwraca wartość ConfigurationSource dla uwzględnionych nazw właściwości.
GetIsClusteredConfigurationSource(IConventionIndex)	Zwraca wartość ConfigurationSource dla tego, czy indeks jest klastrowany.
GetIsCreatedOnlineConfigurationSource(IConventionIndex)	Zwraca wartość ConfigurationSource dla tego, czy indeks jest w trybie online.
GetSortInTempDb(IReadOnlyIndex)	Zwraca wartość wskazującą, czy indeks jest sortowany w bazie danych tempdb.
GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier)	Zwraca wartość wskazującą, czy indeks jest sortowany w bazie danych tempdb.
GetSortInTempDbConfigurationSource(IConventionIndex)	Zwraca wartość ConfigurationSource dla tego, czy indeks jest posortowany w bazie danych tempdb.
IsClustered(IReadOnlyIndex)	Zwraca wartość wskazującą, czy indeks jest klastrowany.
IsClustered(IReadOnlyIndex, StoreObjectIdentifier)	Zwraca wartość wskazującą, czy indeks jest klastrowany.
IsCreatedOnline(IReadOnlyIndex)	Zwraca wartość wskazującą, czy indeks jest w trybie online.
IsCreatedOnline(IReadOnlyIndex, StoreObjectIdentifier)	Zwraca wartość wskazującą, czy indeks jest w trybie online.
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.
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.
SetSortInTempDb(IConventionIndex, Nullable<Boolean>, Boolean)	Ustawia wartość wskazującą, czy indeks jest sortowany w bazie danych tempdb.