DOCSP-28393 C# new atlas search examples #521
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
shuangela
changed the title
✅ Deploy Preview for docs-csharp ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
stephmarie17
requested changes
Mar 12, 2025
source/fundamentals/atlas-search.txt
Outdated
| Use the ``Facet()`` method to group results by values or ranges in the specified faceted fields | ||
| and return the count for each of those groups. | ||
|
|
||
| You can use ``Facet()`` with both the ``$search`` and ``$searchMeta`` stages. MongoDB recommends using |
There was a problem hiding this comment.
[s] Suggestion to include the term method here for consistency with the other sections, and also to differentiate from the other mentions of "using facet" when generally referring to the collector:
Suggested change
| You can use ``Facet()`` with both the ``$search`` and ``$searchMeta`` stages. MongoDB recommends using | |
| You can use the ``Facet()`` method with both the ``$search`` and ``$searchMeta`` stages. MongoDB recommends using |
| The following example searches searches the ``guitars`` collection for any documents in | ||
| which the value of the ``in_stock`` field is ``true``. The query uses the ``Facet()`` method to process the input documents, with a maximum number of ``100`` facet categories to return in the results. The query returns the total count of documents in which the value of ``in_stock`` is ``true``. | ||
|
|
||
| .. literalinclude:: /includes/fundamentals/code-examples/atlas-search/AtlasSearchExamples.cs |
There was a problem hiding this comment.
[q] Curious why the examples throughout this doc (not just in the diff) don't just use the io codeblock which is a bit cleaner? Or at least set copyable to false for the output maybe?
There was a problem hiding this comment.
I am also not sure because this is my first c# pr! I just followed the standard convention/what the rest of the examples had.
source/fundamentals/atlas-search.txt
Outdated
| You can use ``Facet()`` with both the ``$search`` and ``$searchMeta`` stages. MongoDB recommends using | ||
| facet with the ``$searchMeta`` stage to retrieve metadata results only for the query. | ||
| To retrieve metadata results and query results using the ``$search`` stage, you must use the | ||
| ``$$SEARCH_META`` aggregation variable. See :atlas:`SEARCH_META Aggregation Variable </atlas-search/facet/#std-label-fts-facet-aggregation-variable>` to learn more. |
There was a problem hiding this comment.
[s] Suggestion to revise (or something similar) based on the style guide:
Suggested change
| ``$$SEARCH_META`` aggregation variable. See :atlas:`SEARCH_META Aggregation Variable </atlas-search/facet/#std-label-fts-facet-aggregation-variable>` to learn more. | |
| ``$$SEARCH_META`` aggregation variable. To learn more about this variable, see the :atlas:`SEARCH_META Aggregation Variable </atlas-search/facet/#std-label-fts-facet-aggregation-variable>` section. |
source/fundamentals/atlas-search.txt
Outdated
| - You can run facet queries on a single field only. You can't run facet queries on groups of fields. | ||
| - You can run facet queries over sharded collections on clusters running MongoDB v6.0 only. | ||
|
|
||
| The following example searches searches the ``guitars`` collection for any documents in |
There was a problem hiding this comment.
Suggested change
| The following example searches searches the ``guitars`` collection for any documents in | |
| The following example searches the ``guitars`` collection for any documents in |
source/fundamentals/atlas-search.txt
Outdated
| documentation for each individual operator for details on what types | ||
| of path it supports. | ||
|
|
||
| To search multiple indexed fields, use the ``Multi()`` method and pass in your fields. Documents which match on any of the specified fields are included in the result set. The following example searches the description and type fields. |
There was a problem hiding this comment.
[q] Are these references something different than make and description described in the next paragraph? Or are they the same and should they be monospace and should type be make?
Suggested change
| To search multiple indexed fields, use the ``Multi()`` method and pass in your fields. Documents which match on any of the specified fields are included in the result set. The following example searches the description and type fields. | |
| To search multiple indexed fields, use the ``Multi()`` method and pass in your fields. Documents which match on any of the specified fields are included in the result set. The following example searches the ``description`` and ``make`` fields. |
There was a problem hiding this comment.
good catch! it is the same. i will delete that sentence because it seems redundant with the following one
source/fundamentals/atlas-search.txt
Outdated
Comment on lines
725
to
738
| :atlas:`operators </atlas-search/query-syntax>` to specify the field or fields | ||
| to be searched. It may contain: | ||
|
|
||
| - A string | ||
| - An array of strings | ||
| - A :atlas:`multi analyzer </atlas-search/analyzers/multi>` specification | ||
| - An array containing a combination of strings and multi analyzer | ||
| specifications | ||
|
|
||
| .. note:: | ||
|
|
||
| Not all operators can use all the different types of paths. See the | ||
| documentation for each individual operator for details on what types | ||
| of path it supports. |
There was a problem hiding this comment.
[s] Up to you but since this repeats most of the info from the guide, maybe can edit a bit and link to the guide for more information.
stephmarie17
approved these changes
Mar 13, 2025
source/fundamentals/atlas-search.txt
Outdated
| - A :atlas:`multi analyzer </atlas-search/analyzers/multi>` specification | ||
| - An array containing a combination of strings and multi analyzer | ||
| specifications | ||
| to be searched. To learn more about what the ``path`` parameter may contain, see :atlas:`Construct a Query Path </atlas-search/path-construction>` in the Atlas guide. |
There was a problem hiding this comment.
[s] Can potentially shorten to:
Suggested change
| to be searched. To learn more about what the ``path`` parameter may contain, see :atlas:`Construct a Query Path </atlas-search/path-construction>` in the Atlas guide. | |
| to be searched. To learn more about what the ``path`` parameter may contain, see the :atlas:`Construct a Query Path </atlas-search/path-construction>` guide. |
shuangela
requested review from
a team and
rstam
and removed request for
a team
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request Info
PR Reviewing Guidelines
JIRA - https://jira.mongodb.org/browse/DOCSP-28393
Staging Links
Self-Review Checklist