Default package
Get desktop application:
View/edit binary Protocol Buffers messages
rpc Grant (, )
AccessControl.proto:111message
AccessControl.proto:79required user_permission = 1
message
AccessControl.proto:83(message has no fields)
rpc Revoke (, )
AccessControl.proto:114message
AccessControl.proto:86required user_permission = 1
message
AccessControl.proto:90(message has no fields)
message
AccessControl.proto:93optional Permission.Type type = 1
optional table_name = 2
optional bytes namespace_name = 3
message
AccessControl.proto:99repeated user_permission = 1
message
AccessControl.proto:103repeated permission = 1
message
AccessControl.proto:107(message has no fields)
service AdminService
Admin.proto:225rpc GetRegionInfo (, )
Admin.proto:226message
Admin.proto:31required region = 1
optional bool compaction_state = 2
message
Admin.proto:36required region_info = 1
optional GetRegionInfoResponse.CompactionState compaction_state = 2
optional bool isRecovering = 3
rpc GetStoreFile (, )
Admin.proto:229message
Admin.proto:53* Get a list of store files for a set of column families in a particular region. If no column family is specified, get the store files for all column families.
required region = 1
repeated bytes family = 2
message
Admin.proto:58repeated string store_file = 1
rpc GetOnlineRegion (, )
Admin.proto:232message
Admin.proto:62(message has no fields)
message
Admin.proto:65repeated region_info = 1
rpc OpenRegion (, )
Admin.proto:235message
Admin.proto:69repeated open_info = 1
message
Admin.proto:79repeated OpenRegionResponse.RegionOpeningState opening_state = 1
rpc CloseRegion (, )
Admin.proto:238message
Admin.proto:93* Closes the specified region and will use or not use ZK during the close according to the specified flag.
required region = 1
optional uint32 version_of_closing_node = 2
optional bool transition_in_ZK = 3
optional destination_server = 4
message
Admin.proto:100required bool closed = 1
rpc FlushRegion (, )
Admin.proto:241message
Admin.proto:109* Flushes the MemStore of the specified region. <p> This method is synchronous.
required region = 1
optional uint64 if_older_than_ts = 2
message
Admin.proto:114required uint64 last_flush_time = 1
optional bool flushed = 2
rpc SplitRegion (, )
Admin.proto:244message
Admin.proto:126* Splits the specified region. <p> This method currently flushes the region and then forces a compaction which will then trigger a split. The flush is done synchronously but the compaction is asynchronous.
required region = 1
optional bytes split_point = 2
message
Admin.proto:131(message has no fields)
rpc CompactRegion (, )
Admin.proto:247message
Admin.proto:139* Compacts the specified region. Performs a major compaction if specified. <p> This method is asynchronous.
required region = 1
optional bool major = 2
optional bytes family = 3
message
Admin.proto:145(message has no fields)
rpc MergeRegions (, )
Admin.proto:250message
Admin.proto:166* Merges the specified regions. <p> This method currently closes the regions and then merges them
required region_a = 1
required region_b = 2
optional bool forcible = 3
message
Admin.proto:172(message has no fields)
rpc ReplicateWALEntry (, )
Admin.proto:253rpc Replay (, )
Admin.proto:256rpc RollWALWriter (, )
Admin.proto:259message
Admin.proto:198(message has no fields)
message
Admin.proto:201repeated bytes region_to_flush = 1
A list of encoded name of regions to flush
rpc GetServerInfo (, )
Admin.proto:262message
Admin.proto:213(message has no fields)
message
Admin.proto:221required server_info = 1
rpc StopServer (, )
Admin.proto:265message
Admin.proto:206required string reason = 1
message
Admin.proto:210(message has no fields)
rpc UpdateFavoredNodes (, )
Admin.proto:268message
Admin.proto:148repeated update_info = 1
message
Admin.proto:157optional uint32 response = 1
* Refer to the AggregateImplementation class for an overview of the AggregateService method implementations and their functionality.
rpc GetMax (, )
Aggregate.proto:55rpc GetMin (, )
Aggregate.proto:56rpc GetSum (, )
Aggregate.proto:57rpc GetRowNum (, )
Aggregate.proto:58rpc GetAvg (, )
Aggregate.proto:59rpc GetStd (, )
Aggregate.proto:60rpc GetMedian (, )
Aggregate.proto:61
RPC service
message
Authentication.proto:58RPC request & response messages
(message has no fields)
message
Authentication.proto:61optional token = 1
rpc WhoAmI (, )
Authentication.proto:79message
Authentication.proto:65(message has no fields)
message
Authentication.proto:68optional string username = 1
optional string auth_method = 2
service ClientService
Client.proto:354rpc Get (, )
Client.proto:355message
Client.proto:86* The get request. Perform a single Get operation.
required region = 1
required gxt = 2
message
Client.proto:91optional result = 1
rpc Mutate (, )
Client.proto:358message
Client.proto:180* The mutate request. Perform a single Mutate operation. Optionally, you can specify a condition. The mutate will take place only if the condition is met. Otherwise, the mutate will be ignored. In the response result, parameter processed is used to indicate if the mutate actually happened.
required region = 1
required mutation = 2
optional condition = 3
message
Client.proto:186optional result = 1
optional bool processed = 2
used for mutate to indicate processed only
rpc Scan (, )
Client.proto:361message
Client.proto:230* A scan request. Initially, it should specify a scan. Later on, you can use the scanner id returned to fetch result batches with a different scan request. The scanner will remain open if there are more results, and it's not asked to be closed explicitly. You can fetch the results and ask the scanner to be closed to save a trip if you are not interested in remaining results.
optional region = 1
optional scan = 2
optional uint64 scanner_id = 3
optional uint32 number_of_rows = 4
optional bool close_scanner = 5
optional uint64 next_call_seq = 6
message
Client.proto:243* The scan response. If there are no more results, more_results will be false. If it is not specified, it means there are more.
repeated uint32 cells_per_result = 1
This field is filled in if we are doing cellblocks. A cellblock is made up of all Cells serialized out as one cellblock BUT responses from a server have their Cells grouped by Result. So we can reconstitute the Results on the client-side, this field is a list of counts of Cells in each Result that makes up the response. For example, if this field has 3, 3, 3 in it, then we know that on the client, we are to make three Results each of three Cells each.
optional uint64 scanner_id = 2
optional bool more_results = 3
optional uint32 ttl = 4
repeated results = 5
If cells are not carried in an accompanying cellblock, then they are pb'd here. This field is mutually exclusive with cells_per_result (since the Cells will be inside the pb'd Result)
rpc BulkLoadHFile (, )
Client.proto:364message
Client.proto:265* Atomically bulk load multiple HFiles (say from different column families) into an open region.
required region = 1
repeated family_path = 2
optional bool assign_seq_num = 3
message
Client.proto:276required bool loaded = 1
rpc ExecService (, )
Client.proto:367rpc Multi (, )
Client.proto:370message
Client.proto:345* Execute a list of actions on a given region in order. Nothing prevents a request to contains a set of RegionAction on the same region. For this reason, the matching between the MultiRequest and the MultiResponse is not done by the region specifier but by keeping the order of the RegionActionResult vs. the order of the RegionAction.
repeated regionAction = 1
message
Client.proto:349repeated regionActionResult = 1
service MasterService
Master.proto:335rpc GetSchemaAlterStatus (, )
Master.proto:337* Used by the client to get the number of regions that have received the updated schema
message
Master.proto:297required table_name = 1
message
Master.proto:301optional uint32 yet_to_update_regions = 1
optional uint32 total_regions = 2
rpc GetTableDescriptors (, )
Master.proto:341* Get list of TableDescriptors for requested tables.
message
Master.proto:306repeated table_names = 1
message
Master.proto:310repeated table_schema = 1
rpc GetTableNames (, )
Master.proto:345* Get the list of table names.
message
Master.proto:314(message has no fields)
message
Master.proto:317repeated table_names = 1
rpc GetClusterStatus (, )
Master.proto:349* Return cluster status.
message
Master.proto:321(message has no fields)
message
Master.proto:324required cluster_status = 1
rpc IsMasterRunning (, )
Master.proto:353* return true if master is available
message
Master.proto:328(message has no fields)
message
Master.proto:331required bool is_master_running = 1
rpc AddColumn (, )
Master.proto:356* Adds a column to the specified table.
message
Master.proto:34required table_name = 1
required column_families = 2
message
Master.proto:39(message has no fields)
rpc DeleteColumn (, )
Master.proto:360* Deletes a column from the specified table. Table must be disabled.
message
Master.proto:42required table_name = 1
required bytes column_name = 2
message
Master.proto:47(message has no fields)
rpc ModifyColumn (, )
Master.proto:364* Modifies an existing column on the specified table.
message
Master.proto:50required table_name = 1
required column_families = 2
message
Master.proto:55(message has no fields)
rpc MoveRegion (, )
Master.proto:368* Move the region region to the destination server.
message
Master.proto:60required region = 1
optional dest_server_name = 2
message
Master.proto:65(message has no fields)
* Master dispatch merging the regions
message
Master.proto:71* Dispatch merging the specified regions.
required region_a = 1
required region_b = 2
optional bool forcible = 3
message
Master.proto:77(message has no fields)
rpc AssignRegion (, )
Master.proto:376* Assign a region to a server chosen at random.
message
Master.proto:80required region = 1
message
Master.proto:84(message has no fields)
rpc UnassignRegion (, )
Master.proto:385* Unassign a region from current hosting regionserver. Region will then be assigned to a regionserver chosen at random. Region could be reassigned back to the same server. Use MoveRegion if you want to control the region movement.
message
Master.proto:87required region = 1
optional bool force = 2
message
Master.proto:92(message has no fields)
rpc OfflineRegion (, )
Master.proto:394* Offline a region from the assignment manager's in-memory state. The region should be in a closed state and there will be no attempt to automatically reassign the region as in unassign. This is a special method, and should only be used by experts or hbck.
message
Master.proto:95required region = 1
message
Master.proto:99(message has no fields)
rpc DeleteTable (, )
Master.proto:398* Deletes a table
message
Master.proto:112required table_name = 1
message
Master.proto:116(message has no fields)
rpc EnableTable (, )
Master.proto:402* Puts the table on-line (only needed if table has been previously taken offline)
message
Master.proto:119required table_name = 1
message
Master.proto:123(message has no fields)
rpc DisableTable (, )
Master.proto:406* Take table offline
message
Master.proto:126required table_name = 1
message
Master.proto:130(message has no fields)
rpc ModifyTable (, )
Master.proto:410* Modify a table's metadata
message
Master.proto:133required table_name = 1
required table_schema = 2
message
Master.proto:138(message has no fields)
rpc CreateTable (, )
Master.proto:414* Creates a new table asynchronously
message
Master.proto:104required table_schema = 1
repeated bytes split_keys = 2
message
Master.proto:109(message has no fields)
rpc Shutdown (, )
Master.proto:418* Shutdown an HBase cluster.
message
Master.proto:198(message has no fields)
message
Master.proto:201(message has no fields)
rpc StopMaster (, )
Master.proto:422* Stop HBase Master only. Does not shutdown the cluster.
message
Master.proto:204(message has no fields)
message
Master.proto:207(message has no fields)
rpc Balance (, )
Master.proto:430* Run the balancer. Will run the balancer and if regions to move, it will go ahead and do the reassignments. Can NOT run for various reasons. Check logs.
message
Master.proto:210(message has no fields)
message
Master.proto:213required bool balancer_ran = 1
rpc SetBalancerRunning (, )
Master.proto:437* Turn the load balancer on or off. If synchronous is true, it waits until current balance() call, if outstanding, to return.
message
Master.proto:217required bool on = 1
optional bool synchronous = 2
message
Master.proto:222optional bool prev_balance_value = 1
rpc RunCatalogScan (, )
Master.proto:441* Get a run of the catalog janitor
message
Master.proto:226(message has no fields)
message
Master.proto:229optional int32 scan_result = 1
rpc EnableCatalogJanitor (, )
Master.proto:447* Enable the catalog janitor on or off.
message
Master.proto:233required bool enable = 1
message
Master.proto:237optional bool prev_value = 1
* Query whether the catalog janitor is enabled.
message
Master.proto:241(message has no fields)
message
Master.proto:244required bool value = 1
rpc ExecMasterService (, )
Master.proto:459* Call a master coprocessor endpoint
rpc Snapshot (, )
Master.proto:465* Create a snapshot for the given table.
message
Master.proto:248required snapshot = 1
message
Master.proto:252required int64 expected_timeout = 1
* Get completed snapshots. Returns a list of snapshot descriptors for completed snapshots
message
Master.proto:256(message has no fields)
message
Master.proto:259repeated snapshots = 1
rpc DeleteSnapshot (, )
Master.proto:476* Delete an existing snapshot. This method can also be used to clean up an aborted snapshot.
message
Master.proto:263required snapshot = 1
message
Master.proto:267(message has no fields)
rpc IsSnapshotDone (, )
Master.proto:481* Determine if the snapshot is done yet.
message
Master.proto:280if you don't send the snapshot, then you will get it back in the response (if the snapshot is done) so you can check the snapshot
optional snapshot = 1
message
Master.proto:284optional bool done = 1
optional snapshot = 2
rpc RestoreSnapshot (, )
Master.proto:486* Restore a snapshot
message
Master.proto:270required snapshot = 1
message
Master.proto:274(message has no fields)
* Determine if the snapshot restore is done yet.
message
Master.proto:289optional snapshot = 1
message
Master.proto:293optional bool done = 1
rpc ModifyNamespace (, )
Master.proto:494* Modify a namespace's metadata
message
Master.proto:157required namespaceDescriptor = 1
message
Master.proto:161(message has no fields)
rpc CreateNamespace (, )
Master.proto:498* Creates a new namespace synchronously
message
Master.proto:143required namespaceDescriptor = 1
message
Master.proto:147(message has no fields)
rpc DeleteNamespace (, )
Master.proto:502* Deletes namespace synchronously
message
Master.proto:150required string namespaceName = 1
message
Master.proto:154(message has no fields)
* Get a namespace descriptor by name
message
Master.proto:164required string namespaceName = 1
message
Master.proto:168required namespaceDescriptor = 1
* returns a list of namespaces
message
Master.proto:172(message has no fields)
message
Master.proto:175repeated namespaceDescriptor = 1
* returns a list of tables for a given namespace
message
Master.proto:179required string namespaceName = 1
message
Master.proto:183repeated tableSchema = 1
* returns a list of tables for a given namespace
message
Master.proto:187required string namespaceName = 1
message
Master.proto:191repeated tableName = 1
rpc MutateRows (, )
MultiRowMutation.proto:39message
MultiRowMutation.proto:31repeated mutation_request = 1
message
MultiRowMutation.proto:35(message has no fields)
* Called when a region server first starts.
message
RegionServerStatus.proto:30required uint32 port = 1
* Port number this regionserver is up on
required uint64 server_start_code = 2
* This servers' startcode
required uint64 server_current_time = 3
* Current time of the region server in ms
message
RegionServerStatus.proto:41repeated map_entries = 1
* Configuration for the regionserver to use: e.g. filesystem, hbase rootdir, the hostname to use creating the RegionServer ServerName, etc
* Called to report the load the RegionServer is under.
message
RegionServerStatus.proto:50required server = 1
optional load = 2
* load the server is under
message
RegionServerStatus.proto:57(message has no fields)
* Called by a region server to report a fatal error that is causing it to abort.
message
RegionServerStatus.proto:60required server = 1
* name of the server experiencing the error
required string error_message = 2
* informative text to expose in the master logs and UI
message
RegionServerStatus.proto:68(message has no fields)
* Called to get the sequence id of the last MemStore entry flushed to an HFile for a specified region. Used by the region server to speed up log splitting.
message
RegionServerStatus.proto:71required bytes region_name = 1
* region name
message
RegionServerStatus.proto:76required uint64 last_flushed_sequence_id = 1
* the last HLog sequence id flushed from MemStore to HFile for the region
rpc Process (, )
RowProcessor.proto:40message
RowProcessor.proto:29required string row_processor_class_name = 1
optional string row_processor_initializer_message_name = 2
optional bytes row_processor_initializer_message = 3
message
RowProcessor.proto:35required bytes row_processor_result = 1
message
SecureBulkLoad.proto:46required table_name = 1
message
SecureBulkLoad.proto:50required string bulk_token = 1
message
SecureBulkLoad.proto:28repeated family_path = 1
optional bool assign_seq_num = 2
required fs_token = 3
required string bulk_token = 4
message
SecureBulkLoad.proto:35required bool loaded = 1
message
SecureBulkLoad.proto:54required string bulk_token = 1
message
SecureBulkLoad.proto:59(message has no fields)
message
Client.proto:298Either a Get or a Mutation
Used in:
optional uint32 index = 1
If part of a multi action, useful aligning result with what was originally submitted.
optional mutation = 2
optional gxt = 3
message
Aggregate.proto:27Used as request type in: AggregateService.GetAvg, AggregateService.GetMax, AggregateService.GetMedian, AggregateService.GetMin, AggregateService.GetRowNum, AggregateService.GetStd, AggregateService.GetSum
required string interpreter_class_name = 1
* The request passed to the AggregateService consists of three parts (1) the (canonical) classname of the ColumnInterpreter implementation (2) the Scan query (3) any bytes required to construct the ColumnInterpreter object properly
required scan = 2
optional bytes interpreter_specific_bytes = 3
message
Aggregate.proto:39Used as response type in: AggregateService.GetAvg, AggregateService.GetMax, AggregateService.GetMedian, AggregateService.GetMin, AggregateService.GetRowNum, AggregateService.GetStd, AggregateService.GetSum
repeated bytes first_part = 1
* The AggregateService methods all have a response that either is a Pair or a simple object. When it is a Pair both first_part and second_part have defined values (and the second_part is not present in the response when the response is not a pair). Refer to the AggregateImplementation class for an overview of the AggregateResponse object constructions.
optional bytes second_part = 2
message
Authentication.proto:25required int32 id = 1
required int64 expiration_date = 2
required bytes key = 3
message
HBase.proto:175required bytes bigdecimal_msg = 1
message
Comparator.proto:38required comparable = 1
message
Comparator.proto:42required comparable = 1
message
Comparator.proto:46required comparable = 1
required BitComparator.BitwiseOp bitwise_op = 2
Used in:
AND = 1
OR = 2
XOR = 3
message
Client.proto:270Used in: ,
required bytes family = 1
required string path = 2
message
Comparator.proto:34Used in: , ,
optional bytes value = 1
message
HBase.proto:142Used in: , , ,
required bytes first = 1
required bytes second = 2
message
Cell.proto:44* Protocol buffer version of Cell.
Used in:
optional bytes row = 1
optional bytes family = 2
optional bytes qualifier = 3
optional uint64 timestamp = 4
optional CellType cell_type = 5
optional bytes value = 6
message
RPC.proto:92Optional Cell block Message. Included in client RequestHeader
Used in: ,
optional uint32 length = 1
Length of the following cell block. Could calculate it but convenient having it too hand.
* The type of the key in a Cell
Used in: ,
MINIMUM = 0
PUT = 4
DELETE = 8
DELETE_COLUMN = 12
DELETE_FAMILY = 14
MAXIMUM = 255
MAXIMUM is used when searching; you look from maximum on down.
message
ClusterId.proto:30* Content of the '/hbase/hbaseid', cluster id, znode. Also cluster of the ${HBASE_ROOTDIR}/hbase.id file.
Used in:
required string cluster_id = 1
This is the cluster id, a uuid as a String
message
ClusterStatus.proto:165Used in:
optional hbase_version = 1
repeated live_servers = 2
repeated dead_servers = 3
repeated regions_in_transition = 4
optional cluster_id = 5
repeated master_coprocessors = 6
optional master = 7
repeated backup_masters = 8
optional bool balancer_on = 9
message
ZooKeeper.proto:55* Content of the '/hbase/running', cluster state, znode.
required string start_date = 1
If this znode is present, cluster is up. Currently the data is cluster start_date.
message
Client.proto:35* Container for a list of column qualifier names of a family.
Used in: ,
required bytes family = 1
repeated bytes qualifier = 2
message
Filter.proto:35required int32 limit = 1
message
HBase.proto:51* Column Family Schema Inspired by the rest ColumSchemaMessage
Used in: , ,
required bytes name = 1
repeated attributes = 2
repeated configuration = 3
message
Filter.proto:39required int32 limit = 1
optional int32 offset = 2
optional bytes column_offset = 3
message
Filter.proto:45required bytes prefix = 1
message
Filter.proto:49optional bytes min_column = 1
optional bool min_column_inclusive = 2
optional bytes max_column = 3
optional bool max_column_inclusive = 4
message
WAL.proto:80* Special WAL entry to hold all related to a compaction. Written to WAL before completing compaction. There is sufficient info in the below message to complete later the * compaction should we fail the WAL write.
required bytes table_name = 1
TODO: WALKey already stores these, might remove
required bytes encoded_region_name = 2
required bytes family_name = 3
repeated string compaction_input = 4
repeated string compaction_output = 5
required string store_home_dir = 6
message
Comparator.proto:29Used in: , ,
required string name = 1
optional bytes serialized_comparator = 2
message
Filter.proto:56Used in: , , , ,
required CompareType compare_op = 1
optional comparator = 2
Comparison operators
Used in: , ,
LESS = 0
LESS_OR_EQUAL = 1
EQUAL = 2
NOT_EQUAL = 3
GREATER_OR_EQUAL = 4
GREATER = 5
NO_OP = 6
message
Client.proto:101* Condition to check if the value of a given cell (row, family, qualifier) matches a value via a given comparator. Condition is used in check and mutate operations.
Used in:
required bytes row = 1
required bytes family = 2
required bytes qualifier = 3
required CompareType compare_type = 4
required comparator = 5
message
RPC.proto:80This is sent on connection setup after the connection preamble is sent.
optional user_info = 1
optional string service_name = 2
optional string cell_block_codec_class = 3
Cell block codec we will use sending over optional cell blocks. Server throws exception if cannot deal. Null means no codec'ing going on so we are pb all the time (SLOW!!!)
optional string cell_block_compressor_class = 4
Compressor we will use if cell block is compressed. Server will throw exception if not supported. Class must implement hadoop's CompressionCodec Interface. Can't compress if no codec.
message
HBase.proto:128Used in: ,
required string name = 1
message
Client.proto:280Used in:
required bytes row = 1
required string service_name = 2
required string method_name = 3
required bytes request = 4
message
Client.proto:287Used as request type in: ClientService.ExecService, MasterService.ExecMasterService
required region = 1
required call = 2
message
Client.proto:292Used as response type in: ClientService.ExecService, MasterService.ExecMasterService
required region = 1
required value = 2
message
SecureBulkLoad.proto:39Used in:
optional bytes identifier = 1
optional bytes password = 2
optional string kind = 3
optional string service = 4
message
Filter.proto:61required compare_filter = 1
optional bytes column_family = 2
optional bytes column_qualifier = 3
optional bool drop_dependent_column = 4
message
HBase.proto:167(message has no fields)
message
RPC.proto:99At the RPC layer, this message is used to carry the server side exception to the RPC client.
Used in:
optional string exception_class_name = 1
Class name of the exception thrown from the server
optional string stack_trace = 2
Exception stack trace from the server side
optional string hostname = 3
Optional hostname. Filled in for some exceptions such as region moved where exception gives clue on where the region may have moved.
optional int32 port = 4
optional bool do_not_retry = 5
Set if we are NOT to retry on receipt of this exception
message
Filter.proto:68required compare_filter = 1
message
WAL.proto:65Used in:
required bytes family = 1
required ScopeType scope_type = 2
message
HBase.proto:72* Protocol buffer for favored nodes
repeated favored_node = 1
message
HFile.proto:27Map of name/values
repeated map_entry = 1
message
HFile.proto:32HFile file trailer
optional uint64 file_info_offset = 1
optional uint64 load_on_open_data_offset = 2
optional uint64 uncompressed_data_index_size = 3
optional uint64 total_uncompressed_bytes = 4
optional uint32 data_index_count = 5
optional uint32 meta_index_count = 6
optional uint64 entry_count = 7
optional uint32 num_data_index_levels = 8
optional uint64 first_data_block_offset = 9
optional uint64 last_data_block_offset = 10
optional string comparator_class_name = 11
optional uint32 compression_codec = 12
message
Filter.proto:30Used in: , , , , ,
required string name = 1
optional bytes serialized_filter = 2
message
Filter.proto:72required FilterList.Operator operator = 1
repeated filters = 2
Used in:
MUST_PASS_ALL = 1
MUST_PASS_ONE = 2
message
Filter.proto:82required filter = 1
message
Filter.proto:86(message has no fields)
message
Filter.proto:89repeated bytes qualifiers = 1
message
ErrorHandling.proto:54* Exception sent across the wire when a remote task needs to notify other tasks that it failed and why
optional string source = 1
optional generic_exception = 2
message
Filter.proto:93repeated fuzzy_keys_data = 1
message
ErrorHandling.proto:43* Cause of a remote failure for a generic exception. Contains all the information for a generic exception as well as optional info about the error for generic info passing (which should be another protobuffed class).
Used in:
optional string class_name = 1
optional string message = 2
optional bytes error_info = 3
repeated trace = 4
message
Client.proto:46* The protocol buffer version of Get. Unless existence_only is specified, return all the requested data for the row that matches exactly, or the one that immediately precedes it if closest_row_before is specified.
Used in: ,
required bytes row = 1
repeated column = 2
repeated attribute = 3
optional filter = 4
optional time_range = 5
optional uint32 max_versions = 6
optional bool cache_blocks = 7
optional uint32 store_limit = 8
optional uint32 store_offset = 9
optional bool existence_only = 10
The result isn't asked for, just check for the existence.
optional bool closest_row_before = 11
If the row to get doesn't exist, return the closest row before.
Used in:
NONE = 0
MINOR = 1
MAJOR = 2
MAJOR_AND_MINOR = 3
message
AccessControl.proto:58Used in:
repeated Permission.Action action = 1
message
FS.proto:29* The ${HBASE_ROOTDIR}/hbase.version file content
Used in:
required string version = 1
message
Filter.proto:97optional bytes stop_row_key = 1
message
Filter.proto:101required bool len_as_val = 1
message
Cell.proto:57* Protocol buffer version of KeyValue. It doesn't have those transient parameters
required bytes row = 1
required bytes family = 2
required bytes qualifier = 3
optional uint64 timestamp = 4
optional CellType key_type = 5
optional bytes value = 6
message
ClusterStatus.proto:160Used in:
required server = 1
required server_load = 2
message
LoadBalancer.proto:26optional bool balancer_on = 1
message
HBase.proto:170required int64 long_msg = 1
message
ZooKeeper.proto:45* Content of the master znode.
required master = 1
The ServerName of the current Master
optional uint32 rpc_version = 2
Major RPC version so that clients can know what version the master can accept.
message
ZooKeeper.proto:33* Content of the meta-region-server znode.
required server = 1
The ServerName hosting the meta region currently.
optional uint32 rpc_version = 2
The major version of the rpc the server speaks. This is used so that clients connecting to the cluster can have prior knowledge of what version to send to a RegionServer. AsyncHBase will use this to detect versions.
message
MultiRowMutation.proto:25(message has no fields)
message
MultiRowMutation.proto:28(message has no fields)
message
Filter.proto:105repeated bytes sorted_prefixes = 1
message
Client.proto:117* A specific mutation inside a mutate request. It can be an append, increment, put or delete based on the mutation type. It can be fully filled in or only metadata present because data is being carried elsewhere outside of pb.
Used in: , ,
optional bytes row = 1
optional MutationProto.MutationType mutate_type = 2
repeated column_value = 3
optional uint64 timestamp = 4
repeated attribute = 5
optional MutationProto.Durability durability = 6
optional time_range = 7
For some mutations, a result may be returned, in which case, time range can be specified for potential performance gain
optional int32 associated_cell_count = 8
The below count is set when the associated cells are NOT part of this protobuf message; they are passed alongside and then this Message is a placeholder with metadata. The count is needed to know how many to peel off the block of Cells as ours. NOTE: This is different from the pb managed cell_count of the 'cell' field above which is non-null when the cells are pb'd.
message
Client.proto:158Used in:
required bytes family = 1
repeated qualifier_value = 2
message
Client.proto:162Used in:
optional bytes qualifier = 1
optional bytes value = 2
optional uint64 timestamp = 3
optional DeleteType delete_type = 4
Used in:
DELETE_ONE_VERSION = 0
DELETE_MULTIPLE_VERSIONS = 1
DELETE_FAMILY = 2
DELETE_FAMILY_VERSION = 3
Used in:
USE_DEFAULT = 0
SKIP_WAL = 1
ASYNC_WAL = 2
SYNC_WAL = 3
FSYNC_WAL = 4
Used in:
APPEND = 0
INCREMENT = 1
PUT = 2
DELETE = 3
message
HBase.proto:137Used in: , , , , ,
required string name = 1
optional bytes value = 2
message
HBase.proto:147Used in:
optional string name = 1
optional int64 value = 2
message
HBase.proto:132Used in: , , ,
required string name = 1
required string value = 2
message
HBase.proto:184Used in: , , ,
required bytes name = 1
repeated configuration = 2
message
AccessControl.proto:53Used in:
optional bytes namespace_name = 1
repeated Permission.Action action = 2
message
Comparator.proto:57(message has no fields)
message
Admin.proto:72Used in:
required region = 1
optional uint32 version_of_offline_node = 2
repeated favored_nodes = 3
Used in:
OPENED = 0
ALREADY_OPENED = 1
FAILED_OPENING = 2
message
Filter.proto:109required int64 page_size = 1
message
AccessControl.proto:27Used in: , ,
required Permission.Type type = 1
optional global_permission = 2
optional namespace_permission = 3
optional table_permission = 4
Used in: , ,
READ = 0
WRITE = 1
EXEC = 2
CREATE = 3
ADMIN = 4
Used in: ,
Global = 1
Namespace = 2
Table = 3
message
Filter.proto:113optional bytes prefix = 1
message
Filter.proto:117required compare_filter = 1
message
Tracing.proto:28Used to pass through the information necessary to continue a trace after an RPC is made. All we need is the traceid (so we know the overarching trace this message is a part of), and the id of the current span when this message was sent, so we know what span caused the new span we will create when this message is received.
Used in:
optional int64 trace_id = 1
optional int64 parent_id = 2
message
Filter.proto:121required float chance = 1
message
FS.proto:36* Reference file content used when we split an hfile under a region.
required bytes splitkey = 1
required Reference.Range range = 2
Used in:
TOP = 0
BOTTOM = 1
message
Comparator.proto:60required string pattern = 1
required int32 pattern_flags = 2
required string charset = 3
message
Client.proto:309* Actions to run against a Region.
Used in:
required region = 1
optional bool atomic = 2
When set, run mutations as atomic unit.
repeated action = 3
message
Client.proto:332* The result of a RegionAction.
Used in:
repeated resultOrException = 1
optional exception = 2
If the operation failed globally for this region, this exception is set
message
ClusterStatus.proto:57Used in:
required spec = 1
required region_state = 2
message
HBase.proto:60* Protocol buffer version of HRegionInfo.
Used in: , , , ,
required uint64 region_id = 1
required table_name = 2
optional bytes start_key = 3
optional bytes end_key = 4
optional bool offline = 5
optional bool split = 6
message
ClusterStatus.proto:62Used in:
required region_specifier = 1
* the region specifier
optional uint32 stores = 2
* the number of stores for the region
optional uint32 storefiles = 3
* the number of storefiles for the region
optional uint32 store_uncompressed_size_MB = 4
* the total size of the store files for the region, uncompressed, in MB
optional uint32 storefile_size_MB = 5
* the current total size of the store files for the region, in MB
optional uint32 memstore_size_MB = 6
* the current size of the memstore for the region, in MB
optional uint32 storefile_index_size_MB = 7
* The current total size of root-level store file indexes for the region, in MB. The same as {@link #rootIndexSizeKB} but in MB.
optional uint64 read_requests_count = 8
* the current total read requests made to region
optional uint64 write_requests_count = 9
* the current total write requests made to region
optional uint64 total_compacting_KVs = 10
* the total compacting key values in currently running compaction
optional uint64 current_compacted_KVs = 11
* the completed count of key values in currently running compaction
optional uint32 root_index_size_KB = 12
* The current total size of root-level indexes for the region, in KB.
optional uint32 total_static_index_size_KB = 13
* The total size of all index blocks, not just the root level, in KB.
optional uint32 total_static_bloom_size_KB = 14
* The total size of all Bloom filter blocks, not just loaded into the block cache, in KB.
optional uint64 complete_sequence_id = 15
* the most recent sequence Id from cache flush
message
HBase.proto:192* Description of the region server info
optional int32 infoPort = 1
message
HBase.proto:82* Container protocol buffer to specify a region. You can specify region by region name, or the hash of the region name, which is known as encoded region name.
Used in: , , , , , , , , , , , , , , , , , , , , ,
required RegionSpecifier.RegionSpecifierType type = 1
required bytes value = 2
Used in:
REGION_NAME = 1
<tablename>,<startkey>,<regionId>.<encodedName>
ENCODED_REGION_NAME = 2
hash of <tablename>,<startkey>,<regionId>
message
ClusterStatus.proto:30Used in:
required region_info = 1
required RegionState.State state = 2
optional uint64 stamp = 3
Used in:
OFFLINE = 0
region is in an offline state
PENDING_OPEN = 1
sent rpc to server to open but has not begun
OPENING = 2
server has begun to open but not yet done
OPEN = 3
server opened region and updated meta
PENDING_CLOSE = 4
sent rpc to server to close but has not begun
CLOSING = 5
server has begun to close but not yet done
CLOSED = 6
server closed region and updated meta
SPLITTING = 7
server started split of a region
SPLIT = 8
server completed split of a region
FAILED_OPEN = 9
failed to open, and won't retry any more
FAILED_CLOSE = 10
failed to close, and won't retry any more
MERGING = 11
server started merge a region
MERGED = 12
server completed merge of a region
SPLITTING_NEW = 13
new region to be created when RS splits a parent
MERGING_NEW = 14
region but hasn't be created yet, or master doesn't know it's already created
new region to be created when RS merges two
message
ZooKeeper.proto:167* contains a sequence id of a region which should be the minimum of its store sequence ids and list sequence ids of the region's stores
required uint64 last_flushed_sequence_id = 1
repeated store_sequence_id = 2
message
ZooKeeper.proto:65* What we write under unassigned up in zookeeper as a region moves through open/close, etc., regions. Details a region in transition.
required uint32 event_type_code = 1
Code for EventType gotten by doing o.a.h.h.EventHandler.EventType.getCode()
required bytes region_name = 2
Full regionname in bytes
required uint64 create_time = 3
required server_name = 4
The region server where the transition will happen or is happening
optional bytes payload = 5
message
Admin.proto:191* Replicates the given entries. The guarantee is that the given entries will be durable on the slave cluster if this method returns without any exception. hbase.replication has to be set to true for this to work.
Used as request type in: AdminService.Replay, AdminService.ReplicateWALEntry
repeated entry = 1
message
Admin.proto:195Used as response type in: AdminService.Replay, AdminService.ReplicateWALEntry
(message has no fields)
message
ZooKeeper.proto:132* Used by replication. Holds the current position in an HLog file.
required int64 position = 1
message
ZooKeeper.proto:139* Used by replication. Used to lock a region server during failover.
required string lock_owner = 1
message
ZooKeeper.proto:112* Used by replication. Holds a replication peer key.
required string clusterkey = 1
clusterkey is the concatenation of the slave cluster's hbase.zookeeper.quorum:hbase.zookeeper.property.clientPort:zookeeper.znode.parent
message
ZooKeeper.proto:121* Used by replication. Holds whether enabled or disabled
required ReplicationState.State state = 1
Used in:
ENABLED = 0
DISABLED = 1
message
RPC.proto:113Header sent making a request.
optional uint32 call_id = 1
Monotonically increasing call_id to keep track of RPC requests and their response
optional trace_info = 2
optional string method_name = 3
optional bool request_param = 4
If true, then a pb Message param follows.
optional cell_block_meta = 5
If present, then an encoded data block follows.
optional uint32 priority = 6
0 is NORMAL priority. 100 is HIGH. If no priority, treat it as NORMAL. See HConstants.
message
RPC.proto:127optional uint32 call_id = 1
optional exception = 2
If present, then request threw an exception and no response message (else we presume one)
optional cell_block_meta = 3
If present, then an encoded data block follows.
message
Client.proto:66Used in: , , ,
repeated cell = 1
Result includes the Cells or else it just has a count of Cells that are carried otherwise.
optional int32 associated_cell_count = 2
The below count is set when the associated cells are not part of this protobuf message; they are passed alongside and then this Message is just a placeholder with metadata. The count is needed to know how many to peel off the block of Cells as ours. NOTE: This is different from the pb managed cell_count of the 'cell' field above which is non-null when the cells are pb'd.
optional bool exists = 3
used for Get to check existence only. Not set if existence_only was not set to true in the query.
message
Client.proto:321* Either a Result or an Exception NameBytesPair (keyed by exception name whose value is the exception stringified) or maybe empty if no result and no exception.
Used in:
optional uint32 index = 1
If part of a multi call, save original index of the list of all passed so can align this response w/ original request.
optional result = 2
optional exception = 3
message
Filter.proto:125required compare_filter = 1
message
Client.proto:202* Instead of get from a table, you can scan it with optional filters. You can specify the row key range, time range, the columns/families to scan and so on. This scan is used the first time in a scan request. The response of the initial scan will return a scanner id, which should be used to fetch result batches later on before it is closed.
Used in: ,
repeated column = 1
repeated attribute = 2
optional bytes start_row = 3
optional bytes stop_row = 4
optional filter = 5
optional time_range = 6
optional uint32 max_versions = 7
optional bool cache_blocks = 8
optional uint32 batch_size = 9
optional uint64 max_result_size = 10
optional uint32 store_limit = 11
optional uint32 store_offset = 12
optional bool load_column_families_on_demand = 13
DO NOT add defaults to load_column_families_on_demand.
optional bool small = 14
message
MapReduce.proto:28repeated metrics = 1
Used in:
REPLICATION_SCOPE_LOCAL = 0
REPLICATION_SCOPE_GLOBAL = 1
message
Admin.proto:216Used in:
required server_name = 1
optional uint32 webui_port = 2
message
ClusterStatus.proto:117Used in: ,
optional uint32 number_of_requests = 1
* Number of requests since last report.
optional uint32 total_number_of_requests = 2
* Total Number of requests from the start of the region server.
optional uint32 used_heap_MB = 3
* the amount of used heap, in MB.
optional uint32 max_heap_MB = 4
* the maximum allowable size of the heap, in MB.
repeated region_loads = 5
* Information on the load of individual regions.
repeated coprocessors = 6
* Regionserver-level coprocessors, e.g., WALObserver implementations. Region-level coprocessors, on the other hand, are stored inside RegionLoad objects.
optional uint64 report_start_time = 7
* Time when incremental (non-total) counts began being calculated (e.g. number_of_requests) time is measured as the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
optional uint64 report_end_time = 8
* Time when report was generated. time is measured as the difference, measured in milliseconds, between the current time and midnight, January 1, 1970 UTC.
optional uint32 info_server_port = 9
* The port number that this region server is hosing an info server on.
message
HBase.proto:120* Protocol buffer version of ServerName
Used in: , , , , , , , , , , , , , ,
required string host_name = 1
optional uint32 port = 2
optional uint64 start_code = 3
message
Filter.proto:129required single_column_value_filter = 1
message
Filter.proto:133Used in:
optional bytes column_family = 1
optional bytes column_qualifier = 2
required CompareType compare_op = 3
required comparator = 4
optional bool filter_if_missing = 5
optional bool latest_version_only = 6
message
Filter.proto:142required filter = 1
message
HBase.proto:155* Description of the snapshot to take
Used in: , , , , , ,
required string name = 1
optional string table = 2
not needed for delete, but checked for in taking snapshot
optional int64 creation_time = 3
optional SnapshotDescription.Type type = 4
optional int32 version = 5
Used in:
DISABLED = 0
FLUSH = 1
message
ZooKeeper.proto:80* WAL SplitLog directory znodes have this for content. Used doing distributed WAL splitting. Holds current state and name of server that originated split.
required SplitLogTask.State state = 1
required server_name = 2
Used in:
UNASSIGNED = 0
OWNED = 1
RESIGNED = 2
DONE = 3
ERR = 4
message
ErrorHandling.proto:30* Protobuf version of a java.lang.StackTraceElement so we can serialize exceptions.
Used in:
optional string declaring_class = 1
optional string method_name = 2
optional string file_name = 3
optional int32 line_number = 4
message
ZooKeeper.proto:158* sequence Id of a store
Used in:
required bytes family_name = 1
required uint64 sequence_id = 2
message
Comparator.proto:66required string substr = 1
message
ZooKeeper.proto:95* The znode that holds state of table.
required Table.State state = 1
This is the table's state. If no znode for a table, its state is presumed enabled. See o.a.h.h.zookeeper.ZKTable class for more.
Table's current state
Used in:
ENABLED = 0
DISABLED = 1
DISABLING = 2
ENABLING = 3
message
ZooKeeper.proto:146* Metadata associated with a table lock in zookeeper
optional table_name = 1
optional lock_owner = 2
optional int64 thread_id = 3
optional bool is_shared = 4
optional string purpose = 5
optional int64 create_time = 6
message
HBase.proto:31* Table Name
Used in: , , , , , , , , , , , , , , , ,
required bytes namespace = 1
required bytes qualifier = 2
message
AccessControl.proto:46Used in:
optional table_name = 1
optional bytes family = 2
optional bytes qualifier = 3
repeated Permission.Action action = 4
message
HBase.proto:40* Table Schema Inspired by the rest TableSchema
Used in: , , ,
optional table_name = 1
repeated attributes = 2
repeated column_families = 3
repeated configuration = 4
message
MapReduce.proto:32optional region = 1
repeated string locations = 2
message
HBase.proto:101* A range of time. Both from and to are Java time stamp in milliseconds. If you don't specify a time range, it means all time. By default, if not specified, from = 0, and to = Long.MAX_VALUE
Used in: , ,
optional uint64 from = 1
optional uint64 to = 2
message
Filter.proto:146repeated int64 timestamps = 1
message
Authentication.proto:47Serialization of the org.apache.hadoop.security.token.Token class Note that this is a Hadoop class, so fields may change!
Used in:
optional bytes identifier = 1
the TokenIdentifier in serialized form Note: we can't use the protobuf directly because the Hadoop Token class only stores the serialized bytes
optional bytes password = 2
optional bytes service = 3
message
Authentication.proto:32required TokenIdentifier.Kind kind = 1
required bytes username = 2
required int32 key_id = 3
optional int64 issue_date = 4
optional int64 expiration_date = 5
optional int64 sequence_number = 6
Used in:
HBASE_AUTH_TOKEN = 0
message
HBase.proto:179Used in:
required uint64 least_sig_bits = 1
required uint64 most_sig_bits = 2
message
Admin.proto:151Used in:
required region = 1
repeated favored_nodes = 2
message
RPC.proto:74User Information proto. Included in ConnectionHeader on connection setup
Used in:
required string effective_user = 1
optional string real_user = 2
message
AccessControl.proto:62Used in: , ,
required bytes user = 1
required permission = 3
message
AccessControl.proto:70* Content of the /hbase/acl/<table or namespace> znode.
repeated user_permissions = 1
message
AccessControl.proto:71Used in:
required bytes user = 1
repeated permissions = 2
message
Filter.proto:150required compare_filter = 1
message
Admin.proto:176Protocol buffer version of WAL for replication
Used in:
required key = 1
repeated bytes key_value_bytes = 2
Following may be null if the KVs/Cells are carried along the side in a cellblock (See RPC for more on cellblocks). If Cells/KVs are in a cellblock, this next field is null and associated_cell_count has count of Cells associated w/ this WALEntry
optional int32 associated_cell_count = 3
If Cell data is carried alongside in a cellblock, this is count of Cells in the cellblock.
message
WAL.proto:26optional bool has_compression = 1
message
WAL.proto:31Protocol buffer version of HLogKey; see HLogKey comment, not really a key but WALEdit header for some KVs
Used in:
required bytes encoded_region_name = 1
required bytes table_name = 2
required uint64 log_sequence_number = 3
required uint64 write_time = 4
optional cluster_id = 5
This parameter is deprecated in favor of clusters which contains the list of clusters that have consumed the change. It is retained so that the log created by earlier releases (0.94) can be read by the newer releases.
repeated scopes = 6
optional uint32 following_kv_count = 7
repeated cluster_ids = 8
This field contains the list of clusters that have consumed the change
optional CustomEntryType custom_entry_type = 9; enum CustomEntryType { COMPACTION = 0; }
message
WAL.proto:93* A trailer that is appended to the end of a properly closed HLog WAL file. If missing, this is either a legacy or a corrupted WAL file.
(message has no fields)
message
Filter.proto:154required filter = 1