Skip to content

feat(firestore): Support Firestore Collection Group Queries#2066

Merged
jamesdaniels merged 13 commits intomasterfrom
collection_group
May 21, 2019
Merged

feat(firestore): Support Firestore Collection Group Queries#2066
jamesdaniels merged 13 commits intomasterfrom
collection_group

Conversation

@jamesdaniels
Copy link
Copy Markdown
Member

@jamesdaniels jamesdaniels commented May 8, 2019 •
edited
Loading

Checklist

  • Issue number for this PR: #nnn (required)
  • Docs included?: (yes/no; required for all API/functional changes)
  • Test units included?: (yes/no; required)
  • In a clean directory, yarn install, yarn test run successfully? (yes/no; required)

Description

Code sample

constructor(private afs: AngularFirestore) { }

ngOnInit() {
  ...
  // Get all the user's comments, no matter how deeply nested
  this.comments$ = afs.collectionGroup('Comments', ref => ref.where('user', '==', userId))
                      .valueChanges({ idField });
}

@jamesdaniels jamesdaniels self-assigned this May 8, 2019
@jamesdaniels jamesdaniels added this to the 5.2.0 milestone May 8, 2019
@jamesdaniels jamesdaniels changed the base branch from flaky_tests to master May 8, 2019 06:45
@jamesdaniels
Copy link
Copy Markdown
Member Author

jamesdaniels commented May 8, 2019

FYI this has been released for testing on @next as of 5.2.0-beta.3

@jamesdaniels jamesdaniels marked this pull request as ready for review May 20, 2019 01:15
@jamesdaniels

This comment has been minimized.

Sign in to view
@jamesdaniels jamesdaniels changed the title WIP Collection Group Queries feat(afs): Collection Group Queries May 20, 2019
@jamesdaniels jamesdaniels changed the title feat(afs): Collection Group Queries feat(firestore): Support Firestore Collection Group Queries May 20, 2019
@jamesdaniels
Copy link
Copy Markdown
Member Author

jamesdaniels commented May 20, 2019

Adding @davideast for review, alternatively @jhuleatt this could be a good one for a pair review. LMK

jhuleatt
jhuleatt approved these changes May 21, 2019
View reviewed changes
docs/firestore/querying-collections.md Outdated
}
```

`collectionGroup` returns an `AngularFirestoreCollectionGroup` which is similar to `AngularFirestoreCollection` but as it has no set reference there are no data operation methods such as `add`.
Copy link
Copy Markdown
Collaborator

@jhuleatt jhuleatt May 21, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found this a bit tough to interpret on the first pass.

Maybe something like "... similar to AngularFirestoreCollection. The main difference is that AngularFirestoreCollectionGroup has no data operation methods such as add because it doesn't have a unique(?concrete?) reference.

Copy link
Copy Markdown
Member Author

@jamesdaniels jamesdaniels May 21, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like concrete.

src/firestore/firestore.ts
* @param queryGroupFn
*/
collectionGroup<T>(collectionId: string, queryGroupFn?: QueryGroupFn): AngularFirestoreCollectionGroup<T> {
if (major < 6) { throw "collection group queries require Firebase JS SDK >= 6.0"}
Copy link
Copy Markdown
Collaborator

@jhuleatt jhuleatt May 21, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

worth throwing a link to the release notes into this error? https://firebase.google.com/support/release-notes/js#version_600_-_may_7_2019

Copy link
Copy Markdown
Member Author

@jamesdaniels jamesdaniels May 21, 2019

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Eh, probably not. I imagine we'll be talking about so few users over the next couple months & more advanced ones at that.

@jamesdaniels
Copy link
Copy Markdown
Member Author

jamesdaniels commented May 21, 2019

Thanks for reviewing @jhuleatt

@jamesdaniels jamesdaniels merged commit c34c0f3 into master May 21, 2019
@jamesdaniels jamesdaniels deleted the collection_group branch May 21, 2019 20:51
@jamesdaniels jamesdaniels mentioned this pull request May 24, 2019
Closed
@valterh4ck3r
Copy link
Copy Markdown

valterh4ck3r commented Jun 1, 2019

So awesome <3

I'm needing this, thank you for your feature request @jamesdaniels and @jhuleatt.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jhuleatt jhuleatt jhuleatt approved these changes

@davideast davideast Awaiting requested review from davideast

Assignees

@jhuleatt jhuleatt

@davideast davideast

Labels

cla: yes

Projects

None yet

Milestone

5.2.0

Development

Successfully merging this pull request may close these issues.

5 participants

@jamesdaniels @valterh4ck3r @jhuleatt @davideast @googlebot