package yb.tserver
Get desktop application:
View/edit binary Protocol Buffers messages
rpc Heartbeat (, )
pg_client.proto:33message
pg_client.proto:165uint64 session_id = 1
uint32 pid = 2
message
pg_client.proto:170optional status = 1
uint64 session_id = 2
bytes instance_id = 3
rpc AlterDatabase (, )
pg_client.proto:35message
pg_client.proto:181uint64 session_id = 1
string database_name = 2
uint32 database_oid = 3
string new_name = 4
optional ash_metadata = 5
message
pg_client.proto:189optional status = 1
rpc AlterTable (, )
pg_client.proto:36message
pg_client.proto:237uint64 session_id = 1
bool use_transaction = 2
optional table_id = 3
repeated add_columns = 4
repeated rename_columns = 5
repeated string drop_columns = 6
optional rename_table = 7
bool increment_schema_version = 8
optional replica_identity = 9
optional ash_metadata = 10
bool use_regular_transaction_block = 11
message
pg_client.proto:251optional status = 1
rpc BackfillIndex (, )
pg_client.proto:37message
pg_client.proto:193uint64 session_id = 1
optional table_id = 2
optional ash_metadata = 3
message
pg_client.proto:199optional status = 1
rpc CreateDatabase (, )
pg_client.proto:38message
pg_client.proto:255uint64 session_id = 1
bool use_transaction = 2
string database_name = 3
uint32 database_oid = 4
uint32 source_database_oid = 5
uint32 next_oid = 6
bool colocated = 7
fixed64 clone_time = 8
string source_database_name = 9
string source_owner = 10
string target_owner = 11
optional ash_metadata = 12
bool use_regular_transaction_block = 13
message
pg_client.proto:271optional status = 1
message
pg_client.proto:305uint64 session_id = 1
uint32 database_oid = 2
string replication_slot_name = 3
PgReplicationSlotSnapshotActionPB snapshot_action = 4
string output_plugin_name = 5
optional ash_metadata = 6
PGReplicationSlotLsnType lsn_type = 7
PGReplicationSlotOrderingMode ordering_mode = 8
message
pg_client.proto:316optional status = 1
bytes stream_id = 2
uint64 cdcsdk_consistent_snapshot_time = 3
message
pg_client.proto:275(message has no fields)
message
pg_client.proto:322optional status = 1
rpc CreateTable (, )
pg_client.proto:43message
pg_client.proto:341uint64 session_id = 1
bool use_transaction = 2
bool use_regular_transaction_block = 26
optional table_id = 3
string database_name = 4
string table_name = 5
int32 num_tablets = 6
bool is_pg_catalog_table = 7
bool is_shared_table = 8
bool if_not_exist = 9
bool is_colocated_via_database = 10
optional tablegroup_oid = 11
oneof optional_colocation_id
Auto-generated by catalog manager if not specified. Only makes sense for colocated tables. Note: proto3 v3.15 includes an "optional" keyword as a syntactic sugar for this oneof wrapper.
uint32 colocation_id = 20
optional tablespace_oid = 12
repeated create_columns = 13
repeated split_bounds = 14
optional base_table_id = 15
Actual for index only.
bool is_unique_index = 16
bool skip_index_backfill = 17
bool is_matview = 21
optional pg_table_oid = 18
Used during a table rewrite operation to explicitly store the PG table oid.
string schema_name = 19
optional old_relfilenode_oid = 22
Used during a table rewrite operation to store the relfilenode OID that maps to the old DocDB table.
bool is_truncate = 23
Set to true when the table is being re-written as part of a TRUNCATE operation.
optional vector_idx_options = 24
optional ash_metadata = 25
message
pg_client.proto:387optional status = 1
rpc CreateTablegroup (, )
pg_client.proto:44message
pg_client.proto:391uint64 session_id = 1
string database_name = 2
optional tablegroup_id = 3
optional tablespace_id = 4
optional ash_metadata = 5
bool use_regular_transaction_block = 6
message
pg_client.proto:403optional status = 1
rpc DropDatabase (, )
pg_client.proto:45message
pg_client.proto:407uint64 session_id = 1
string database_name = 3
uint32 database_oid = 4
optional ash_metadata = 5
message
pg_client.proto:414optional status = 1
message
pg_client.proto:418uint64 session_id = 1
string replication_slot_name = 2
optional ash_metadata = 3
message
pg_client.proto:424optional status = 1
rpc DropTable (, )
pg_client.proto:47message
pg_client.proto:428uint64 session_id = 1
optional table_id = 2
bool index = 3
optional ash_metadata = 4
bool use_regular_transaction_block = 5
message
pg_client.proto:436optional status = 1
optional indexed_table = 2
rpc DropTablegroup (, )
pg_client.proto:48message
pg_client.proto:441uint64 session_id = 1
optional tablegroup_id = 2
optional ash_metadata = 3
bool use_regular_transaction_block = 4
message
pg_client.proto:448optional status = 1
rpc FinishTransaction (, )
pg_client.proto:49message
pg_client.proto:460uint64 session_id = 1
bool commit = 2
optional ddl_mode = 3
optional ash_metadata = 4
message
pg_client.proto:479optional status = 1
message
pg_client.proto:452(message has no fields)
message
pg_client.proto:483optional status = 1
uint64 version = 2
rpc GetXClusterRole (, )
pg_client.proto:52message
pg_client.proto:455uint32 db_oid = 1
optional ash_metadata = 2
message
pg_client.proto:488optional status = 1
uint32 xcluster_role = 2
Really XClusterNamespaceInfoPB.XClusterRole.
rpc GetDatabaseInfo (, )
pg_client.proto:53message
pg_client.proto:493uint32 oid = 1
message
pg_client.proto:497optional status = 1
optional info = 2
rpc GetLockStatus (, )
pg_client.proto:54message
pg_client.proto:511bytes table_id = 1
The table to scan. If unset, scan all tables
bytes transaction_id = 2
If set, only read the locks associated with this txn_id and ignore the fields min_txn_age_ms and max_num_txns.
uint32 min_txn_age_ms = 3
Return lock statuses of transactions with age >= 'min_txn_age_ms'
uint32 max_num_txns = 4
Limit number of old transactions whose lock info is retrieved.
uint32 max_txn_locks_per_tablet = 5
Limit number of locks returned per transaction at each tablet
optional ash_metadata = 6
message
pg_client.proto:531optional status = 1
repeated node_locks = 2
map<string, > transactions_by_node = 3
Map of transactions keyed by the host node uuid.
rpc GetReplicationSlot (, )
pg_client.proto:55message
pg_client.proto:550string replication_slot_name = 1
optional ash_metadata = 2
message
pg_client.proto:558optional status = 1
optional replication_slot_info = 2
rpc IsInitDbDone (, )
pg_client.proto:56message
pg_client.proto:503(message has no fields)
message
pg_client.proto:506optional status = 1
bool done = 2
message
pg_client.proto:568bool primary_only = 1
optional ash_metadata = 2
message
pg_client.proto:597optional status = 1
repeated servers = 2
string universe_uuid = 3
message
pg_client.proto:603optional ash_metadata = 1
message
pg_client.proto:626optional status = 1
repeated replication_slots = 2
message
pg_client.proto:585repeated index_ids = 1
optional ash_metadata = 2
message
pg_client.proto:590optional status = 1
repeated uint64 rows_processed_entries = 2
The ordering of the indexes' results here is expected to be the same as the ordering in the corresponding request PB (PgGetIndexBackfillProgressRequestPB).
rpc OpenTable (, )
pg_client.proto:63message
pg_client.proto:631string table_id = 1
bool reopen = 2
bool include_hidden = 4
Allows a hidden table to be opened. Hidden table is a dropped table retained in DocDB for PITR, CLONE, AS-OF.
optional ash_metadata = 5
uint64 ysql_catalog_version = 6
message
pg_client.proto:651optional status = 1
optional info = 2
optional partitions = 3
message
pg_client.proto:658string table_id = 1
optional ash_metadata = 2
message
pg_client.proto:663optional status = 1
optional partitions = 2
rpc Perform (, )
pg_client.proto:66message
pg_client.proto:737uint64 session_id = 1
optional options = 2
repeated ops = 3
fixed64 write_time = 4
message
pg_client.proto:744optional status = 1
repeated responses = 2
optional catalog_read_time = 3
fixed64 used_in_txn_limit_ht = 4
message
pg_client.proto:668string table_id = 1
optional ash_metadata = 2
message
pg_client.proto:673optional status = 1
bool ready = 2
rpc ReserveOids (, )
pg_client.proto:73message
pg_client.proto:751uint32 database_oid = 1
uint32 next_oid = 2
uint32 count = 3
optional ash_metadata = 4
message
pg_client.proto:758optional status = 1
uint32 begin_oid = 2
uint32 end_oid = 3
message
pg_client.proto:765uint64 session_id = 1
uint32 sub_transaction_id = 2
optional options = 3
optional ash_metadata = 4
message
pg_client.proto:772optional status = 1
rpc TabletServerCount (, )
pg_client.proto:77message
pg_client.proto:776bool primary_only = 1
optional ash_metadata = 2
message
pg_client.proto:781optional status = 1
int32 count = 2
rpc TruncateTable (, )
pg_client.proto:78message
pg_client.proto:786uint64 session_id = 1
optional table_id = 2
optional ash_metadata = 3
message
pg_client.proto:792optional status = 1
rpc ValidatePlacement (, )
pg_client.proto:79message
pg_client.proto:805uint64 session_id = 1
int32 num_replicas = 2
deprecated, use replication_info
repeated placement_infos = 3
deprecated, use replication_info
optional ash_metadata = 4
optional replication_info = 5
message
pg_client.proto:813optional status = 1
rpc GetTableDiskSize (, )
pg_client.proto:81message
pg_client.proto:912optional table_id = 1
optional ash_metadata = 2
message
pg_client.proto:917optional status = 1
int64 size = 2
size is 0 for colocated tables
int32 num_missing_tablets = 3
message
pg_client.proto:992uint64 session_id = 1
uint32 database_oid = 2
uint64 catalog_version = 3
int32 requestor_pg_backend_pid = 5
optional ash_metadata = 4
message
pg_client.proto:1000optional status = 1
int32 num_lagging_backends = 2
Number of YSQL backends (across all tservers) that have not reached the requested catalog version. If the field is -1, the counting is in-progress.
message
pg_client.proto:817uint64 session_id = 1
int64 db_oid = 2
int64 seq_oid = 3
uint64 ysql_catalog_version = 4
uint64 ysql_db_catalog_version = 7
int64 last_val = 5
bool is_called = 6
optional ash_metadata = 8
message
pg_client.proto:828optional status = 1
message
pg_client.proto:832uint64 session_id = 1
int64 db_oid = 2
int64 seq_oid = 3
uint64 ysql_catalog_version = 4
uint64 ysql_db_catalog_version = 10
int64 last_val = 5
bool is_called = 6
bool has_expected = 7
int64 expected_last_val = 8
bool expected_is_called = 9
optional ash_metadata = 11
message
pg_client.proto:846optional status = 1
bool skipped = 2
rpc FetchSequenceTuple (, )
pg_client.proto:88message
pg_client.proto:851uint64 session_id = 1
int64 db_oid = 2
int64 seq_oid = 3
uint64 ysql_catalog_version = 4
uint64 ysql_db_catalog_version = 10
uint32 fetch_count = 5
The number of values to fetch. If the cache method is connection, this quantity of values will be returned to the connection. If the cache method is server, this quantity will be retrieved from the master server when it is exhausted, and only one value will be returned to the connection.
int64 inc_by = 6
int64 min_value = 7
int64 max_value = 8
bool cycle = 9
optional ash_metadata = 11
message
pg_client.proto:869optional status = 1
int64 first_value = 2
int64 last_value = 3
rpc ReadSequenceTuple (, )
pg_client.proto:89message
pg_client.proto:875uint64 session_id = 1
int64 db_oid = 2
int64 seq_oid = 3
uint64 ysql_catalog_version = 4
uint64 ysql_db_catalog_version = 5
uint64 read_time = 6
optional ash_metadata = 7
message
pg_client.proto:885optional status = 1
int64 last_val = 2
bool is_called = 3
message
pg_client.proto:891uint64 session_id = 1
int64 db_oid = 2
int64 seq_oid = 3
optional ash_metadata = 4
message
pg_client.proto:898optional status = 1
rpc DeleteDBSequences (, )
pg_client.proto:91message
pg_client.proto:902uint64 session_id = 1
int64 db_oid = 2
optional ash_metadata = 3
message
pg_client.proto:908optional status = 1
rpc CheckIfPitrActive (, )
pg_client.proto:92message
pg_client.proto:925optional ash_metadata = 1
message
pg_client.proto:929bool is_pitr_active = 1
optional status = 2
message
pg_client.proto:934optional table_id = 2
optional ash_metadata = 3
message
pg_client.proto:939optional status = 1
bool is_object_part_of_xrepl = 2
message
pg_client.proto:944bool size_only = 1
True if we only want to return the size of the catalog version map from tserver.
uint32 db_oid = 2
If > 0, we ask for the catalog version of the given database from the tserver. If == 0, we ask for the catalog version map of all databases from the tserver.
optional ash_metadata = 3
message
pg_client.proto:953optional status = 1
repeated entries = 2
uint32 num_entries = 3
rpc CancelTransaction (, )
pg_client.proto:97message
pg_client.proto:1007bytes transaction_id = 1
bytes status_tablet_id = 2
Populating the field is optional. When populated, the cancel request is sent to the specified status tablet alone. If not, the request is forwarded to all tablet servers and is thereafter broadcast to all status tablets hosted by the tablet server.
optional ash_metadata = 3
message
pg_client.proto:1017optional status = 1
message
pg_client.proto:1021uint32 sample_size = 7
bool fetch_tserver_states = 1
bool fetch_flush_and_compaction_states = 2
bool fetch_cql_states = 3
bool ignore_ash_and_perform_calls = 4
bool fetch_raft_log_appender_states = 5
bool export_wait_state_code_as_string = 6
message
pg_client.proto:1037optional status = 1
optional tserver_wait_states = 2
optional DEPRECATED_flush_and_compaction_wait_states = 3
flush_and_compaction_wait_states and raft_log_appender_wait_states are included in tserver_wait_states
optional DEPRECATED_raft_log_appender_wait_states = 4
optional cql_wait_states = 5
message
pg_client.proto:1047optional session_id = 1
optional ash_metadata = 2
message
pg_client.proto:1052optional status = 1
repeated entries = 2
rpc GetTableKeyRanges (, )
pg_client.proto:103message
pg_client.proto:1061uint64 session_id = 1
optional table_id = 2
bytes lower_bound_key = 3
bytes upper_bound_key = 4
uint64 max_num_ranges = 5
uint64 range_size_bytes = 6
bool is_forward = 7
uint32 max_key_length = 8
optional ash_metadata = 9
message
pg_client.proto:1073optional status = 1
fixed64 current_ht = 2
rpc GetNewObjectId (, )
pg_client.proto:105message
pg_client.proto:1078uint32 db_oid = 1
optional ash_metadata = 2
message
pg_client.proto:1083optional status = 1
uint32 new_oid = 2
rpc TabletsMetadata (, )
pg_client.proto:108message
pg_client.proto:1121optional ash_metadata = 1
message
pg_client.proto:1125optional status = 1
repeated tablets = 2
rpc ServersMetrics (, )
pg_client.proto:110message
pg_client.proto:1130optional ash_metadata = 1
message
pg_client.proto:1146optional status = 1
repeated servers_metrics = 2
rpc ListClones (, )
pg_client.proto:112message
pg_client.proto:1168optional ash_metadata = 1
message
pg_client.proto:1172optional status = 1
repeated database_clones = 2
rpc FetchData (, )
pg_client.proto:114message
pg_client.proto:1088uint64 session_id = 1
uint64 data_id = 2
message
pg_client.proto:1093optional status = 1
uint32 sidecar = 2
message
pg_client.proto:1098optional ash_metadata = 1
message
pg_client.proto:1102optional status = 1
repeated statements = 2
rpc CronSetLastMinute (, )
pg_client.proto:121message
pg_client.proto:1151int64 last_minute = 1
optional ash_metadata = 2
message
pg_client.proto:1156optional status = 1
rpc CronGetLastMinute (, )
pg_client.proto:124message
pg_client.proto:1160optional ash_metadata = 1
message
pg_client.proto:1164int64 last_minute = 1
optional status = 2
message
pg_client.proto:1207uint64 session_id = 1
Set for both session and txn level locks.
uint32 db_oid = 2
repeated locks = 3
bool wait = 4
bool session = 5
Acquire lock in session level or transaction level.
optional options = 6
Only set on txn level locks.
optional ash_metadata = 7
message
pg_client.proto:1217optional status = 1
message
pg_client.proto:1221uint64 session_id = 1
Only session advisory locks can be explicitly released. Transaction level locks are released automatically once txn finishes.
uint32 db_oid = 2
repeated locks = 3
optional ash_metadata = 4
message
pg_client.proto:1230optional status = 1
rpc AcquireObjectLock (, )
pg_client.proto:132message
pg_client.proto:1246uint64 session_id = 1
optional options = 2
uint64 database_oid = 3
uint64 object_oid = 4
ObjectLockMode lock_type = 5
Cannot use TableLockType enum due to proto2/3 compatibility issues.
optional ash_metadata = 6
message
pg_client.proto:1256optional status = 1
rpc ExportTxnSnapshot (, )
pg_client.proto:135message
pg_client.proto:1260uint64 session_id = 1
optional snapshot = 2
optional options = 3
optional ash_metadata = 4
message
pg_client.proto:1267optional status = 1
string snapshot_id = 2
rpc ImportTxnSnapshot (, )
pg_client.proto:138message
pg_client.proto:1272uint64 session_id = 1
string snapshot_id = 2
optional options = 3
optional ash_metadata = 4
message
pg_client.proto:1279optional status = 1
optional snapshot = 2
message
pg_client.proto:1284uint64 session_id = 1
optional ash_metadata = 2
message
pg_client.proto:1289optional status = 1
message
pg_client.proto:959uint32 db_oid = 1
uint64 ysql_catalog_version = 2
We are only interested in messages associated with ysql_catalog_version + 1 and beyond. For example, if ysql_catalog_version == x, we will fetch messages x + 1, x + 2, ... x + k stored in tserver messages queue (with no holes), where k is num_catalog_versions. This represents the case where PG backend's local catalog version is x and the shared memory catalog version is x + k. Those messages of catalog version y (y <= x) in the tserver message queue will be skipped for this request.
uint32 num_catalog_versions = 3
optional ash_metadata = 4
message
pg_client.proto:972optional status = 1
repeated entries = 2
Each entry is a list of messages associated with a catalog version. If the request cannot be fulfilled, entries will be empty. This only happens when the requested sequence does not exist in the tserver's message queue.
message
pg_client.proto:980uint32 db_oid = 1
bool is_breaking_change = 2
uint64 new_catalog_version = 3
optional message_list = 4
optional ash_metadata = 5
message
pg_client.proto:988optional status = 1
RaftConfig remote bootstrap RPC calls.
Establish a remote bootstrap session.
message
remote_bootstrap.proto:146required bytes requestor_uuid = 1
permanent_uuid of the requesting peer.
required bytes tablet_id = 2
tablet_id of the tablet the requester desires to bootstrap from.
optional tablet_leader_conn_info = 3
connection info of the tablet leader peer for the corresponding tablet_id
optional ash_metadata = 4
message
remote_bootstrap.proto:159required bytes session_id = 1
Opaque session id assigned by the server. No guarantees are made as to the format of the session id.
required uint64 session_idle_timeout_millis = 2
Maximum session idle timeout between requests. Learners will have to start over again if they reach this timeout. A value of 0 means there is no timeout.
required superblock = 3
Active superblock at the time of the request.
repeated uint64 DEPRECATED_wal_segment_seqnos = 4
Identifiers for the WAL segments available for download. Each WAL segment is keyed by its sequence number.
optional uint64 first_wal_segment_seqno = 6
Sequence number of first WAL segment available for download.
required initial_committed_cstate = 5
A snapshot of the committed Consensus state at the time that the remote bootstrap session was started.
optional bool retryable_requests_file_flushed = 7
If the tablet has a retryable requests file flushed to disk.
Establish a remote snapshot transfer session.
message
remote_bootstrap.proto:187required bytes requestor_uuid = 1
permanent_uuid of the requesting peer.
required bytes tablet_id = 2
tablet_id of the tablet the requester desires to bootstrap from.
message
remote_bootstrap.proto:195required bytes session_id = 1
Opaque session id assigned by the server. No guarantees are made as to the format of the session id.
required uint64 session_idle_timeout_millis = 2
Maximum session idle timeout between requests. Learners will have to start over again if they reach this timeout. A value of 0 means there is no timeout.
required superblock = 3
Active superblock at the time of the request.
Check whether the specified session is active.
message
remote_bootstrap.proto:209required bytes session_id = 1
Valid Session ID returned by a BeginRemoteBootstrapSession() RPC call.
optional bool keepalive = 2
Set keepalive to true to reset the session timeout timer.
message
remote_bootstrap.proto:217required bool session_is_active = 1
Whether the given session id represents an active remote bootstrap session.
rpc FetchData (, )
remote_bootstrap.proto:61Fetch data (blocks, logs) from the server.
message
remote_bootstrap.proto:243required bytes session_id = 1
Valid Session ID returned by a BeginRemoteBootstrapSession() RPC call.
required data_id = 2
The server will use this ID to determine the key and type of data that was requested.
optional uint64 offset = 3
Offset into data to start reading from. If not specified, the server will send the data from offset 0.
optional int64 max_length = 4
Maximum length of the chunk of data to return. If max_length is not specified, or if the server's max is less than the requested max, the server will use its own max.
optional ash_metadata = 5
message
remote_bootstrap.proto:279required chunk = 1
The server will automatically release the resources (i.e. close file, free read buffers) for a given data resource after the last byte is read. So, per-resource, chunks are optimized to be fetched in-order.
End a remote bootstrap session, allow server to release resources.
message
remote_bootstrap.proto:286required bytes session_id = 1
required bool is_success = 2
Set to true if bootstrap is successful.
optional error = 3
Client-provided error message. The server will log this error so that an admin can identify when bad things are happening with remote bootstrap.
optional bool keep_session = 4
True if we should not remove session on this request, and it will be removed by upcoming RemoveRemoteBootstrapSession.
message
remote_bootstrap.proto:301optional bool session_kept = 1
message
remote_bootstrap.proto:305optional bytes session_id = 1
message
remote_bootstrap.proto:309(message has no fields)
Register Log Anchor on the leader. RBS source calls this function on the tablet leader while beginning the RemoteBootstrapSession
message
remote_bootstrap.proto:312required bytes owner_info = 1
information on the owner requesting this anchor. can be something suffixed with the session id of the ongoing RemoteBootstrapSession. Used to map the incoming requests with the LogAnchors maintained.
required bytes tablet_id = 2
tablet_id of the tablet the requester desires to bootstrap from.
required op_id = 3
The 'index' field of op_id should be set to the log index where the anchor needs to be registered at. The 'term' field of op_id is ignored.
optional bool session_succeeded = 4
Indicates whether the rbs dest was able to suucessfully fetch all the data from the source.
message
remote_bootstrap.proto:329(message has no fields)
Updates the Log Anchor on the tablet leader. RBS source calls the function whenever the LogAnchor is being updated locally.
message
remote_bootstrap.proto:331required bytes owner_info = 1
RemoteBootstrapSession session_id that was used earlier to initiate a RemoteBootstrapAnchor request.
required op_id = 2
The 'index' field of op_id should be set to the log index where the anchor needs to be updated to. The 'term' field of op_id is ignored.
optional bool session_succeeded = 3
Indicates whether the rbs dest was able to suucessfully fetch all the data from the source.
message
remote_bootstrap.proto:344(message has no fields)
Unregisters the Log Anchor on the leader, called by RBS source.
message
remote_bootstrap.proto:346required bytes owner_info = 1
RemoteBootstrapSession session_id that was used earlier to initiate a RemoteBootstrapAnchor request.
message
remote_bootstrap.proto:352(message has no fields)
Request to refresh the Log Anchor Session, called by RBS source.
message
remote_bootstrap.proto:354required bytes owner_info = 1
RemoteBootstrapSession session_id that was used earlier to initiate a RemoteBootstrapAnchor request.
optional bool session_succeeded = 2
Indicates whether the rbs dest was able to suucessfully fetch all the data from the source. This state is used to determine the amount by which the session's expiration time should be bumped up on the leader peer.
message
remote_bootstrap.proto:365(message has no fields)
RBS source asks the leader to change the role of the new peer post bootstrap.
message
remote_bootstrap.proto:367required bytes owner_info = 1
RemoteBootstrapSession session_id that was used earlier to initiate a RemoteBootstrapAnchor request.
required bytes requestor_uuid = 2
peer uuid of the new peer being bootstrapped.
message
remote_bootstrap.proto:376(message has no fields)
rpc CreateTablet (, )
tserver_admin.proto:386Create a new, empty tablet with the specified parameters. Only used for brand-new tablets, not for "moves".
message
tserver_admin.proto:127A create tablet request.
optional bytes dest_uuid = 8
UUID of server this request is addressed to.
required bytes table_id = 1
required bytes tablet_id = 2
optional bytes start_key = 3
DEPRECATED.
optional bytes end_key = 4
DEPRECATED.
optional partition = 9
The partition of the tablet.
optional bytes namespace_id = 14
optional bytes namespace_name = 15
required string table_name = 5
optional TableType table_type = 11
required schema = 6
optional partition_schema = 10
The partition schema of the table which the tablet belongs to.
required config = 7
Initial consensus configuration for the tablet.
optional index_info = 12
For index table: information about this index.
optional bool colocated = 13
True if the tablet is colocated.
repeated bytes snapshot_schedules = 16
repeated StatefulServiceKind hosted_stateful_services = 17
optional bytes pg_table_id = 18
In case the table was rewritten, explicitly store the TableId containing the PG table OID (as the table's TableId no longer matches).
optional uint32 wal_retention_secs = 19
optional bool cdc_sdk_set_retention_barriers = 20
If set to true, retention barriers will be set on the tablet.
message
tserver_admin.proto:171optional error = 1
optional cdc_sdk_safe_op_id = 2
CDC SDK Create dynamic table context. The initial safe_op_id for a tablet of a dynamically added table.
Prepare a transasction tablet for deletion. This waits for all relevant intents to be applied and cleaned up.
message
tserver_admin.proto:179optional bytes dest_uuid = 2
UUID of server this request is addressed to.
required bytes tablet_id = 1
message
tserver_admin.proto:186optional error = 1
rpc DeleteTablet (, )
tserver_admin.proto:394Delete a tablet replica.
message
tserver_admin.proto:191A delete tablet request.
optional bytes dest_uuid = 4
UUID of server this request is addressed to.
required bytes tablet_id = 1
optional string reason = 2
Reason the tablet is being deleted (for logging purposes)
optional tablet.TabletDataState delete_type = 3
Must be one of TABLET_DATA_DELETED (for table deletes) or TABLET_DATA_TOMBSTONED (for replica retirement).
optional int64 cas_config_opid_index_less_or_equal = 5
The highest allowed OpId index of the latest known committed config. This optional parameter is here to provide an atomic (compare-and-swap) DeleteTablet operation. If this parameter is specified, the DeleteTablet() operation will succeed only if the committed config has an opid_index that is less than or equal to this value. See also the definition of RaftConfigPB. Note: At the time of this writing, there is a small race between checking the value of the committed config opid index and shutting down the tablet for deletion. See comments in ts_tablet_manager.cc
optional bool hide_only = 6
Hide tablet instead of deleting it.
optional bool should_abort_active_txns = 7
Tablet server should trigger abort of all transactions it participates in upon shutting down this tablet. Should generally be set to true in the case of a dropped table.
optional bool keep_data = 8
Do not delete tablet data.
message
tserver_admin.proto:226optional error = 1
rpc AlterSchema (, )
tserver_admin.proto:397Alter a tablet's schema.
rpc GetSafeTime (, )
tserver_admin.proto:400GetSafeTime API to get the current safe time.
message
tserver_admin.proto:63optional bytes dest_uuid = 1
UUID of server this request is addressed to.
required bytes tablet_id = 2
optional uint32 schema_version = 3
optional fixed64 propagated_hybrid_time = 4
optional fixed64 min_hybrid_time_for_backfill = 5
message
tserver_admin.proto:76optional error = 1
optional fixed64 safe_time = 2
optional fixed64 propagated_hybrid_time = 3
rpc BackfillIndex (, )
tserver_admin.proto:404Backfill the index for the specified index tables. Addressed to the indexed table.
message
tserver_admin.proto:84optional bytes dest_uuid = 1
UUID of server this request is addressed to.
required bytes tablet_id = 2
repeated indexes = 3
Indexes on the _same table_ to backfill.
optional uint32 schema_version = 4
optional fixed64 read_at_hybrid_time = 5
optional bytes start_key = 6
optional bytes end_key = 7
optional fixed64 propagated_hybrid_time = 8
optional string namespace_name = 9
Currently only used for YSQL.
optional bytes indexed_table_id = 10
Indexed table ID so we can properly address a colocated table.
message
tserver_admin.proto:109optional error = 1
optional fixed64 propagated_hybrid_time = 2
optional bytes backfilled_until = 3
If non-empty, this is used to keep track of how far along the backfill has completed, so that it can be resumed. Encoded as the DocKey for the next row to be backfilled.
repeated bytes failed_index_ids = 4
In case of a partial error, list of indexes that failed.
optional uint64 number_rows_processed = 5
Returns the number of rows backfilled in the request.
rpc BackfillDone (, )
tserver_admin.proto:407Marks an index table as having completed backfilling.
rpc FlushTablets (, )
tserver_admin.proto:409message
tserver_admin.proto:231TODO: rename this to FlushOrCompactTabletsRequestPB
optional bytes dest_uuid = 1
UUID of server this request is addressed to.
repeated bytes tablet_ids = 2
Tablets to flush.
optional fixed64 propagated_hybrid_time = 3
optional FlushTabletsRequestPB.Operation operation = 4
Actual operation that we plan to perform.
optional bool all_tablets = 5
Whether we want to flush or compact all tablets in the server.
optional bool regular_only = 6
Only flush/compact regular RocksDB, not intents RocksDB.
repeated bytes vector_index_ids = 7
Performs operation only for the given vector indexes for the specified tablets.
optional bool all_vector_indexes = 8
Whether we want to perform operation for all vector indexes for the specified tablets.
message
tserver_admin.proto:262optional error = 1
optional bytes failed_tablet_id = 2
optional fixed64 propagated_hybrid_time = 3
rpc CountIntents (, )
tserver_admin.proto:411message
tserver_admin.proto:270(message has no fields)
message
tserver_admin.proto:273optional error = 1
optional int64 num_intents = 2
message
tserver_admin.proto:278required bytes tablet_id = 1
required add_table = 2
message
tserver_admin.proto:283optional error = 1
optional fixed64 propagated_hybrid_time = 2
message
tserver_admin.proto:288required bytes tablet_id = 1
required bytes remove_table_id = 2
message
tserver_admin.proto:293optional error = 1
optional fixed64 propagated_hybrid_time = 2
rpc SplitTablet (, )
tserver_admin.proto:418message
tserver_admin.proto:298optional error = 1
optional fixed64 propagated_hybrid_time = 2
rpc UpgradeYsql (, )
tserver_admin.proto:420message
tserver_admin.proto:303optional bool use_single_connection = 1
Perform an upgrade unsing just one connection. This is much slower but does not incur overhead for each database.
message
tserver_admin.proto:309optional error = 1
message
tserver_admin.proto:313optional uint32 database_oid = 1
required
optional uint64 catalog_version = 2
required
optional int32 requestor_pg_backend_pid = 4
optional
optional int32 prev_num_lagging_backends = 3
Previously known number of YSQL backends that have not reached the requested catalog version. -1 means unknown.
required
message
tserver_admin.proto:322optional error = 1
optional int32 num_lagging_backends = 2
Number of YSQL backends that have not reached the requested catalog version.
message
tserver_admin.proto:343required uint64 version = 1
message
tserver_admin.proto:347optional error = 1
rpc CloneTablet (, )
tserver_admin.proto:428message
tserver_admin.proto:351optional error = 1
optional fixed64 propagated_hybrid_time = 2
rpc ClonePgSchema (, )
tserver_admin.proto:431Create PG objects (database, tables and indexes) of the clone database.
message
tserver_admin.proto:356optional bytes source_db_name = 1
optional bytes target_db_name = 2
optional fixed64 restore_ht = 3
optional bytes source_owner = 4
optional bytes target_owner = 5
message
tserver_admin.proto:364optional error = 1
rpc EnableDbConns (, )
tserver_admin.proto:433message
tserver_admin.proto:368optional bytes target_db_name = 1
message
tserver_admin.proto:372optional error = 1
rpc TestRetry (, )
tserver_admin.proto:436For test purposes: returns TryAgain error until specified number of calls is done.
message
tserver_admin.proto:328optional bytes dest_uuid = 2
UUID of server this request is addressed to.
optional fixed64 propagated_hybrid_time = 3
required int32 num_retries = 4
See TestRetry RPC method description below.
message
tserver_admin.proto:338optional error = 1
optional fixed64 propagated_hybrid_time = 2
message
tserver_admin.proto:376(message has no fields)
message
tserver_admin.proto:378optional error = 1
optional pg_socket_dir = 2
rpc TabletSnapshotOp (, )
backup.proto:25message
backup.proto:99optional error = 1
fixed64 propagated_hybrid_time = 2
rpc Write (, )
tserver_service.proto:51message
tserver.proto:57A batched set of insert/mutate requests.
TODO(proto3) reserved 2, 3, 9;
required bytes tablet_id = 1
optional write_batch = 7
When replicating RocksDB write operations through Raft for single-shard transactions, we put a write batch here.
repeated redis_write_batch = 8
A batch of redis operations.
repeated ql_write_batch = 10
A batch of QL operations.
repeated pgsql_write_batch = 13
A batch of Pgsql operations.
repeated pgsql_lock_batch = 25
A batch of Pgsql locks.
optional fixed64 propagated_hybrid_time = 5
A hybrid_time obtained by the client from a previous request. TODO crypto sign this and propagate the signature along with the hybrid_time.
optional bool include_trace = 6
optional read_time = 12
optional fixed64 client_id1 = 14
Use 2 int64 to represent UUID.
optional fixed64 client_id2 = 15
optional int64 request_id = 16
optional int64 min_running_request_id = 17
optional double rejection_score = 18
optional fixed64 external_hybrid_time = 19
optional uint64 batch_idx = 20
optional int64 leader_term = 21
optional uint64 start_time_micros = 22
optional ash_metadata = 23
optional int64 raft_config_opid_index = 24
message
tserver.proto:107optional error = 1
If the entire WriteResponsePB request failed, the error status that caused the failure. This type of error is triggered for cases such as the tablet not being on this server, or the schema not matching. If any error specific to a given row occurs, this error will be recorded in per_row_errors below, even if all rows failed.
repeated per_row_errors = 2
repeated redis_response_batch = 8
A batch of redis responses.
repeated ql_response_batch = 9
A batch of QL responses.
repeated pgsql_response_batch = 12
A batch of QL responses.
optional fixed64 propagated_hybrid_time = 3
The hybrid_time chosen by the server for this write. TODO KUDU-611 propagate hybrid_times with server signature.
optional string trace_buffer = 10
optional restart_read_time = 11
Used to report restart whether this operation requires read restart.
optional used_read_time = 13
Used to report used read time when transaction asked for it.
optional fixed64 local_limit_ht = 14
optional tablet_consensus_info = 15
optional string restart_read_key = 16
key causing read restart. Present when restart_read_time is.
rpc Read (, )
tserver_service.proto:52message
tserver.proto:211optional bytes tablet_id = 1
The tablet to scan.
repeated redis_batch = 2
repeated ql_batch = 4
repeated pgsql_batch = 10
optional bool cache_blocks = 3
Whether data blocks will be cached when read from the files or discarded after use. Disable this to lower cache churn when doing large scans.
optional bool include_trace = 5
optional YBConsistencyLevel consistency_level = 6
TODO: add hybrid_time in future
optional transaction = 7
optional subtransaction = 15
optional fixed64 propagated_hybrid_time = 8
optional read_time = 9
See ReadHybridTime for explation of next two fields.
optional string proxy_uuid = 11
optional bool DEPRECATED_may_have_metadata = 12
optional double rejection_score = 13
optional uint64 batch_idx = 14
optional uint64 start_time_micros = 16
optional ash_metadata = 17
optional int64 raft_config_opid_index = 18
message
tserver.proto:254repeated redis_batch = 1
repeated ql_batch = 4
repeated pgsql_batch = 8
optional error = 3
optional string trace_buffer = 5
optional fixed64 propagated_hybrid_time = 6
optional restart_read_time = 7
Used to report restart whether this operation requires read restart.
optional used_read_time = 9
Used to report used read time when transaction asked for it.
optional fixed64 local_limit_ht = 10
optional tablet_consensus_info = 11
optional string restart_read_key = 12
key causing read restart. Present when restart_read_time is.
message
tserver.proto:184A verification request to check if a range of rows in main table is consistent with index table content. We will verify index table rows using the primary table.
required bytes tablet_id = 1
repeated bytes index_ids = 2
If indexes is empty, we will check all indexes If it contains entries, then we will check only the ones provided.
optional bytes start_key = 3
optional uint32 num_rows = 4
optional fixed64 read_time = 5
Read time if left empty will be replaced by the earliest safe time to read
optional fixed64 propagated_hybrid_time = 6
message
tserver.proto:201optional error = 1
map<string, uint64> consistency_stats = 2
optional bytes verified_until = 3
optional fixed64 propagated_hybrid_time = 4
rpc NoOp (, )
tserver_service.proto:56message
tserver.proto:173optional bytes tablet_id = 1
message
tserver.proto:177optional error = 1
rpc ListTablets (, )
tserver_service.proto:57message
tserver.proto:156A list tablets request
optional bool include_user_tablets_only = 1
message
tserver.proto:161A list tablets response
optional error = 1
repeated status_and_schema = 2
message
tserver_service.proto:221(message has no fields)
message
tserver_service.proto:224optional string log_location = 1
rpc Checksum (, )
tserver_service.proto:64Run full-scan data checksum on a tablet to verify data integrity. TODO: Consider refactoring this as a scan that runs a checksum aggregation function.
message
tserver_service.proto:228optional bytes tablet_id = 6
optional YBConsistencyLevel consistency_level = 7
message
tserver_service.proto:235optional error = 1
Error message, if any.
optional uint64 checksum = 2
The (possibly partial) checksum of the tablet data. This checksum is only complete if 'has_more_results' is false.
message
tserver_service.proto:246(message has no fields)
message
tserver_service.proto:249repeated entries = 1
rpc ImportData (, )
tserver_service.proto:69message
tserver_service.proto:266optional string tablet_id = 1
optional string source_dir = 2
message
tserver_service.proto:271optional error = 1
Error message, if any.
message
tserver_service.proto:276optional bytes tablet_id = 1
optional state = 2
optional fixed64 propagated_hybrid_time = 3
optional fixed64 start_time = 5
optional ash_metadata = 6
message
tserver_service.proto:288optional error = 1
Error message, if any.
optional fixed64 propagated_hybrid_time = 2
Returns transaction status at coordinator, i.e. PENDING, ABORTED, COMMITTED etc.
message
tserver_service.proto:295optional bytes tablet_id = 1
repeated bytes transaction_id = 2
optional fixed64 propagated_hybrid_time = 3
optional int64 raft_config_opid_index = 5
message
tserver_service.proto:304optional error = 1
Error message, if any.
repeated TransactionStatus status = 2
For backward compatibility we use multiple repeated fields instead of one field with custom message.
repeated fixed64 status_hybrid_time = 3
For description of status_hybrid_time see comment in TransactionStatusResult.
optional fixed64 propagated_hybrid_time = 4
repeated int64 num_replicated_batches = 5
repeated fixed64 coordinator_safe_time = 6
Size could be less than status size. In this case appropriates values should be interpreted as invalid hybrid time.
repeated aborted_subtxn_set = 7
repeated deadlock_reason = 8
Status containing deadlock info if the transaction was aborted due to deadlock. Else, it is set to Status::OK(). Note: The field might not be present on older versions of YB and hence its existence should be checked before usage by the reader.
optional tablet_consensus_info = 9
repeated uint64 pg_session_req_version = 11
Returns the oldest transactions (older than a specified age) from a specified status tablet.
message
tserver_service.proto:339optional bytes tablet_id = 1
optional uint32 min_txn_age_ms = 2
optional uint32 max_num_txns = 3
optional fixed64 propagated_hybrid_time = 4
message
tserver_service.proto:350TODO(pglocks): Add term field to the response so that we can filter out responses from stale status tablet leader peers. Refer https://github.com/yugabyte/yugabyte-db/issues/18140 for details.
optional error = 1
Error message, if any.
repeated txn = 2
optional fixed64 propagated_hybrid_time = 3
Returns the oldest single shard waiters (older than a specified age) by querying the waiting transaction registry at the Tablet Server.
message
tserver_service.proto:366optional uint32 min_txn_age_ms = 1
optional uint32 max_num_txns = 2
optional fixed64 propagated_hybrid_time = 3
message
tserver_service.proto:372optional error = 1
Error message, if any.
repeated txn = 2
optional fixed64 propagated_hybrid_time = 3
Returns transaction status at participant, i.e. number of replicated batches or whether it was aborted.
message
tserver_service.proto:466optional bytes tablet_id = 1
optional bytes transaction_id = 2
optional fixed64 propagated_hybrid_time = 3
optional int64 required_num_replicated_batches = 4
message
tserver_service.proto:473optional error = 1
Error message, if any.
optional fixed64 propagated_hybrid_time = 2
optional int64 num_replicated_batches = 3
optional fixed64 status_hybrid_time = 4
optional bool aborted = 5
message
tserver_service.proto:482optional bytes tablet_id = 1
optional bytes transaction_id = 2
optional fixed64 propagated_hybrid_time = 3
optional deadlock_reason = 4
Status containing deadlock info if the transaction is being aborted due to deadlock.
optional ash_metadata = 5
message
tserver_service.proto:493optional error = 1
Error message, if any.
optional TransactionStatus status = 2
optional fixed64 status_hybrid_time = 3
For description of status_hybrid_time see comment in TransactionStatusResult.
optional fixed64 propagated_hybrid_time = 4
optional fixed64 coordinator_safe_time = 5
Change the status tablet id used for a transaction.
message
tserver_service.proto:506optional bytes tablet_id = 1
optional bytes transaction_id = 2
optional fixed64 propagated_hybrid_time = 3
optional bytes new_status_tablet_id = 4
ID of new status tablet that the transaction will be using.
message
tserver_service.proto:515optional error = 1
Error message, if any.
message
tserver_service.proto:386optional fixed64 propagated_hybrid_time = 1
optional bytes tablet_id = 2
repeated waiting_transactions = 3
optional bytes tserver_uuid = 4
optional bool is_full_update = 5
message
tserver_service.proto:411optional fixed64 propagated_hybrid_time = 1
optional error = 2
message
tserver_service.proto:417optional fixed64 propagated_hybrid_time = 1
optional bytes tablet_id = 2
optional bytes probe_origin_txn_id = 3
optional bytes blocking_txn_id = 4
optional bytes detector_id = 5
optional fixed32 probe_num = 6
optional fixed32 min_probe_num = 7
optional blocking_subtxn_set = 8
message
tserver_service.proto:435optional fixed64 propagated_hybrid_time = 1
optional error = 2
repeated bytes deadlocked_txn_ids = 3
If empty, no deadlock was detected. Otherwise, includes reverse ordered list of the deadlock participants detected by the probe recipient. The probe sender should append its own txn to this list before responding to its own probe sender.
deprecated in favor of deadlock field below
repeated deadlock = 4
optional bool should_erase_probe = 5
If set, it indicates that the blocking transaction/sub-transaction(s) info sent in ProbeTransactionDeadlockRequestPB has been resolved.
rpc Truncate (, )
tserver_service.proto:91message
tserver.proto:307Truncate tablet response.
optional error = 1
optional fixed64 propagated_hybrid_time = 2
message
tserver.proto:313Tablet's status request
optional bytes tablet_id = 1
message
tserver.proto:318Tablet's status response
optional error = 1
optional tablet_status = 2
message
tserver.proto:323(message has no fields)
message
tserver.proto:326optional error = 1
optional string master_addresses = 2
rpc Publish (, )
tserver_service.proto:95message
tserver.proto:331required bytes channel = 1
required bytes message = 2
message
tserver.proto:336required int32 num_clients_forwarded_to = 1
message
tserver.proto:342Get this tserver's notion of being ready for handling IO requests across all tablets that it owns.
(message has no fields)
message
tserver.proto:348When response has no errors, the tserver is deemed ready as per its tablet manager layer when the number of not running tablets is 0. Or the client can choose to timeout before that. Also returns total tablets under this tablet server.
optional error = 1
optional int32 num_tablets_not_running = 2
optional int32 total_tablets = 3
rpc GetSplitKey (, )
tserver_service.proto:99message
tserver_service.proto:520required bytes tablet_id = 1
optional fixed64 propagated_hybrid_time = 2
optional bool is_manual_split = 3
message
tserver_service.proto:526optional error = 1
optional bytes split_partition_key = 2
optional bytes split_encoded_key = 3
optional fixed64 propagated_hybrid_time = 4
message
tserver_service.proto:533optional bool size_only = 1
If true, we only ask for the size of the catalog version map in tserver. Otherwise, we ask for database catalog version info from the tserver.
optional uint32 db_oid = 2
If set we ask for the catalog version of the given database from the tserver. If not set or has value 0, we ask for the catalog version map of all databases from the tserver.
message
tserver_service.proto:543optional error = 1
Error message, if any.
repeated entries = 2
optional uint32 num_entries = 3
message
tserver.proto:355A list master servers request
(message has no fields)
message
tserver.proto:359A list master servers response
optional error = 1
repeated master_server_and_type = 2
Returns all lock information requested, based on persisted intents and any requests waiting on a persisted intent. These intents may correspond to explicit or implicit locks.
message
tserver_service.proto:160Note: Either among transactions_by_tablet or transaction_ids should be set. Both the fields shouldn't be set together nor should be left empty together.
map<string, > transactions_by_tablet = 1
Tablets to scan. Limit per tablet results to the specified transaction_ids in TabletTransactionInfoPB when non-empty. If empty and 'max_single_shard_waiter_start_time_us' is left at default, include lock info of all transactions at that tablet.
optional bool include_trace = 2
optional fixed64 propagated_hybrid_time = 3
repeated bytes transaction_ids = 4
Limit results to the specified transaction_ids when transactions_by_tablet is empty.
optional fixed64 max_single_shard_waiter_start_time_us = 5
Sets the maximum start time of single shard waiters that should be returned, i.e, all single shard waiters with start time before the specified value will be returned. All tablets listed in 'transactions_by_tablet' would be scanned.
optional uint32 max_txn_locks_per_tablet = 6
Limit number of locks returned per transaction at each tablet. If the field is set to 0, the result set isn't limited and all locks are returned.
message
tserver_service.proto:192optional error = 1
optional string trace_buffer = 2
optional fixed64 propagated_hybrid_time = 3
repeated tablet_lock_infos = 4
message
tserver_service.proto:562optional bytes transaction_id = 1
optional bytes status_tablet_id = 2
When the field is not populated, the cancel request is broadcast to all the status tablets hosted by the TabletServer.
message
tserver_service.proto:570optional error = 1
Error message, if any.
Returns the schema version on the XCluster consumer side that is compatible with the schema provided in the request.
message
tserver.proto:371Gets the schema version of the schema that is compatible with the requested schema.
optional bytes tablet_id = 1
optional schema = 2
message
tserver.proto:377Update Schema version mapping response PB.
optional error = 1
optional uint32 compatible_schema_version = 2
optional uint32 latest_schema_version = 3
Added on Oct 2024 (v2025.1), will not be set for older versions. Value is set in the case of a schema mismatch.
message
tserver_service.proto:575optional bytes dest_uuid = 1
UUID of server this request is addressed to.
required bytes tablet_id = 2
required bytes snapshot_id = 3
required bytes source_peer_uuid = 4
Identification for the host we are bootstrapping from.
repeated source_private_addr = 5
repeated source_broadcast_addr = 6
optional source_cloud_info = 7
optional bytes new_snapshot_id = 8
When importing a snapshot from producer to consumer, the consumer universe actually creates a new snapshot with a separate ID. Thus, when downloading files from producer to consumer, we want to account for the new_snapshot_id generated on the consumer universe.
message
tserver_service.proto:596optional error = 1
message
tserver.proto:283optional bytes tablet_id = 1
optional fixed64 propagated_hybrid_time = 2
optional bytes lower_bound_key = 3
optional bytes upper_bound_key = 4
optional uint64 max_num_ranges = 5
optional uint64 range_size_bytes = 6
optional bool is_forward = 7
optional uint32 max_key_length = 8
message
tserver.proto:294optional error = 1
optional fixed64 propagated_hybrid_time = 2
message
tserver.proto:385repeated bytes tablet_ids = 1
message
tserver.proto:389optional error = 1
repeated tablet_healths = 2
message
tserver.proto:400(message has no fields)
message
tserver.proto:402(message has no fields)
Clear metacache entries (tables and tablets) that belong to the provided namespace.
message
tserver.proto:404optional string namespace_id = 1
Only Ysql namespace can be cleared from metacache.
message
tserver.proto:409optional error = 1
message
tserver.proto:413(message has no fields)
message
tserver.proto:416optional error = 1
message
tserver.proto:434optional error = 1
optional fixed64 propagated_hybrid_time = 2
message
tserver.proto:472optional error = 1
optional fixed64 propagated_hybrid_time = 2
message
tserver_service.proto:202(message has no fields)
message
tserver_service.proto:205optional error = 1
optional bool is_live = 2
optional uint64 lease_epoch = 3
rpc GetMetrics (, )
tserver_service.proto:142message
tserver_service.proto:212(message has no fields)
message
tserver_service.proto:216repeated metrics = 1
optional error = 2
message
tserver_service.proto:600required string database_name = 1
repeated string pgsql_statements = 2
The list of SQL statements to execute. Execution will stop at the first error.
message
tserver_service.proto:606optional error = 1
message
tserver_service.proto:610required bytes snapshot_id = 1
message
tserver_service.proto:614optional error = 1
optional snapshot = 2
optional snapshot_read_time = 3
message
tserver_service.proto:620(message has no fields)
message
tserver_service.proto:623optional error = 1
message
tserver_service.proto:550optional uint32 db_oid = 1
optional uint64 ysql_catalog_version = 2
optional uint32 num_catalog_versions = 3
message
tserver_service.proto:556optional error = 1
Error message, if any.
repeated entries = 2
message
tserver.proto:420Used as request type in: TabletServerService.AcquireObjectLocks
Used as field type in:
optional bytes txn_id = 1
optional uint32 subtxn_id = 2
repeated object_locks = 3
optional bytes session_host_uuid = 4
The field is used only on the master side. Master remembers which tserver requested the exclusive lock(s) so that it can issue a cleanup when the tserver looses its lease.
optional uint64 lease_epoch = 5
The lease epoch of the requesting tserver.
optional fixed64 ignore_after_hybrid_time = 6
optional fixed64 propagated_hybrid_time = 7
optional ash_metadata = 8
message
pg_client.proto:1191-------------------------------------------------------------------------------------------------- Advisory lock - Acquire / Release locks. -------------------------------------------------------------------------------------------------- Pg Advisory Lock - (dbid, classid, objid, objsubid).
Used in:
uint32 classid = 1
uint32 objid = 2
uint32 objsubid = 3
Used in:
LOCK_SHARE = 0
LOCK_EXCLUSIVE = 1
message
pg_client.proto:1202Used in: ,
optional lock_id = 2
AdvisoryLockMode lock_mode = 3
message
tserver_admin.proto:54Used as response type in: TabletServerAdminService.AlterSchema, TabletServerAdminService.BackfillDone
optional error = 1
optional fixed64 propagated_hybrid_time = 2
optional cdc_sdk_snapshot_safe_op_id = 3
CDC SDK Create Stream context
message
tserver.proto:390Used in:
optional bytes tablet_id = 1
optional PeerRole role = 2
optional int64 follower_lag_ms = 3
Only valid if role is not LEADER.
message
tserver.proto:445Used in: ,
repeated db_catalog_versions = 1
message
remote_bootstrap.proto:264A chunk of data (a slice of a block, file, etc).
Used in:
required uint64 offset = 1
Offset into the complete data block or file that 'data' starts at.
required bytes data = 2
Actual bytes of data from the data block, starting at 'offset'.
required fixed32 crc32 = 3
CRC32C of the bytes contained in 'data'.
required int64 total_data_length = 4
Full length, in bytes, of the complete data block or file on the server. The number of bytes returned in 'data' can certainly be less than this.
message
remote_bootstrap.proto:224A "union" type that allows the same RPC call to fetch different types of data (data blocks or log files).
Used in:
required DataIdPB.IdType type = 1
Indicator whether it's a block or log segment id.
optional uint64 wal_segment_seqno = 3
To fetch a log segment.
optional string file_name = 4
To fetch a RocksDB file.
optional bytes snapshot_id = 5
To fetch a Snapshot file.
Used in:
UNKNOWN = 0
LOG_SEGMENT = 2
ROCKSDB_FILE = 3
SNAPSHOT_FILE = 4
RETRYABLE_REQUESTS = 5
message
tserver.proto:477Used in:
repeated lock_entries = 1
message
tserver_admin.proto:50This is used to export tablet metadata changes to a protobuf file to be reloaded on a new cluster startup to avoid running initdb.
repeated metadata_changes = 1
Used in:
FLUSH = 0
COMPACT = 1
LOG_GC = 2
message
tserver_service.proto:166Used in:
repeated transactions = 1
message
tserver_service.proto:161Used in:
optional bytes id = 1
optional aborted = 2
message
tserver_service.proto:376Used in:
optional bytes tablet = 1
optional fixed64 start_time = 2
optional string host_node_uuid = 3
message
tserver_service.proto:354Used in:
optional bytes transaction_id = 1
repeated bytes tablets = 2
optional aborted_subtxn_set = 3
optional fixed64 start_time = 4
optional string host_node_uuid = 5
message
tserver.proto:362Used in:
optional string master_server = 1
optional bool is_leader = 2
message
tserver_service.proto:251An entry for each tablet.
Used in:
optional string table_name = 1
optional bytes tablet_id = 2
optional bool is_leader = 3
optional tablet.RaftGroupStatePB state = 4
optional uint64 num_sst_files = 5
optional uint64 num_log_segments = 6
optional uint64 num_memtables_intents = 7
optional uint64 num_memtables_regular = 8
optional bool has_leader_lease = 9
message
tserver.proto:164Used in:
required tablet_status = 1
required schema = 2
optional partition_schema = 3
Used in:
NO_LOCK = 0
ACCESS_SHARE_LOCK = 1
ROW_SHARE_LOCK = 2
ROW_EXCLUSIVE_LOCK = 3
SHARE_UPDATE_EXCLUSIVE_LOCK = 4
SHARE_LOCK = 5
SHARE_ROW_EXCLUSIVE_LOCK = 6
EXCLUSIVE_LOCK = 7
ACCESS_EXCLUSIVE_LOCK = 8
message
pg_client.proto:153TODO: Remove the OptionalUint32PB helper message after updating protobuf generator to allow 'optional' in proto3
Used in:
fixed64 value = 1
message
pg_client.proto:157Used in: ,
uint32 value = 1
message
pg_client.proto:161Used in:
uint64 value = 1
proto2 version of the ReplicationSlotLsnType enum from yb/common/common_types.proto
Used in: ,
ReplicationSlotLsnTypePg_UNDEFINED = 0
ReplicationSlotLsnTypePg_SEQUENCE = 1
ReplicationSlotLsnTypePg_HYBRID_TIME = 2
proto2 version of the ReplicationSlotOrderingMode enum from yb/common/common.proto
Used in:
ReplicationSlotOrderingModePg_UNDEFINED = 0
ReplicationSlotOrderingModePg_ROW = 1
ReplicationSlotOrderingModePg_TRANSACTION = 2
message
pg_client.proto:326Used in: ,
string attr_name = 1
int32 attr_num = 2
int32 attr_ybtype = 3
bool is_hash = 4
bool is_range = 5
int32 sorting_type = 6
int32 attr_pgoid = 7
optional attr_missing_val = 8
message
pg_client.proto:337Used in:
repeated values = 1
message
pg_client.proto:1177Used in:
uint32 db_id = 1
string db_name = 2
uint32 parent_db_id = 3
string parent_db_name = 4
string state = 5
fixed64 as_of_time = 6
string failure_reason = 7
message
pg_client.proto:461Used in:
bool has_docdb_schema_changes = 1
This transaction contains changes to the DocDB schema protobufs.
optional silently_altered_db = 2
bool use_regular_transaction_block = 3
Use transaction block for DDL operations instead of a separate autonomous DDL transaction. Set to false if ysql_yb_ddl_transaction_block_enabled is false or if this is an online schema change operation.
message
pg_client.proto:1053Used in:
uint64 session_id = 1
bytes txn_id = 2
message
pg_client.proto:534Used in:
bytes permanent_uuid = 1
repeated tablet_lock_infos = 2
message
pg_client.proto:542Used in:
repeated bytes transaction_ids = 1
message
pg_client.proto:573Used in:
string uuid = 1
string hostname = 2
string placement_uuid = 3
string cloud = 4
string region = 5
string zone = 6
bool is_primary = 7
string public_ip = 8
uint32 pg_port = 9
Used in:
OK = 0
ERROR = 1
message
pg_client.proto:176Used in: , , , , , , , , , ,
uint32 database_oid = 1
uint32 object_oid = 2
message
pg_client.proto:678Used in:
oneof op
write = 1
read = 2
bool read_from_followers = 3
message
pg_client.proto:692Used in: , , , , ,
uint32 isolation = 2
Cannot use IsolationLevel enum, since we cannot use proto2 enum in proto3 messages. Replace with IsolationLevel after migration to proto3.
bool ddl_mode = 3
bool ddl_use_regular_transaction_block = 25
uint64 txn_serial_no = 4
uint64 read_time_serial_no = 20
optional in_txn_limit_ht = 5
See ReadHybridTimePB for information about in_txn_limit_ht.
bool use_existing_priority = 6
fixed64 priority = 7
bool restart_transaction = 8
bool defer_read_point = 9
ReadTimeManipulation read_time_manipulation = 10
optional read_time = 11
bool use_catalog_session = 12
bool force_global_transaction = 13
string namespace_id = 14
bool use_xcluster_database_consistency = 15
uint32 active_sub_transaction_id = 16
optional caching_info = 17
bool read_from_followers = 18
bool trace_requested = 19
bool yb_non_ddl_txn_for_sys_tables_allowed = 21
int64 pg_txn_start_us = 22
optional ash_metadata = 23
bool clamp_uncertainty_window = 24
When set, - Sets the read time locally. - Clamps the read uncertainty window. See the commit desc for more info.
bool non_transactional_buffered_write = 26
message
pg_client.proto:693Used in:
uint32 key_group = 1
bytes key_value = 2
optional lifetime_threshold_ms = 3
message
pg_client.proto:796Used in:
string cloud = 1
string region = 2
string zone = 3
int32 min_num_replicas = 4
int32 leader_preference = 5
message
pg_client.proto:203Used in:
string old_name = 1
string new_name = 2
message
pg_client.proto:208Used in:
string database_name = 1
string table_name = 2
string schema_name = 3
message
pg_client.proto:233Used in: ,
PgReplicaIdentityType replica_identity = 1
Available replica identity modes for use in CDC
Used in:
DEFAULT = 0
Entire updated row as new image, only key as old image for DELETE The name DEFAULT is taken from PG, however it is not the default replica identity mode
FULL = 1
Both old and new images of the entire row
NOTHING = 2
No old image for any operation
CHANGE = 3
Only the changed columns as new image, no old image except DELETE This is the default replica identity mode in YSQL
message
pg_client.proto:607Used in: ,
string slot_name = 1
bytes stream_id = 2
uint32 database_oid = 3
ReplicationSlotStatus replication_slot_status = 4
uint64 confirmed_flush_lsn = 5
uint64 restart_lsn = 6
uint32 xmin = 7
map<uint32, > replica_identity_map = 8
This map stores the replica identity for each table in the stream at the time of stream creation. The key for this map is table_oid and the value is replica identity for that table.
uint64 record_id_commit_time_ht = 9
uint64 last_pub_refresh_time = 10
string output_plugin_name = 11
PGReplicationSlotLsnType yb_lsn_type = 12
uint64 active_pid = 13
bool expired = 14
proto2 version of the CDCSDKSnapshotOption enum from yb/common/common_types.proto
Used in:
REPLICATION_SLOT_UNKNOWN_SNAPSHOT = 0
Invalid, should not be used. This is only present here to keep the same enum tags between the proto2 (this) and the proto3 versions.
REPLICATION_SLOT_NOEXPORT_SNAPSHOT = 1
Client does not wish to consume snapshot.
REPLICATION_SLOT_USE_SNAPSHOT = 2
Client wishes to consume snapshot from the source universe.
REPLICATION_SLOT_EXPORT_SNAPSHOT = 3
Client wishes to export snapshot to be used in other session
message
pg_client.proto:1134Used in:
string uuid = 1
repeated metrics = 2
PgMetricsInfoStatus status = 3
string error = 4
message
pg_client.proto:646Used in: ,
uint32 version = 1
repeated bytes keys = 2
message
tserver_service.proto:445Used in:
optional bytes id = 1
optional bytes tablet_id = 2
optional bytes detector_id = 3
optional fixed64 txn_start_us = 4
optional bool is_pg_session_txn = 5
optional uint64 pg_session_req_version = 6
Used in:
NONE = 0
RESTART = 1
ENSURE_READ_TIME_IS_SET = 2
message
tserver.proto:449Used as request type in: TabletServerService.ReleaseObjectLocks
Used as field type in:
optional bytes txn_id = 1
optional uint32 subtxn_id = 2
When set, only locks owned by the given subtxn id are released. If unset, releases all locks held by <txn_id>.
optional bytes session_host_uuid = 3
optional uint64 lease_epoch = 4
The lease epoch of the requesting tserver.
optional fixed64 apply_after_hybrid_time = 5
If there is any Acquire request that failed, and may be pending on any of the tservers/master. apply_after should be set to the max of the deadlines used for the acquire requests. This ensures that the release will only be applied after the Acquire, to prevent out of order acquire request from leaking locks.
optional fixed64 propagated_hybrid_time = 6
optional db_catalog_version_data = 7
optional uint64 request_id = 8
Used for tracking in-progress DDL unlock requests at the master.
optional ash_metadata = 9
message
remote_bootstrap.proto:96Remote bootstrap-specific errors use this protobuf.
required RemoteBootstrapErrorPB.Code code = 1
The error code.
required status = 2
The Status object for the error. This will include a textual message that may be more useful to present in log messages, etc, though its error code is less specific.
Used in:
UNKNOWN_ERROR = 1
An error which has no more specific error code. The code and message in 'status' may reveal more details. RPCs should avoid returning this, since callers will not be able to easily parse the error.
NO_SESSION = 2
The specified remote bootstrap session either never existed or has expired.
TABLET_NOT_FOUND = 3
Unknown tablet.
BLOCK_NOT_FOUND = 4
Unknown data block.
WAL_SEGMENT_NOT_FOUND = 5
Unknown WAL segment.
INVALID_REMOTE_BOOTSTRAP_REQUEST = 6
Invalid request. Possibly missing parameters.
IO_ERROR = 7
Error reading or transferring data.
ROCKSDB_FILE_NOT_FOUND = 8
Unknown RocksDB file.
REMOTE_LOG_ANCHOR_FAILURE = 9
Unable to register/update LogAnchor on the tablet leader peer
REMOTE_CHANGE_PEER_ROLE_FAILURE = 10
Cannot ChangeRole for the new peer on the tablet-leader
Used in:
ACTIVE = 0
INACTIVE = 1
Enum of the server's Tablet Manager state: currently this is only used for assertions, but this can also be sent to the master.
UNKNOWN = 999
MANAGER_INITIALIZING = 0
Indicates that Tablet Manager is initializing.
MANAGER_RUNNING = 1
Indicates that Tablet Manager is running and can create new tablets.
MANAGER_QUIESCING = 2
Indicates that tablet manager is shutting down and no new tablets can be created.
MANAGER_SHUTDOWN = 3
Tablet Manager has shutdown.
message
backup.proto:28Used in:
uint32 schema_version = 1
optional schema = 2
repeated indexes = 3
bytes table_id = 4
message
tserver.proto:51Used in: , , ,
optional bytes tablet_id = 1
optional consensus_state = 2
message
tserver_types.proto:22Tablet-server specific errors use this protobuf.
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
required TabletServerErrorPB.Code code = 1
The error code.
required status = 2
The Status object for the error. This will include a textual message that may be more useful to present in log messages, etc, though its error code is less specific.
Used in:
UNKNOWN_ERROR = 1
An error which has no more specific error code. The code and message in 'status' may reveal more details. RPCs should avoid returning this, since callers will not be able to easily parse the error.
INVALID_SCHEMA = 2
The schema provided for a request was not well-formed.
INVALID_ROW_BLOCK = 3
The row data provided for a request was not well-formed.
INVALID_MUTATION = 4
The mutations or mutation keys provided for a request were not well formed.
MISMATCHED_SCHEMA = 5
The schema provided for a request didn't match the actual schema of the tablet.
TABLET_NOT_FOUND = 6
The requested tablet_id is not currently hosted on this server.
SCANNER_EXPIRED = 7
A request was made against a scanner ID that was either never created or has expired.
INVALID_SCAN_SPEC = 8
An invalid scan was specified -- e.g the values passed for predicates were incorrect sizes.
INVALID_CONFIG = 9
The provided configuration was not well-formed and/or had a sequence number that was below the current config.
TABLET_ALREADY_EXISTS = 10
On a create tablet request, signals that the tablet already exists.
TABLET_HAS_A_NEWER_SCHEMA = 11
If the tablet has a newer schema than the requested one the "alter" request will be rejected with this error.
TABLET_NOT_RUNNING = 12
The tablet is hosted on this server, but not in RUNNING state.
INVALID_SNAPSHOT = 13
Client requested a snapshot read but the snapshot was invalid.
INVALID_SCAN_CALL_SEQ_ID = 14
An invalid scan call sequence ID was specified.
NOT_THE_LEADER = 15
This tserver is not the leader of the consensus configuration.
WRONG_SERVER_UUID = 16
The destination UUID in the request does not match this server.
CAS_FAILED = 17
The compare-and-swap specified by an atomic RPC operation failed.
LEADER_NOT_READY_CHANGE_CONFIG = 18
This server leader is not ready for the change configuration operation.
LEADER_NOT_READY_TO_STEP_DOWN = 19
This server leader is not ready to step down.
ADD_CHANGE_CONFIG_ALREADY_PRESENT = 20
Adding a peer which is already present in the current raft config.
REMOVE_CHANGE_CONFIG_NOT_PRESENT = 21
Removing a peer which is not present in the current raft config.
LEADER_NEEDS_STEP_DOWN = 22
Leader needs to be stepped down before calling change config. This happens if the server we are trying to remove from the config is currently the leader.
OPERATION_NOT_SUPPORTED = 23
The operation is not supported.
LEADER_NOT_READY_TO_SERVE = 24
This tserver is the leader of the consensus configuration, but it's not ready to serve requests. (That means in fact that the elected leader has not yet commited NoOp request. The client must wait a bit for the end of this replica-operation.)
STALE_FOLLOWER = 25
This follower hasn't heard from the leader for a specified amount of time.
ALREADY_IN_PROGRESS = 26
The operation is already in progress. Used for remote bootstrap requests for now.
PENDING_LOCAL_BOOTSTRAPS = 27
Tablet server has some tablets pending local bootstraps.
TABLET_SPLIT = 28
Tablet splitting has been started (after split is completed - tablet stays in this state until it is deleted).
TABLET_SPLIT_PARENT_STILL_LIVE = 29
Tablet splitting has not been started on this peer yet.
TABLET_SPLIT_DISABLED_TTL_EXPIRY = 30
Tablet splitting disabled for this tablet because TTL file expiration feature enabled.
TABLET_SPLIT_KEY_RANGE_TOO_SMALL = 31
This tablet's partition is too small to split (e.g. if it only contains 1 hash code).
message
backup.proto:35Used as request type in: TabletServerBackupService.TabletSnapshotOp
Used as field type in:
bytes dest_uuid = 1
UUID of server this request is addressed to.
TabletSnapshotOpRequestPB.Operation operation = 2
bytes snapshot_id = 3
In case of transactional id it is binary representation of snapshot UUID, i.e. 16 bytes. Otherwise it is hexadecimal representation of snapshot UUID, i.e. 32 bytes.
repeated bytes tablet_id = 4
Tablets to snapshot. In case of CREATE_ON_MASTER it contains UUIDs of all tablets of snapshot. Otherwise it contains just one tablet.
fixed64 propagated_hybrid_time = 5
string snapshot_dir_override = 6
Override the snapshot directory. Used in restoring sys catalog to avoid running initdb.
fixed64 snapshot_hybrid_time = 7
fixed64 restoration_hybrid_time = 17
optional extra_data = 8
Extra data assigned for this snapshot request, so instance it could contain SysRowEntries.
bool imported = 9
bytes schedule_id = 10
bytes restoration_id = 11
uint32 schema_version = 12
optional schema = 13
repeated indexes = 14
fixed64 previous_snapshot_hybrid_time = 15
bool hide = 16
int64 db_oid = 18
This is the database oid that needs to be restored partially. Applicable only for tablets of sequences_data table currently.
repeated colocated_tables_metadata = 19
Metadata of all colocated tables in the case of RESTORE_ON_TABLET rpc.
int32 retention_duration_hours = 20
Number of hours the snapshot needs to be kept around before it is deleted. Set only for CREATE_ON_MASTER for non-pitr use-cases. Set to -1 to retain indefinitely until an explicit delete_snapshot.
Used in:
UNKNOWN = 0
CREATE_ON_TABLET = 1
Replicated at tserver, to create snapshot for a particular tablet.
RESTORE_ON_TABLET = 2
DELETE_ON_TABLET = 3
CREATE_ON_MASTER = 4
Replicated at master, while creating snapshot for multiple tablets.
DELETE_ON_MASTER = 5
RESTORE_SYS_CATALOG = 6
RESTORE_FINISHED = 7
Whole restore operation is finished.
message
tserver.proto:300Truncate tablet request.
Used as request type in: TabletServerService.Truncate
Used as field type in:
optional bytes tablet_id = 1
optional fixed64 propagated_hybrid_time = 2
optional truncate = 3
message
tserver_service.proto:387Used in:
optional bytes transaction_id = 1
optional bytes status_tablet_id = 2
optional subtxn_set = 3
message
tserver_service.proto:392Used in:
optional bytes transaction_id = 1
repeated blocking_transaction = 2
optional fixed64 wait_start_time = 3
optional int64 request_id = 4
optional uint64 pg_session_req_version = 5
message
pg_client.proto:1031Used in:
repeated wait_states = 1
uint32 component = 2
float sample_weight = 3
message
tserver.proto:118If errors occurred with particular row operations, then the errors for those operations will be passed back in 'per_row_errors'.
Used in:
required int32 row_index = 1
The index of the row in the incoming batch.
required error = 2
The error that occurred.
message
pg_client.proto:1107Used in:
int64 queryid = 1
string query = 2
bool is_prepared = 3
int64 calls = 4
double total_time = 5
Time in ms
double min_time = 6
double max_time = 7
double mean_time = 8
double stddev_time = 9
string keyspace = 10
message
tserver.proto:439Used in:
optional uint32 db_oid = 1
optional uint64 current_version = 2
optional uint64 last_breaking_version = 3