DOCSP-45110: queries subsections #80

rustagir · 2024-12-20T18:06:32Z

Pull Request Info

JIRA - https://jira.mongodb.org/browse/DOCSP-45110
Staging -

Self-Review Checklist

Is this free of any warnings or errors in the RST?
Did you run a spell-check?
Did you run a grammar-check?
Are all the links working?
Are the facets and meta keywords accurate?

netlify · 2024-12-20T18:06:55Z

✅ Deploy Preview for docs-mongoid ready!

Name	Link
🔨 Latest commit	`1c68896`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-mongoid/deploys/678018483ef9310008a6f35a
😎 Deploy Preview	https://deploy-preview-80--docs-mongoid.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

mayaraman19

Looks pretty good to me, I just left a couple comments

mayaraman19 · 2024-12-24T00:18:41Z

source/interact-data/query-async.txt

+executed synchronously on the caller's thread. The following list
+describes possible scenarios that this might occur depending on when the
+query results are being accessed:
+
+1. If the scheduled asynchronous task has been executed, the
+   results are returned.
+
+#. If the task has been started, but hasn't completed, the caller's
+   thread blocks until the task is finished.
+
+#. If the task has not been started yet, it is removed from the
+   execution queue, and the query is executed synchronously on the
+   caller's thread.


Q: is this list exhaustive?

I am not sure - taken from the original text. But the introduction to this list doesn't give the impression that it is exhuastive "possible scenarios"

mayaraman19 · 2024-12-24T00:19:53Z

source/interact-data/query-async.txt

+executed synchronously on the caller's thread. The following list
+describes possible scenarios that this might occur depending on when the
+query results are being accessed:


S:

Suggested change

executed synchronously on the caller's thread. The following list

describes possible scenarios that this might occur depending on when the

query results are being accessed:

executed synchronously on the caller's thread. The following list

describes possible scenarios that this might occur:

mayaraman19 · 2024-12-24T00:21:05Z

source/interact-data/query-async.txt

+You can then access the results of the queries in your view as you
+normally do for synchronous queries.
+
+Even if a query is scheduled for asynchronous execution, it might be


S: active voice

Suggested change

Even if a query is scheduled for asynchronous execution, it might be

Even if you schedule a query for asynchronous execution, it might be

mayaraman19 · 2024-12-24T00:24:08Z

source/interact-data/query-async.txt

+on the current thread, blocking as required. Therefore, calling
+``load_async`` on a ``Criteria`` instance in this situation is similar
+to calling the ``to_a`` method to force query execution.


Q: I'm not familiar with this method - how is this similar?

to_a performs a conversion to an array of documents, i believe that this forces query execution because it requires the query to return documents to convert those documents to an array

Correct, if you don't call to_a you're not actually sending the command to the server and just returning an instance of Mongoid::Criteria instead

mayaraman19 · 2024-12-24T00:27:11Z

source/interact-data/query-cache.txt

+     Mongo::QueryCache.enabled = false
+   end
+
+Cache the Result of the first Method


Suggested change

Cache the Result of the first Method

Cache the Result of the ``first`` Method

Avoiding using monospace in titles per style guide

mayaraman19 · 2024-12-24T00:27:52Z

source/interact-data/query-cache.txt

+cached results from ``all``. However, because of the sort that {+odm+}
+applies to the second call, both methods query the database and


Suggested change

cached results from ``all``. However, because of the sort that {+odm+}

applies to the second call, both methods query the database and

cached results from ``all``. However, because {+odm+} applies

a sort to the second call, both methods query the database and

mayaraman19 · 2024-12-24T00:29:06Z

source/interact-data/query-cache.txt

+To use the cached results when calling the ``first`` method, call
+``all.to_a.first`` on the model class, as shown in the following example
+code:
+
+.. code-block::
+
+   Band.all.to_a.first


S: might just be my unfamiliarity with to_a, but can you briefly explain what this code does?

to_a stores the documents in an array, so when first applies the sort, its just on the array in memory instead of executing a new query. I can add this info to the page.

gmiller-mdb

Great work, requesting changes just because I left a few suggestions!

gmiller-mdb · 2025-01-08T19:21:30Z

source/interact-data/query-async.txt

+1. If the scheduled asynchronous task has been executed, the
+   results are returned.
+
+#. If the task has been started, but hasn't completed, the caller's
+   thread blocks until the task is finished.
+
+#. If the task has not been started yet, it is removed from the
+   execution queue, and the query is executed synchronously on the
+   caller's thread.


S: Can you convert some of these from passive to active voice?

gmiller-mdb · 2025-01-08T19:25:34Z

source/interact-data/query-persistence.txt

+  - Example: ``Band.where(name: 'Daft Punk').create``
+
+- ``create!``: Saves a model instance to MongoDB or raises an exception
+  if a validation error occurs.


s: remove this period as it is a sentence fragment. applies to all items in this list.

Suggested change

if a validation error occurs.

if a validation error occurs

removed periods from all lists except delete section as one entry has two sentences.

gmiller-mdb · 2025-01-08T19:26:13Z

source/interact-data/query-persistence.txt

+You can use the following methods to update documents based on your
+query criteria:
+
+- ``update``: Updates attributes of the first matching document.


s: same suggestion as above.

Suggested change

- ``update``: Updates attributes of the first matching document.

- ``update``: Updates attributes of the first matching document

gmiller-mdb · 2025-01-08T19:30:35Z

source/interact-data/query-cache.txt

+query cache for Rack web requests and Active Job job runs. See the
+:ref:`Query Cache Rack Middleware <query-cache-middleware>` section of
+the Configuration guide for instructions.


s: Link text should begin with an explanation of the purpose of the link: https://www.mongodb.com/docs/meta/style-guide/style/links-and-cross-references/#make-link-text-clear

Suggested change

query cache for Rack web requests and Active Job job runs. See the

:ref:`Query Cache Rack Middleware <query-cache-middleware>` section of

the Configuration guide for instructions.

query cache for Rack web requests and Active Job job runs. For instructions

on automatically enabling the query cache, see the :ref:`Query Cache Rack Middleware <query-cache middleware>` section of the configuration guide.

gmiller-mdb · 2025-01-08T19:31:44Z

source/interact-data/query-persistence.txt

+
+- ``update``: Updates attributes of the first matching document.
+
+  - Example: ``Band.where(name: 'Sundown').update(label: 'ABC Records')``


q: up to you, but was wondering why this is a long list instead of a table, given that each method has an example.

We prev got feedback that people think the code in tables is too small to read

gmiller-mdb

LGTM!

* DOCSP-42732: qs * fix * wip * remove action * NR suggestion * DOCSP-42732: qs download * wip * adapt for sinatra * vale fix * snooty landing page * MW PR fixes 1 * DOCSP-42733: atlas prep qs * MW PR fixes 1 * DOCSP-42735: configure cxn * small fix - vale * JS PR fixes 1 * DOCSP-44008: read/write sinatra quickstart * fixes * NR PR fixes 1 * DOCSP-43961: rails qs * vale * ordering * small fix * MW PR fixes 1 * small fixes * MW PR fixes 2 * DOCSP-44647: add to existing app * fix vale action * vale fixes * depth * MW PR fixes 1 * fixes * DOCSP-42745: interact with data drawer * tags * fix vale action * remove extra word Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> * DOCSP-42753: specify query part 1 * vale * title * code edits * MW PR fixes 2 * DOCSP-44849: modify results * vale * JS PR fixes 1 * fix * fix * list fixes * MW PR fixes 1 * DOCSP-44954: scoping * add landing page * link * vale * highlighting * DOCSP-44821: specify a query pt 2 * MR PR fixes 1 * wip * wip * wip * small fixes * DOCSP-42767 Aggregation (#57) * DOCSP-42774: transactions * vale * link text * MW PR fixes 1 * MR PR fixes 1 * DOCSP-45306: model data drawer * DOCSP-45330: inheritance (WIP) * MR PR fixes 2 * try using roles * wip * vale * add label * fixes * fix * small fixes - MW * DOCSP-45358: documents * fix * wip * wip * DR tech review 1 * page fmt * page fmt * SA PR fixes 1 * MR PR fixes 1 * DR small fix Co-authored-by: Dmitry Rybakov <160598371+comandeo-mongo@users.noreply.github.com> * DOCSP-45360: nested attributes (#71) * DOCSP-45360: nested attributes * vale + fixes * fixes * NR PR fixes 1 * DOCSP-45362: text search (#72) * DOCSP-45362: text search * wip * vale * MM PR fixes 1 * DOCSP-45436 Field Behaviors page (#68) * DOCSP-45363: validation (#73) * DOCSP-45363: validation * keywords * wip * SA PR fixes 1 * DOCSP-44794 Field Types (#69) * DOCSP-45357 Sharding Configuration (#76) * DOCSP-42762: Indexes (#74) * DOCSP-45367 Associations pt. 1 (#79) * DOCSP-45368: Persistence Configuration (#77) * DOCSP-45361: callbacks (#75) * DOCSP-45361: callbacks * wip * wip * wip * NR PR fixes 1 * DOCSP-45364: CRUD pt 1 (#81) * checkpoint * checkpoint 2 * woohoo first pass * indent * Edits * updates * vale chekcs * RR PR fixes 1 * fix code file * code fixes * RM PR fixes 1 --------- Co-authored-by: rustagir <rea.rustagi@mongodb.com> * DOCSP-45110: queries subsections (#80) * DOCSP-45110: queries misc sections * wip: * vale * MR PR fixes 1 * GM PR fixes 1 * DOCSP-46072 Associations part 2 (#82) * DOCSP-46394: CRUD remaining sections (#83) * DOCSP-46394: CRUD remaining sections * vale fixes * JS PR fixes 1 * DOCSP-46213: bump to rails 8 and remove old tuts (#84) * DOCSP-45356: i&h + code doc (#86) * DOCSP-45356: i&h + code doc * remove contributing * vale fixes * link fix * vale fixes + RM comment * DOCSP-42770: release notes/whats new (#87) * DOCSP-42770: release notes/whats new * fixes * fixes * DOCSP-42773: api links (#88) * DOCSP-42773: api links * fix * link fixes * DOCSP-42772: compatibility (#90) * DOCSP-42772: compatibility * small fix * small fix * SA PR fixes 1 * delete files for old build system * column width adjustment * DOCSP-45366 Encryption (#89) * DOCSP-42741: config pages (#91) * DOCSP-42741: config * wip * wip * some vale fixes * RM PR fixes 1 * small fix * DOCSP-46555: rails integration (#92) * wip * DOCSP-46555: rails integration * RM PR fixes 1 * DOCSP-45359 External Resources (#94) * add additional resources page * edits * feedback * DOCSP-42743 Collection config (#95) * DOCSP-42730: landing page (#96) * DOCSP-42730: landing page * MW PR fixes 1 * small fix * small fix * small fix * DOCSP-46121: cleanup (#97) * cleanup * copy compat action * redirects * MW PR fixes 1 * add index section * change vs in redirects --------- Co-authored-by: Nora Reidy <nora.reidy@mongodb.com> Co-authored-by: Jordan Smith <45415425+jordan-smith721@users.noreply.github.com> Co-authored-by: Dmitry Rybakov <160598371+comandeo-mongo@users.noreply.github.com> Co-authored-by: Maya Raman <maya.raman19@gmail.com>

rustagir added 2 commits December 20, 2024 11:36

DOCSP-45110: queries misc sections

dc8884c

wip:

795524b

vale

f0de4e8

rustagir marked this pull request as ready for review December 20, 2024 18:10

mayaraman19 requested changes Dec 24, 2024

View reviewed changes

MR PR fixes 1

86c5d29

gmiller-mdb requested changes Jan 8, 2025

View reviewed changes

GM PR fixes 1

1c68896

rustagir requested a review from gmiller-mdb January 9, 2025 18:41

gmiller-mdb approved these changes Jan 9, 2025

View reviewed changes

rustagir merged commit 39e5eee into mongodb:standardized Jan 10, 2025
4 of 5 checks passed

	Even if a query is scheduled for asynchronous execution, it might be
	Even if you schedule a query for asynchronous execution, it might be

	Cache the Result of the first Method
	Cache the Result of the ``first`` Method

		cached results from ``all``. However, because of the sort that {+odm+}
		applies to the second call, both methods query the database and

	- ``update``: Updates attributes of the first matching document.
	- ``update``: Updates attributes of the first matching document


		- ``update``: Updates attributes of the first matching document.

		- Example: ``Band.where(name: 'Sundown').update(label: 'ABC Records')``

DOCSP-45110: queries subsections #80

DOCSP-45110: queries subsections #80

Uh oh!

Conversation

rustagir commented Dec 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Info

Self-Review Checklist

Uh oh!

netlify bot commented Dec 20, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-mongoid ready!

Uh oh!

mayaraman19 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gmiller-mdb left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

gmiller-mdb left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

rustagir commented Dec 20, 2024 •

edited

Loading

netlify bot commented Dec 20, 2024 •

edited

Loading