Uses of Interface
org.apache.hadoop.hbase.client.ColumnFamilyDescriptor
Package
Description
Provides HBase Client
Provides implementations of
HFile
and HFile
BlockCache
.Provides HBase MapReduce
Input/OutputFormats, a table indexing MapReduce job, and utility methods.
Provides an HBase Thrift
service.
Provides an HBase Thrift
service.
-
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase
Modifier and TypeMethodDescriptionstatic List<ColumnFamilyDescriptor>
HBaseTestingUtility.generateColumnDescriptors()
Deprecated.Create a set of column descriptors with the combination of compression, encoding, bloom codecs available.static List<ColumnFamilyDescriptor>
HBaseTestingUtility.generateColumnDescriptors
(String prefix) Deprecated.Create a set of column descriptors with the combination of compression, encoding, bloom codecs available.Modifier and TypeMethodDescriptionstatic int
HBaseTestingUtility.createPreSplitLoadTestTable
(org.apache.hadoop.conf.Configuration conf, TableDescriptor desc, ColumnFamilyDescriptor hcd) Deprecated.Creates a pre-split table for load testing.static int
HBaseTestingUtility.createPreSplitLoadTestTable
(org.apache.hadoop.conf.Configuration conf, TableDescriptor desc, ColumnFamilyDescriptor[] hcds, int numRegionsPerServer) Deprecated.Creates a pre-split table for load testing.static int
HBaseTestingUtility.createPreSplitLoadTestTable
(org.apache.hadoop.conf.Configuration conf, TableDescriptor td, ColumnFamilyDescriptor[] cds, RegionSplitter.SplitAlgorithm splitter, int numRegionsPerServer) Deprecated.Creates a pre-split table for load testing.static int
HBaseTestingUtility.createPreSplitLoadTestTable
(org.apache.hadoop.conf.Configuration conf, TableDescriptor desc, ColumnFamilyDescriptor hcd, int numRegionsPerServer) Deprecated.Creates a pre-split table for load testing.HBaseTestingUtility.createTestRegion
(String tableName, ColumnFamilyDescriptor cd) Deprecated.HBaseTestingUtility.createTestRegion
(String tableName, ColumnFamilyDescriptor cd, BlockCache blockCache) Deprecated. -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.backup.impl
Modifier and TypeMethodDescriptionColumnFamilyMismatchException.ColumnFamilyMismatchExceptionBuilder.addMismatchedTable
(TableName tableName, ColumnFamilyDescriptor[] currentCfs, ColumnFamilyDescriptor[] backupCfs) private static boolean
IncrementalTableBackupClient.areCfsCompatible
(ColumnFamilyDescriptor[] currentCfs, ColumnFamilyDescriptor[] backupCfs) -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.client
Modifier and TypeClassDescriptionprivate static final class
An ModifyableFamilyDescriptor contains information about a column family such as the number of versions, compression settings, etc.Modifier and TypeFieldDescriptionstatic final Comparator<ColumnFamilyDescriptor>
ColumnFamilyDescriptor.COMPARATOR
static final Comparator<ColumnFamilyDescriptor>
ColumnFamilyDescriptor.COMPARATOR_IGNORE_REPLICATION
private final Map<byte[],
ColumnFamilyDescriptor> TableDescriptorBuilder.ModifyableTableDescriptor.families
Maps column family name to the respective FamilyDescriptorsModifier and TypeMethodDescriptionColumnFamilyDescriptorBuilder.build()
static ColumnFamilyDescriptor
ColumnFamilyDescriptorBuilder.copy
(ColumnFamilyDescriptor desc) TableDescriptor.getColumnFamilies()
Returns an unmodifiable collection of all theColumnFamilyDescriptor
of all the column families of the table.TableDescriptorBuilder.ModifyableTableDescriptor.getColumnFamilies()
TableDescriptor.getColumnFamily
(byte[] name) Returns the ColumnDescriptor for a specific column family with name as specified by the parameter column.TableDescriptorBuilder.ModifyableTableDescriptor.getColumnFamily
(byte[] column) Returns the ColumnFamilyDescriptor for a specific column family with name as specified by the parameter column.static ColumnFamilyDescriptor
ColumnFamilyDescriptorBuilder.of
(byte[] name) static ColumnFamilyDescriptor
private static ColumnFamilyDescriptor
ColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor.parseFrom
(byte[] bytes) Parse the serialized representation of aColumnFamilyDescriptorBuilder.ModifyableColumnFamilyDescriptor
static ColumnFamilyDescriptor
ColumnFamilyDescriptorBuilder.parseFrom
(byte[] pbBytes) TableDescriptorBuilder.ModifyableTableDescriptor.removeColumnFamily
(byte[] column) Removes the ColumnFamilyDescriptor with name specified by the parameter column from the table descriptorModifier and TypeMethodDescriptiondefault void
Admin.addColumnFamily
(TableName tableName, ColumnFamilyDescriptor columnFamily) Add a column family to an existing table.AsyncAdmin.addColumnFamily
(TableName tableName, ColumnFamilyDescriptor columnFamily) Add a column family to an existing table.AsyncHBaseAdmin.addColumnFamily
(TableName tableName, ColumnFamilyDescriptor columnFamily) RawAsyncHBaseAdmin.addColumnFamily
(TableName tableName, ColumnFamilyDescriptor columnFamily) Admin.addColumnFamilyAsync
(TableName tableName, ColumnFamilyDescriptor columnFamily) Add a column family to an existing table.AdminOverAsyncAdmin.addColumnFamilyAsync
(TableName tableName, ColumnFamilyDescriptor columnFamily) static ColumnFamilyDescriptor
ColumnFamilyDescriptorBuilder.copy
(ColumnFamilyDescriptor desc) default void
Admin.modifyColumnFamily
(TableName tableName, ColumnFamilyDescriptor columnFamily) Modify an existing column family on a table.AsyncAdmin.modifyColumnFamily
(TableName tableName, ColumnFamilyDescriptor columnFamily) Modify an existing column family on a table.AsyncHBaseAdmin.modifyColumnFamily
(TableName tableName, ColumnFamilyDescriptor columnFamily) RawAsyncHBaseAdmin.modifyColumnFamily
(TableName tableName, ColumnFamilyDescriptor columnFamily) TableDescriptorBuilder.ModifyableTableDescriptor.modifyColumnFamily
(ColumnFamilyDescriptor family) Modifies the existing column family.TableDescriptorBuilder.modifyColumnFamily
(ColumnFamilyDescriptor family) Admin.modifyColumnFamilyAsync
(TableName tableName, ColumnFamilyDescriptor columnFamily) Modify an existing column family on a table.AdminOverAsyncAdmin.modifyColumnFamilyAsync
(TableName tableName, ColumnFamilyDescriptor columnFamily) ColumnFamilyDescriptorBuilder.newBuilder
(ColumnFamilyDescriptor desc) TableDescriptorBuilder.ModifyableTableDescriptor.putColumnFamily
(ColumnFamilyDescriptor family) TableDescriptorBuilder.ModifyableTableDescriptor.setColumnFamily
(ColumnFamilyDescriptor family) Adds a column family.TableDescriptorBuilder.setColumnFamily
(ColumnFamilyDescriptor family) static byte[]
ColumnFamilyDescriptorBuilder.toByteArray
(ColumnFamilyDescriptor desc) Serialize the table descriptor to a byte array.Modifier and TypeMethodDescriptionstatic Comparator<TableDescriptor>
TableDescriptor.getComparator
(Comparator<ColumnFamilyDescriptor> cfComparator) TableDescriptorBuilder.setColumnFamilies
(Collection<ColumnFamilyDescriptor> families) ModifierConstructorDescriptionprivate
Constructor.ModifierConstructorDescriptionprivate
ModifyableTableDescriptor
(TableName name, Collection<ColumnFamilyDescriptor> families, Map<Bytes, Bytes> values) -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.io.hfile
ModifierConstructorDescriptionCacheConfig
(org.apache.hadoop.conf.Configuration conf, ColumnFamilyDescriptor family, BlockCache blockCache, ByteBuffAllocator byteBuffAllocator) Create a cache configuration using the specified configuration object and family descriptor. -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.mapreduce
Modifier and TypeFieldDescription(package private) static Function<ColumnFamilyDescriptor,
String> HFileOutputFormat2.blockSizeDetails
Serialize column family to block size map to configuration.(package private) static Function<ColumnFamilyDescriptor,
String> HFileOutputFormat2.bloomParamDetails
Serialize column family to bloom param map to configuration.(package private) static Function<ColumnFamilyDescriptor,
String> HFileOutputFormat2.bloomTypeDetails
Serialize column family to bloom type map to configuration.(package private) static Function<ColumnFamilyDescriptor,
String> HFileOutputFormat2.compressionDetails
Serialize column family to compression algorithm map to configuration.(package private) static Function<ColumnFamilyDescriptor,
String> HFileOutputFormat2.dataBlockEncodingDetails
Serialize column family to data block encoding map to configuration.Modifier and TypeMethodDescription(package private) static String
HFileOutputFormat2.serializeColumnFamilyAttribute
(Function<ColumnFamilyDescriptor, String> fn, List<TableDescriptor> allTables) -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.master
Modifier and TypeMethodDescriptionlong
HMaster.addColumn
(TableName tableName, ColumnFamilyDescriptor column, long nonceGroup, long nonce) long
MasterServices.addColumn
(TableName tableName, ColumnFamilyDescriptor column, long nonceGroup, long nonce) Add a new column to an existing tablelong
HMaster.modifyColumn
(TableName tableName, ColumnFamilyDescriptor descriptor, long nonceGroup, long nonce) long
MasterServices.modifyColumn
(TableName tableName, ColumnFamilyDescriptor descriptor, long nonceGroup, long nonce) Modify the column descriptor of an existing column in an existing table -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.mob
Modifier and TypeMethodDescriptionstatic List<ColumnFamilyDescriptor>
MobUtils.getMobColumnFamilies
(TableDescriptor htd) Get list of Mob column families (if any exists)Modifier and TypeMethodDescriptionprivate static void
MobFileCleanupUtil.checkColumnFamilyDescriptor
(org.apache.hadoop.conf.Configuration conf, TableName table, org.apache.hadoop.fs.FileSystem fs, Admin admin, ColumnFamilyDescriptor hcd, Set<String> regionNames, long maxCreationTimeToArchive) void
ExpiredMobFileCleaner.cleanExpiredMobFiles
(TableDescriptor htd, ColumnFamilyDescriptor family) Cleans the MOB files when they're expired and their min versions are 0.static void
MobUtils.cleanExpiredMobFiles
(org.apache.hadoop.fs.FileSystem fs, org.apache.hadoop.conf.Configuration conf, TableDescriptor htd, ColumnFamilyDescriptor columnDescriptor, CacheConfig cacheConfig, long current) Cleans the expired mob files.static StoreFileWriter
MobUtils.createWriter
(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, ColumnFamilyDescriptor family, String date, org.apache.hadoop.fs.Path basePath, long maxKeyCount, Compression.Algorithm compression, String startKey, CacheConfig cacheConfig, Encryption.Context cryptoContext, boolean isCompaction, String regionName) Creates a writer for the mob file in temp directory.static StoreFileWriter
MobUtils.createWriter
(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, ColumnFamilyDescriptor family, org.apache.hadoop.fs.Path path, long maxKeyCount, Compression.Algorithm compression, CacheConfig cacheConfig, Encryption.Context cryptoContext, ChecksumType checksumType, int bytesPerChecksum, int blocksize, BloomType bloomType, boolean isCompaction) Creates a writer for the mob file in temp directory.static StoreFileWriter
MobUtils.createWriter
(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, ColumnFamilyDescriptor family, org.apache.hadoop.fs.Path path, long maxKeyCount, Compression.Algorithm compression, CacheConfig cacheConfig, Encryption.Context cryptoContext, ChecksumType checksumType, int bytesPerChecksum, int blocksize, BloomType bloomType, boolean isCompaction, Consumer<org.apache.hadoop.fs.Path> writerCreationTracker) Creates a writer for the mob file in temp directory.static StoreFileWriter
MobUtils.createWriter
(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.FileSystem fs, ColumnFamilyDescriptor family, MobFileName mobFileName, org.apache.hadoop.fs.Path basePath, long maxKeyCount, Compression.Algorithm compression, CacheConfig cacheConfig, Encryption.Context cryptoContext, boolean isCompaction) Creates a writer for the mob file in temp directory.static boolean
MobUtils.isMobFileExpired
(ColumnFamilyDescriptor column, long current, String fileDate) Checks if the mob file is expired.void
MobFileCompactionChore.performMajorCompactionInBatches
(Admin admin, TableDescriptor htd, ColumnFamilyDescriptor hcd) -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.regionserver
Modifier and TypeFieldDescriptionprivate ColumnFamilyDescriptor
StoreContext.Builder.family
private final ColumnFamilyDescriptor
StoreContext.family
Modifier and TypeMethodDescriptionHStore.getColumnFamilyDescriptor()
Store.getColumnFamilyDescriptor()
StoreContext.getFamily()
Modifier and TypeMethodDescriptionprotected CacheConfig
HStore.createCacheConf
(ColumnFamilyDescriptor family) Creates the cache config.static org.apache.hadoop.conf.Configuration
StoreUtils.createStoreConfiguration
(org.apache.hadoop.conf.Configuration conf, TableDescriptor td, ColumnFamilyDescriptor cfd) static long
HStore.determineTTLFromFamily
(ColumnFamilyDescriptor family) Returns TTL in seconds of the specified familyprivate StoreContext
HStore.initializeStoreContext
(ColumnFamilyDescriptor family) protected HStore
HRegion.instantiateHStore
(ColumnFamilyDescriptor family, boolean warmup) StoreContext.Builder.withColumnFamilyDescriptor
(ColumnFamilyDescriptor family) ModifierConstructorDescriptionHMobStore
(HRegion region, ColumnFamilyDescriptor family, org.apache.hadoop.conf.Configuration confParam, boolean warmup) protected
HStore
(HRegion region, ColumnFamilyDescriptor family, org.apache.hadoop.conf.Configuration confParam, boolean warmup) ConstructorScanInfo
(org.apache.hadoop.conf.Configuration conf, ColumnFamilyDescriptor family, long ttl, long timeToPurgeDeletes, CellComparator comparator) -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.regionserver.storefiletracker
Modifier and TypeMethodDescriptionprivate static void
StoreFileTrackerValidationUtils.checkForNewFamily
(org.apache.hadoop.conf.Configuration conf, TableDescriptor table, ColumnFamilyDescriptor family) static StoreFileTracker
StoreFileTrackerFactory.create
(org.apache.hadoop.conf.Configuration conf, TableDescriptor td, ColumnFamilyDescriptor cfd, HRegionFileSystem regionFs) Used at master side when splitting/merging regions, as we do not have a Store, thus no StoreContext at master side.static StoreFileTracker
StoreFileTrackerFactory.create
(org.apache.hadoop.conf.Configuration conf, TableDescriptor td, ColumnFamilyDescriptor cfd, HRegionFileSystem regionFs, boolean isPrimaryReplica) private static org.apache.hadoop.conf.Configuration
StoreFileTrackerFactory.mergeConfigurations
(org.apache.hadoop.conf.Configuration global, TableDescriptor table, ColumnFamilyDescriptor family) -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.security
Modifier and TypeMethodDescriptionstatic Encryption.Context
EncryptionUtil.createEncryptionContext
(org.apache.hadoop.conf.Configuration conf, ColumnFamilyDescriptor family) Helper to create an encyption context. -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.snapshot
Modifier and TypeMethodDescriptionprivate List<StoreFileInfo>
SnapshotManifest.getStoreFiles
(org.apache.hadoop.fs.Path storePath, TableDescriptor htd, ColumnFamilyDescriptor hcd, RegionInfo regionInfo) -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.thrift
Modifier and TypeMethodDescriptionstatic ColumnFamilyDescriptor
ThriftUtilities.colDescFromThrift
(org.apache.hadoop.hbase.thrift.generated.ColumnDescriptor in) This utility method creates a new Hbase HColumnDescriptor object based on a Thrift ColumnDescriptor "struct".Modifier and TypeMethodDescriptionstatic org.apache.hadoop.hbase.thrift.generated.ColumnDescriptor
ThriftUtilities.colDescFromHbase
(ColumnFamilyDescriptor in) This utility method creates a new Thrift ColumnDescriptor "struct" based on an Hbase HColumnDescriptor object. -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.thrift2
Modifier and TypeMethodDescriptionstatic ColumnFamilyDescriptor
ThriftUtilities.columnFamilyDescriptorFromThrift
(org.apache.hadoop.hbase.thrift2.generated.TColumnFamilyDescriptor in) Modifier and TypeMethodDescriptionstatic org.apache.hadoop.hbase.thrift2.generated.TColumnFamilyDescriptor
ThriftUtilities.columnFamilyDescriptorFromHBase
(ColumnFamilyDescriptor in) -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.thrift2.client
Modifier and TypeMethodDescriptionvoid
ThriftAdmin.addColumnFamily
(TableName tableName, ColumnFamilyDescriptor columnFamily) ThriftAdmin.addColumnFamilyAsync
(TableName tableName, ColumnFamilyDescriptor columnFamily) void
ThriftAdmin.modifyColumnFamily
(TableName tableName, ColumnFamilyDescriptor columnFamily) ThriftAdmin.modifyColumnFamilyAsync
(TableName tableName, ColumnFamilyDescriptor columnFamily) -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.tool
Modifier and TypeFieldDescriptionprivate ColumnFamilyDescriptor
CanaryTool.RegionTaskResult.column
Modifier and TypeMethodDescriptionCanaryTool.RegionTaskResult.getColumnFamily()
private ColumnFamilyDescriptor
CanaryTool.RegionTask.randomPickOneColumnFamily
(ColumnFamilyDescriptor[] cfs) Modifier and TypeMethodDescriptionprivate static void
BulkLoadHFilesTool.copyHFileHalf
(org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.Path inFile, org.apache.hadoop.fs.Path outFile, Reference reference, ColumnFamilyDescriptor familyDescriptor, AsyncTableRegionLocator loc) Copy half of an HFile into a new HFile with favored nodes.void
CanaryTool.RegionStdOutSink.publishReadFailure
(ServerName serverName, RegionInfo region, ColumnFamilyDescriptor column, Exception e) void
CanaryTool.RegionStdOutSink.publishReadTiming
(ServerName serverName, RegionInfo region, ColumnFamilyDescriptor column, long msTime) void
CanaryTool.RegionStdOutSink.publishWriteFailure
(ServerName serverName, RegionInfo region, ColumnFamilyDescriptor column, Exception e) void
CanaryTool.RegionStdOutSink.publishWriteTiming
(ServerName serverName, RegionInfo region, ColumnFamilyDescriptor column, long msTime) private ColumnFamilyDescriptor
CanaryTool.RegionTask.randomPickOneColumnFamily
(ColumnFamilyDescriptor[] cfs) private Void
CanaryTool.RegionTask.readColumnFamily
(Table table, ColumnFamilyDescriptor column) (package private) static void
BulkLoadHFilesTool.splitStoreFile
(AsyncTableRegionLocator loc, org.apache.hadoop.conf.Configuration conf, org.apache.hadoop.fs.Path inFile, ColumnFamilyDescriptor familyDesc, byte[] splitKey, org.apache.hadoop.fs.Path bottomOut, org.apache.hadoop.fs.Path topOut) Split a storefile into a top and bottom half with favored nodes, maintaining the metadata, recreating bloom filters, etc.ModifierConstructorDescriptionRegionTaskResult
(RegionInfo region, TableName tableName, ServerName serverName, ColumnFamilyDescriptor column) -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.util
Modifier and TypeMethodDescriptionstatic ColumnFamilyDescriptor
FSTableDescriptors.getNamespaceFamilyDescForMeta
(org.apache.hadoop.conf.Configuration conf) static ColumnFamilyDescriptor
FSTableDescriptors.getReplBarrierFamilyDescForMeta()
static ColumnFamilyDescriptor
FSTableDescriptors.getTableFamilyDescForMeta
(org.apache.hadoop.conf.Configuration conf) Modifier and TypeMethodDescriptionstatic int
LoadTestUtil.createPreSplitLoadTestTable
(org.apache.hadoop.conf.Configuration conf, TableDescriptor desc, ColumnFamilyDescriptor hcd) Creates a pre-split table for load testing.static int
LoadTestUtil.createPreSplitLoadTestTable
(org.apache.hadoop.conf.Configuration conf, TableDescriptor desc, ColumnFamilyDescriptor[] hcds, int numRegionsPerServer) Creates a pre-split table for load testing.static int
LoadTestUtil.createPreSplitLoadTestTable
(org.apache.hadoop.conf.Configuration conf, TableDescriptor td, ColumnFamilyDescriptor[] cds, RegionSplitter.SplitAlgorithm splitter, int numRegionsPerServer) Creates a pre-split table for load testing.static int
LoadTestUtil.createPreSplitLoadTestTable
(org.apache.hadoop.conf.Configuration conf, TableDescriptor desc, ColumnFamilyDescriptor hcd, int numRegionsPerServer) Creates a pre-split table for load testing. -
Uses of ColumnFamilyDescriptor in org.apache.hadoop.hbase.util.compaction
Modifier and TypeMethodDescriptionprivate long
MajorCompactionTTLRequest.getColFamilyCutoffTime
(ColumnFamilyDescriptor colDesc)