001/**
002 * Licensed to the Apache Software Foundation (ASF) under one
003 * or more contributor license agreements.  See the NOTICE file
004 * distributed with this work for additional information
005 * regarding copyright ownership.  The ASF licenses this file
006 * to you under the Apache License, Version 2.0 (the
007 * "License"); you may not use this file except in compliance
008 * with the License.  You may obtain a copy of the License at
009 *
010 *     http://www.apache.org/licenses/LICENSE-2.0
011 *
012 * Unless required by applicable law or agreed to in writing, software
013 * distributed under the License is distributed on an "AS IS" BASIS,
014 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
015 * See the License for the specific language governing permissions and
016 * limitations under the License.
017 */
018package org.apache.hadoop.hbase.client;
019
020import java.io.IOException;
021import java.util.Collections;
022import java.util.HashMap;
023import java.util.HashSet;
024import java.util.Map;
025import java.util.Set;
026import java.util.function.Function;
027import org.apache.hadoop.hbase.HConstants;
028import org.apache.hadoop.hbase.KeepDeletedCells;
029import org.apache.hadoop.hbase.MemoryCompactionPolicy;
030import org.apache.hadoop.hbase.exceptions.DeserializationException;
031import org.apache.hadoop.hbase.exceptions.HBaseException;
032import org.apache.hadoop.hbase.io.compress.Compression;
033import org.apache.hadoop.hbase.io.encoding.DataBlockEncoding;
034import org.apache.hadoop.hbase.regionserver.BloomType;
035import org.apache.hadoop.hbase.util.Bytes;
036import org.apache.hadoop.hbase.util.PrettyPrinter;
037import org.apache.hadoop.hbase.util.PrettyPrinter.Unit;
038import org.apache.yetus.audience.InterfaceAudience;
039
040import org.apache.hbase.thirdparty.com.google.common.base.Preconditions;
041
042import org.apache.hadoop.hbase.shaded.protobuf.ProtobufUtil;
043import org.apache.hadoop.hbase.shaded.protobuf.generated.HBaseProtos.ColumnFamilySchema;
044
045/**
046 * @since 2.0.0
047 */
048@InterfaceAudience.Public
049public class ColumnFamilyDescriptorBuilder {
050  // For future backward compatibility
051
052  // Version  3 was when column names become byte arrays and when we picked up
053  // Time-to-live feature.  Version 4 was when we moved to byte arrays, HBASE-82.
054  // Version  5 was when bloom filter descriptors were removed.
055  // Version  6 adds metadata as a map where keys and values are byte[].
056  // Version  7 -- add new compression and hfile blocksize to HColumnDescriptor (HBASE-1217)
057  // Version  8 -- reintroduction of bloom filters, changed from boolean to enum
058  // Version  9 -- add data block encoding
059  // Version 10 -- change metadata to standard type.
060  // Version 11 -- add column family level configuration.
061  private static final byte COLUMN_DESCRIPTOR_VERSION = (byte) 11;
062
063  @InterfaceAudience.Private
064  public static final String IN_MEMORY_COMPACTION = "IN_MEMORY_COMPACTION";
065  private static final Bytes IN_MEMORY_COMPACTION_BYTES = new Bytes(Bytes.toBytes(IN_MEMORY_COMPACTION));
066
067  @InterfaceAudience.Private
068  public static final String IN_MEMORY = HConstants.IN_MEMORY;
069  private static final Bytes IN_MEMORY_BYTES = new Bytes(Bytes.toBytes(IN_MEMORY));
070
071  // These constants are used as FileInfo keys
072  @InterfaceAudience.Private
073  public static final String COMPRESSION = "COMPRESSION";
074  private static final Bytes COMPRESSION_BYTES = new Bytes(Bytes.toBytes(COMPRESSION));
075  @InterfaceAudience.Private
076  public static final String COMPRESSION_COMPACT = "COMPRESSION_COMPACT";
077  private static final Bytes COMPRESSION_COMPACT_BYTES = new Bytes(Bytes.toBytes(COMPRESSION_COMPACT));
078  @InterfaceAudience.Private
079  public static final String DATA_BLOCK_ENCODING = "DATA_BLOCK_ENCODING";
080  private static final Bytes DATA_BLOCK_ENCODING_BYTES = new Bytes(Bytes.toBytes(DATA_BLOCK_ENCODING));
081  /**
082   * Key for the BLOCKCACHE attribute. A more exact name would be
083   * CACHE_DATA_ON_READ because this flag sets whether or not we cache DATA
084   * blocks. We always cache INDEX and BLOOM blocks; caching these blocks cannot
085   * be disabled.
086   */
087  @InterfaceAudience.Private
088  public static final String BLOCKCACHE = "BLOCKCACHE";
089  private static final Bytes BLOCKCACHE_BYTES = new Bytes(Bytes.toBytes(BLOCKCACHE));
090  @InterfaceAudience.Private
091  public static final String CACHE_DATA_ON_WRITE = "CACHE_DATA_ON_WRITE";
092  private static final Bytes CACHE_DATA_ON_WRITE_BYTES = new Bytes(Bytes.toBytes(CACHE_DATA_ON_WRITE));
093  @InterfaceAudience.Private
094  public static final String CACHE_INDEX_ON_WRITE = "CACHE_INDEX_ON_WRITE";
095  private static final Bytes CACHE_INDEX_ON_WRITE_BYTES = new Bytes(Bytes.toBytes(CACHE_INDEX_ON_WRITE));
096  @InterfaceAudience.Private
097  public static final String CACHE_BLOOMS_ON_WRITE = "CACHE_BLOOMS_ON_WRITE";
098  private static final Bytes CACHE_BLOOMS_ON_WRITE_BYTES = new Bytes(Bytes.toBytes(CACHE_BLOOMS_ON_WRITE));
099  @InterfaceAudience.Private
100  public static final String EVICT_BLOCKS_ON_CLOSE = "EVICT_BLOCKS_ON_CLOSE";
101  private static final Bytes EVICT_BLOCKS_ON_CLOSE_BYTES = new Bytes(Bytes.toBytes(EVICT_BLOCKS_ON_CLOSE));
102
103  /**
104   * Key for the PREFETCH_BLOCKS_ON_OPEN attribute. If set, all INDEX, BLOOM,
105   * and DATA blocks of HFiles belonging to this family will be loaded into the
106   * cache as soon as the file is opened. These loads will not count as cache
107   * misses.
108   */
109  @InterfaceAudience.Private
110  public static final String PREFETCH_BLOCKS_ON_OPEN = "PREFETCH_BLOCKS_ON_OPEN";
111  private static final Bytes PREFETCH_BLOCKS_ON_OPEN_BYTES = new Bytes(Bytes.toBytes(PREFETCH_BLOCKS_ON_OPEN));
112
113  /**
114   * Size of storefile/hfile 'blocks'. Default is {@link #DEFAULT_BLOCKSIZE}.
115   * Use smaller block sizes for faster random-access at expense of larger
116   * indices (more memory consumption). Note that this is a soft limit and that
117   * blocks have overhead (metadata, CRCs) so blocks will tend to be the size
118   * specified here and then some; i.e. don't expect that setting BLOCKSIZE=4k
119   * means hbase data will align with an SSDs 4k page accesses (TODO).
120   */
121  @InterfaceAudience.Private
122  public static final String BLOCKSIZE = "BLOCKSIZE";
123  private static final Bytes BLOCKSIZE_BYTES = new Bytes(Bytes.toBytes(BLOCKSIZE));
124
125  @InterfaceAudience.Private
126  public static final String TTL = "TTL";
127  private static final Bytes TTL_BYTES = new Bytes(Bytes.toBytes(TTL));
128  @InterfaceAudience.Private
129  public static final String BLOOMFILTER = "BLOOMFILTER";
130  private static final Bytes BLOOMFILTER_BYTES = new Bytes(Bytes.toBytes(BLOOMFILTER));
131  @InterfaceAudience.Private
132  public static final String REPLICATION_SCOPE = "REPLICATION_SCOPE";
133  @InterfaceAudience.Private
134  public static final String MAX_VERSIONS = HConstants.VERSIONS;
135  private static final Bytes MAX_VERSIONS_BYTES = new Bytes(Bytes.toBytes(MAX_VERSIONS));
136  @InterfaceAudience.Private
137  public static final String MIN_VERSIONS = "MIN_VERSIONS";
138  private static final Bytes MIN_VERSIONS_BYTES = new Bytes(Bytes.toBytes(MIN_VERSIONS));
139  /**
140   * Retain all cells across flushes and compactions even if they fall behind a
141   * delete tombstone. To see all retained cells, do a 'raw' scan; see
142   * Scan#setRaw or pass RAW => true attribute in the shell.
143   */
144  @InterfaceAudience.Private
145  public static final String KEEP_DELETED_CELLS = "KEEP_DELETED_CELLS";
146  private static final Bytes KEEP_DELETED_CELLS_BYTES = new Bytes(Bytes.toBytes(KEEP_DELETED_CELLS));
147  @InterfaceAudience.Private
148  public static final String COMPRESS_TAGS = "COMPRESS_TAGS";
149  private static final Bytes COMPRESS_TAGS_BYTES = new Bytes(Bytes.toBytes(COMPRESS_TAGS));
150  @InterfaceAudience.Private
151  public static final String ENCRYPTION = "ENCRYPTION";
152  private static final Bytes ENCRYPTION_BYTES = new Bytes(Bytes.toBytes(ENCRYPTION));
153  @InterfaceAudience.Private
154  public static final String ENCRYPTION_KEY = "ENCRYPTION_KEY";
155  private static final Bytes ENCRYPTION_KEY_BYTES = new Bytes(Bytes.toBytes(ENCRYPTION_KEY));
156
157  private static final boolean DEFAULT_MOB = false;
158  @InterfaceAudience.Private
159  public static final String IS_MOB = "IS_MOB";
160  private static final Bytes IS_MOB_BYTES = new Bytes(Bytes.toBytes(IS_MOB));
161  @InterfaceAudience.Private
162  public static final String MOB_THRESHOLD = "MOB_THRESHOLD";
163  private static final Bytes MOB_THRESHOLD_BYTES = new Bytes(Bytes.toBytes(MOB_THRESHOLD));
164  public static final long DEFAULT_MOB_THRESHOLD = 100 * 1024; // 100k
165  @InterfaceAudience.Private
166  public static final String MOB_COMPACT_PARTITION_POLICY = "MOB_COMPACT_PARTITION_POLICY";
167  private static final Bytes MOB_COMPACT_PARTITION_POLICY_BYTES = new Bytes(Bytes.toBytes(MOB_COMPACT_PARTITION_POLICY));
168  public static final MobCompactPartitionPolicy DEFAULT_MOB_COMPACT_PARTITION_POLICY
169          = MobCompactPartitionPolicy.DAILY;
170  @InterfaceAudience.Private
171  public static final String DFS_REPLICATION = "DFS_REPLICATION";
172  private static final Bytes DFS_REPLICATION_BYTES = new Bytes(Bytes.toBytes(DFS_REPLICATION));
173  public static final short DEFAULT_DFS_REPLICATION = 0;
174  @InterfaceAudience.Private
175  public static final String STORAGE_POLICY = "STORAGE_POLICY";
176  private static final Bytes STORAGE_POLICY_BYTES = new Bytes(Bytes.toBytes(STORAGE_POLICY));
177
178  public static final String NEW_VERSION_BEHAVIOR = "NEW_VERSION_BEHAVIOR";
179  private static final Bytes NEW_VERSION_BEHAVIOR_BYTES = new Bytes(Bytes.toBytes(NEW_VERSION_BEHAVIOR));
180  public static final boolean DEFAULT_NEW_VERSION_BEHAVIOR = false;
181  /**
182   * Default compression type.
183   */
184  public static final Compression.Algorithm DEFAULT_COMPRESSION = Compression.Algorithm.NONE;
185
186  /**
187   * Default data block encoding algorithm.
188   */
189  public static final DataBlockEncoding DEFAULT_DATA_BLOCK_ENCODING = DataBlockEncoding.NONE;
190
191  /**
192   * Default number of versions of a record to keep.
193   */
194  public static final int DEFAULT_MAX_VERSIONS = 1;
195
196  /**
197   * Default is not to keep a minimum of versions.
198   */
199  public static final int DEFAULT_MIN_VERSIONS = 0;
200
201  /**
202   * Default setting for whether to try and serve this column family from memory
203   * or not.
204   */
205  public static final boolean DEFAULT_IN_MEMORY = false;
206
207  /**
208   * Default setting for preventing deleted from being collected immediately.
209   */
210  public static final KeepDeletedCells DEFAULT_KEEP_DELETED = KeepDeletedCells.FALSE;
211
212  /**
213   * Default setting for whether to use a block cache or not.
214   */
215  public static final boolean DEFAULT_BLOCKCACHE = true;
216
217  /**
218   * Default setting for whether to cache data blocks on write if block caching
219   * is enabled.
220   */
221  public static final boolean DEFAULT_CACHE_DATA_ON_WRITE = false;
222
223  /**
224   * Default setting for whether to cache index blocks on write if block caching
225   * is enabled.
226   */
227  public static final boolean DEFAULT_CACHE_INDEX_ON_WRITE = false;
228
229  /**
230   * Default size of blocks in files stored to the filesytem (hfiles).
231   */
232  public static final int DEFAULT_BLOCKSIZE = HConstants.DEFAULT_BLOCKSIZE;
233
234  /**
235   * Default setting for whether or not to use bloomfilters.
236   */
237  public static final BloomType DEFAULT_BLOOMFILTER = BloomType.ROW;
238
239  /**
240   * Default setting for whether to cache bloom filter blocks on write if block
241   * caching is enabled.
242   */
243  public static final boolean DEFAULT_CACHE_BLOOMS_ON_WRITE = false;
244
245  /**
246   * Default time to live of cell contents.
247   */
248  public static final int DEFAULT_TTL = HConstants.FOREVER;
249
250  /**
251   * Default scope.
252   */
253  public static final int DEFAULT_REPLICATION_SCOPE = HConstants.REPLICATION_SCOPE_LOCAL;
254
255  /**
256   * Default setting for whether to evict cached blocks from the blockcache on
257   * close.
258   */
259  public static final boolean DEFAULT_EVICT_BLOCKS_ON_CLOSE = false;
260
261  /**
262   * Default compress tags along with any type of DataBlockEncoding.
263   */
264  public static final boolean DEFAULT_COMPRESS_TAGS = true;
265
266  /*
267   * Default setting for whether to prefetch blocks into the blockcache on open.
268   */
269  public static final boolean DEFAULT_PREFETCH_BLOCKS_ON_OPEN = false;
270
271  private final static Map<String, String> DEFAULT_VALUES = new HashMap<>();
272
273  private static Map<Bytes, Bytes> getDefaultValuesBytes() {
274    Map<Bytes, Bytes> values = new HashMap<>();
275    DEFAULT_VALUES.forEach((k, v) -> values.put(new Bytes(Bytes.toBytes(k)), new Bytes(Bytes.toBytes(v))));
276    return values;
277  }
278
279  public static Map<String, String> getDefaultValues() {
280    return Collections.unmodifiableMap(DEFAULT_VALUES);
281  }
282
283  private final static Set<Bytes> RESERVED_KEYWORDS = new HashSet<>();
284
285  static {
286    DEFAULT_VALUES.put(BLOOMFILTER, DEFAULT_BLOOMFILTER.name());
287    DEFAULT_VALUES.put(REPLICATION_SCOPE, String.valueOf(DEFAULT_REPLICATION_SCOPE));
288    DEFAULT_VALUES.put(MAX_VERSIONS, String.valueOf(DEFAULT_MAX_VERSIONS));
289    DEFAULT_VALUES.put(MIN_VERSIONS, String.valueOf(DEFAULT_MIN_VERSIONS));
290    DEFAULT_VALUES.put(COMPRESSION, DEFAULT_COMPRESSION.name());
291    DEFAULT_VALUES.put(TTL, String.valueOf(DEFAULT_TTL));
292    DEFAULT_VALUES.put(BLOCKSIZE, String.valueOf(DEFAULT_BLOCKSIZE));
293    DEFAULT_VALUES.put(IN_MEMORY, String.valueOf(DEFAULT_IN_MEMORY));
294    DEFAULT_VALUES.put(BLOCKCACHE, String.valueOf(DEFAULT_BLOCKCACHE));
295    DEFAULT_VALUES.put(KEEP_DELETED_CELLS, String.valueOf(DEFAULT_KEEP_DELETED));
296    DEFAULT_VALUES.put(DATA_BLOCK_ENCODING, String.valueOf(DEFAULT_DATA_BLOCK_ENCODING));
297    // Do NOT add this key/value by default. NEW_VERSION_BEHAVIOR is NOT defined in hbase1 so
298    // it is not possible to make an hbase1 HCD the same as an hbase2 HCD and so the replication
299    // compare of schemas will fail. It is OK not adding the below to the initial map because of
300    // fetch of this value, we will check for null and if null will return the default.
301    // DEFAULT_VALUES.put(NEW_VERSION_BEHAVIOR, String.valueOf(DEFAULT_NEW_VERSION_BEHAVIOR));
302    DEFAULT_VALUES.keySet().forEach(s -> RESERVED_KEYWORDS.add(new Bytes(Bytes.toBytes(s))));
303    RESERVED_KEYWORDS.add(new Bytes(Bytes.toBytes(ENCRYPTION)));
304    RESERVED_KEYWORDS.add(new Bytes(Bytes.toBytes(ENCRYPTION_KEY)));
305    RESERVED_KEYWORDS.add(new Bytes(Bytes.toBytes(IS_MOB)));
306    RESERVED_KEYWORDS.add(new Bytes(Bytes.toBytes(MOB_THRESHOLD)));
307    RESERVED_KEYWORDS.add(new Bytes(Bytes.toBytes(MOB_COMPACT_PARTITION_POLICY)));
308  }
309
310  public static Unit getUnit(String key) {
311    /* TTL for now, we can add more as we need */
312    switch (key) {
313      case TTL:
314        return Unit.TIME_INTERVAL;
315      default:
316        return Unit.NONE;
317    }
318  }
319
320  /**
321   * @param b Family name.
322   * @return <code>b</code>
323   * @throws IllegalArgumentException If not null and not a legitimate family
324   * name: i.e. 'printable' and ends in a ':' (Null passes are allowed because
325   * <code>b</code> can be null when deserializing). Cannot start with a '.'
326   * either. Also Family can not be an empty value or equal "recovered.edits".
327   */
328  public static byte[] isLegalColumnFamilyName(final byte[] b) {
329    if (b == null) {
330      return null;
331    }
332    Preconditions.checkArgument(b.length != 0, "Column Family name can not be empty");
333    if (b[0] == '.') {
334      throw new IllegalArgumentException("Column Family names cannot start with a "
335              + "period: " + Bytes.toString(b));
336    }
337    for (int i = 0; i < b.length; i++) {
338      if (Character.isISOControl(b[i]) || b[i] == ':' || b[i] == '\\' || b[i] == '/') {
339        throw new IllegalArgumentException("Illegal character <" + b[i]
340                + ">. Column Family names cannot contain control characters or colons: "
341                + Bytes.toString(b));
342      }
343    }
344    byte[] recoveredEdit = Bytes.toBytes(HConstants.RECOVERED_EDITS_DIR);
345    if (Bytes.equals(recoveredEdit, b)) {
346      throw new IllegalArgumentException("Column Family name cannot be: "
347              + HConstants.RECOVERED_EDITS_DIR);
348    }
349    return b;
350  }
351
352  private final ModifyableColumnFamilyDescriptor desc;
353
354  public static ColumnFamilyDescriptor parseFrom(final byte[] pbBytes) throws DeserializationException {
355    return ModifyableColumnFamilyDescriptor.parseFrom(pbBytes);
356  }
357
358  public static ColumnFamilyDescriptorBuilder newBuilder(final byte[] name) {
359    return new ColumnFamilyDescriptorBuilder(name);
360  }
361
362  public static ColumnFamilyDescriptorBuilder newBuilder(final ColumnFamilyDescriptor desc) {
363    return new ColumnFamilyDescriptorBuilder(desc);
364  }
365
366  public static ColumnFamilyDescriptor copy(ColumnFamilyDescriptor desc) {
367    return new ModifyableColumnFamilyDescriptor(desc);
368  }
369
370  public static ColumnFamilyDescriptor of(String name) {
371    return of(Bytes.toBytes(name));
372  }
373
374  public static ColumnFamilyDescriptor of(byte[] name) {
375    return newBuilder(name).build();
376  }
377
378  private ColumnFamilyDescriptorBuilder(final byte[] name) {
379    this.desc = new ModifyableColumnFamilyDescriptor(name);
380  }
381
382  private ColumnFamilyDescriptorBuilder(final ColumnFamilyDescriptor desc) {
383    this.desc = new ModifyableColumnFamilyDescriptor(desc);
384  }
385
386  /**
387   * @param desc The table descriptor to serialize
388   * @return This instance serialized with pb with pb magic prefix
389   */
390  public static byte[] toByteArray(ColumnFamilyDescriptor desc) {
391    if (desc instanceof ModifyableColumnFamilyDescriptor) {
392      return ((ModifyableColumnFamilyDescriptor) desc).toByteArray();
393    }
394    return new ModifyableColumnFamilyDescriptor(desc).toByteArray();
395  }
396
397  public ColumnFamilyDescriptor build() {
398    return new ModifyableColumnFamilyDescriptor(desc);
399  }
400
401  public ColumnFamilyDescriptorBuilder removeConfiguration(String key) {
402    desc.removeConfiguration(key);
403    return this;
404  }
405
406  public String getNameAsString() {
407    return desc.getNameAsString();
408  }
409
410  public ColumnFamilyDescriptorBuilder setBlockCacheEnabled(boolean value) {
411    desc.setBlockCacheEnabled(value);
412    return this;
413  }
414
415  public ColumnFamilyDescriptorBuilder setBlocksize(int value) {
416    desc.setBlocksize(value);
417    return this;
418  }
419
420  public ColumnFamilyDescriptorBuilder setBloomFilterType(final BloomType value) {
421    desc.setBloomFilterType(value);
422    return this;
423  }
424
425  public ColumnFamilyDescriptorBuilder setCacheBloomsOnWrite(boolean value) {
426    desc.setCacheBloomsOnWrite(value);
427    return this;
428  }
429
430  public ColumnFamilyDescriptorBuilder setCacheDataOnWrite(boolean value) {
431    desc.setCacheDataOnWrite(value);
432    return this;
433  }
434
435  public ColumnFamilyDescriptorBuilder setCacheIndexesOnWrite(final boolean value) {
436    desc.setCacheIndexesOnWrite(value);
437    return this;
438  }
439
440  public ColumnFamilyDescriptorBuilder setCompactionCompressionType(Compression.Algorithm value) {
441    desc.setCompactionCompressionType(value);
442    return this;
443  }
444
445  public ColumnFamilyDescriptorBuilder setCompressTags(boolean value) {
446    desc.setCompressTags(value);
447    return this;
448  }
449
450  public ColumnFamilyDescriptorBuilder setCompressionType(Compression.Algorithm value) {
451    desc.setCompressionType(value);
452    return this;
453  }
454
455  public Compression.Algorithm getCompressionType() {
456    return desc.getCompressionType();
457  }
458
459  public ColumnFamilyDescriptorBuilder setConfiguration(final String key, final String value) {
460    desc.setConfiguration(key, value);
461    return this;
462  }
463
464  public ColumnFamilyDescriptorBuilder setDFSReplication(short value) {
465    desc.setDFSReplication(value);
466    return this;
467  }
468
469  public ColumnFamilyDescriptorBuilder setDataBlockEncoding(DataBlockEncoding value) {
470    desc.setDataBlockEncoding(value);
471    return this;
472  }
473
474  public ColumnFamilyDescriptorBuilder setEncryptionKey(final byte[] value) {
475    desc.setEncryptionKey(value);
476    return this;
477  }
478
479  public ColumnFamilyDescriptorBuilder setEncryptionType(String value) {
480    desc.setEncryptionType(value);
481    return this;
482  }
483
484  public ColumnFamilyDescriptorBuilder setEvictBlocksOnClose(boolean value) {
485    desc.setEvictBlocksOnClose(value);
486    return this;
487  }
488
489  public ColumnFamilyDescriptorBuilder setInMemory(final boolean value) {
490    desc.setInMemory(value);
491    return this;
492  }
493
494  public ColumnFamilyDescriptorBuilder setInMemoryCompaction(final MemoryCompactionPolicy value) {
495    desc.setInMemoryCompaction(value);
496    return this;
497  }
498
499  public ColumnFamilyDescriptorBuilder setKeepDeletedCells(KeepDeletedCells value) {
500    desc.setKeepDeletedCells(value);
501    return this;
502  }
503
504  public ColumnFamilyDescriptorBuilder setMaxVersions(final int value) {
505    desc.setMaxVersions(value);
506    return this;
507  }
508
509  public ColumnFamilyDescriptorBuilder setMinVersions(final int value) {
510    desc.setMinVersions(value);
511    return this;
512  }
513
514  public ColumnFamilyDescriptorBuilder setMobCompactPartitionPolicy(final MobCompactPartitionPolicy value) {
515    desc.setMobCompactPartitionPolicy(value);
516    return this;
517  }
518
519  public ColumnFamilyDescriptorBuilder setMobEnabled(final boolean value) {
520    desc.setMobEnabled(value);
521    return this;
522  }
523
524  public ColumnFamilyDescriptorBuilder setMobThreshold(final long value) {
525    desc.setMobThreshold(value);
526    return this;
527  }
528
529  public ColumnFamilyDescriptorBuilder setPrefetchBlocksOnOpen(final boolean value) {
530    desc.setPrefetchBlocksOnOpen(value);
531    return this;
532  }
533
534  public ColumnFamilyDescriptorBuilder setScope(final int value) {
535    desc.setScope(value);
536    return this;
537  }
538
539  public ColumnFamilyDescriptorBuilder setStoragePolicy(final String value) {
540    desc.setStoragePolicy(value);
541    return this;
542  }
543
544  public ColumnFamilyDescriptorBuilder setTimeToLive(final int value) {
545    desc.setTimeToLive(value);
546    return this;
547  }
548
549  public ColumnFamilyDescriptorBuilder setTimeToLive(final String value) throws HBaseException {
550    desc.setTimeToLive(value);
551    return this;
552  }
553
554  public ColumnFamilyDescriptorBuilder setNewVersionBehavior(final boolean value) {
555    desc.setNewVersionBehavior(value);
556    return this;
557  }
558
559  public ColumnFamilyDescriptorBuilder setValue(final Bytes key, final Bytes value) {
560    desc.setValue(key, value);
561    return this;
562  }
563
564  public ColumnFamilyDescriptorBuilder setValue(final byte[] key, final byte[] value) {
565    desc.setValue(key, value);
566    return this;
567  }
568
569  public ColumnFamilyDescriptorBuilder setValue(final String key, final String value) {
570    desc.setValue(key, value);
571    return this;
572  }
573
574  public ColumnFamilyDescriptorBuilder setVersionsWithTimeToLive(final int retentionInterval,
575      final int versionAfterInterval) {
576    desc.setVersionsWithTimeToLive(retentionInterval, versionAfterInterval);
577    return this;
578  }
579
580  /**
581   * An ModifyableFamilyDescriptor contains information about a column family such as the
582   * number of versions, compression settings, etc.
583   *
584   * It is used as input when creating a table or adding a column.
585   */
586  private static final class ModifyableColumnFamilyDescriptor
587      implements ColumnFamilyDescriptor, Comparable<ModifyableColumnFamilyDescriptor> {
588
589    // Column family name
590    private final byte[] name;
591
592    // Column metadata
593    private final Map<Bytes, Bytes> values = new HashMap<>();
594
595    /**
596     * A map which holds the configuration specific to the column family. The
597     * keys of the map have the same names as config keys and override the
598     * defaults with cf-specific settings. Example usage may be for compactions,
599     * etc.
600     */
601    private final Map<String, String> configuration = new HashMap<>();
602
603    /**
604     * Construct a column descriptor specifying only the family name The other
605     * attributes are defaulted.
606     *
607     * @param name Column family name. Must be 'printable' -- digit or
608     * letter -- and may not contain a <code>:</code>
609     * TODO: make this private after the HCD is removed.
610     */
611    @InterfaceAudience.Private
612    public ModifyableColumnFamilyDescriptor(final byte[] name) {
613      this(isLegalColumnFamilyName(name), getDefaultValuesBytes(), Collections.emptyMap());
614    }
615
616    /**
617     * Constructor. Makes a deep copy of the supplied descriptor.
618     * TODO: make this private after the HCD is removed.
619     * @param desc The descriptor.
620     */
621    @InterfaceAudience.Private
622    public ModifyableColumnFamilyDescriptor(ColumnFamilyDescriptor desc) {
623      this(desc.getName(), desc.getValues(), desc.getConfiguration());
624    }
625
626    private ModifyableColumnFamilyDescriptor(byte[] name, Map<Bytes, Bytes> values, Map<String, String> config) {
627      this.name = name;
628      this.values.putAll(values);
629      this.configuration.putAll(config);
630    }
631
632    @Override
633    public byte[] getName() {
634      return Bytes.copy(name);
635    }
636
637    @Override
638    public String getNameAsString() {
639      return Bytes.toString(name);
640    }
641
642    @Override
643    public Bytes getValue(Bytes key) {
644      return values.get(key);
645    }
646
647    @Override
648    public byte[] getValue(byte[] key) {
649      Bytes value = values.get(new Bytes(key));
650      return value == null ? null : value.get();
651    }
652
653    @Override
654    public Map<Bytes, Bytes> getValues() {
655      return Collections.unmodifiableMap(values);
656    }
657
658    /**
659     * @param key The key.
660     * @param value The value.
661     * @return this (for chained invocation)
662     */
663    public ModifyableColumnFamilyDescriptor setValue(byte[] key, byte[] value) {
664      return setValue(toBytesOrNull(key, Function.identity()), toBytesOrNull(value, Function.identity()));
665    }
666
667    public ModifyableColumnFamilyDescriptor setValue(String key, String value) {
668      return setValue(toBytesOrNull(key, Bytes::toBytes), toBytesOrNull(value, Bytes::toBytes));
669    }
670
671    private ModifyableColumnFamilyDescriptor setValue(Bytes key, String value) {
672      return setValue(key, toBytesOrNull(value, Bytes::toBytes));
673    }
674    /**
675     * @param key The key.
676     * @param value The value.
677     * @return this (for chained invocation)
678     */
679    private ModifyableColumnFamilyDescriptor setValue(Bytes key, Bytes value) {
680      if (value == null) {
681        values.remove(key);
682      } else {
683        values.put(key, value);
684      }
685      return this;
686    }
687
688    private static <T> Bytes toBytesOrNull(T t, Function<T, byte[]> f) {
689      if (t == null) {
690        return null;
691      } else {
692        return new Bytes(f.apply(t));
693      }
694    }
695
696    private <T> T getStringOrDefault(Bytes key, Function<String, T> function, T defaultValue) {
697      return getOrDefault(key, b -> function.apply(Bytes.toString(b)), defaultValue);
698    }
699
700    private <T> T getOrDefault(Bytes key, Function<byte[], T> function, T defaultValue) {
701      Bytes value = values.get(key);
702      if (value == null) {
703        return defaultValue;
704      } else {
705        return function.apply(value.get());
706      }
707    }
708
709    @Override
710    public int getMaxVersions() {
711      return getStringOrDefault(MAX_VERSIONS_BYTES, Integer::parseInt, DEFAULT_MAX_VERSIONS);
712    }
713
714    /**
715     * @param maxVersions maximum number of versions
716     * @return this (for chained invocation)
717     */
718    public ModifyableColumnFamilyDescriptor setMaxVersions(int maxVersions) {
719      if (maxVersions <= 0) {
720        // TODO: Allow maxVersion of 0 to be the way you say "Keep all versions".
721        // Until there is support, consider 0 or < 0 -- a configuration error.
722        throw new IllegalArgumentException("Maximum versions must be positive");
723      }
724      if (maxVersions < this.getMinVersions()) {
725        throw new IllegalArgumentException("Set MaxVersion to " + maxVersions
726                + " while minVersion is " + this.getMinVersions()
727                + ". Maximum versions must be >= minimum versions ");
728      }
729      setValue(MAX_VERSIONS_BYTES, Integer.toString(maxVersions));
730      return this;
731    }
732
733    /**
734     * Set minimum and maximum versions to keep
735     *
736     * @param minVersions minimal number of versions
737     * @param maxVersions maximum number of versions
738     * @return this (for chained invocation)
739     */
740    public ModifyableColumnFamilyDescriptor setVersions(int minVersions, int maxVersions) {
741      if (minVersions <= 0) {
742        // TODO: Allow minVersion and maxVersion of 0 to be the way you say "Keep all versions".
743        // Until there is support, consider 0 or < 0 -- a configuration error.
744        throw new IllegalArgumentException("Minimum versions must be positive");
745      }
746
747      if (maxVersions < minVersions) {
748        throw new IllegalArgumentException("Unable to set MaxVersion to " + maxVersions
749                + " and set MinVersion to " + minVersions
750                + ", as maximum versions must be >= minimum versions.");
751      }
752      setMinVersions(minVersions);
753      setMaxVersions(maxVersions);
754      return this;
755    }
756
757
758    @Override
759    public int getBlocksize() {
760      return getStringOrDefault(BLOCKSIZE_BYTES, Integer::valueOf, DEFAULT_BLOCKSIZE);
761    }
762
763    /**
764     * @param s Blocksize to use when writing out storefiles/hfiles on this
765     * column family.
766     * @return this (for chained invocation)
767     */
768    public ModifyableColumnFamilyDescriptor setBlocksize(int s) {
769      return setValue(BLOCKSIZE_BYTES, Integer.toString(s));
770    }
771
772    @Override
773    public Compression.Algorithm getCompressionType() {
774      return getStringOrDefault(COMPRESSION_BYTES,
775        n -> Compression.Algorithm.valueOf(n.toUpperCase()), DEFAULT_COMPRESSION);
776    }
777
778    /**
779     * Compression types supported in hbase. LZO is not bundled as part of the
780     * hbase distribution. See
781     * See <a href="http://hbase.apache.org/book.html#lzo.compression">LZO Compression</a>
782     * for how to enable it.
783     *
784     * @param type Compression type setting.
785     * @return this (for chained invocation)
786     */
787    public ModifyableColumnFamilyDescriptor setCompressionType(Compression.Algorithm type) {
788      return setValue(COMPRESSION_BYTES, type.name());
789    }
790
791    @Override
792    public DataBlockEncoding getDataBlockEncoding() {
793      return getStringOrDefault(DATA_BLOCK_ENCODING_BYTES,
794        n -> DataBlockEncoding.valueOf(n.toUpperCase()), DataBlockEncoding.NONE);
795    }
796
797    /**
798     * Set data block encoding algorithm used in block cache.
799     *
800     * @param type What kind of data block encoding will be used.
801     * @return this (for chained invocation)
802     */
803    public ModifyableColumnFamilyDescriptor setDataBlockEncoding(DataBlockEncoding type) {
804      return setValue(DATA_BLOCK_ENCODING_BYTES, type == null ? DataBlockEncoding.NONE.name() : type.name());
805    }
806
807    /**
808     * Set whether the tags should be compressed along with DataBlockEncoding.
809     * When no DataBlockEncoding is been used, this is having no effect.
810     *
811     * @param compressTags
812     * @return this (for chained invocation)
813     */
814    public ModifyableColumnFamilyDescriptor setCompressTags(boolean compressTags) {
815      return setValue(COMPRESS_TAGS_BYTES, String.valueOf(compressTags));
816    }
817
818    @Override
819    public boolean isCompressTags() {
820      return getStringOrDefault(COMPRESS_TAGS_BYTES, Boolean::valueOf,
821              DEFAULT_COMPRESS_TAGS);
822    }
823
824    @Override
825    public Compression.Algorithm getCompactionCompressionType() {
826      return getStringOrDefault(COMPRESSION_COMPACT_BYTES,
827        n -> Compression.Algorithm.valueOf(n.toUpperCase()), getCompressionType());
828    }
829
830    /**
831     * Compression types supported in hbase. LZO is not bundled as part of the
832     * hbase distribution. See
833     * See <a href="http://hbase.apache.org/book.html#lzo.compression">LZO Compression</a>
834     * for how to enable it.
835     *
836     * @param type Compression type setting.
837     * @return this (for chained invocation)
838     */
839    public ModifyableColumnFamilyDescriptor setCompactionCompressionType(
840            Compression.Algorithm type) {
841      return setValue(COMPRESSION_COMPACT_BYTES, type.name());
842    }
843
844    @Override
845    public boolean isInMemory() {
846      return getStringOrDefault(IN_MEMORY_BYTES, Boolean::valueOf, DEFAULT_IN_MEMORY);
847    }
848
849    /**
850     * @param inMemory True if we are to favor keeping all values for this
851     * column family in the HRegionServer cache
852     * @return this (for chained invocation)
853     */
854    public ModifyableColumnFamilyDescriptor setInMemory(boolean inMemory) {
855      return setValue(IN_MEMORY_BYTES, Boolean.toString(inMemory));
856    }
857
858    @Override
859    public MemoryCompactionPolicy getInMemoryCompaction() {
860      return getStringOrDefault(IN_MEMORY_COMPACTION_BYTES,
861        n -> MemoryCompactionPolicy.valueOf(n.toUpperCase()), null);
862    }
863
864    /**
865     * @param inMemoryCompaction the prefered in-memory compaction policy for
866     * this column family
867     * @return this (for chained invocation)
868     */
869    public ModifyableColumnFamilyDescriptor setInMemoryCompaction(MemoryCompactionPolicy inMemoryCompaction) {
870      return setValue(IN_MEMORY_COMPACTION_BYTES, inMemoryCompaction.name());
871    }
872
873    @Override
874    public KeepDeletedCells getKeepDeletedCells() {
875      return getStringOrDefault(KEEP_DELETED_CELLS_BYTES,
876          KeepDeletedCells::getValue, DEFAULT_KEEP_DELETED);
877    }
878
879    /**
880     * @param keepDeletedCells True if deleted rows should not be collected
881     * immediately.
882     * @return this (for chained invocation)
883     */
884    public ModifyableColumnFamilyDescriptor setKeepDeletedCells(KeepDeletedCells keepDeletedCells) {
885      return setValue(KEEP_DELETED_CELLS_BYTES, keepDeletedCells.name());
886    }
887
888    /**
889     * By default, HBase only consider timestamp in versions. So a previous Delete with higher ts
890     * will mask a later Put with lower ts. Set this to true to enable new semantics of versions.
891     * We will also consider mvcc in versions. See HBASE-15968 for details.
892     */
893    @Override
894    public boolean isNewVersionBehavior() {
895      return getStringOrDefault(NEW_VERSION_BEHAVIOR_BYTES,
896          Boolean::parseBoolean, DEFAULT_NEW_VERSION_BEHAVIOR);
897    }
898
899    public ModifyableColumnFamilyDescriptor setNewVersionBehavior(boolean newVersionBehavior) {
900      return setValue(NEW_VERSION_BEHAVIOR_BYTES, Boolean.toString(newVersionBehavior));
901    }
902
903    @Override
904    public int getTimeToLive() {
905      return getStringOrDefault(TTL_BYTES, Integer::parseInt, DEFAULT_TTL);
906    }
907
908    /**
909     * @param timeToLive Time-to-live of cell contents, in seconds.
910     * @return this (for chained invocation)
911     */
912    public ModifyableColumnFamilyDescriptor setTimeToLive(int timeToLive) {
913      return setValue(TTL_BYTES, Integer.toString(timeToLive));
914    }
915
916    /**
917     * @param timeToLive Time-to-live of cell contents, in seconds.
918     * @return this (for chained invocation)
919     * @throws org.apache.hadoop.hbase.exceptions.HBaseException
920     */
921    public ModifyableColumnFamilyDescriptor setTimeToLive(String timeToLive) throws HBaseException {
922      return setTimeToLive(Integer.parseInt(PrettyPrinter.valueOf(timeToLive, Unit.TIME_INTERVAL)));
923    }
924
925    @Override
926    public int getMinVersions() {
927      return getStringOrDefault(MIN_VERSIONS_BYTES, Integer::valueOf, DEFAULT_MIN_VERSIONS);
928    }
929
930    /**
931     * @param minVersions The minimum number of versions to keep. (used when
932     * timeToLive is set)
933     * @return this (for chained invocation)
934     */
935    public ModifyableColumnFamilyDescriptor setMinVersions(int minVersions) {
936      return setValue(MIN_VERSIONS_BYTES, Integer.toString(minVersions));
937    }
938
939    /**
940     * Retain all versions for a given TTL(retentionInterval), and then only a specific number
941     * of versions(versionAfterInterval) after that interval elapses.
942     *
943     * @param retentionInterval Retain all versions for this interval
944     * @param versionAfterInterval Retain no of versions to retain after retentionInterval
945     * @return this (for chained invocation)
946     */
947    public ModifyableColumnFamilyDescriptor setVersionsWithTimeToLive(
948        final int retentionInterval, final int versionAfterInterval) {
949      ModifyableColumnFamilyDescriptor modifyableColumnFamilyDescriptor =
950        setVersions(versionAfterInterval, Integer.MAX_VALUE);
951      modifyableColumnFamilyDescriptor.setTimeToLive(retentionInterval);
952      modifyableColumnFamilyDescriptor.setKeepDeletedCells(KeepDeletedCells.TTL);
953      return modifyableColumnFamilyDescriptor;
954    }
955
956    @Override
957    public boolean isBlockCacheEnabled() {
958      return getStringOrDefault(BLOCKCACHE_BYTES, Boolean::valueOf, DEFAULT_BLOCKCACHE);
959    }
960
961    /**
962     * @param blockCacheEnabled True if hfile DATA type blocks should be cached
963     * (We always cache INDEX and BLOOM blocks; you cannot turn this off).
964     * @return this (for chained invocation)
965     */
966    public ModifyableColumnFamilyDescriptor setBlockCacheEnabled(boolean blockCacheEnabled) {
967      return setValue(BLOCKCACHE_BYTES, Boolean.toString(blockCacheEnabled));
968    }
969
970    @Override
971    public BloomType getBloomFilterType() {
972      return getStringOrDefault(BLOOMFILTER_BYTES, n -> BloomType.valueOf(n.toUpperCase()),
973        DEFAULT_BLOOMFILTER);
974    }
975
976    public ModifyableColumnFamilyDescriptor setBloomFilterType(final BloomType bt) {
977      return setValue(BLOOMFILTER_BYTES, bt.name());
978    }
979
980    @Override
981    public int getScope() {
982      return getStringOrDefault(REPLICATION_SCOPE_BYTES, Integer::valueOf, DEFAULT_REPLICATION_SCOPE);
983    }
984
985    /**
986     * @param scope the scope tag
987     * @return this (for chained invocation)
988     */
989    public ModifyableColumnFamilyDescriptor setScope(int scope) {
990      return setValue(REPLICATION_SCOPE_BYTES, Integer.toString(scope));
991    }
992
993    @Override
994    public boolean isCacheDataOnWrite() {
995      return getStringOrDefault(CACHE_DATA_ON_WRITE_BYTES, Boolean::valueOf, DEFAULT_CACHE_DATA_ON_WRITE);
996    }
997
998    /**
999     * @param value true if we should cache data blocks on write
1000     * @return this (for chained invocation)
1001     */
1002    public ModifyableColumnFamilyDescriptor setCacheDataOnWrite(boolean value) {
1003      return setValue(CACHE_DATA_ON_WRITE_BYTES, Boolean.toString(value));
1004    }
1005
1006    @Override
1007    public boolean isCacheIndexesOnWrite() {
1008      return getStringOrDefault(CACHE_INDEX_ON_WRITE_BYTES, Boolean::valueOf, DEFAULT_CACHE_INDEX_ON_WRITE);
1009    }
1010
1011    /**
1012     * @param value true if we should cache index blocks on write
1013     * @return this (for chained invocation)
1014     */
1015    public ModifyableColumnFamilyDescriptor setCacheIndexesOnWrite(boolean value) {
1016      return setValue(CACHE_INDEX_ON_WRITE_BYTES, Boolean.toString(value));
1017    }
1018
1019    @Override
1020    public boolean isCacheBloomsOnWrite() {
1021      return getStringOrDefault(CACHE_BLOOMS_ON_WRITE_BYTES, Boolean::valueOf, DEFAULT_CACHE_BLOOMS_ON_WRITE);
1022    }
1023
1024    /**
1025     * @param value true if we should cache bloomfilter blocks on write
1026     * @return this (for chained invocation)
1027     */
1028    public ModifyableColumnFamilyDescriptor setCacheBloomsOnWrite(boolean value) {
1029      return setValue(CACHE_BLOOMS_ON_WRITE_BYTES, Boolean.toString(value));
1030    }
1031
1032    @Override
1033    public boolean isEvictBlocksOnClose() {
1034      return getStringOrDefault(EVICT_BLOCKS_ON_CLOSE_BYTES, Boolean::valueOf, DEFAULT_EVICT_BLOCKS_ON_CLOSE);
1035    }
1036
1037    /**
1038     * @param value true if we should evict cached blocks from the blockcache on
1039     * close
1040     * @return this (for chained invocation)
1041     */
1042    public ModifyableColumnFamilyDescriptor setEvictBlocksOnClose(boolean value) {
1043      return setValue(EVICT_BLOCKS_ON_CLOSE_BYTES, Boolean.toString(value));
1044    }
1045
1046    @Override
1047    public boolean isPrefetchBlocksOnOpen() {
1048      return getStringOrDefault(PREFETCH_BLOCKS_ON_OPEN_BYTES, Boolean::valueOf, DEFAULT_PREFETCH_BLOCKS_ON_OPEN);
1049    }
1050
1051    /**
1052     * @param value true if we should prefetch blocks into the blockcache on
1053     * open
1054     * @return this (for chained invocation)
1055     */
1056    public ModifyableColumnFamilyDescriptor setPrefetchBlocksOnOpen(boolean value) {
1057      return setValue(PREFETCH_BLOCKS_ON_OPEN_BYTES, Boolean.toString(value));
1058    }
1059
1060    @Override
1061    public String toString() {
1062      StringBuilder s = new StringBuilder();
1063      s.append('{');
1064      s.append(HConstants.NAME);
1065      s.append(" => '");
1066      s.append(getNameAsString());
1067      s.append("'");
1068      s.append(getValues(true));
1069      s.append('}');
1070      return s.toString();
1071    }
1072
1073
1074    @Override
1075    public String toStringCustomizedValues() {
1076      StringBuilder s = new StringBuilder();
1077      s.append('{');
1078      s.append(HConstants.NAME);
1079      s.append(" => '");
1080      s.append(getNameAsString());
1081      s.append("'");
1082      s.append(getValues(false));
1083      s.append('}');
1084      return s.toString();
1085    }
1086
1087    private StringBuilder getValues(boolean printDefaults) {
1088      StringBuilder s = new StringBuilder();
1089
1090      boolean hasConfigKeys = false;
1091
1092      // print all reserved keys first
1093      for (Map.Entry<Bytes, Bytes> entry : values.entrySet()) {
1094        if (!RESERVED_KEYWORDS.contains(entry.getKey())) {
1095          hasConfigKeys = true;
1096          continue;
1097        }
1098        String key = Bytes.toString(entry.getKey().get());
1099        String value = Bytes.toStringBinary(entry.getValue().get());
1100        if (printDefaults
1101                || !DEFAULT_VALUES.containsKey(key)
1102                || !DEFAULT_VALUES.get(key).equalsIgnoreCase(value)) {
1103          s.append(", ");
1104          s.append(key);
1105          s.append(" => ");
1106          s.append('\'').append(PrettyPrinter.format(value, getUnit(key))).append('\'');
1107        }
1108      }
1109
1110      // print all non-reserved, advanced config keys as a separate subset
1111      if (hasConfigKeys) {
1112        s.append(", ");
1113        s.append(HConstants.METADATA).append(" => ");
1114        s.append('{');
1115        boolean printComma = false;
1116        for (Map.Entry<Bytes, Bytes> entry : values.entrySet()) {
1117          Bytes k = entry.getKey();
1118          if (RESERVED_KEYWORDS.contains(k)) {
1119            continue;
1120          }
1121          String key = Bytes.toString(k.get());
1122          String value = Bytes.toStringBinary(entry.getValue().get());
1123          if (printComma) {
1124            s.append(", ");
1125          }
1126          printComma = true;
1127          s.append('\'').append(key).append('\'');
1128          s.append(" => ");
1129          s.append('\'').append(PrettyPrinter.format(value, getUnit(key))).append('\'');
1130        }
1131        s.append('}');
1132      }
1133
1134      if (!configuration.isEmpty()) {
1135        s.append(", ");
1136        s.append(HConstants.CONFIGURATION).append(" => ");
1137        s.append('{');
1138        boolean printCommaForConfiguration = false;
1139        for (Map.Entry<String, String> e : configuration.entrySet()) {
1140          if (printCommaForConfiguration) {
1141            s.append(", ");
1142          }
1143          printCommaForConfiguration = true;
1144          s.append('\'').append(e.getKey()).append('\'');
1145          s.append(" => ");
1146          s.append('\'').append(PrettyPrinter.format(e.getValue(), getUnit(e.getKey()))).append('\'');
1147        }
1148        s.append("}");
1149      }
1150      return s;
1151    }
1152
1153    @Override
1154    public boolean equals(Object obj) {
1155      if (this == obj) {
1156        return true;
1157      }
1158      if (obj instanceof ModifyableColumnFamilyDescriptor) {
1159        return ColumnFamilyDescriptor.COMPARATOR.compare(this, (ModifyableColumnFamilyDescriptor) obj) == 0;
1160      }
1161      return false;
1162    }
1163
1164    @Override
1165    public int hashCode() {
1166      int result = Bytes.hashCode(name);
1167      result ^= (int) COLUMN_DESCRIPTOR_VERSION;
1168      result ^= values.hashCode();
1169      result ^= configuration.hashCode();
1170      return result;
1171    }
1172
1173    @Override
1174    public int compareTo(ModifyableColumnFamilyDescriptor other) {
1175      return COMPARATOR.compare(this, other);
1176    }
1177
1178    /**
1179     * @return This instance serialized with pb with pb magic prefix
1180     * @see #parseFrom(byte[])
1181     */
1182    private byte[] toByteArray() {
1183      return ProtobufUtil.prependPBMagic(ProtobufUtil.toColumnFamilySchema(this)
1184                      .toByteArray());
1185    }
1186
1187    /**
1188     * @param bytes A pb serialized {@link ModifyableColumnFamilyDescriptor} instance with pb
1189     * magic prefix
1190     * @return An instance of {@link ModifyableColumnFamilyDescriptor} made from
1191     * <code>bytes</code>
1192     * @throws DeserializationException
1193     * @see #toByteArray()
1194     */
1195    private static ColumnFamilyDescriptor parseFrom(final byte[] bytes) throws DeserializationException {
1196      if (!ProtobufUtil.isPBMagicPrefix(bytes)) {
1197        throw new DeserializationException("No magic");
1198      }
1199      int pblen = ProtobufUtil.lengthOfPBMagic();
1200      ColumnFamilySchema.Builder builder = ColumnFamilySchema.newBuilder();
1201      ColumnFamilySchema cfs = null;
1202      try {
1203        ProtobufUtil.mergeFrom(builder, bytes, pblen, bytes.length - pblen);
1204        cfs = builder.build();
1205      } catch (IOException e) {
1206        throw new DeserializationException(e);
1207      }
1208      return ProtobufUtil.toColumnFamilyDescriptor(cfs);
1209    }
1210
1211    @Override
1212    public String getConfigurationValue(String key) {
1213      return configuration.get(key);
1214    }
1215
1216    @Override
1217    public Map<String, String> getConfiguration() {
1218      // shallow pointer copy
1219      return Collections.unmodifiableMap(configuration);
1220    }
1221
1222    /**
1223     * Setter for storing a configuration setting in {@link #configuration} map.
1224     *
1225     * @param key Config key. Same as XML config key e.g.
1226     * hbase.something.or.other.
1227     * @param value String value. If null, removes the configuration.
1228     * @return this (for chained invocation)
1229     */
1230    public ModifyableColumnFamilyDescriptor setConfiguration(String key, String value) {
1231      if (value == null) {
1232        configuration.remove(key);
1233      } else {
1234        configuration.put(key, value);
1235      }
1236      return this;
1237    }
1238
1239    /**
1240     * Remove a configuration setting represented by the key from the
1241     * {@link #configuration} map.
1242     *
1243     * @param key
1244     * @return this (for chained invocation)
1245     */
1246    public ModifyableColumnFamilyDescriptor removeConfiguration(final String key) {
1247      return setConfiguration(key, null);
1248    }
1249
1250    @Override
1251    public String getEncryptionType() {
1252      return getStringOrDefault(ENCRYPTION_BYTES, Function.identity(), null);
1253    }
1254
1255    /**
1256     * Set the encryption algorithm for use with this family
1257     *
1258     * @param algorithm
1259     * @return this (for chained invocation)
1260     */
1261    public ModifyableColumnFamilyDescriptor setEncryptionType(String algorithm) {
1262      return setValue(ENCRYPTION_BYTES, algorithm);
1263    }
1264
1265    @Override
1266    public byte[] getEncryptionKey() {
1267      return getOrDefault(ENCRYPTION_KEY_BYTES, Bytes::copy, null);
1268    }
1269
1270    /**
1271     * Set the raw crypto key attribute for the family
1272     *
1273     * @param keyBytes
1274     * @return this (for chained invocation)
1275     */
1276    public ModifyableColumnFamilyDescriptor setEncryptionKey(byte[] keyBytes) {
1277      return setValue(ENCRYPTION_KEY_BYTES, new Bytes(keyBytes));
1278    }
1279
1280    @Override
1281    public long getMobThreshold() {
1282      return getStringOrDefault(MOB_THRESHOLD_BYTES, Long::valueOf, DEFAULT_MOB_THRESHOLD);
1283    }
1284
1285    /**
1286     * Sets the mob threshold of the family.
1287     *
1288     * @param threshold The mob threshold.
1289     * @return this (for chained invocation)
1290     */
1291    public ModifyableColumnFamilyDescriptor setMobThreshold(long threshold) {
1292      return setValue(MOB_THRESHOLD_BYTES, String.valueOf(threshold));
1293    }
1294
1295    @Override
1296    public boolean isMobEnabled() {
1297      return getStringOrDefault(IS_MOB_BYTES, Boolean::valueOf, DEFAULT_MOB);
1298    }
1299
1300    /**
1301     * Enables the mob for the family.
1302     *
1303     * @param isMobEnabled Whether to enable the mob for the family.
1304     * @return this (for chained invocation)
1305     */
1306    public ModifyableColumnFamilyDescriptor setMobEnabled(boolean isMobEnabled) {
1307      return setValue(IS_MOB_BYTES, String.valueOf(isMobEnabled));
1308    }
1309
1310    @Override
1311    public MobCompactPartitionPolicy getMobCompactPartitionPolicy() {
1312      return getStringOrDefault(MOB_COMPACT_PARTITION_POLICY_BYTES,
1313        n -> MobCompactPartitionPolicy.valueOf(n.toUpperCase()),
1314        DEFAULT_MOB_COMPACT_PARTITION_POLICY);
1315    }
1316
1317    /**
1318     * Set the mob compact partition policy for the family.
1319     *
1320     * @param policy policy type
1321     * @return this (for chained invocation)
1322     */
1323    public ModifyableColumnFamilyDescriptor setMobCompactPartitionPolicy(MobCompactPartitionPolicy policy) {
1324      return setValue(MOB_COMPACT_PARTITION_POLICY_BYTES, policy.name());
1325    }
1326
1327    @Override
1328    public short getDFSReplication() {
1329      return getStringOrDefault(DFS_REPLICATION_BYTES,
1330              Short::valueOf, DEFAULT_DFS_REPLICATION);
1331    }
1332
1333    /**
1334     * Set the replication factor to hfile(s) belonging to this family
1335     *
1336     * @param replication number of replicas the blocks(s) belonging to this CF
1337     * should have, or {@link #DEFAULT_DFS_REPLICATION} for the default
1338     * replication factor set in the filesystem
1339     * @return this (for chained invocation)
1340     */
1341    public ModifyableColumnFamilyDescriptor setDFSReplication(short replication) {
1342      if (replication < 1 && replication != DEFAULT_DFS_REPLICATION) {
1343        throw new IllegalArgumentException(
1344                "DFS replication factor cannot be less than 1 if explicitly set.");
1345      }
1346      return setValue(DFS_REPLICATION_BYTES, Short.toString(replication));
1347    }
1348
1349    @Override
1350    public String getStoragePolicy() {
1351      return getStringOrDefault(STORAGE_POLICY_BYTES, Function.identity(), null);
1352    }
1353
1354    /**
1355     * Set the storage policy for use with this family
1356     *
1357     * @param policy the policy to set, valid setting includes:
1358     * <i>"LAZY_PERSIST"</i>,
1359     * <i>"ALL_SSD"</i>, <i>"ONE_SSD"</i>, <i>"HOT"</i>, <i>"WARM"</i>,
1360     * <i>"COLD"</i>
1361     * @return this (for chained invocation)
1362     */
1363    public ModifyableColumnFamilyDescriptor setStoragePolicy(String policy) {
1364      return setValue(STORAGE_POLICY_BYTES, policy);
1365    }
1366
1367  }
1368}