Skip to content

Commit

Permalink
docstore: clarify docs for queries references nested field paths (#3511)
Browse files Browse the repository at this point in the history
  • Loading branch information
vangent authored Nov 25, 2024
1 parent 73ef855 commit 0d91a59
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docstore/doc.go
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,13 @@
//
// iter := coll.Query().Where("Author.Last", "=", "Bulgakov").Limit(3).Get(ctx)
//
// Dot-separated paths work as you'd expect for nested structs and maps, addressing
// the nested struct field or map key. For nested slices, some providers (notably
// MongoDB) treat s.f, where s is a sequence, as the slice of e.f for each e in s.
// However, others do not support field selectors inside slices, so docstore does
// not support them -- while you may find that they work with some providers, you
// cannot rely on that if you need fully portable code.
//
// You can make multiple Where calls. In some cases, parts of a Where clause may be
// processed in the driver rather than natively by the backing service, which may have
// performance implications for large result sets. See the driver package
Expand Down

0 comments on commit 0d91a59

Please sign in to comment.