package pb
Get desktop application:
View/edit binary Protocol Buffers messages
service ClientService
Client.proto:443rpc Get (, )
Client.proto:444message
Client.proto:120* The get request. Perform a single Get operation.
required region = 1
required get = 2
message
Client.proto:125optional result = 1
rpc Mutate (, )
Client.proto:447message
Client.proto:217* 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
optional uint64 nonce_group = 4
message
Client.proto:224optional result = 1
optional bool processed = 2
used for mutate to indicate processed only
rpc Scan (, )
Client.proto:450message
Client.proto:271* 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
optional bool client_handles_partials = 7
optional bool client_handles_heartbeats = 8
message
Client.proto:286* 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)
optional bool stale = 6
repeated bool partial_flag_per_result = 7
This field is filled in if we are doing cellblocks. In the event that a row could not fit all of its cells into a single RPC chunk, the results will be returned as partials, and reconstructed into a complete result on the client side. This field is a list of flags indicating whether or not the result that the cells belong to is a partial result. For example, if this field has false, false, true in it, then we know that on the client side, we need to make another RPC request since the last result was only a partial.
optional bool more_results_in_region = 8
A server may choose to limit the number of results returned to the client for reasons such as the size in bytes or quantity of results accumulated. This field will true when more results exist in the current region.
optional bool heartbeat_message = 9
This field is filled in if the server is sending back a heartbeat message. Heartbeat messages are sent back to the client to prevent the scanner from timing out. Seeing a heartbeat message communicates to the Client that the server would have continued to scan had the time limit not been reached.
rpc BulkLoadHFile (, )
Client.proto:453message
Client.proto:330* 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:341required bool loaded = 1
rpc ExecService (, )
Client.proto:456rpc Multi (, )
Client.proto:462message
Client.proto:430* 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
optional uint64 nonceGroup = 2
optional condition = 3
message
Client.proto:436repeated regionActionResult = 1
optional bool processed = 2
used for mutate to indicate processed only
service MasterService
Master.proto:425rpc GetSchemaAlterStatus (, )
Master.proto:427* Used by the client to get the number of regions that have received the updated schema
message
Master.proto:319required table_name = 1
message
Master.proto:323optional uint32 yet_to_update_regions = 1
optional uint32 total_regions = 2
rpc GetTableDescriptors (, )
Master.proto:431* Get list of TableDescriptors for requested tables.
message
Master.proto:328repeated table_names = 1
optional string regex = 2
optional bool include_sys_tables = 3
optional string namespace = 4
message
Master.proto:335repeated table_schema = 1
rpc GetTableNames (, )
Master.proto:435* Get the list of table names.
message
Master.proto:339optional string regex = 1
optional bool include_sys_tables = 2
optional string namespace = 3
message
Master.proto:345repeated table_names = 1
rpc GetClusterStatus (, )
Master.proto:439* Return cluster status.
message
Master.proto:349(message has no fields)
message
Master.proto:352required cluster_status = 1
rpc IsMasterRunning (, )
Master.proto:443* return true if master is available
message
Master.proto:356(message has no fields)
message
Master.proto:359required bool is_master_running = 1
rpc AddColumn (, )
Master.proto:446* Adds a column to the specified table.
message
Master.proto:37required table_name = 1
required column_families = 2
message
Master.proto:42(message has no fields)
rpc DeleteColumn (, )
Master.proto:450* Deletes a column from the specified table. Table must be disabled.
message
Master.proto:45required table_name = 1
required bytes column_name = 2
message
Master.proto:50(message has no fields)
rpc ModifyColumn (, )
Master.proto:454* Modifies an existing column on the specified table.
message
Master.proto:53required table_name = 1
required column_families = 2
message
Master.proto:58(message has no fields)
rpc MoveRegion (, )
Master.proto:458* Move the region region to the destination server.
message
Master.proto:63required region = 1
optional dest_server_name = 2
message
Master.proto:68(message has no fields)
* Master dispatch merging the regions
message
Master.proto:74* Dispatch merging the specified regions.
required region_a = 1
required region_b = 2
optional bool forcible = 3
message
Master.proto:80(message has no fields)
rpc AssignRegion (, )
Master.proto:466* Assign a region to a server chosen at random.
message
Master.proto:83required region = 1
message
Master.proto:87(message has no fields)
rpc UnassignRegion (, )
Master.proto:475* 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:90required region = 1
optional bool force = 2
message
Master.proto:95(message has no fields)
rpc OfflineRegion (, )
Master.proto:484* 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:98required region = 1
message
Master.proto:102(message has no fields)
rpc DeleteTable (, )
Master.proto:488* Deletes a table
message
Master.proto:116required table_name = 1
message
Master.proto:120optional uint64 proc_id = 1
rpc truncateTable (, )
Master.proto:492* Truncate a table
message
Master.proto:124required tableName = 1
optional bool preserveSplits = 2
message
Master.proto:129(message has no fields)
rpc EnableTable (, )
Master.proto:496* Puts the table on-line (only needed if table has been previously taken offline)
message
Master.proto:132required table_name = 1
message
Master.proto:136optional uint64 proc_id = 1
rpc DisableTable (, )
Master.proto:500* Take table offline
message
Master.proto:140required table_name = 1
message
Master.proto:144optional uint64 proc_id = 1
rpc ModifyTable (, )
Master.proto:504* Modify a table's metadata
message
Master.proto:148required table_name = 1
required table_schema = 2
message
Master.proto:153(message has no fields)
rpc CreateTable (, )
Master.proto:508* Creates a new table asynchronously
message
Master.proto:107required table_schema = 1
repeated bytes split_keys = 2
message
Master.proto:112optional uint64 proc_id = 1
rpc Shutdown (, )
Master.proto:512* Shutdown an HBase cluster.
message
Master.proto:213(message has no fields)
message
Master.proto:216(message has no fields)
rpc StopMaster (, )
Master.proto:516* Stop HBase Master only. Does not shutdown the cluster.
message
Master.proto:219(message has no fields)
message
Master.proto:222(message has no fields)
rpc Balance (, )
Master.proto:524* 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:225(message has no fields)
message
Master.proto:228required bool balancer_ran = 1
rpc SetBalancerRunning (, )
Master.proto:531* Turn the load balancer on or off. If synchronous is true, it waits until current balance() call, if outstanding, to return.
message
Master.proto:232required bool on = 1
optional bool synchronous = 2
message
Master.proto:237optional bool prev_balance_value = 1
rpc IsBalancerEnabled (, )
Master.proto:537* Query whether the Region Balancer is running.
message
Master.proto:241(message has no fields)
message
Master.proto:244required bool enabled = 1
rpc RunCatalogScan (, )
Master.proto:541* Get a run of the catalog janitor
message
Master.proto:248(message has no fields)
message
Master.proto:251optional int32 scan_result = 1
rpc EnableCatalogJanitor (, )
Master.proto:547* Enable the catalog janitor on or off.
message
Master.proto:255required bool enable = 1
message
Master.proto:259optional bool prev_value = 1
* Query whether the catalog janitor is enabled.
message
Master.proto:263(message has no fields)
message
Master.proto:266required bool value = 1
rpc ExecMasterService (, )
Master.proto:559* Call a master coprocessor endpoint
rpc Snapshot (, )
Master.proto:565* Create a snapshot for the given table.
message
Master.proto:270required snapshot = 1
message
Master.proto:274required int64 expected_timeout = 1
* Get completed snapshots. Returns a list of snapshot descriptors for completed snapshots
message
Master.proto:278(message has no fields)
message
Master.proto:281repeated snapshots = 1
rpc DeleteSnapshot (, )
Master.proto:576* Delete an existing snapshot. This method can also be used to clean up an aborted snapshot.
message
Master.proto:285required snapshot = 1
message
Master.proto:289(message has no fields)
rpc IsSnapshotDone (, )
Master.proto:581* Determine if the snapshot is done yet.
message
Master.proto:302if 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:306optional bool done = 1
optional snapshot = 2
rpc RestoreSnapshot (, )
Master.proto:586* Restore a snapshot
message
Master.proto:292required snapshot = 1
message
Master.proto:296(message has no fields)
* Determine if the snapshot restore is done yet.
message
Master.proto:311optional snapshot = 1
message
Master.proto:315optional bool done = 1
rpc ExecProcedure (, )
Master.proto:596* Execute a distributed procedure.
rpc ExecProcedureWithRet (, )
Master.proto:601* Execute a distributed procedure with return data.
rpc IsProcedureDone (, )
Master.proto:606* Determine if the procedure is done yet.
message
Master.proto:372optional procedure = 1
message
Master.proto:376optional bool done = 1
optional snapshot = 2
rpc ModifyNamespace (, )
Master.proto:612* Modify a namespace's metadata
message
Master.proto:172required namespaceDescriptor = 1
message
Master.proto:176(message has no fields)
rpc CreateNamespace (, )
Master.proto:616* Creates a new namespace synchronously
message
Master.proto:158required namespaceDescriptor = 1
message
Master.proto:162(message has no fields)
rpc DeleteNamespace (, )
Master.proto:620* Deletes namespace synchronously
message
Master.proto:165required string namespaceName = 1
message
Master.proto:169(message has no fields)
* Get a namespace descriptor by name
message
Master.proto:179required string namespaceName = 1
message
Master.proto:183required namespaceDescriptor = 1
* returns a list of namespaces
message
Master.proto:187(message has no fields)
message
Master.proto:190repeated namespaceDescriptor = 1
* returns a list of tables for a given namespace
message
Master.proto:194required string namespaceName = 1
message
Master.proto:198repeated tableSchema = 1
* returns a list of tables for a given namespace
message
Master.proto:202required string namespaceName = 1
message
Master.proto:206repeated tableName = 1
rpc SetQuota (, )
Master.proto:640* Apply the new quota settings
message
Master.proto:399optional string user_name = 1
optional string user_group = 2
optional string namespace = 3
optional table_name = 4
optional bool remove_all = 5
optional bool bypass_globals = 6
optional throttle = 7
message
Master.proto:410(message has no fields)
* Returns the timestamp of the last major compaction
message
Master.proto:413required table_name = 1
* Returns the timestamp of the last major compaction
message
Master.proto:417required region = 1
rpc getProcedureResult (, )
Master.proto:650message
Master.proto:381required uint64 proc_id = 1
message
Master.proto:385required GetProcedureResultResponse.State state = 1
optional uint64 start_time = 2
optional uint64 last_update = 3
optional bytes result = 4
optional exception = 5
rpc MutateRows (, )
MultiRowMutation.proto:42message
MultiRowMutation.proto:32repeated mutation_request = 1
optional uint64 nonce_group = 2
optional uint64 nonce = 3
message
MultiRowMutation.proto:38(message has no fields)
message
Client.proto:367Either 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 get = 3
optional service_call = 4
message
Client.proto:36* The protocol buffer version of Authorizations.
repeated string label = 1
message
HBase.proto:202required bytes bigdecimal_msg = 1
message
Comparator.proto:39required comparable = 1
message
Comparator.proto:47required comparable = 1
message
Comparator.proto:51required comparable = 1
required BitComparator.BitwiseOp bitwise_op = 2
Used in:
AND = 1
OR = 2
XOR = 3
message
Client.proto:335Used in:
required bytes family = 1
required string path = 2
message
Comparator.proto:35Used in: , , ,
optional bytes value = 1
message
HBase.proto:144Used in: , , ,
required bytes first = 1
required bytes second = 2
message
Cell.proto:45* 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
optional bytes tags = 7
message
RPC.proto:104Optional 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
Client.proto:43* The protocol buffer version of CellVisibility.
required string expression = 1
message
ClusterId.proto:31* 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:214Used 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:62* 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:50* Container for a list of column qualifier names of a family.
Used in: ,
required bytes family = 1
repeated bytes qualifier = 2
message
Filter.proto:36required int32 limit = 1
message
HBase.proto:52* Column Family Schema Inspired by the rest ColumSchemaMessage
Used in: , ,
required bytes name = 1
repeated attributes = 2
repeated configuration = 3
message
Filter.proto:40required int32 limit = 1
optional int32 offset = 2
optional bytes column_offset = 3
message
Filter.proto:46required bytes prefix = 1
message
Filter.proto:50optional bytes min_column = 1
optional bool min_column_inclusive = 2
optional bytes max_column = 3
optional bool max_column_inclusive = 4
message
Comparator.proto:30Used in: , ,
required string name = 1
optional bytes serialized_comparator = 2
message
Filter.proto:57Used 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:135* 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:91This 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.
optional version_info = 5
* Consistency defines the expected consistency level for an operation.
Used in: ,
STRONG = 0
TIMELINE = 1
message
HBase.proto:130Used in: ,
required string name = 1
message
Client.proto:345Used in: ,
required bytes row = 1
required string service_name = 2
required string method_name = 3
required bytes request = 4
message
Client.proto:356Used as request type in: ClientService.ExecRegionServerService, ClientService.ExecService, MasterService.ExecMasterService
required region = 1
required call = 2
message
Client.proto:361Used as response type in: ClientService.ExecRegionServerService, ClientService.ExecService, MasterService.ExecMasterService
required region = 1
required value = 2
message
Client.proto:352Used in:
optional value = 1
message
Filter.proto:62required compare_filter = 1
optional bytes column_family = 2
optional bytes column_qualifier = 3
optional bool drop_dependent_column = 4
message
HBase.proto:198required double double_msg = 1
message
HBase.proto:181(message has no fields)
message
RPC.proto:111At 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
Master.proto:363Used as request type in: MasterService.ExecProcedure, MasterService.ExecProcedureWithRet
required procedure = 1
message
Master.proto:367Used as response type in: MasterService.ExecProcedure, MasterService.ExecProcedureWithRet
optional int64 expected_timeout = 1
optional bytes return_data = 2
message
Filter.proto:69required compare_filter = 1
message
HBase.proto:74* Protocol buffer for favored nodes
repeated favored_node = 1
message
Filter.proto:31Used in: , , , , ,
required string name = 1
optional bytes serialized_filter = 2
message
Filter.proto:158(message has no fields)
message
Filter.proto:73required FilterList.Operator operator = 1
repeated filters = 2
Used in:
MUST_PASS_ALL = 1
MUST_PASS_ONE = 2
message
Filter.proto:83required filter = 1
message
Filter.proto:87(message has no fields)
message
Filter.proto:90repeated bytes qualifiers = 1
message
ErrorHandling.proto:55* Exception sent across the wire when a remote task needs to notify other tasks that it failed and why
Used in:
optional string source = 1
optional generic_exception = 2
message
Filter.proto:94repeated fuzzy_keys_data = 1
message
ErrorHandling.proto:44* 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:69* 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.
optional Consistency consistency = 12
Used in:
NOT_FOUND = 0
RUNNING = 1
FINISHED = 2
message
FS.proto:30* The ${HBASE_ROOTDIR}/hbase.version file content
Used in:
required string version = 1
message
Filter.proto:98optional bytes stop_row_key = 1
message
Filter.proto:102required bool len_as_val = 1
message
Cell.proto:59* 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
optional bytes tags = 7
message
ClusterStatus.proto:209Used in:
required server = 1
required server_load = 2
message
Comparator.proto:43required comparable = 1
message
HBase.proto:194required int64 long_msg = 1
message
Master.proto:421Used as response type in: MasterService.getLastMajorCompactionTimestamp, MasterService.getLastMajorCompactionTimestampForRegion
required int64 compaction_timestamp = 1
message
ZooKeeper.proto:51* 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.
optional uint32 info_port = 3
message
ZooKeeper.proto:35* Content of the meta-region-server znode.
required server = 1
The ServerName hosting the meta region currently, or destination server, if meta region is in transition.
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.
optional RegionState.State state = 3
State of the region transition. OPEN means fully operational 'hbase:meta'
message
MultiRowMutation.proto:26(message has no fields)
message
MultiRowMutation.proto:29(message has no fields)
message
Filter.proto:168repeated row_range_list = 1
message
Filter.proto:106repeated bytes sorted_prefixes = 1
message
Client.proto:151* 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.
optional uint64 nonce = 9
message
Client.proto:194Used in:
required bytes family = 1
repeated qualifier_value = 2
message
Client.proto:198Used in:
optional bytes qualifier = 1
optional bytes value = 2
optional uint64 timestamp = 3
optional DeleteType delete_type = 4
optional bytes tags = 5
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:139Used in: , , , , , ,
required string name = 1
optional bytes value = 2
message
HBase.proto:149optional string name = 1
optional int64 value = 2
message
HBase.proto:134Used in: , , , ,
required string name = 1
required string value = 2
message
HBase.proto:211Used in: , , ,
required bytes name = 1
repeated configuration = 2
message
Comparator.proto:62(message has no fields)
message
Filter.proto:110required int64 page_size = 1
message
Filter.proto:114optional bytes prefix = 1
message
HBase.proto:174* Description of the distributed procedure to take
Used in: , ,
required string signature = 1
the unique signature of the procedure
optional string instance = 2
the procedure instance name
optional int64 creation_time = 3
repeated configuration = 4
message
Filter.proto:118required compare_filter = 1
Used in:
CLUSTER = 1
MACHINE = 2
THROTTLE = 1
message
Quota.proto:73(message has no fields)
message
Quota.proto:68optional bool bypass_globals = 1
optional throttle = 2
message
Tracing.proto:30Used 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:122required float chance = 1
message
FS.proto:37* 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:65required string pattern = 1
required int32 pattern_flags = 2
required string charset = 3
optional string engine = 4
message
Client.proto:379* 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:417* 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:58Used in:
required spec = 1
required region_state = 2
message
HBase.proto:61* 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
optional int32 replica_id = 7
message
ClusterStatus.proto:80Used 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
optional float data_locality = 16
* The current data locality for region in the regionserver
optional uint64 last_major_compaction_ts = 17
repeated store_complete_sequence_id = 18
* the most recent sequence Id of store from cache flush
message
Client.proto:389Statistics about the current load on the region
Used in:
optional int32 memstoreLoad = 1
Percent load on the memstore. Guaranteed to be positive, between 0 and 100.
optional int32 heapOccupancy = 2
Percent JVM heap occupancy. Guaranteed to be positive, between 0 and 100. We can move this to "ServerLoadStats" should we develop them.
message
HBase.proto:219* Description of the region server info
optional int32 infoPort = 1
message
HBase.proto:84* 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:31Used 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
ClusterStatus.proto:75* contains a sequence id of a region which should be the minimum of its store sequence ids and list of sequence ids of the region's stores
required uint64 last_flushed_sequence_id = 1
repeated store_sequence_id = 2
message
ZooKeeper.proto:72* 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
ZooKeeper.proto:148* Used by replication. Holds the current position in an WAL file.
required int64 position = 1
message
ClusterStatus.proto:143Used in:
required uint64 ageOfLastAppliedOp = 1
required uint64 timeStampsOfLastAppliedOp = 2
message
ClusterStatus.proto:148Used in:
required string peerID = 1
required uint64 ageOfLastShippedOp = 2
required uint32 sizeOfLogQueue = 3
required uint64 timeStampOfLastShippedOp = 4
required uint64 replicationLag = 5
message
ZooKeeper.proto:155* Used by replication. Used to lock a region server during failover.
required string lock_owner = 1
message
ZooKeeper.proto:125* 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
optional string replicationEndpointImpl = 2
repeated data = 3
repeated configuration = 4
message
ZooKeeper.proto:137* Used by replication. Holds whether enabled or disabled
required ReplicationState.State state = 1
Used in:
ENABLED = 0
DISABLED = 1
message
RPC.proto:125Header 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. 200 is HIGH. If no priority, treat it as NORMAL. See HConstants.
message
RPC.proto:139optional 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:91Used 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.
optional bool stale = 4
Whether or not the results are coming from possibly stale data
optional bool partial = 5
Whether or not the entire result could be returned. Results will be split when the RPC chunk size limit is reached. Partial results contain only a subset of the cells for a row and must be combined with a result containing the remaining cells to form a complete result
message
Client.proto:402* 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
optional service_result = 4
result if this was a coprocessor service call
optional loadStats = 5
current load on the region
message
Filter.proto:126required compare_filter = 1
message
Filter.proto:161Used in:
optional bytes start_row = 1
optional bool start_row_inclusive = 2
optional bytes stop_row = 3
optional bool stop_row_inclusive = 4
message
Client.proto:240* 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
optional bool reversed = 15
optional Consistency consistency = 16
optional uint32 caching = 17
message
ClusterStatus.proto:156Used in:
optional uint64 number_of_requests = 1
* Number of requests since last report.
optional uint64 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.
repeated replLoadSource = 10
* The replicationLoadSource for the replication Source status of this region server.
optional replLoadSink = 11
* The replicationLoadSink for the replication Sink status of this region server.
message
HBase.proto:122* Protocol buffer version of ServerName
Used in: , , , , , , , ,
required string host_name = 1
optional uint32 port = 2
optional uint64 start_code = 3
message
Filter.proto:130required single_column_value_filter = 1
message
Filter.proto:134Used 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:143required filter = 1
message
HBase.proto:157* 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
optional string owner = 6
Used in:
DISABLED = 0
FLUSH = 1
SKIPFLUSH = 2
message
ZooKeeper.proto:87* 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
optional SplitLogTask.RecoveryMode mode = 3
Used in:
UNKNOWN = 0
LOG_SPLITTING = 1
LOG_REPLAY = 2
Used in:
UNASSIGNED = 0
OWNED = 1
RESIGNED = 2
DONE = 3
ERR = 4
message
ErrorHandling.proto:31* 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
ClusterStatus.proto:66* sequence Id of a store
Used in: ,
required bytes family_name = 1
required uint64 sequence_id = 2
message
Comparator.proto:72required string substr = 1
message
ZooKeeper.proto:108* 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:162* 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:32* Table Name
Used in: , , , , , , , , , , , , , , , ,
required bytes namespace = 1
required bytes qualifier = 2
message
HBase.proto:41* Table Schema Inspired by the rest TableSchema
Used in: , , ,
optional table_name = 1
repeated attributes = 2
repeated column_families = 3
repeated configuration = 4
message
Quota.proto:48Used in:
optional req_num = 1
optional req_size = 2
optional write_num = 3
optional write_size = 4
optional read_num = 5
optional read_size = 6
message
Quota.proto:59Used in:
optional ThrottleType type = 1
optional timed_quota = 2
Used in:
REQUEST_NUMBER = 1
REQUEST_SIZE = 2
WRITE_NUMBER = 3
WRITE_SIZE = 4
READ_NUMBER = 5
READ_SIZE = 6
message
HBase.proto:103* 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
Used in:
NANOSECONDS = 1
MICROSECONDS = 2
MILLISECONDS = 3
SECONDS = 4
MINUTES = 5
HOURS = 6
DAYS = 7
message
Quota.proto:32Used in: ,
required TimeUnit time_unit = 1
optional uint64 soft_limit = 2
optional float share = 3
optional QuotaScope scope = 4
message
Filter.proto:147repeated int64 timestamps = 1
message
HBase.proto:206required uint64 least_sig_bits = 1
required uint64 most_sig_bits = 2
message
RPC.proto:75User Information proto. Included in ConnectionHeader on connection setup
Used in:
required string effective_user = 1
optional string real_user = 2
message
Filter.proto:151required compare_filter = 1
message
RPC.proto:81Rpc client version info proto. Included in ConnectionHeader on connection setup
Used in:
required string version = 1
required string url = 2
required string revision = 3
required string user = 4
required string date = 5
required string src_checksum = 6
message
Filter.proto:155required filter = 1