Details
-
Bug
-
Resolution: Fixed
-
Critical
-
None
-
4.0
-
None
Description
There are many issues on this page:
http://developer.couchbase.com/documentation/server/4.0/backup-restore/cbbackup-wrapper.html
First of all there is no syntax provided for cbrestorewrapper which actually differs from the cbbackupwrapper syntax and actually caused me a lot of confusion when trying to use cbrestorewrapper myself.
The syntax should be:
cbrestorewrapper BACKUPDIR CLUSTER OPTIONS
|
Secondly, there is no options table provided for cbrestorewrapper which again differs from cbbackupwrapper. As an example, there is a parameter called '-B' which allows the user to specify the destination bucket for a restore (assuming that the bucket in the backup is named differently), this is not documented anywhere on this page and I had to look at the source code for the CLI tool in order to find this out.
If this were a customer that had to find out how one of our tools worked by reading the source code then it would be totally unacceptable.
As an extension to this, all of the options in the table relate specifically to cbbackupwrapper, e.g:
'Specify the path to cbbackup. Defaults to current directory' which for cbrestorewrapper should be 'Specify the path to cbrestore. Defaults to current directory', again this might be confusing to customers.
Additionally, the extra option 'rehash=0' does not work at all with cbrestorewrapper, in all fairness I believe that this is a bug with the actual tool and should in fact function as explained, I shall raise a defect for this, but in the mean time the documentation does not accurately reflect what inputs the tool takes.