Collection Group Queries (#43)

Author: samtstern

firestore/main/.gitignore

@@ -0,0 +1,65 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+firebase-debug.log*
+
+# Firebase cache
+.firebase/
+
+# Firebase config
+
+# Uncomment this if you'd like others to create their own Firebase project.
+# For a team working on the same Firebase project(s), it is recommended to leave
+# it commented so all members can deploy to the same project(s) in .firebaserc.
+# .firebaserc
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env

firestore/main/firebase.json

@@ -0,0 +1,6 @@
+{
+  "firestore": {
+    "rules": "firestore.rules",
+    "indexes": "firestore.indexes.json"
+  }
+}

firestore/main/firestore.indexes.json

@@ -0,0 +1,42 @@
+{
+  "indexes": [
+    {
+      "collectionGroup": "cities",
+      "queryScope": "COLLECTION",
+      "fields": [
+        {
+          "fieldPath": "name",
+          "order": "ASCENDING"
+        },
+        {
+          "fieldPath": "state",
+          "order": "ASCENDING"
+        }
+      ]
+    }
+  ],
+  "fieldOverrides": [
+    {
+      "collectionGroup": "landmarks",
+      "fieldPath": "type",
+      "indexes": [
+        {
+          "order": "ASCENDING",
+          "queryScope": "COLLECTION"
+        },
+        {
+          "order": "DESCENDING",
+          "queryScope": "COLLECTION"
+        },
+        {
+          "arrayConfig": "CONTAINS",
+          "queryScope": "COLLECTION"
+        },
+        {
+          "order": "ASCENDING",
+          "queryScope": "COLLECTION_GROUP"
+        }
+      ]
+    }
+  ]
+}

firestore/main/index.js

@@ -820,6 +820,65 @@ function listenErrors(db) {
   // [END listen_errors]
 }
 
+function collectionGroupQuery(db) {
+  // [START fs_collection_group_query_data_setup]
+  var citiesRef = db.collection('cities');
+
+  var landmarks = Promise.all([
+    citiesRef.doc('SF').collection('landmarks').doc().set({
+      name: 'Golden Gate Bridge',
+      type: 'bridge'
+    }),
+    citiesRef.doc('SF').collection('landmarks').doc().set({
+      name: 'Legion of Honor',
+      type: 'museum'
+    }),
+    citiesRef.doc('LA').collection('landmarks').doc().set({
+      name: 'Griffith Park',
+      type: 'park'
+    }),
+    citiesRef.doc('LA').collection('landmarks').doc().set({
+      name: 'The Getty',
+      type: 'museum'
+    }),
+    citiesRef.doc('DC').collection('landmarks').doc().set({
+      name: 'Lincoln Memorial',
+      type: 'memorial'
+    }),
+    citiesRef.doc('DC').collection('landmarks').doc().set({
+      name: 'National Air and Space Museum',
+      type: 'museum'
+    }),
+    citiesRef.doc('TOK').collection('landmarks').doc().set({
+      name: 'Ueno Park',
+      type: 'park'
+    }),
+    citiesRef.doc('TOK').collection('landmarks').doc().set({
+      name: 'National Museum of Nature and Science',
+      type: 'museum'
+    }),
+    citiesRef.doc('BJ').collection('landmarks').doc().set({
+      name: 'Jingshan Park',
+      type: 'park'
+    }),
+    citiesRef.doc('BJ').collection('landmarks').doc().set({ 
+      name: 'Beijing Ancient Observatory',
+      type: 'museum'
+    })
+  ]);
+  // [END fs_collection_group_query_data_setup]
+  landmarks.then((l) => console.log(l));
+
+  // [START fs_collection_group_query]
+  let museums = db.collectionGroup('landmarks').where('type', '==', 'museum');
+  museums.get().then(function(querySnapshot) {
+    querySnapshot.forEach(function(doc) {
+      console.log(doc.id, ' => ', doc.data());
+    });
+  });
+  // [end fs_collection_group_query]
+}
+
 // ============================================================================
 // https://firebase.google.com/docs/firestore/query-data/query-cursors
 // ============================================================================
@@ -1121,4 +1180,8 @@ describe('Firestore Smoketests', () => {
   it('should delete the whole collection', () => {
     return deleteCollection(db, 'cities', 50);
   });
+
+  it('should find all museums when querying a collection group', () => {
+    return collectionGroupQuery(db);
+  });
 });