Skip to content

DOCS-3443 - clarification re: user for db.copyDatabase() with --auth #1986

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.

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

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 4 additions & 0 deletions source/includes/fact-copydb-behavior.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,10 @@ Be aware of the following properties of |copydb|:
- |copydb| runs on the destination :program:`mongod`
instance, i.e. the host receiving the copied data.

- If the destination :program:`mongod` has authorization enforcement enabled,
|copydb| *must* be executed with the credentials of a user present in the *source*
Copy link
Contributor

Choose a reason for hiding this comment

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

shouldn't "be executed with" -> "specifying"

Copy link
Contributor Author

Choose a reason for hiding this comment

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

? "db.copyDatabase() must specifying the credentials of a user present in the source"?

Maybe s/with/using/ or s/with/specifying/? Or is that what you meant to begin with?

Copy link
Contributor

Choose a reason for hiding this comment

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

sorry, grammatical integration issue.

"you must specify the credentials to |copydb| of a user present in the source database."

"executed with" makes me think of the state at the call site rather than the arguments. to the function.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Perhaps s/executed/called/ then? Otherwise your sentence seems fine with the prepositional phrases swapped - "you must specify the credentials of a user present in the source database [when calling] |copydb|." which keeps the 'of a user' more closely modifying 'credentials.' I know you love your second person replacements of passive clauses. =)

database who has the privileges outlined in :ref:`copyDatabases-requiredAccess`.

- |copydb| creates the target database if it does not exist.

- |copydb| requires enough free disk space on the host
Expand Down
2 changes: 2 additions & 0 deletions source/reference/method/db.copyDatabase.txt
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ Behavior

.. include:: /includes/fact-copydb-behavior.rst

.. _copyDatabases-requiredAccess:

Required Access
---------------

Expand Down