Skip to content

Commit

Permalink
PR feedback: monospacing
Browse files Browse the repository at this point in the history
  • Loading branch information
ricellis committed Mar 12, 2024
1 parent 8252f5d commit 56a61b2
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ It comes with a companion command-line utility that can restore the backed up da

## Limitations

Couchbackup has some restrictions in the data it's able to backup:
CouchBackup has some restrictions in the data it's able to backup:

* **couchbackup does not do CouchDB replication as such, it simply streams through a database's `_changes` feed, and uses `POST /db/_bulk_get` to fetch the documents, storing the documents it finds on disk.**
* **couchbackup does not support backing up or restoring databases containing documents with attachments. The recommendation is to store attachments directly in an object store. DO NOT USE THIS TOOL FOR DATABASES CONTAINING ATTACHMENTS.** [Note](#note-on-attachments)
* **`couchbackup` does not do CouchDB replication as such, it simply streams through a database's `_changes` feed, and uses `POST /db/_bulk_get` to fetch the documents, storing the documents it finds on disk.**
* **`couchbackup` does not support backing up or restoring databases containing documents with attachments. The recommendation is to store attachments directly in an object store. DO NOT USE THIS TOOL FOR DATABASES CONTAINING ATTACHMENTS.** [Note](#note-on-attachments)

## Installation

Expand Down Expand Up @@ -120,7 +120,7 @@ couchbackup --db animaldb --log animaldb.log --resume true --output animaldb.txt

### Compatibility note

When using `--resume` use the same version of couchbackup that started the backup.
When using `--resume` use the same version of `couchbackup` that started the backup.

## Restore

Expand All @@ -138,9 +138,9 @@ cat animaldb.txt | couchrestore --db animaldb2

### Compatibility note

**Do not use an older version of couchbackup to restore a backup created with a newer version.**
**Do not use an older version of `couchbackup` to restore a backup created with a newer version.**

Newer versions of couchbackup can restore backups created by older versions within the same major version.
Newer versions of `couchbackup` can restore backups created by older versions within the same major version.

## Compressed backups

Expand Down Expand Up @@ -191,13 +191,13 @@ from the server or fewer if it is the last batch.

A log file has a line:

- for every batch of document ids that couchbackup needs to fetch, for example: `:t batch56 [{"id":"a"},{"id":"b"}]`
- for every batch that couchbackup has fetched and stored, for example: `:d batch56`
- for every batch of document ids that `couchbackup` needs to fetch, for example: `:t batch56 [{"id":"a"},{"id":"b"}]`
- for every batch that `couchbackup` has fetched and stored, for example: `:d batch56`
- to indicate that the changes feed was fully consumed, for example: `:changes_complete`

## What's shallow mode?

When you run `couchbackup` with `--mode shallow` couchbackup performs a simpler backup.
When you run `couchbackup` with `--mode shallow` `couchbackup` performs a simpler backup.
It only backs up the winning revisions and ignores any conflicting revisions.
This is a faster, but less complete backup.

Expand All @@ -218,7 +218,7 @@ This tool can script the backup of your databases. Move the backup and log files
* `COUCH_URL` - the URL of the CouchDB/Cloudant server, for example: `http://127.0.0.1:5984`
* `COUCH_DATABASE` - the name of the database to act upon, for example: `mydb` (default `test`)
* `COUCH_PARALLELISM` - the number of HTTP requests to perform in parallel when restoring a backup, for example: `10` (Default `5`)
* `COUCH_BUFFER_SIZE` - the number of documents fetched and restored at once, for example: `100` (default `500`). When using CouchBackup with [Cloudant on Transaction Engine](https://www.ibm.com/cloud/blog/announcements/ibm-cloudant-on-transaction-engine) `COUCH_BUFFER_SIZE` must be less than `2000` to avoid bad request errors.
* `COUCH_BUFFER_SIZE` - the number of documents fetched and restored at once, for example: `100` (default `500`).
* `COUCH_REQUEST_TIMEOUT` - the number of milliseconds to wait for a response to a HTTP request before retrying the request, for example: `10000` (Default `120000`)
* `COUCH_LOG` - the file to store logging information during backup
* `COUCH_RESUME` - if `true`, resumes an earlier backup from its last known position (requires a log file)
Expand Down Expand Up @@ -439,9 +439,9 @@ details them.

## Note on attachments

TLDR; If you backup a database that has attachments couchrestore cannot restore it.
TLDR; If you backup a database that has attachments `couchbackup` cannot restore it.

As documented above couchbackup does not support backing up or restoring databases containing documents with attachments.
As documented above `couchbackup` does not support backing up or restoring databases containing documents with attachments.
Backing up a database that includes documents with attachments appears to complete successfully. However, the attachment
content is not downloaded and the backup file contains attachment metadata. So attempts to
restore the backup result in errors because the attachment metadata references attachments that are not present
Expand Down

0 comments on commit 56a61b2

Please sign in to comment.