org.apache.hadoop.hbase
Class HConstants

java.lang.Object
  extended by org.apache.hadoop.hbase.HConstants

public final class HConstants
extends Object

HConstants holds a bunch of HBase-related constants


Nested Class Summary
static class HConstants.Modify
          modifyTable op for replacing the table descriptor
static class HConstants.OperationStatusCode
          Status codes used for return values of bulk operations.
 
Field Summary
static int ALL_VERSIONS
          Define for 'return-all-versions'.
static byte[] CATALOG_FAMILY
          The catalog family
static String CATALOG_FAMILY_STR
          The catalog family as a string
static String CLUSTER_DISTRIBUTED
          Cluster is in distributed mode or not
static String CLUSTER_IS_DISTRIBUTED
          Cluster is fully-distributed
static String CLUSTER_IS_LOCAL
          Cluster is standalone or pseudo-distributed
static byte DEFAULT_CLUSTER_ID
          Default cluster ID, cannot be used to identify a cluster so a key with this value means it wasn't meant for replication.
static long DEFAULT_HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE
          Maximum number of bytes returned when calling a scanner's next method.
static long DEFAULT_HBASE_REGIONSERVER_LEASE_PERIOD
          Default value of HBASE_REGIONSERVER_LEASE_PERIOD_KEY.
static int DEFAULT_HBASE_RPC_TIMEOUT
          Default value of HBASE_RPC_TIMEOUT_KEY
static String DEFAULT_HOST
          default host address
static int DEFAULT_MASTER_INFOPORT
          default port for master web api
static int DEFAULT_MASTER_PORT
          default port that the master listens on
static boolean DEFAULT_MASTER_TYPE_BACKUP
          by default every master is a possible primary master unless the conf explicitly overrides it
static long DEFAULT_MAX_FILE_SIZE
          Default maximum file size
static String DEFAULT_REGION_SERVER_CLASS
          Default region server interface class name.
static int DEFAULT_REGIONSERVER_INFOPORT
          default port for region server web api
static int DEFAULT_REGIONSERVER_PORT
          Default port region server listens on.
static int DEFAULT_SIZE_RESERVATION_BLOCK
          Default size of a reservation block
static int DEFAULT_THREAD_WAKE_FREQUENCY
          Default value for thread wake frequency
static String DEFAULT_ZOOKEEPER_ZNODE_PARENT
           
static int DEFAULT_ZOOKEPER_CLIENT_PORT
          default client port that the zookeeper listens on
static byte[] EMPTY_BYTE_ARRAY
          An empty instance.
static byte[] EMPTY_END_ROW
          Last row in a table.
static byte[] EMPTY_START_ROW
          Used by scanners, etc when they want to start at the beginning of a region
static String FILE_SYSTEM_VERSION
          Current version of file system.
static int FOREVER
          Unlimited time-to-live.
static String HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE_KEY
          Parameter name for maximum number of bytes returned when calling a scanner's next method.
static float HBASE_CLUSTER_MINIMUM_MEMORY_THRESHOLD
           
static String HBASE_DIR
          Parameter name for HBase instance root directory
static String HBASE_MASTER_LOGCLEANER_PLUGINS
           
static String HBASE_REGIONSERVER_LEASE_PERIOD_KEY
          HRegion server lease period in milliseconds.
static String HBASE_RPC_TIMEOUT_KEY
          timeout for each RPC
static String HBCK_CODE_NAME
          HBCK special code name used as server name when manipulating ZK nodes
static String HREGION_COMPACTIONDIR_NAME
          Used to construct the name of the compaction directory during compaction
static String HREGION_LOGDIR_NAME
          Used to construct the name of the log directory for a region server Use '.' as a special character to seperate the log files from table data
static String HREGION_OLDLOGDIR_NAME
          Like the previous, but for old logs that are about to be deleted
static String IN_MEMORY
           
static byte[] LAST_ROW
          Used by scanners and others when they're trying to detect the end of a table
static long LATEST_TIMESTAMP
          Timestamp to use when we want to refer to the latest cell.
static byte[] LATEST_TIMESTAMP_BYTES
          LATEST_TIMESTAMP in bytes form
static String MAJOR_COMPACTION_PERIOD
          Parameter name for how often a region should should perform a major compaction
static String MASTER_IMPL
          Parameter name for what master implementation to use.
static String MASTER_PORT
          Parameter name for port master listens on.
static String MASTER_TYPE_BACKUP
          Parameter name for the master type being backup (waits for primary to go inactive).
static int MAX_ROW_LENGTH
          Max length a row can have because of the limitation in TFile.
static int MAXIMUM_VALUE_LENGTH
          Maximum value length, enforced on KeyValue construction
static int META_ROW_DELIMITER
          delimiter used between portions of a region name
static byte[] META_TABLE_NAME
          The META table's name.
static String NAME
           
static String NINES
           
static long OLDEST_TIMESTAMP
          Timestamp to use when we want to refer to the oldest cell.
static String REGION_IMPL
           
static String REGION_SERVER_CLASS
          Parameter name for what region server interface to use.
static String REGION_SERVER_IMPL
          Parameter name for what region server implementation to use.
static byte[] REGIONINFO_QUALIFIER
          The regioninfo column qualifier
static String REGIONSERVER_PORT
          Parameter name for port region server listens on.
static String REPLICATION_ENABLE_KEY
           
static int REPLICATION_SCOPE_GLOBAL
          Scope tag for globally scoped data.
static int REPLICATION_SCOPE_LOCAL
          Scope tag for locally scoped data.
static int[] RETRY_BACKOFF
          This is a retry backoff multiplier table similar to the BSD TCP syn backoff table, a bit more aggressive than simple exponential backoff.
static byte[] ROOT_TABLE_NAME
          The root table's name.
static byte[] SERVER_QUALIFIER
          The server column qualifier
static byte[] SPLITA_QUALIFIER
          The lower-half split region column qualifier
static byte[] SPLITB_QUALIFIER
          The upper-half split region column qualifier
static byte[] STARTCODE_QUALIFIER
          The startcode column qualifier
static String THREAD_WAKE_FREQUENCY
          Parameter name for how often threads should wake up
static String UTF8_ENCODING
          When we encode strings, we always specify UTF8 encoding
static String VERSION_FILE_NAME
          name of version file
static String VERSIONS
           
static int WEEK_IN_SECONDS
          Seconds in a week
static Long ZERO_L
          long constant for zero
static String ZEROES
           
static String ZOOKEEPER_CONFIG_NAME
          Name of ZooKeeper config file in conf/ directory.
static String ZOOKEEPER_QUORUM
          Name of ZooKeeper quorum configuration parameter.
static String ZOOKEEPER_ZNODE_PARENT
          Parameter name for the root dir in ZK for this cluster
 
Method Summary
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

ZERO_L

public static final Long ZERO_L
long constant for zero


NINES

public static final String NINES
See Also:
Constant Field Values

ZEROES

public static final String ZEROES
See Also:
Constant Field Values

VERSION_FILE_NAME

public static final String VERSION_FILE_NAME
name of version file

See Also:
Constant Field Values

FILE_SYSTEM_VERSION

public static final String FILE_SYSTEM_VERSION
Current version of file system. Version 4 supports only one kind of bloom filter. Version 5 changes versions in catalog table regions. Version 6 enables blockcaching on catalog tables. Version 7 introduces hfile -- hbase 0.19 to 0.20..

See Also:
Constant Field Values

CLUSTER_DISTRIBUTED

public static final String CLUSTER_DISTRIBUTED
Cluster is in distributed mode or not

See Also:
Constant Field Values

CLUSTER_IS_LOCAL

public static final String CLUSTER_IS_LOCAL
Cluster is standalone or pseudo-distributed

See Also:
Constant Field Values

CLUSTER_IS_DISTRIBUTED

public static final String CLUSTER_IS_DISTRIBUTED
Cluster is fully-distributed

See Also:
Constant Field Values

DEFAULT_HOST

public static final String DEFAULT_HOST
default host address

See Also:
Constant Field Values

MASTER_PORT

public static final String MASTER_PORT
Parameter name for port master listens on.

See Also:
Constant Field Values

DEFAULT_MASTER_PORT

public static final int DEFAULT_MASTER_PORT
default port that the master listens on

See Also:
Constant Field Values

DEFAULT_MASTER_INFOPORT

public static final int DEFAULT_MASTER_INFOPORT
default port for master web api

See Also:
Constant Field Values

MASTER_TYPE_BACKUP

public static final String MASTER_TYPE_BACKUP
Parameter name for the master type being backup (waits for primary to go inactive).

See Also:
Constant Field Values

DEFAULT_MASTER_TYPE_BACKUP

public static final boolean DEFAULT_MASTER_TYPE_BACKUP
by default every master is a possible primary master unless the conf explicitly overrides it

See Also:
Constant Field Values

ZOOKEEPER_QUORUM

public static final String ZOOKEEPER_QUORUM
Name of ZooKeeper quorum configuration parameter.

See Also:
Constant Field Values

ZOOKEEPER_CONFIG_NAME

public static final String ZOOKEEPER_CONFIG_NAME
Name of ZooKeeper config file in conf/ directory.

See Also:
Constant Field Values

DEFAULT_ZOOKEPER_CLIENT_PORT

public static final int DEFAULT_ZOOKEPER_CLIENT_PORT
default client port that the zookeeper listens on

See Also:
Constant Field Values

ZOOKEEPER_ZNODE_PARENT

public static final String ZOOKEEPER_ZNODE_PARENT
Parameter name for the root dir in ZK for this cluster

See Also:
Constant Field Values

DEFAULT_ZOOKEEPER_ZNODE_PARENT

public static final String DEFAULT_ZOOKEEPER_ZNODE_PARENT
See Also:
Constant Field Values

REGIONSERVER_PORT

public static final String REGIONSERVER_PORT
Parameter name for port region server listens on.

See Also:
Constant Field Values

DEFAULT_REGIONSERVER_PORT

public static final int DEFAULT_REGIONSERVER_PORT
Default port region server listens on.

See Also:
Constant Field Values

DEFAULT_REGIONSERVER_INFOPORT

public static final int DEFAULT_REGIONSERVER_INFOPORT
default port for region server web api

See Also:
Constant Field Values

REGION_SERVER_CLASS

public static final String REGION_SERVER_CLASS
Parameter name for what region server interface to use.

See Also:
Constant Field Values

REGION_SERVER_IMPL

public static final String REGION_SERVER_IMPL
Parameter name for what region server implementation to use.

See Also:
Constant Field Values

DEFAULT_REGION_SERVER_CLASS

public static final String DEFAULT_REGION_SERVER_CLASS
Default region server interface class name.


MASTER_IMPL

public static final String MASTER_IMPL
Parameter name for what master implementation to use.

See Also:
Constant Field Values

THREAD_WAKE_FREQUENCY

public static final String THREAD_WAKE_FREQUENCY
Parameter name for how often threads should wake up

See Also:
Constant Field Values

DEFAULT_THREAD_WAKE_FREQUENCY

public static final int DEFAULT_THREAD_WAKE_FREQUENCY
Default value for thread wake frequency

See Also:
Constant Field Values

MAJOR_COMPACTION_PERIOD

public static final String MAJOR_COMPACTION_PERIOD
Parameter name for how often a region should should perform a major compaction

See Also:
Constant Field Values

HBASE_DIR

public static final String HBASE_DIR
Parameter name for HBase instance root directory

See Also:
Constant Field Values

HREGION_LOGDIR_NAME

public static final String HREGION_LOGDIR_NAME
Used to construct the name of the log directory for a region server Use '.' as a special character to seperate the log files from table data

See Also:
Constant Field Values

HREGION_OLDLOGDIR_NAME

public static final String HREGION_OLDLOGDIR_NAME
Like the previous, but for old logs that are about to be deleted

See Also:
Constant Field Values

HREGION_COMPACTIONDIR_NAME

public static final String HREGION_COMPACTIONDIR_NAME
Used to construct the name of the compaction directory during compaction

See Also:
Constant Field Values

DEFAULT_MAX_FILE_SIZE

public static final long DEFAULT_MAX_FILE_SIZE
Default maximum file size

See Also:
Constant Field Values

DEFAULT_SIZE_RESERVATION_BLOCK

public static final int DEFAULT_SIZE_RESERVATION_BLOCK
Default size of a reservation block

See Also:
Constant Field Values

MAXIMUM_VALUE_LENGTH

public static final int MAXIMUM_VALUE_LENGTH
Maximum value length, enforced on KeyValue construction

See Also:
Constant Field Values

ROOT_TABLE_NAME

public static final byte[] ROOT_TABLE_NAME
The root table's name.


META_TABLE_NAME

public static final byte[] META_TABLE_NAME
The META table's name.


META_ROW_DELIMITER

public static final int META_ROW_DELIMITER
delimiter used between portions of a region name

See Also:
Constant Field Values

CATALOG_FAMILY_STR

public static final String CATALOG_FAMILY_STR
The catalog family as a string

See Also:
Constant Field Values

CATALOG_FAMILY

public static final byte[] CATALOG_FAMILY
The catalog family


REGIONINFO_QUALIFIER

public static final byte[] REGIONINFO_QUALIFIER
The regioninfo column qualifier


SERVER_QUALIFIER

public static final byte[] SERVER_QUALIFIER
The server column qualifier


STARTCODE_QUALIFIER

public static final byte[] STARTCODE_QUALIFIER
The startcode column qualifier


SPLITA_QUALIFIER

public static final byte[] SPLITA_QUALIFIER
The lower-half split region column qualifier


SPLITB_QUALIFIER

public static final byte[] SPLITB_QUALIFIER
The upper-half split region column qualifier


EMPTY_BYTE_ARRAY

public static final byte[] EMPTY_BYTE_ARRAY
An empty instance.


EMPTY_START_ROW

public static final byte[] EMPTY_START_ROW
Used by scanners, etc when they want to start at the beginning of a region


EMPTY_END_ROW

public static final byte[] EMPTY_END_ROW
Last row in a table.


LAST_ROW

public static final byte[] LAST_ROW
Used by scanners and others when they're trying to detect the end of a table


MAX_ROW_LENGTH

public static final int MAX_ROW_LENGTH
Max length a row can have because of the limitation in TFile.

See Also:
Constant Field Values

UTF8_ENCODING

public static final String UTF8_ENCODING
When we encode strings, we always specify UTF8 encoding

See Also:
Constant Field Values

LATEST_TIMESTAMP

public static final long LATEST_TIMESTAMP
Timestamp to use when we want to refer to the latest cell. This is the timestamp sent by clients when no timestamp is specified on commit.

See Also:
Constant Field Values

OLDEST_TIMESTAMP

public static final long OLDEST_TIMESTAMP
Timestamp to use when we want to refer to the oldest cell.

See Also:
Constant Field Values

LATEST_TIMESTAMP_BYTES

public static final byte[] LATEST_TIMESTAMP_BYTES
LATEST_TIMESTAMP in bytes form


ALL_VERSIONS

public static final int ALL_VERSIONS
Define for 'return-all-versions'.

See Also:
Constant Field Values

FOREVER

public static final int FOREVER
Unlimited time-to-live.

See Also:
Constant Field Values

WEEK_IN_SECONDS

public static final int WEEK_IN_SECONDS
Seconds in a week

See Also:
Constant Field Values

NAME

public static final String NAME
See Also:
Constant Field Values

VERSIONS

public static final String VERSIONS
See Also:
Constant Field Values

IN_MEMORY

public static final String IN_MEMORY
See Also:
Constant Field Values

RETRY_BACKOFF

public static int[] RETRY_BACKOFF
This is a retry backoff multiplier table similar to the BSD TCP syn backoff table, a bit more aggressive than simple exponential backoff.


REGION_IMPL

public static final String REGION_IMPL
See Also:
Constant Field Values

REPLICATION_SCOPE_LOCAL

public static final int REPLICATION_SCOPE_LOCAL
Scope tag for locally scoped data. This data will not be replicated.

See Also:
Constant Field Values

REPLICATION_SCOPE_GLOBAL

public static final int REPLICATION_SCOPE_GLOBAL
Scope tag for globally scoped data. This data will be replicated to all peers.

See Also:
Constant Field Values

DEFAULT_CLUSTER_ID

public static final byte DEFAULT_CLUSTER_ID
Default cluster ID, cannot be used to identify a cluster so a key with this value means it wasn't meant for replication.

See Also:
Constant Field Values

HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE_KEY

public static String HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE_KEY
Parameter name for maximum number of bytes returned when calling a scanner's next method.


DEFAULT_HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE

public static long DEFAULT_HBASE_CLIENT_SCANNER_MAX_RESULT_SIZE
Maximum number of bytes returned when calling a scanner's next method. Note that when a single row is larger than this limit the row is still returned completely. The default value is unlimited.


HBASE_REGIONSERVER_LEASE_PERIOD_KEY

public static String HBASE_REGIONSERVER_LEASE_PERIOD_KEY
HRegion server lease period in milliseconds. Clients must report in within this period else they are considered dead. Unit measured in ms (milliseconds).


DEFAULT_HBASE_REGIONSERVER_LEASE_PERIOD

public static long DEFAULT_HBASE_REGIONSERVER_LEASE_PERIOD
Default value of HBASE_REGIONSERVER_LEASE_PERIOD_KEY.


HBASE_RPC_TIMEOUT_KEY

public static String HBASE_RPC_TIMEOUT_KEY
timeout for each RPC


DEFAULT_HBASE_RPC_TIMEOUT

public static int DEFAULT_HBASE_RPC_TIMEOUT
Default value of HBASE_RPC_TIMEOUT_KEY


REPLICATION_ENABLE_KEY

public static final String REPLICATION_ENABLE_KEY
See Also:
Constant Field Values

HBCK_CODE_NAME

public static final String HBCK_CODE_NAME
HBCK special code name used as server name when manipulating ZK nodes

See Also:
Constant Field Values

HBASE_MASTER_LOGCLEANER_PLUGINS

public static final String HBASE_MASTER_LOGCLEANER_PLUGINS
See Also:
Constant Field Values

HBASE_CLUSTER_MINIMUM_MEMORY_THRESHOLD

public static final float HBASE_CLUSTER_MINIMUM_MEMORY_THRESHOLD
See Also:
Constant Field Values


Copyright © 2011 The Apache Software Foundation. All Rights Reserved.