CosmosPropertyExtensions 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.
Property extension methods for Cosmos metadata.
[System.Runtime.CompilerServices.Nullable(0)]
public static class CosmosPropertyExtensionspublic static class CosmosPropertyExtensions[<System.Runtime.CompilerServices.Nullable(0)>]
type CosmosPropertyExtensions = classtype CosmosPropertyExtensions = classPublic Module CosmosPropertyExtensions- Inheritance
-
CosmosPropertyExtensions
- Attributes
Remarks
See Modeling entity types and relationships, and Accessing Azure Cosmos DB with EF Core for more information and examples.
Methods
| Name | Description |
|---|---|
| GetFullTextSearchLanguage(IReadOnlyProperty) |
Returns the full-text search language defined for this property. |
| GetFullTextSearchLanguageConfigurationSource(IConventionProperty) |
Gets the ConfigurationSource for the definition of the full-text search language for this property. |
| GetIsFullTextSearchEnabled(IReadOnlyProperty) |
Returns the value indicating whether full-text search is enabled for this property. |
| GetIsFullTextSearchEnabledConfigurationSource(IConventionProperty) |
Gets the ConfigurationSource for enabling full-text search for this property. |
| GetJsonPropertyName(IProperty) |
Returns the property name that the property is mapped to when targeting Cosmos. |
| GetJsonPropertyName(IReadOnlyProperty) |
Returns the property name that the property is mapped to when targeting Cosmos. |
| GetJsonPropertyNameConfigurationSource(IConventionProperty) |
Gets the ConfigurationSource for the property name that the property is mapped to when targeting Cosmos. |
| GetPropertyName(IProperty) |
Returns the property name used when targeting Cosmos. |
| GetPropertyNameConfigurationSource(IConventionProperty) |
Gets the ConfigurationSource for the property name used when targeting Cosmos. |
| GetVectorDimensions(IReadOnlyProperty) |
Returns the dimensions of the vector stored in this property. |
| GetVectorDimensionsConfigurationSource(IConventionProperty) |
Gets the ConfigurationSource for the dimensions of the vector stored in this property. |
| GetVectorDistanceFunction(IReadOnlyProperty) |
Returns the distance function of the vector stored in this property. |
| GetVectorDistanceFunctionConfigurationSource(IConventionProperty) |
Gets the ConfigurationSource for the distance function of the vector stored in this property. |
| GetVectorType(IReadOnlyProperty) |
Returns the definition of the vector stored in this property. |
| GetVectorTypeConfigurationSource(IConventionProperty) |
Gets the ConfigurationSource for the definition of the vector stored in this property. |
| SetFullTextSearchLanguage(IConventionProperty, String, Boolean) |
Sets the full-text search language defined for this property. |
| SetFullTextSearchLanguage(IMutableProperty, String) |
Sets the full-text search language defined for this property. |
| SetIsFullTextSearchEnabled(IConventionProperty, Nullable<Boolean>, Boolean) |
Enables full-text search for this property. |
| SetIsFullTextSearchEnabled(IMutableProperty, Nullable<Boolean>) |
Enables full-text search for this property. |
| SetJsonPropertyName(IConventionProperty, String, Boolean) |
Sets the property name that the property is mapped to when targeting Cosmos. |
| SetJsonPropertyName(IMutableProperty, String) |
Sets the property name that the property is mapped to when targeting Cosmos. |
| SetPropertyName(IConventionProperty, String, Boolean) |
Sets the property name used when targeting Cosmos. |
| SetPropertyName(IMutableProperty, String) |
Sets the property name used when targeting Cosmos. |
| SetVectorDimensions(IConventionProperty, Nullable<Int32>, Boolean) |
Sets the dimensions of the vector stored in this property. |
| SetVectorDimensions(IMutableProperty, Nullable<Int32>) |
Sets the dimensions of the vector stored in this property. |
| SetVectorDistanceFunction(IConventionProperty, Nullable<DistanceFunction>, Boolean) |
Sets the distance function of the vector stored in this property. |
| SetVectorDistanceFunction(IMutableProperty, Nullable<DistanceFunction>) |
Sets the distance function of the vector stored in this property. |
| SetVectorType(IConventionProperty, CosmosVectorType, Boolean) |
Sets the definition of the vector stored in this property. |
| SetVectorType(IMutableProperty, CosmosVectorType) |
Sets the definition of the vector stored in this property. |
