Geometry.IsValidDetailed Method

Reference

Definition

Namespace:: Microsoft.Azure.Cosmos.Spatial

Assembly:: Microsoft.Azure.Cosmos.Client.dll

Package:: Microsoft.Azure.Cosmos v3.39.0

Source:: Geometry.cs

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.

Determines if the geometry specified is valid and can be indexed or used in queries by Azure Cosmos DB service and if invalid, gives the additional reason as a string value.

If a geometry is not valid, it will not be indexed. Also during query time invalid geometries are equivalent to undefined.

public Microsoft.Azure.Cosmos.Spatial.GeometryValidationResult IsValidDetailed ();

member this.IsValidDetailed : unit -> Microsoft.Azure.Cosmos.Spatial.GeometryValidationResult

Public Function IsValidDetailed () As GeometryValidationResult

Returns

GeometryValidationResult

Instance of GeometryValidationResult.

Examples

This example select all the documents which contain invalid geometries which were not indexed.

var invalidReason = documents.Where(document => !document.Location.IsValid()).Select(document => document.Location.IsValidDetailed());

Remarks

Currently this function supports geometry of type Point and Polygon.

Applies to