Skip to content

docstore: Clarify docs for nested field paths#3511

Merged
vangent merged 1 commit into
google:masterfrom
vangent:fp
Nov 25, 2024
Merged

docstore: Clarify docs for nested field paths#3511
vangent merged 1 commit into
google:masterfrom
vangent:fp

Conversation

@vangent

@vangent vangent commented Nov 22, 2024

Copy link
Copy Markdown
Contributor

Updates #3506.

Comment thread docstore/doc.go Outdated
// 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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

We ended up not merging the PR, so I would say: "However, others do not support field selectors inside slices, so docstore does not support them."

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Sorry, I hadn't seen your comment on the bug. I think this should say we don't support it, but then the memdocstore option should explain that it's not portable and will only work on mongodb.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Done.

@vangent vangent merged commit 0d91a59 into google:master Nov 25, 2024
@vangent vangent deleted the fp branch November 25, 2024 17:50
@codecov

codecov Bot commented Nov 25, 2024

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 73.24%. Comparing base (a93c109) to head (b5bbe22).
Report is 2 commits behind head on master.

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #3511   +/-   ##
=======================================
  Coverage   73.24%   73.24%           
=======================================
  Files         113      113           
  Lines       15052    15052           
=======================================
  Hits        11025    11025           
  Misses       3262     3262           
  Partials      765      765           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

sandeepvinayak pushed a commit to sandeepvinayak/go-cloud that referenced this pull request Apr 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants