Skip to content

DOCSP-28393 C# new atlas search examples #521

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mcmorisi merged 8 commits into from
Apr 1, 2025
Merged

DOCSP-28393 C# new atlas search examples #521

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7dd0258
new atlas search examples
shuangela Mar 12, 2025
245c7ba
fix link
shuangela Mar 12, 2025
340a215
fix link
shuangela Mar 12, 2025
b27afa0
add details
shuangela Mar 12, 2025
5ac354f
small fixes
shuangela Mar 12, 2025
b1fc9b3
sa edits
shuangela Mar 13, 2025
7ee831f
sa edit
shuangela Mar 13, 2025
0ad34f9
Merge branch 'master' into DOCSP-28393-advanced-atlas-search-methods
mcmorisi Apr 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 5 additions & 11 deletions source/fundamentals/atlas-search.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,17 +256,17 @@ Facet
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
You can use the ``Facet()`` method 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.
``$$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>` Atlas guide.

The following limitations apply:

- 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
The following example 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
Copy link
Collaborator

@stephmarie17 stephmarie17 Mar 12, 2025

Choose a reason for hiding this comment

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

[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?

Copy link
Collaborator Author

@shuangela shuangela Mar 13, 2025

Choose a reason for hiding this comment

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

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.

Expand Down Expand Up @@ -723,21 +723,15 @@ Search Multiple Fields

The ``path`` parameter is used by the Atlas Search
: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
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.
Copy link
Collaborator

@stephmarie17 stephmarie17 Mar 13, 2025

Choose a reason for hiding this comment

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

[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.


.. 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.

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 for the string ``classic`` in either the ``make`` or the ``description`` field.

Expand Down
Loading