[DOCS-431] Typos, and some suggestions, in "Backup and Restoration Strategies" page of manual Created: 22/Aug/12  Updated: 30/Oct/23  Resolved: 19/Oct/12

Status: Closed
Project: Documentation
Component/s: manual
Affects Version/s: None
Fix Version/s: Server_Docs_20231030

Type: Improvement Priority: Minor - P4
Reporter: Ian Daniel Assignee: Sam Kleinman (Inactive)
Resolution: Done Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Participants:
Days since reply: 11 years, 17 weeks, 5 days ago

 Description   

I came up with the following changes from reading Backup and Restoration Strategies from the manual. Most of them are typos, with a couple of suggestions thrown in.

Block Level Methods

I think this section could use an introduction saying what needs to be backed up are the dbpath data files. This isn't actually stated anywhere, so when you read the content that follows, the question that constantly comes to mind is, "But what actually needs to be backed up?"

Database Dump with mongodump

1st paragraph:

  • "The mongodump utility performs a live backup the data" -> "The mongodump utility performs a live backup of the data" ("of" missing)
  • "or part of a collection using of query,)" -> "or part of a collection using a query)" (replace "of" with "a", remove comma before bracket)
  • "in a in the current directory" -> "in the current directory" (remove "in a")

Paragraph straight after first example command:

  • "This command creates a dump in of the database" -> "This command creates a dump of the database" (remove "in")

Two paragraphs later:

  • "the location to your MongoDB instance's database files" -> "the location of your MongoDB instance's database files" (replace "to" with "of")

Replica Sets (at bottom of page)

First paragraph:

  • "When you unlock the database, the slave will catch master or primary node." -> "When you unlock the database, the slave will catch up to the master or primary node." (presumably this was the intent)

Finally, this page does not mention that in 2.0.x mongodump/mongorestore does not restoring indexes (SERVER-1311), and that it is fixed in 2.2. Could that be added?



 Comments   
Comment by auto [ 19/Oct/12 ]

Author:

{u'date': u'2012-10-19T15:30:15-07:00', u'email': u'samk@10gen.com', u'name': u'Sam Kleinman'}

Message: edits: DOCS-431 correcting problems with mongodump/restore sections
Branch: master
https://github.com/mongodb/docs/commit/ca1b0cbcdbf507d6186a3ec490906ab7fa0d9060

Comment by Ian Daniel [ 01/Sep/12 ]

Hi Ed,

My last comment about SERVER-1311 and mongodump/mongorestore not restoring indexes: it is only true when restoring individual collections. I was confused by a CS ticket linked from SERVER-1311. Given that, and that it is fixed in 2.2, I'm now ambivalent about including mention of it in the manual.

Cheers,
Ian

Generated at Thu Feb 08 07:38:39 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.