DOCS-133 document applyOps

[epc]

flesh out documentation for applyOps

[epc]

Updated with suggested revisions.
One problem: the ..writelock and ..see-also statements kept getting included in the code block until I unindented them.

[tychoish]

yeah, the writelock/see lines are both comments that shouldn't be visable at all. so that's fine.

[tychoish]

sorry, I didn't catch this earlier, but I think we can just say "It applies entries from an oplog," I'm not sure "a command object entry," makes sense.

If we want to be really extravagant, we could also say, "It applies oplog entries passed to the command in the <operations> array, to a database, or collection if you specify the ns option."

Correspondingly, we should probably change the "array of operations to perform," to "array of operations to apply."

[epc]

That was my initial understanding, but on re-reading the code there's
actually no mention of an oplog at all. It takes oplog entries but applies
them against a collection, used to replay the oplog on shards or replica
sets.

ApplyOps itself is a wrapper around applyOperation_inlock.

On Tue, Jul 24, 2012 at 11:03 PM, Sam Kleinman <
[email protected]

wrote:

:dbcommand:`applyOps` is an internal command that supports sharding

• functionality.
• functionality. It applies a command object entry from an
  :term:oplog against a :term:collection.

sorry, I didn't catch this earlier, but I think we can just say "It
applies entries from an oplog," I'm not sure "a command object entry,"
makes sense.

If we want to be really extravagant, we could also say, "It applies oplog
entries passed to the command in the <operations> array, to a
database, or collection if you specify the ns option."

Correspondingly, we should probably change the "array of operations to
perform," to "array of operations to apply."

---

Reply to this email directly or view it on GitHub:
https://github.com/mongodb/docs/pull/86/files#r1232017

-ed costello
@epc https://twitter.com/epc / +19179752073

[tychoish]

I think this is consistent with the change that I suggested, but I could be wrong.

[epc]

Added suggested changes.