From 04b52e74d04717cde4bfe0bff75349c7828d88a2 Mon Sep 17 00:00:00 2001 From: Robert van Gent Date: Fri, 22 Nov 2024 22:43:35 +0000 Subject: [PATCH] docstore: Clarify docs for nested field paths --- docstore/doc.go | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docstore/doc.go b/docstore/doc.go index 297bcc4bce..6296f9bb12 100644 --- a/docstore/doc.go +++ b/docstore/doc.go @@ -212,6 +212,12 @@ // // 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. If you need fully +// portable code, you cannot rely on this feature. +// // 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