IConventionIndex Interface
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Représente un index sur un ensemble de propriétés.
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
- Implémente
Remarques
Cette interface est utilisée lors de la création du modèle et permet de modifier les métadonnées. Une fois le modèle généré, IIndex représente une vue en lecture seule des mêmes métadonnées.
Pour plus d’informations et d’exemples, consultez les conventions de génération de modèles.
Propriétés
| Nom | Description |
|---|---|
| Builder |
Obtient le générateur qui peut être utilisé pour configurer cet index. |
| CollectionIndices |
Obtient les index de collection complexe parcourus pour atteindre chaque propriété indexée. (Hérité de IReadOnlyIndex) |
| DeclaringEntityType |
Obtient le type d’entité sur lequel l’index est défini. Cela peut être différent du type Properties défini lorsque l’index est défini comme type dérivé dans une hiérarchie d’héritage (dans la mesure où les propriétés peuvent être définies sur un type de base). |
| IsDescending |
Ensemble de valeurs indiquant si chaque colonne d’index correspondante a un ordre de tri décroissant. (Hérité de IReadOnlyIndex) |
| IsInModel |
Indique si cet objet se trouve dans un modèle, c’est-à-dire qu’il n’a pas été supprimé d’un modèle. (Hérité de IConventionAnnotatable) |
| IsUnique |
Obtient une valeur indiquant si les valeurs affectées aux propriétés indexées sont uniques. (Hérité de IIndex) |
| Item[String] |
Obtient l’annotation de valeur avec le nom donné, en retournant |
| Name |
Obtient le nom de cet index. (Hérité de IIndex) |
| Properties |
Obtient les propriétés sur laquelle cet index est défini. |
Méthodes
| Nom | Description |
|---|---|
| AddAnnotation(String, Object, Boolean) |
Ajoute une annotation à cet objet. Lève si une annotation portant le nom spécifié existe déjà. (Hérité de IConventionAnnotatable) |
| AddAnnotations(IEnumerable<IConventionAnnotation>, Boolean) |
Ajoute des annotations à un objet. (Hérité de IConventionAnnotatable) |
| AddRuntimeAnnotation(String, Object) |
Ajoute une annotation runtime à cet objet. Lève si une annotation portant le nom spécifié existe déjà. (Hérité de IAnnotatable) |
| AnnotationsToDebugString(Int32) |
Obtient la chaîne de débogage pour toutes les annotations déclarées sur l’objet. (Hérité de IReadOnlyAnnotatable) |
| DisplayName() |
Obtient le nom d’affichage convivial de l’objet donné IReadOnlyIndex, en retournant son Name si l’un est défini ou une représentation sous forme de chaîne de celle-ci Properties s’il s’agit d’un index sans nom. (Hérité de IReadOnlyIndex) |
| FindAnnotation(String) |
Obtient l’annotation portant le nom donné, en retournant |
| FindRuntimeAnnotation(String) |
Obtient l’annotation runtime avec le nom donné, en retournant |
| FindRuntimeAnnotationValue(String) |
Obtient la valeur de l’annotation runtime avec le nom donné, en retournant |
| GetAnnotation(String) |
Obtient l’annotation portant le nom donné, levée s’il n’existe pas. (Hérité de IConventionAnnotatable) |
| GetAnnotations() |
Obtient toutes les annotations sur l’objet actuel. (Hérité de IAnnotatable) |
| GetConfigurationSource() |
Retourne la source de configuration de cet index. |
| GetIsDescendingConfigurationSource() |
Retourne la source de configuration pour IsDescending. |
| GetIsUniqueConfigurationSource() |
Retourne la source de configuration pour IsUnique. |
| GetNullableValueFactory<TKey>() |
Obtient une fabrique pour les valeurs de clé en fonction des valeurs de clé d’index extraites de différentes formes de données d’entité. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code d’application. (Hérité de IIndex) |
| GetOrAddRuntimeAnnotationValue<TValue,TArg>(String, Func<TArg,TValue>, TArg) |
Obtient la valeur de l’annotation runtime avec le nom donné, en l’ajoutant si elle n’existe pas. (Hérité de IAnnotatable) |
| GetRuntimeAnnotations() |
Obtient toutes les annotations runtime sur l’objet actuel. (Hérité de IAnnotatable) |
| RemoveAnnotation(String) |
Supprime l’annotation portant le nom donné de cet objet. (Hérité de IConventionAnnotatable) |
| RemoveRuntimeAnnotation(String) |
Supprime l’annotation runtime donnée de cet objet. (Hérité de IAnnotatable) |
| SetAnnotation(String, Object, Boolean) |
Définit l’annotation stockée sous le nom donné. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà. (Hérité de IConventionAnnotatable) |
| SetIsDescending(IReadOnlyList<Boolean>, Boolean) |
Définit le ou les ordres de tri pour cet index (croissant ou décroissant). |
| SetIsUnique(Nullable<Boolean>, Boolean) |
Définit une valeur indiquant si les valeurs affectées aux propriétés d’index sont uniques. |
| SetOrRemoveAnnotation(String, Object, Boolean) |
Définit l’annotation stockée sous le nom donné. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà. Supprime l’annotation existante si |
| SetRuntimeAnnotation(String, Object) |
Définit l’annotation runtime stockée sous la clé donnée. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà. (Hérité de IAnnotatable) |
| ToDebugString(MetadataDebugStringOptions, Int32) |
Crée une représentation lisible par l’homme des métadonnées données. Avertissement : Ne vous appuyez pas sur le format de la chaîne retournée. Il est conçu pour le débogage uniquement et peut changer arbitrairement entre les versions. (Hérité de IReadOnlyIndex) |
Méthodes d’extension
| Nom | Description |
|---|---|
| AddAnnotations(IConventionAnnotatable, IEnumerable<IConventionAnnotation>, Boolean) |
Ajoute des annotations à un objet. |
| AnnotationsToDebugString(IAnnotatable, Int32) |
Obtient la chaîne de débogage pour toutes les annotations déclarées sur l’objet. |
| FindSharedObjectRootIndex(IConventionIndex, StoreObjectIdentifier) |
Recherche le premier IConventionIndex mappé au même index dans un objet de type table partagé. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code d’application. |
| FindSharedObjectRootIndex(IIndex, StoreObjectIdentifier) |
Recherche le premier IConventionIndex mappé au même index dans un objet de type table partagé. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code d’application. |
| FindSharedObjectRootIndex(IReadOnlyIndex, StoreObjectIdentifier) |
Recherche le premier IIndex mappé au même index dans un objet de type table partagé. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code d’application. |
| GetAnnotation(IAnnotatable, String) |
Obtient l’annotation portant le nom donné, levée s’il n’existe pas. |
| GetAnnotation(IConventionAnnotatable, String) |
Obtient l’annotation portant le nom donné, levée s’il n’existe pas. |
| GetDatabaseName(IIndex, StoreObjectIdentifier) |
Retourne le nom de l’index dans la base de données. |
| GetDatabaseName(IIndex) |
Retourne le nom de l’index dans la base de données. |
| GetDatabaseName(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne le nom de l’index dans la base de données. |
| GetDatabaseName(IReadOnlyIndex) |
Retourne le nom de l’index dans la base de données. |
| GetDatabaseNameConfigurationSource(IConventionIndex) |
Obtient le ConfigurationSource nom de l’index dans la base de données. |
| GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne la compression des données utilisée par l’index. |
| GetDataCompression(IReadOnlyIndex) |
Retourne la compression des données utilisée par l’index. |
| GetDataCompressionConfigurationSource(IConventionIndex) |
Retourne la ConfigurationSource compression des données utilisée par l’index. |
| GetDefaultDatabaseName(IIndex, StoreObjectIdentifier) |
Retourne le nom par défaut qui serait utilisé pour cet index. |
| GetDefaultDatabaseName(IIndex) |
Retourne le nom par défaut qui serait utilisé pour cet index. |
| GetDefaultDatabaseName(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne le nom par défaut qui serait utilisé pour cet index. |
| GetDefaultDatabaseName(IReadOnlyIndex) |
Retourne le nom par défaut qui serait utilisé pour cet index. |
| GetDefaultName(IIndex) |
Obsolète.
Retourne le nom par défaut qui serait utilisé pour cet index. |
| GetFillFactor(IIndex) |
Retourne une valeur indiquant si l’index utilise le facteur de remplissage. |
| GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne le facteur de remplissage que l’index utilise. |
| GetFillFactor(IReadOnlyIndex) |
Retourne le facteur de remplissage que l’index utilise. |
| GetFillFactorConfigurationSource(IConventionIndex) |
Retourne si ConfigurationSource l’index utilise le facteur de remplissage. |
| GetFilter(IIndex, StoreObjectIdentifier) |
Retourne l’expression de filtre d’index. |
| GetFilter(IIndex) |
Retourne l’expression de filtre d’index. |
| GetFilter(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne l’expression de filtre d’index. |
| GetFilter(IReadOnlyIndex) |
Retourne l’expression de filtre d’index. |
| GetFilterConfigurationSource(IConventionIndex) |
Obtient l’expression ConfigurationSource de filtre d’index. |
| GetFullTextCatalog(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne le nom du catalogue de texte intégral pour l’index de recherche en texte intégral. |
| GetFullTextCatalog(IReadOnlyIndex) |
Retourne le nom du catalogue de texte intégral pour l’index de recherche en texte intégral. |
| GetFullTextCatalogConfigurationSource(IConventionIndex) |
Retourne le ConfigurationSource catalogue de texte intégral de l’index de recherche en texte intégral. |
| GetFullTextChangeTracking(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne le mode de suivi des modifications pour l’index de recherche en texte intégral. |
| GetFullTextChangeTracking(IReadOnlyIndex) |
Retourne le mode de suivi des modifications pour l’index de recherche en texte intégral. |
| GetFullTextChangeTrackingConfigurationSource(IConventionIndex) |
Retourne le ConfigurationSource mode de suivi des modifications de l’index de recherche en texte intégral. |
| GetFullTextKeyIndex(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne le nom KEY INDEX pour l’index de recherche en texte intégral. |
| GetFullTextKeyIndex(IReadOnlyIndex) |
Retourne le nom KEY INDEX pour l’index de recherche en texte intégral. |
| GetFullTextKeyIndexConfigurationSource(IConventionIndex) |
Retourne l’INDEX ConfigurationSource KEY de l’index de recherche en texte intégral. |
| GetFullTextLanguage(IReadOnlyIndex, String) |
Retourne la langue de texte intégral d’une propriété spécifique dans l’index de recherche en texte intégral. |
| GetFullTextLanguages(IReadOnlyIndex) |
Retourne toutes les langues de texte intégral configurées pour l’index de recherche en texte intégral. |
| GetFullTextLanguagesConfigurationSource(IConventionIndex) |
Retourne les ConfigurationSource langues de texte intégral de l’index de recherche en texte intégral. |
| GetIncludeProperties(IIndex) |
Retourne les noms de propriétés inclus ou |
| GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne les noms de propriétés inclus ou |
| GetIncludeProperties(IReadOnlyIndex) |
Retourne les noms de propriétés inclus ou |
| GetIncludePropertiesConfigurationSource(IConventionIndex) |
Retourne le ConfigurationSource nom des propriétés incluses. |
| GetIsClusteredConfigurationSource(IConventionIndex) |
Retourne si ConfigurationSource l’index est cluster. |
| GetIsCreatedOnlineConfigurationSource(IConventionIndex) |
Retourne si ConfigurationSource l’index est en ligne. |
| GetIsFullTextIndexConfigurationSource(IConventionIndex) |
Retourne la ConfigurationSource valeur pour déterminer si le IsFullTextIndex(IReadOnlyIndex). |
| GetMappedTableIndexes(IIndex) |
Obtient les index de table auxquels l’index est mappé. |
| GetName(IIndex) |
Obsolète.
Retourne le nom de l’index dans la base de données. |
| GetNameConfigurationSource(IConventionIndex) |
Obsolète.
Obtient le ConfigurationSource nom de l’index dans la base de données. |
| GetNullableValueFactory<TKey>(IIndex) |
Obtient une fabrique pour les valeurs de clé en fonction des valeurs de clé d’index extraites de différentes formes de données d’entité. Cette méthode est généralement utilisée par les fournisseurs de base de données (et d’autres extensions). Il n’est généralement pas utilisé dans le code d’application. |
| GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne une valeur indiquant si l’index est trié dans tempdb. |
| GetSortInTempDb(IReadOnlyIndex) |
Retourne une valeur indiquant si l’index est trié dans tempdb. |
| GetSortInTempDbConfigurationSource(IConventionIndex) |
Retourne si ConfigurationSource l’index est trié dans tempdb. |
| GetVectorIndexType(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne le type de l’index vectoriel. |
| GetVectorIndexType(IReadOnlyIndex) |
Retourne le type d’index vectoriel à utiliser, tel que « flat », « diskANN » ou « quantizedFlat ». Pour plus d’informations, consultez Recherche vectorielle dans Azure Cosmos DB pour NoSQL. |
| GetVectorIndexType(IReadOnlyIndex) |
Retourne le type de l’index vectoriel. |
| GetVectorIndexTypeConfigurationSource(IConventionIndex) |
Retourne la ConfigurationSource valeur pour déterminer si le GetVectorIndexType(IReadOnlyIndex). |
| GetVectorIndexTypeConfigurationSource(IConventionIndex) |
Retourne le ConfigurationSource type de l’index vectoriel. |
| GetVectorMetric(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne la métrique de similarité pour l’index vectoriel. |
| GetVectorMetric(IReadOnlyIndex) |
Retourne la métrique de similarité pour l’index vectoriel. |
| GetVectorMetricConfigurationSource(IConventionIndex) |
Retourne la ConfigurationSource métrique de similarité de l’index vectoriel. |
| IsClustered(IIndex, StoreObjectIdentifier) |
Retourne une valeur indiquant si l’index est cluster. |
| IsClustered(IIndex) |
Retourne une valeur indiquant si l’index est cluster. |
| IsClustered(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne une valeur indiquant si l’index est cluster. |
| IsClustered(IReadOnlyIndex) |
Retourne une valeur indiquant si l’index est cluster. |
| IsCreatedOnline(IIndex) |
Retourne une valeur indiquant si l’index est en ligne. |
| IsCreatedOnline(IReadOnlyIndex, StoreObjectIdentifier) |
Retourne une valeur indiquant si l’index est en ligne. |
| IsCreatedOnline(IReadOnlyIndex) |
Retourne une valeur indiquant si l’index est en ligne. |
| IsFullTextIndex(IReadOnlyIndex) |
Retourne la valeur indiquant si l’index est configuré pour la recherche en texte intégral. Pour plus d’informations, consultez la recherche en texte intégral dans Azure Cosmos DB pour NoSQL. |
| IsFullTextIndex(IReadOnlyIndex) |
Retourne si l’index est un index de recherche en texte intégral. |
| IsVectorIndex(IReadOnlyIndex) |
Retourne si l’index est un index vectoriel. |
| SetDatabaseName(IConventionIndex, String, Boolean) |
Définit le nom de l’index dans la base de données. |
| SetDataCompression(IConventionIndex, Nullable<DataCompressionType>, Boolean) |
Définit une valeur indiquant la compression des données utilisée par l’index. |
| SetFillFactor(IConventionIndex, Nullable<Int32>, Boolean) |
Définit une valeur indiquant si l’index utilise le facteur de remplissage. |
| SetFilter(IConventionIndex, String, Boolean) |
Définit l’expression de filtre d’index. |
| SetFullTextCatalog(IConventionIndex, String, Boolean) |
Définit le nom du catalogue de texte intégral pour l’index de recherche en texte intégral. |
| SetFullTextChangeTracking(IConventionIndex, Nullable<FullTextChangeTracking>, Boolean) |
Définit le mode de suivi des modifications pour l’index de recherche en texte intégral. |
| SetFullTextKeyIndex(IConventionIndex, String, Boolean) |
Définit le nom KEY INDEX pour l’index de recherche en texte intégral. La définition d’une valeur non null marque cet index en tant qu’index de recherche en texte intégral. |
| SetFullTextLanguage(IConventionIndex, String, String, Boolean) |
Définit la langue de texte intégral d’une propriété spécifique dans l’index de recherche en texte intégral. |
| SetFullTextLanguages(IConventionIndex, IReadOnlyDictionary<String,String>, Boolean) |
Définit les langues de texte intégral pour toutes les propriétés de l’index de recherche en texte intégral. |
| SetIncludeProperties(IConventionIndex, IReadOnlyList<String>, Boolean) |
Définit les noms de propriétés inclus. |
| SetIsClustered(IConventionIndex, Nullable<Boolean>, Boolean) |
Définit une valeur indiquant si l’index est cluster. |
| SetIsCreatedOnline(IConventionIndex, Nullable<Boolean>, Boolean) |
Définit une valeur indiquant si l’index est en ligne. |
| SetIsFullTextIndex(IConventionIndex, Nullable<Boolean>, Boolean) |
Configure l’index pour la recherche en texte intégral. Pour plus d’informations, consultez la recherche en texte intégral dans Azure Cosmos DB pour NoSQL. |
| SetName(IConventionIndex, String, Boolean) |
Obsolète.
Définit le nom de l’index dans la base de données. |
| SetOrRemoveAnnotation(IConventionAnnotatable, String, Object, Boolean) |
Définit l’annotation stockée sous le nom donné. Remplace l’annotation existante si une annotation portant le nom spécifié existe déjà. Supprime l’annotation existante si |
| SetSortInTempDb(IConventionIndex, Nullable<Boolean>, Boolean) |
Définit une valeur indiquant si l’index est trié dans tempdb. |
| SetVectorIndexType(IConventionIndex, Nullable<VectorIndexType>, Boolean) |
Définit le type d’index vectoriel à utiliser, tel que « flat », « diskANN » ou « quantizedFlat ». Pour plus d’informations, consultez Recherche vectorielle dans Azure Cosmos DB pour NoSQL. |
| SetVectorIndexType(IConventionIndex, Nullable<VectorIndexType>, Nullable<Boolean>, Boolean) |
Définit le type d’index vectoriel à utiliser, tel que « flat », « diskANN » ou « quantizedFlat ». Pour plus d’informations, consultez Recherche vectorielle dans Azure Cosmos DB pour NoSQL. |
| SetVectorIndexType(IConventionIndex, String, Boolean) |
Définit le type de l’index vectoriel. |
| SetVectorMetric(IConventionIndex, String, Boolean) |
Définit la métrique de similarité pour l’index vectoriel. |
| ToDebugString(IIndex, MetadataDebugStringOptions, Int32) |
Crée une représentation lisible par l’homme des métadonnées données. Avertissement : Ne vous appuyez pas sur le format de la chaîne retournée. Il est conçu pour le débogage uniquement et peut changer arbitrairement entre les versions. |