Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
oclc committed May 8, 2012
1 parent 8006667 commit 2413421
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,19 @@ The code was tested with the following components.
* HBase 0.92.1
* Hadoop 0.20.2-cdh3u3

## Overview ##

This backup utility is based around [HBASE-4618](https://issues.apache.org/jira/browse/HBASE-4618). We took the features we liked from the documents and implemented some generic tools that would work for us. This package comes equipped with three utilities: a backup tool to get snapshots of HFiles, an import/restore tool, and a tool to frequently copy HLogs. There is a fourth tool we use, but did not develop it ourselves so we have not included it in the our package. It's WALPlayer, and it is described in [HBASE-5604](https://issues.apache.org/jira/browse/HBASE-5604). WALPlayer is in the 0.94.0RC version of HBase so we back ported the code to work with HBase 0.92.1, the current version we are using.

* Backup copies snapshots of HFiles while being tolerant of several errors that may occur when copying files from HBase. It attempts to account for region splits and performs some basic verifications at the end of the backup.
* Import is used to restore the HFiles into a running HBase cluster.
* LogCopier is basic program that watches the Write-Ahead-Log directories and archives HBase log files. These logs can then be replayed with a tool like WALPlayer (See the comment above)

It is important to point out that these tools, like any other backup options in HBase at the moment, are relatively new. We are continually testing them and looking for any issues. We encourage people looking for backup solutions to try it out and send any feedback. To get more details about these tools, please take a look at the wiki page.

## Building ##

`mvn assembly:assembly`
`$ mvn assembly:assembly`

## Usage ##

Expand All @@ -37,16 +47,6 @@ Notice that backup directory name contains the start and end date of the backup.

To get a list of the arguments these tools support, run them with the -h argument

## Overview ##

This backup utility is based around [HBASE-4618](https://issues.apache.org/jira/browse/HBASE-4618). We took the features we liked from the documents and implemented some generic tools that would work for us. This package comes equipped with three utilities: a backup tool to get snapshots of HFiles, an import/restore tool, and a tool to frequently copy HLogs. There is a fourth tool we use, but did not develop it ourselves so we have not included it in the our package. It's WALPlayer, and it is described in [HBASE-5604](https://issues.apache.org/jira/browse/HBASE-5604). WALPlayer is in the 0.94.0RC version of HBase so we back ported the code to work with HBase 0.92.1, the current version we are using.

* Backup copies snapshots of HFiles while being tolerant of several errors that may occur when copying files from HBase. It attempts to account for region splits and performs some basic verifications at the end of the backup.
* Import is used to restore the HFiles into a running HBase cluster.
* LogCopier is basic program that watches the Write-Ahead-Log directories and archives HBase log files. These logs can then be replayed with a tool like WALPlayer (See the comment above)

It is important to point out that these tools, like any other backup options in HBase at the moment, are relatively new. We are continually testing them and looking for any issues. We encourage people looking for backup solutions to try it out and send any feedback. To get more details about these tools, please take a look at the wiki page.

## Features ##
* Error tolerant. Failed regions are retried. Takes region splitting into account
* Backup individual tables or entire database
Expand Down

0 comments on commit 2413421

Please sign in to comment.