IConventionIndex Интерфейс

Определение

Пространство имен:

Microsoft.EntityFrameworkCore.Metadata

Сборка:

Microsoft.EntityFrameworkCore.dll

Пакет:

Microsoft.EntityFrameworkCore v8.0.0

Представляет индекс для набора свойств.

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

Реализации

IConventionAnnotatable IReadOnlyAnnotatable IReadOnlyIndex

Комментарии

Этот интерфейс используется во время создания модели и позволяет изменять метаданные. После построения IIndex модели представляет доступное только для чтения представление одних и того же метаданных.

Дополнительные сведения и примеры см. в разделе Соглашения о создании моделей .

Свойства

Builder	Возвращает построитель, который можно использовать для настройки этого индекса.
DeclaringEntityType	Возвращает тип сущности, для который определен индекс. Это может отличаться от типа, Properties определенного в , когда индекс определяется производным типом в иерархии наследования (так как свойства могут быть определены для базового типа).
IsDescending	Набор значений, указывающих, имеет ли каждый соответствующий столбец индекса порядок сортировки по убыванию. (Унаследовано от IReadOnlyIndex)
IsInModel	Указывает, находится ли этот объект в модели, т. е. не был удален из нее. (Унаследовано от IConventionAnnotatable)
IsUnique	Возвращает значение, указывающее, являются ли значения, назначенные индексированных свойствам, уникальными. (Унаследовано от IReadOnlyIndex)
Item[String]	Возвращает значение заметки с заданным именем, возвращая null значение , если она не существует. (Унаследовано от IReadOnlyAnnotatable)
Name	Возвращает имя этого индекса. (Унаследовано от IReadOnlyIndex)
Properties	Возвращает свойства, для которым определен этот индекс.

Методы

AddAnnotation(String, Object, Boolean)	Добавляет заметку к этому объекту. Вызывает исключение, если заметка с указанным именем уже существует. (Унаследовано от IConventionAnnotatable)
AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean)	Добавляет заметки в объект . (Унаследовано от IConventionAnnotatable)
AnnotationsToDebugString(Int32)	Возвращает отладочную строку для всех заметок, объявленных в объекте . (Унаследовано от IReadOnlyAnnotatable)
DisplayName()	Возвращает понятное отображаемое имя для заданного IReadOnlyIndexобъекта , возвращающее его Name , если он определен, или строковое представление его Properties , если это неименованный индекс. (Унаследовано от IReadOnlyIndex)
FindAnnotation(String)	Возвращает заметку с заданным именем, возвращающую null значение , если она не существует. (Унаследовано от IReadOnlyAnnotatable)
GetAnnotation(String)	Возвращает заметку с заданным именем, вызывая исключение, если она не существует. (Унаследовано от IReadOnlyAnnotatable)
GetAnnotations()	Возвращает все заметки для текущего объекта. (Унаследовано от IReadOnlyAnnotatable)
GetConfigurationSource()	Возвращает источник конфигурации для этого индекса.
GetIsDescendingConfigurationSource()	Возвращает источник конфигурации для IsDescending.
GetIsUniqueConfigurationSource()	Возвращает источник конфигурации для IsUnique.
RemoveAnnotation(String)	Удаляет заметку с заданным именем из этого объекта. (Унаследовано от IConventionAnnotatable)
SetAnnotation(String, Object, Boolean)	Задает заметку, хранящуюся под заданным именем. Перезаписывает существующую заметку, если заметка с указанным именем уже существует. (Унаследовано от IConventionAnnotatable)
SetIsDescending(IReadOnlyList<Boolean>, Boolean)	Задает порядок сортировки для этого индекса (по возрастанию или по убыванию).
SetIsUnique(Nullable<Boolean>, Boolean)	Задает значение, указывающее, являются ли значения, назначенные свойствам индекса, уникальными.
SetOrRemoveAnnotation(String, Object, Boolean)	Задает заметку, хранящуюся под заданным именем. Перезаписывает существующую заметку, если заметка с указанным именем уже существует. Удаляет существующую заметку, если null она указана. (Унаследовано от IConventionAnnotatable)
ToDebugString(MetadataDebugStringOptions, Int32)	Создает понятное представление заданных метаданных. Предупреждение. Не полагайтесь на формат возвращаемой строки. Он предназначен только для отладки и может изменяться произвольно между выпусками. (Унаследовано от IReadOnlyIndex)

Методы расширения

FindSharedObjectRootIndex(IConventionIndex, StoreObjectIdentifier)	Находит первый IConventionIndex объект, сопоставленный с тем же индексом в общем табличном объекте. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Как правило, он не используется в коде приложения.
FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier)	Находит первый IIndex объект, сопоставленный с тем же индексом в общем табличном объекте. Этот метод обычно используется поставщиками баз данных (и другими расширениями). Как правило, он не используется в коде приложения.
GetDatabaseName(IReadOnlyIndex)	Возвращает имя индекса в базе данных.
GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	Возвращает имя индекса в базе данных.
GetDatabaseNameConfigurationSource(IConventionIndex)	Возвращает для ConfigurationSource имени индекса в базе данных.
GetDefaultDatabaseName(IReadOnlyIndex)	Возвращает имя по умолчанию, которое будет использоваться для этого индекса.
GetDefaultDatabaseName(IReadOnlyIndex, StoreObjectIdentifier)	Возвращает имя по умолчанию, которое будет использоваться для этого индекса.
GetFilter(IReadOnlyIndex)	Возвращает выражение фильтра индекса.
GetFilter(IReadOnlyIndex, StoreObjectIdentifier)	Возвращает выражение фильтра индекса.
GetFilterConfigurationSource(IConventionIndex)	ConfigurationSource Возвращает для выражения фильтра индекса.
SetDatabaseName(IConventionIndex, String, Boolean)	Задает имя индекса в базе данных.
SetFilter(IConventionIndex, String, Boolean)	Задает выражение фильтра индекса.
GetDataCompression(IReadOnlyIndex)	Возвращает сжатие данных, которое использует индекс.
GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier)	Возвращает сжатие данных, которое использует индекс.
GetDataCompressionConfigurationSource(IConventionIndex)	Возвращает для ConfigurationSource сжатия данных, который использует индекс.
GetFillFactor(IReadOnlyIndex)	Возвращает коэффициент заполнения, который использует индекс.
GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier)	Возвращает коэффициент заполнения, который использует индекс.
GetFillFactorConfigurationSource(IConventionIndex)	Возвращает значение ConfigurationSource , указывающее, использует ли индекс коэффициент заполнения.
GetIncludeProperties(IReadOnlyIndex)	Возвращает включенные имена свойств или null , если они не были указаны.
GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier)	Возвращает включенные имена свойств или null , если они не были указаны.
GetIncludePropertiesConfigurationSource(IConventionIndex)	Возвращает для ConfigurationSource включенных имен свойств.
GetIsClusteredConfigurationSource(IConventionIndex)	Возвращает значение ConfigurationSource , указывающее, является ли индекс кластеризованным.
GetIsCreatedOnlineConfigurationSource(IConventionIndex)	Возвращает значение ConfigurationSource , указывающее, подключен ли индекс к сети.
GetSortInTempDb(IReadOnlyIndex)	Возвращает значение, указывающее, отсортирован ли индекс в базе данных tempdb.
GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier)	Возвращает значение, указывающее, отсортирован ли индекс в базе данных tempdb.
GetSortInTempDbConfigurationSource(IConventionIndex)	Возвращает значение ConfigurationSource , указывающее, отсортирован ли индекс в базе данных tempdb.
IsClustered(IReadOnlyIndex)	Возвращает значение, указывающее, является ли индекс кластеризованным.
IsClustered(IReadOnlyIndex, StoreObjectIdentifier)	Возвращает значение, указывающее, является ли индекс кластеризованным.
IsCreatedOnline(IReadOnlyIndex)	Возвращает значение, указывающее, подключен ли индекс к сети.
IsCreatedOnline(IReadOnlyIndex, StoreObjectIdentifier)	Возвращает значение, указывающее, подключен ли индекс к сети.
SetDataCompression(IConventionIndex, Nullable<DataCompressionType>, Boolean)	Задает значение, указывающее сжатие данных, которое использует индекс.
SetFillFactor(IConventionIndex, Nullable<Int32>, Boolean)	Определяет значение, указывающее, использует ли индекс коэффициент заполнения.
SetIncludeProperties(IConventionIndex, IReadOnlyList<String>, Boolean)	Задает включенные имена свойств.
SetIsClustered(IConventionIndex, Nullable<Boolean>, Boolean)	Задает значение, указывающее, является ли индекс кластеризованным.
SetIsCreatedOnline(IConventionIndex, Nullable<Boolean>, Boolean)	Задает значение, указывающее, подключен ли индекс к сети.
SetSortInTempDb(IConventionIndex, Nullable<Boolean>, Boolean)	Задает значение, указывающее, отсортирован ли индекс в базе данных tempdb.