Merge pull request #16 from samtstern/ss-new-indexes

New Firestore indexes spec
toba · Jan 24, 2019 · 50855cb · 50855cb
2 parents 3e855ae + e23dfdf
commit 50855cb
Show file tree

Hide file tree

Showing 2 changed files with 84 additions and 28 deletions.
diff --git a/syntaxes/index.schema.json b/syntaxes/index.schema.json
@@ -7,14 +7,17 @@
          "items": {
             "type": "object",
             "properties": {
-               "name": {
-                  "type": "string",
-                  "description": "The resource name of the index."
-               },
-               "collectionId": {
+               "collectionGroup": {
                   "type": "string",
                   "pattern": "^[a-zA-Z0-9_]+$",
-                  "description": "The collection ID to which this index applies."
+                  "description": "The collection group ID to which this index applies."
+               },
+               "queryScope": {
+                  "enum": [
+                     "COLLECTION",
+                     "COLLECTION_GROUP"
+                  ],
+                  "description": "The query scope to which this index applies."
                },
                "fields": {
                   "type": "array",
@@ -26,35 +29,80 @@
                            "pattern": "^[a-zA-Z0-9_\/\.]+$",
                            "description": "The path of the field. Special field paths __name__, __type__, and __scatter__ may be used."
                         },
-                        "mode": {
+                        "order": {
                            "enum": [
                               "ASCENDING",
-                              "DESCENDING",
-                              "MODE_UNSPECIFIED"
+                              "DESCENDING"
                            ],
-                           "description": "The mode determines how a field is indexed."
+                           "description": "The order determines how a field is indexed."
+                        },
+                        "arrayConfig": {
+                           "enum": [
+                              "CONTAINS"
+                           ],
+                           "description": "The arrayConfig determines how an array field is indexed."
                         }
                      },
                      "uniqueItems": true,
                      "required": ["fieldPath"]
                   },
                   "minItems": 1
+               }
+            },
+            "required": ["collectionGroup", "queryScope", "fields"]
+         },
+         "minItems": 0
+      },
+      "fieldOverrides": {
+         "type": "array",
+         "items": {
+            "type": "object",
+            "properties": {
+               "collectionGroup": {
+                  "type": "string",
+                  "pattern": "^[a-zA-Z0-9_]+$",
+                  "description": "The collection group ID to which this field override applies."
                },
-               "state": {
-                  "enum": [
-                     "STATE_UNSPECIFIED",
-                     "DISABLED",
-                     "ENABLED",
-                     "ENABLING",
-                     "DISABLING",
-                     "ERROR"
-                  ],
-                  "description": "The state of the index. The state is read-only and is manipulated by using the enable and disable RPCs. During enabling, the process could result in an error, in which case the index will move to the ERROR state. The process can be recovered by either fixing the data that caused the error and retrying by calling enable or by aborting the index build by calling disable."
+               "fieldPath": {
+                  "type": "string",
+                  "pattern": "^[a-zA-Z0-9_\/\.]+$",
+                  "description": "The field path to which this field override applies."
+               },
+               "indexes": {
+                  "type": "array",
+                  "items": {
+                     "type": "object",
+                     "properties": {
+                        "queryScope": {
+                           "enum": [
+                              "COLLECTION",
+                              "COLLECTION_GROUP"
+                           ],
+                           "description": "The query scope to which this index applies."
+                        },
+                        "order": {
+                           "enum": [
+                              "ASCENDING",
+                              "DESCENDING"
+                           ],
+                           "description": "The order determines how a field is indexed."
+                        },
+                        "arrayConfig": {
+                           "enum": [
+                              "CONTAINS"
+                           ],
+                           "description": "The arrayConfig determines how an array field is indexed."
+                        }
+                     },
+                     "uniqueItems": true,
+                     "required": ["order", "queryScope"]
+                  },
+                  "minItems": 0
                }
             },
-            "required": ["collectionId", "fields"]
+            "required": ["collectionGroup", "queryScope", "fields"]
          },
-         "minItems": 1
+         "minItems": 0
       }
    },
    "required": ["indexes"]

diff --git a/syntaxes/sample.indexes.json b/syntaxes/sample.indexes.json
@@ -1,12 +1,20 @@
-{
+  {
    "indexes": [
       {
-         "name": "my index",
-         "collectionId": "widgets",
+         "collectionGroup": "widgets",
+         "queryScope": "COLLECTION",
          "fields": [
-            { "fieldPath": "foo", "mode": "ASCENDING" },
-            { "fieldPath": "bar", "mode": "DESCENDING" },
-            { "fieldPath": "baz", "mode": "ASCENDING" }
+            { "fieldPath": "foo", "arrayConfig": "CONTAINS" },
+            { "fieldPath": "bar", "order": "DESCENDING" }
+         ]
+      }
+   ],
+   "fieldOverrides": [
+      {
+         "collectionGroup": "widgets",
+         "fieldPath": "baz",
+         "indexes": [
+            { "order": "ASCENDING", "queryScope": "COLLECTION" }
          ]
       }
    ]