Return-Path: X-Original-To: archive-asf-public-internal@cust-asf2.ponee.io Delivered-To: archive-asf-public-internal@cust-asf2.ponee.io Received: from cust-asf.ponee.io (cust-asf.ponee.io [163.172.22.183]) by cust-asf2.ponee.io (Postfix) with ESMTP id 24CAD200BC5 for ; Tue, 8 Nov 2016 07:16:20 +0100 (CET) Received: by cust-asf.ponee.io (Postfix) id 23692160B1A; Tue, 8 Nov 2016 06:16:20 +0000 (UTC) Delivered-To: archive-asf-public@cust-asf.ponee.io Received: from mail.apache.org (hermes.apache.org [140.211.11.3]) by cust-asf.ponee.io (Postfix) with SMTP id 25FE0160B11 for ; Tue, 8 Nov 2016 07:16:17 +0100 (CET) Received: (qmail 16911 invoked by uid 500); 8 Nov 2016 06:16:16 -0000 Mailing-List: contact commits-help@hbase.apache.org; run by ezmlm Precedence: bulk List-Help: List-Unsubscribe: List-Post: List-Id: Reply-To: dev@hbase.apache.org Delivered-To: mailing list commits@hbase.apache.org Received: (qmail 16455 invoked by uid 99); 8 Nov 2016 06:16:15 -0000 Received: from git1-us-west.apache.org (HELO git1-us-west.apache.org) (140.211.11.23) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 08 Nov 2016 06:16:15 +0000 Received: by git1-us-west.apache.org (ASF Mail Server at git1-us-west.apache.org, from userid 33) id 9476EF12EF; Tue, 8 Nov 2016 06:16:15 +0000 (UTC) Content-Type: text/plain; charset="us-ascii" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit From: stack@apache.org To: commits@hbase.apache.org Date: Tue, 08 Nov 2016 06:16:18 -0000 Message-Id: In-Reply-To: <829e84479a1a499884c9f9ad8aa96c59@git.apache.org> References: <829e84479a1a499884c9f9ad8aa96c59@git.apache.org> X-Mailer: ASF-Git Admin Mailer Subject: [04/51] [partial] hbase-site git commit: Empty commit archived-at: Tue, 08 Nov 2016 06:16:20 -0000 http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/backup/HFileArchiver.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/backup/HFileArchiver.html b/1.1/apidocs/org/apache/hadoop/hbase/backup/HFileArchiver.html new file mode 100644 index 0000000..029f97c --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/backup/HFileArchiver.html @@ -0,0 +1,360 @@ + + + + + + +HFileArchiver (Apache HBase 1.1.8-SNAPSHOT API) + + + + + + + + + + + +
+
org.apache.hadoop.hbase.backup
+

Class HFileArchiver

+
+
+ +
+
    +
  • +
    +
    +
    public class HFileArchiver
    +extends Object
    +
    Utility class to handle the removal of HFiles (or the respective StoreFiles) + for a HRegion from the FileSystem. The hfiles will be archived or deleted, depending on + the state of the system.
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Summary

      + + + + + + + + + + + + + + + + + + + + + + + + + + +
      Methods 
      Modifier and TypeMethod and Description
      static voidarchiveFamily(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.conf.Configuration conf, + HRegionInfo parent, + org.apache.hadoop.fs.Path tableDir, + byte[] family) +
      Remove from the specified region the store files of the specified column family, + either by archiving them or outright deletion
      +
      static voidarchiveRegion(org.apache.hadoop.conf.Configuration conf, + org.apache.hadoop.fs.FileSystem fs, + HRegionInfo info) +
      Cleans up all the files for a HRegion by archiving the HFiles to the + archive directory
      +
      static booleanarchiveRegion(org.apache.hadoop.fs.FileSystem fs, + org.apache.hadoop.fs.Path rootdir, + org.apache.hadoop.fs.Path tableDir, + org.apache.hadoop.fs.Path regionDir) +
      Remove an entire region from the table directory via archiving the region's hfiles.
      +
      static voidarchiveStoreFile(org.apache.hadoop.conf.Configuration conf, + org.apache.hadoop.fs.FileSystem fs, + HRegionInfo regionInfo, + org.apache.hadoop.fs.Path tableDir, + byte[] family, + org.apache.hadoop.fs.Path storeFile) +
      Archive the store file
      +
      static voidarchiveStoreFiles(org.apache.hadoop.conf.Configuration conf, + org.apache.hadoop.fs.FileSystem fs, + HRegionInfo regionInfo, + org.apache.hadoop.fs.Path tableDir, + byte[] family, + Collection<StoreFile> compactedFiles) +
      Remove the store files, either by archiving them or outright deletion
      +
      + +
    • +
    +
  • +
+
+
+
    +
  • + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        archiveRegion

        +
        public static void archiveRegion(org.apache.hadoop.conf.Configuration conf,
        +                 org.apache.hadoop.fs.FileSystem fs,
        +                 HRegionInfo info)
        +                          throws IOException
        +
        Cleans up all the files for a HRegion by archiving the HFiles to the + archive directory
        +
        Parameters:
        conf - the configuration to use
        fs - the file system object
        info - HRegionInfo for region to be deleted
        +
        Throws:
        +
        IOException
        +
      • +
      + + + +
        +
      • +

        archiveRegion

        +
        public static boolean archiveRegion(org.apache.hadoop.fs.FileSystem fs,
        +                    org.apache.hadoop.fs.Path rootdir,
        +                    org.apache.hadoop.fs.Path tableDir,
        +                    org.apache.hadoop.fs.Path regionDir)
        +                             throws IOException
        +
        Remove an entire region from the table directory via archiving the region's hfiles.
        +
        Parameters:
        fs - FileSystem from which to remove the region
        rootdir - Path to the root directory where hbase files are stored (for building + the archive path)
        tableDir - Path to where the table is being stored (for building the archive path)
        regionDir - Path to where a region is being stored (for building the archive path)
        +
        Returns:
        true if the region was sucessfully deleted. false if the filesystem + operations could not complete.
        +
        Throws:
        +
        IOException - if the request cannot be completed
        +
      • +
      + + + +
        +
      • +

        archiveFamily

        +
        public static void archiveFamily(org.apache.hadoop.fs.FileSystem fs,
        +                 org.apache.hadoop.conf.Configuration conf,
        +                 HRegionInfo parent,
        +                 org.apache.hadoop.fs.Path tableDir,
        +                 byte[] family)
        +                          throws IOException
        +
        Remove from the specified region the store files of the specified column family, + either by archiving them or outright deletion
        +
        Parameters:
        fs - the filesystem where the store files live
        conf - Configuration to examine to determine the archive directory
        parent - Parent region hosting the store files
        tableDir - Path to where the table is being stored (for building the archive path)
        family - the family hosting the store files
        +
        Throws:
        +
        IOException - if the files could not be correctly disposed.
        +
      • +
      + + + +
        +
      • +

        archiveStoreFiles

        +
        public static void archiveStoreFiles(org.apache.hadoop.conf.Configuration conf,
        +                     org.apache.hadoop.fs.FileSystem fs,
        +                     HRegionInfo regionInfo,
        +                     org.apache.hadoop.fs.Path tableDir,
        +                     byte[] family,
        +                     Collection<StoreFile> compactedFiles)
        +                              throws IOException
        +
        Remove the store files, either by archiving them or outright deletion
        +
        Parameters:
        conf - Configuration to examine to determine the archive directory
        fs - the filesystem where the store files live
        regionInfo - HRegionInfo of the region hosting the store files
        family - the family hosting the store files
        compactedFiles - files to be disposed of. No further reading of these files should be + attempted; otherwise likely to cause an IOException
        +
        Throws:
        +
        IOException - if the files could not be correctly disposed.
        +
      • +
      + + + +
        +
      • +

        archiveStoreFile

        +
        public static void archiveStoreFile(org.apache.hadoop.conf.Configuration conf,
        +                    org.apache.hadoop.fs.FileSystem fs,
        +                    HRegionInfo regionInfo,
        +                    org.apache.hadoop.fs.Path tableDir,
        +                    byte[] family,
        +                    org.apache.hadoop.fs.Path storeFile)
        +                             throws IOException
        +
        Archive the store file
        +
        Parameters:
        fs - the filesystem where the store files live
        regionInfo - region hosting the store files
        conf - Configuration to examine to determine the archive directory
        tableDir - Path to where the table is being stored (for building the archive path)
        family - the family hosting the store files
        storeFile - file to be archived
        +
        Throws:
        +
        IOException - if the files could not be correctly disposed.
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + +

Copyright © 2007-2016 The Apache Software Foundation. All Rights Reserved.

+ + http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/backup/class-use/HFileArchiver.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/backup/class-use/HFileArchiver.html b/1.1/apidocs/org/apache/hadoop/hbase/backup/class-use/HFileArchiver.html new file mode 100644 index 0000000..a0b29f6 --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/backup/class-use/HFileArchiver.html @@ -0,0 +1,117 @@ + + + + + + +Uses of Class org.apache.hadoop.hbase.backup.HFileArchiver (Apache HBase 1.1.8-SNAPSHOT API) + + + + + + + + + + +
+

Uses of Class
org.apache.hadoop.hbase.backup.HFileArchiver

+
+
No usage of org.apache.hadoop.hbase.backup.HFileArchiver
+ + + + +

Copyright © 2007-2016 The Apache Software Foundation. All Rights Reserved.

+ + http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html b/1.1/apidocs/org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html new file mode 100644 index 0000000..558a01c --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/backup/example/HFileArchiveTableMonitor.html @@ -0,0 +1,331 @@ + + + + + + +HFileArchiveTableMonitor (Apache HBase 1.1.8-SNAPSHOT API) + + + + + + + + + + + +
+
org.apache.hadoop.hbase.backup.example
+

Class HFileArchiveTableMonitor

+
+
+
    +
  • java.lang.Object
  • +
  • +
      +
    • org.apache.hadoop.hbase.backup.example.HFileArchiveTableMonitor
    • +
    +
  • +
+
+
    +
  • +
    +
    +
    public class HFileArchiveTableMonitor
    +extends Object
    +
    Monitor the actual tables for which HFiles are archived for long-term retention (always kept + unless ZK state changes). +

    + It is internally synchronized to ensure consistent view of the table state.

    +
  • +
+
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        HFileArchiveTableMonitor

        +
        public HFileArchiveTableMonitor()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        setArchiveTables

        +
        public void setArchiveTables(List<String> tables)
        +
        Set the tables to be archived. Internally adds each table and attempts to + register it. +

        + Note: All previous tables will be removed in favor of these tables.

        +
        Parameters:
        tables - add each of the tables to be archived.
        +
      • +
      + + + +
        +
      • +

        addTable

        +
        public void addTable(String table)
        +
        Add the named table to be those being archived. Attempts to register the + table
        +
        Parameters:
        table - name of the table to be registered
        +
      • +
      + + + +
        +
      • +

        removeTable

        +
        public void removeTable(String table)
        +
      • +
      + + + +
        +
      • +

        clearArchive

        +
        public void clearArchive()
        +
      • +
      + + + +
        +
      • +

        shouldArchiveTable

        +
        public boolean shouldArchiveTable(String tableName)
        +
        Determine if the given table should or should not allow its hfiles to be deleted in the archive
        +
        Parameters:
        tableName - name of the table to check
        +
        Returns:
        true if its store files should be retained, false otherwise
        +
      • +
      +
    • +
    +
  • +
+
+
+ + + + + +

Copyright © 2007-2016 The Apache Software Foundation. All Rights Reserved.

+ + http://git-wip-us.apache.org/repos/asf/hbase-site/blob/6960a0bd/1.1/apidocs/org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html ---------------------------------------------------------------------- diff --git a/1.1/apidocs/org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html b/1.1/apidocs/org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html new file mode 100644 index 0000000..2123886 --- /dev/null +++ b/1.1/apidocs/org/apache/hadoop/hbase/backup/example/LongTermArchivingHFileCleaner.html @@ -0,0 +1,364 @@ + + + + + + +LongTermArchivingHFileCleaner (Apache HBase 1.1.8-SNAPSHOT API) + + + + + + + + + + + +
+
org.apache.hadoop.hbase.backup.example
+

Class LongTermArchivingHFileCleaner

+
+
+ +
+ +
+
+ +
+
+
    +
  • + +
      +
    • + + +

      Constructor Detail

      + + + +
        +
      • +

        LongTermArchivingHFileCleaner

        +
        public LongTermArchivingHFileCleaner()
        +
      • +
      +
    • +
    + +
      +
    • + + +

      Method Detail

      + + + +
        +
      • +

        isFileDeletable

        +
        public boolean isFileDeletable(org.apache.hadoop.fs.FileStatus fStat)
        +
        Description copied from class: BaseFileCleanerDelegate
        +
        Should the master delete the file or keep it?
        +
        +
        Specified by:
        +
        isFileDeletable in class BaseFileCleanerDelegate
        +
        Parameters:
        fStat - file status of the file to check
        +
        Returns:
        true if the file is deletable, false if not
        +
      • +
      + + + +
        +
      • +

        setConf

        +
        public void setConf(org.apache.hadoop.conf.Configuration config)
        +
        +
        Specified by:
        +
        setConf in interface org.apache.hadoop.conf.Configurable
        +
        Overrides:
        +
        setConf in class BaseConfigurable
        +
        +
      • +
      + + + + +
    • +
    +
  • +
+
+
+ + + + + +

Copyright © 2007-2016 The Apache Software Foundation. All Rights Reserved.

+ +