SqlServerIndexExtensions Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Index extension methods for SQL Server-specific metadata.
[System.Runtime.CompilerServices.Nullable(0)]
public static class SqlServerIndexExtensionspublic static class SqlServerIndexExtensions[<System.Runtime.CompilerServices.Nullable(0)>]
type SqlServerIndexExtensions = classtype SqlServerIndexExtensions = classPublic Module SqlServerIndexExtensions- Inheritance
-
SqlServerIndexExtensions
- Attributes
Remarks
See Modeling entity types and relationships, and Accessing SQL Server and Azure SQL databases with EF Core for more information and examples.
Methods
| Name | Description |
|---|---|
| GetDataCompression(IReadOnlyIndex, StoreObjectIdentifier) |
Returns the data compression that the index uses. |
| GetDataCompression(IReadOnlyIndex) |
Returns the data compression that the index uses. |
| GetDataCompressionConfigurationSource(IConventionIndex) |
Returns the ConfigurationSource for the data compression the index uses. |
| GetFillFactor(IIndex) |
Returns a value indicating whether the index uses the fill factor. |
| GetFillFactor(IReadOnlyIndex, StoreObjectIdentifier) |
Returns the fill factor that the index uses. |
| GetFillFactor(IReadOnlyIndex) |
Returns the fill factor that the index uses. |
| GetFillFactorConfigurationSource(IConventionIndex) |
Returns the ConfigurationSource for whether the index uses the fill factor. |
| GetFullTextCatalog(IReadOnlyIndex, StoreObjectIdentifier) |
Returns the full-text catalog name for the full-text index. |
| GetFullTextCatalog(IReadOnlyIndex) |
Returns the full-text catalog name for the full-text index. |
| GetFullTextCatalogConfigurationSource(IConventionIndex) |
Returns the ConfigurationSource for the full-text catalog of the full-text index. |
| GetFullTextChangeTracking(IReadOnlyIndex, StoreObjectIdentifier) |
Returns the change tracking mode for the full-text index. |
| GetFullTextChangeTracking(IReadOnlyIndex) |
Returns the change tracking mode for the full-text index. |
| GetFullTextChangeTrackingConfigurationSource(IConventionIndex) |
Returns the ConfigurationSource for the change tracking mode of the full-text index. |
| GetFullTextKeyIndex(IReadOnlyIndex, StoreObjectIdentifier) |
Returns the KEY INDEX name for the full-text index. |
| GetFullTextKeyIndex(IReadOnlyIndex) |
Returns the KEY INDEX name for the full-text index. |
| GetFullTextKeyIndexConfigurationSource(IConventionIndex) |
Returns the ConfigurationSource for the KEY INDEX of the full-text index. |
| GetFullTextLanguage(IReadOnlyIndex, String) |
Returns the full-text language for a specific property in the full-text index. |
| GetFullTextLanguages(IReadOnlyIndex) |
Returns all full-text languages configured for the full-text index. |
| GetFullTextLanguagesConfigurationSource(IConventionIndex) |
Returns the ConfigurationSource for the full-text languages of the full-text index. |
| GetIncludeProperties(IIndex) |
Returns included property names, or |
| GetIncludeProperties(IReadOnlyIndex, StoreObjectIdentifier) |
Returns included property names, or |
| GetIncludeProperties(IReadOnlyIndex) |
Returns included property names, or |
| GetIncludePropertiesConfigurationSource(IConventionIndex) |
Returns the ConfigurationSource for the included property names. |
| GetIsClusteredConfigurationSource(IConventionIndex) |
Returns the ConfigurationSource for whether the index is clustered. |
| GetIsCreatedOnlineConfigurationSource(IConventionIndex) |
Returns the ConfigurationSource for whether the index is online. |
| GetSortInTempDb(IReadOnlyIndex, StoreObjectIdentifier) |
Returns a value indicating whether the index is sorted in tempdb. |
| GetSortInTempDb(IReadOnlyIndex) |
Returns a value indicating whether the index is sorted in tempdb. |
| GetSortInTempDbConfigurationSource(IConventionIndex) |
Returns the ConfigurationSource for whether the index is sorted in tempdb. |
| GetVectorIndexType(IReadOnlyIndex, StoreObjectIdentifier) |
Returns the type of the vector index. |
| GetVectorIndexType(IReadOnlyIndex) |
Returns the type of the vector index. |
| GetVectorIndexTypeConfigurationSource(IConventionIndex) |
Returns the ConfigurationSource for the type of the vector index. |
| GetVectorMetric(IReadOnlyIndex, StoreObjectIdentifier) |
Returns the similarity metric for the vector index. |
| GetVectorMetric(IReadOnlyIndex) |
Returns the similarity metric for the vector index. |
| GetVectorMetricConfigurationSource(IConventionIndex) |
Returns the ConfigurationSource for the similarity metric of the vector index. |
| IsClustered(IIndex, StoreObjectIdentifier) |
Returns a value indicating whether the index is clustered. |
| IsClustered(IIndex) |
Returns a value indicating whether the index is clustered. |
| IsClustered(IReadOnlyIndex, StoreObjectIdentifier) |
Returns a value indicating whether the index is clustered. |
| IsClustered(IReadOnlyIndex) |
Returns a value indicating whether the index is clustered. |
| IsCreatedOnline(IIndex) |
Returns a value indicating whether the index is online. |
| IsCreatedOnline(IReadOnlyIndex, StoreObjectIdentifier) |
Returns a value indicating whether the index is online. |
| IsCreatedOnline(IReadOnlyIndex) |
Returns a value indicating whether the index is online. |
| IsFullTextIndex(IReadOnlyIndex) |
Returns whether the index is a full-text index. |
| IsVectorIndex(IReadOnlyIndex) |
Returns whether the index is a vector index. |
| SetDataCompression(IConventionIndex, Nullable<DataCompressionType>, Boolean) |
Sets a value indicating the data compression the index uses. |
| SetDataCompression(IMutableIndex, Nullable<DataCompressionType>) |
Sets a value indicating the data compression the index uses. |
| SetFillFactor(IConventionIndex, Nullable<Int32>, Boolean) |
Defines a value indicating whether the index uses the fill factor. |
| SetFillFactor(IMutableIndex, Nullable<Int32>) |
Sets a value indicating whether the index uses the fill factor. |
| SetFullTextCatalog(IConventionIndex, String, Boolean) |
Sets the full-text catalog name for the full-text index. |
| SetFullTextCatalog(IMutableIndex, String) |
Sets the full-text catalog name for the full-text index. |
| SetFullTextChangeTracking(IConventionIndex, Nullable<FullTextChangeTracking>, Boolean) |
Sets the change tracking mode for the full-text index. |
| SetFullTextChangeTracking(IMutableIndex, Nullable<FullTextChangeTracking>) |
Sets the change tracking mode for the full-text index. |
| SetFullTextKeyIndex(IConventionIndex, String, Boolean) |
Sets the KEY INDEX name for the full-text index. Setting a non-null value marks this index as a full-text index. |
| SetFullTextKeyIndex(IMutableIndex, String) |
Sets the KEY INDEX name for the full-text index. Setting a non-null value marks this index as a full-text index. |
| SetFullTextLanguage(IConventionIndex, String, String, Boolean) |
Sets the full-text language for a specific property in the full-text index. |
| SetFullTextLanguage(IMutableIndex, String, String) |
Sets the full-text language for a specific property in the full-text index. |
| SetFullTextLanguages(IConventionIndex, IReadOnlyDictionary<String,String>, Boolean) |
Sets the full-text languages for all properties in the full-text index. |
| SetFullTextLanguages(IMutableIndex, IReadOnlyDictionary<String,String>) |
Sets the full-text languages for all properties in the full-text index. |
| SetIncludeProperties(IConventionIndex, IReadOnlyList<String>, Boolean) |
Sets included property names. |
| SetIncludeProperties(IMutableIndex, IReadOnlyList<String>) |
Sets included property names. |
| SetIsClustered(IConventionIndex, Nullable<Boolean>, Boolean) |
Sets a value indicating whether the index is clustered. |
| SetIsClustered(IMutableIndex, Nullable<Boolean>) |
Sets a value indicating whether the index is clustered. |
| SetIsCreatedOnline(IConventionIndex, Nullable<Boolean>, Boolean) |
Sets a value indicating whether the index is online. |
| SetIsCreatedOnline(IMutableIndex, Nullable<Boolean>) |
Sets a value indicating whether the index is online. |
| SetSortInTempDb(IConventionIndex, Nullable<Boolean>, Boolean) |
Sets a value indicating whether the index is sorted in tempdb. |
| SetSortInTempDb(IMutableIndex, Nullable<Boolean>) |
Sets a value indicating whether the index is sorted in tempdb. |
| SetVectorIndexType(IConventionIndex, String, Boolean) |
Sets the type of the vector index. |
| SetVectorIndexType(IMutableIndex, String) |
Sets the type of the vector index. |
| SetVectorMetric(IConventionIndex, String, Boolean) |
Sets the similarity metric for the vector index. |
| SetVectorMetric(IMutableIndex, String) |
Sets the similarity metric for the vector index. |
