[Cosmos] Add support for geospatial indexing and configuration

sdk/cosmosdb/cosmos/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Release History
 
+## 3.6.0 (2020-2-10)
+
+- FEATURE: Add support for spatial indexing, bounding boxes, and geospatial configuration
+- BUG FIX: Fix bug when passing forceQueryPlan to QueryIterator for non-item resources (#7333)
+
 ## 3.5.4 (2020-1-28)
 
 - BUG FIX: Return parsed number instead of string for request charge

sdk/cosmosdb/cosmos/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@azure/cosmos",
-  "version": "3.5.4",
+  "version": "3.6.0",
   "description": "Microsoft Azure Cosmos DB Service Node.js SDK for SQL API",
   "sdk-type": "client",
   "keywords": [

sdk/cosmosdb/cosmos/src/client/Container/ContainerDefinition.ts

@@ -3,6 +3,7 @@
 import { IndexingPolicy, PartitionKeyDefinition } from "../../documents";
 import { ConflictResolutionPolicy } from "../Conflict/ConflictResolutionPolicy";
 import { UniqueKeyPolicy } from "./UniqueKeyPolicy";
+import { GeospatialType } from "../../documents/GeospatialType";
 
 export interface ContainerDefinition {
   /** The id of the container. */
@@ -17,4 +18,8 @@ export interface ContainerDefinition {
   conflictResolutionPolicy?: ConflictResolutionPolicy;
   /** Policy for additional keys that must be unique per partition key */
   uniqueKeyPolicy?: UniqueKeyPolicy;
+  /** Geospatial configuration for a collection. Type is set to Geography by default */
+  geospatialConfig?: {
+    type: GeospatialType;
+  };
 }

sdk/cosmosdb/cosmos/src/documents/GeospatialType.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT license.
+
+export enum GeospatialType {
+  /** Represents data in round-earth coordinate system. */
+  Geography = "Geography",
+  /** Represents data in Eucledian(flat) coordinate system. */
+  Geometry = "Geometry"
+}

sdk/cosmosdb/cosmos/src/documents/IndexingPolicy.ts

@@ -10,6 +10,32 @@ export interface IndexingPolicy {
   includedPaths?: IndexedPath[];
   /** An array of {@link IncludedPath} represents the paths to be excluded for indexing. */
   excludedPaths?: IndexedPath[];
+  spatialIndexes?: SpatialIndex[];
+}
+
+/* The target data type of a spatial path */
+export enum SpatialType {
+  LineString = "LineString",
+  MultiPolygon = "MultiPolygon",
+  Point = "Point",
+  Polygon = "Polygon"
+}
+
+export interface SpatialIndex {
+  /* Path in JSON document to index */
+  path: string;
+  types: SpatialType[];
+  /* Bounding box for geometry spatial path */
+  boundingBox: {
+    /* X-coordinate of the lower-left corner of the bounding box. */
+    xmin: number;
+    /* Y-coordinate of the lower-left corner of the bounding box. */
+    ymin: number;
+    /* X-coordinate of the upper-right corner of the bounding box. */
+    xmax: number;
+    /* Y-coordinate of the upper-right corner of the bounding box. */
+    ymax: number;
+  };
 }
 
 export interface IndexedPath {

sdk/cosmosdb/cosmos/test/functional/container.spec.ts

@@ -11,6 +11,8 @@ import {
   IndexingPolicy,
   IndexKind
 } from "../../dist-esm/documents";
+import { SpatialType } from "../../dist-esm/documents/IndexingPolicy";
+import { GeospatialType } from "../../dist-esm/documents/GeospatialType";
 import { getTestDatabase, removeAllDatabases } from "../common/TestHelpers";
 
 describe("Containers", function() {
@@ -64,6 +66,19 @@ describe("Containers", function() {
 
       // Replacing indexing policy is allowed.
       containerDef.indexingPolicy.indexingMode = IndexingMode.lazy;
+      containerDef.indexingPolicy.spatialIndexes = [
+        {
+          path: "/region/?",
+          types: [SpatialType.Polygon],
+          boundingBox: {
+            xmin: 0,
+            ymin: 0,
+            xmax: 10,
+            ymax: 10
+          }
+        }
+      ];
+      containerDef.geospatialConfig.type = GeospatialType.Geometry;
       const { resource: replacedContainer } = await container.replace(containerDef);
       assert.equal("lazy", replacedContainer.indexingPolicy.indexingMode);