View Javadoc

1   /**
2    *
3    * Licensed to the Apache Software Foundation (ASF) under one
4    * or more contributor license agreements.  See the NOTICE file
5    * distributed with this work for additional information
6    * regarding copyright ownership.  The ASF licenses this file
7    * to you under the Apache License, Version 2.0 (the
8    * "License"); you may not use this file except in compliance
9    * with the License.  You may obtain a copy of the License at
10   *
11   *     http://www.apache.org/licenses/LICENSE-2.0
12   *
13   * Unless required by applicable law or agreed to in writing, software
14   * distributed under the License is distributed on an "AS IS" BASIS,
15   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16   * See the License for the specific language governing permissions and
17   * limitations under the License.
18   */
19  package org.apache.hadoop.hbase;
20  
21  /**
22   * Ways to keep cells marked for delete around.
23   */
24  /*
25   * Don't change the TRUE/FALSE labels below, these have to be called
26   * this way for backwards compatibility.
27   */
28  public enum KeepDeletedCells {
29    /** Deleted Cells are not retained. */
30    FALSE,
31    /**
32     * Deleted Cells are retained until they are removed by other means
33     * such TTL or VERSIONS.
34     * If no TTL is specified or no new versions of delete cells are
35     * written, they are retained forever.
36     */
37    TRUE,
38    /**
39     * Deleted Cells are retained until the delete marker expires due to TTL.
40     * This is useful when TTL is combined with MIN_VERSIONS and one
41     * wants to keep a minimum number of versions around but at the same
42     * time remove deleted cells after the TTL.
43     */
44    TTL;
45  }