package yb.master
Get desktop application:
View/edit binary Protocol Buffers messages
rpc FlushTables (, )
master_admin.proto:320message
master_admin.proto:27TODO: rename to FlushOrCompact TablesRequestPB https://github.com/YugaByte/yugabyte-db/issues/729
repeated tables = 1
optional bool is_compaction = 2
Whether we want to compact the tablets instead of flushing them.
optional bool add_indexes = 3
Whether we want to include index tables in this flush. If there are index tables in the tables field this field must be set to false, otherwise the request will fail.
optional bool regular_only = 4
Whether the operation only applies to regular RocksDB but not intents RocksDB.
message
master_admin.proto:41optional error = 1
optional bytes flush_request_id = 2
message
master_admin.proto:47optional bytes flush_request_id = 1
message
master_admin.proto:51optional error = 1
optional bool done = 2
true if the flush tables operation is completed, false otherwise.
optional bool success = 3
true if the flush tables operation is successful.
message
master_admin.proto:61(message has no fields)
message
master_admin.proto:64optional error = 1
message
master_admin.proto:68(message has no fields)
message
master_admin.proto:71optional error = 1
message
master_admin.proto:75optional table = 1
optional bool show_tablets = 2
message
master_admin.proto:88optional error = 1
optional fixed64 last_request_time = 2
Time when an admin compaction was last requested by the user.a Raw representation of a HybridTime.
optional fixed64 last_full_compaction_time = 3
Time when the most recent full compaction was completed. Raw representation of a HybridTime.
optional tablet.FullCompactionState full_compaction_state = 4
Overall full compaction state of the table.
repeated replica_statuses = 5
Full compaction statuses of all tablet replicas.
rpc IsInitDbDone (, )
master_admin.proto:328message
master_admin.proto:106(message has no fields)
message
master_admin.proto:109optional error = 1
optional bool pg_proc_exists = 2
Someone started running initdb, as indicated by the existence of template1.pg_proc.
optional bool done = 4
This is true if the master ran initdb and it finished, successfully or not.
optional string initdb_error = 5
If this is set to a non-empty string, initdb has failed.
rpc SplitTablet (, )
master_admin.proto:330message
master_admin.proto:122required bytes tablet_id = 1
message
master_admin.proto:126optional error = 1
message
master_admin.proto:130required string table_name = 1
optional replication_info = 2
message
master_admin.proto:135optional error = 1
message
master_admin.proto:139required bytes table_id = 1
message
master_admin.proto:143optional error = 1
message
master_admin.proto:147required bytes tablet_id = 1
message
master_admin.proto:151optional error = 1
message
master_admin.proto:155optional uint64 disable_duration_ms = 1
optional string feature_name = 2
message
master_admin.proto:160optional error = 1
message
master_admin.proto:164optional bool wait_for_parent_deletion = 1
message
master_admin.proto:168optional error = 1
optional bool is_tablet_splitting_complete = 2
message
master_admin.proto:257repeated bytes tserver_uuids = 1
UUIDs of the tservers being taken down.
repeated bytes master_uuids = 2
UUIDs of the masters being taken down.
optional int64 follower_lag_bound_ms = 3
message
master_admin.proto:267optional error = 1
message
master_admin.proto:271(message has no fields)
message
master_admin.proto:273optional error = 1
repeated heartbeat_delay = 2
rpc DdlLog (, )
master_admin.proto:348message
master_admin.proto:173(message has no fields)
message
master_admin.proto:176optional error = 1
repeated entries = 2
message
master_admin.proto:181(message has no fields)
message
master_admin.proto:183optional error = 1
message
master_admin.proto:187(message has no fields)
message
master_admin.proto:189optional error = 1
optional bool done = 2
message
master_admin.proto:194(message has no fields)
message
master_admin.proto:196optional error = 1
message
master_admin.proto:200(message has no fields)
message
master_admin.proto:202optional error = 1
message
master_admin.proto:206(message has no fields)
message
master_admin.proto:218optional error = 1
optional YsqlMajorCatalogUpgradeState state = 2
message
master_admin.proto:223(message has no fields)
message
master_admin.proto:225optional error = 1
optional bool is_pitr_active = 2
message
master_admin.proto:230optional int32 value = 1
Read mode: if value is unset, this mode is used. Write mode: if value is set, it will be written to the register.
message
master_admin.proto:236optional error = 1
optional int32 value = 2
Read mode: value is read from the register. Write mode: value is read from the register before write.
required
message
master_admin.proto:243optional uint32 database_oid = 1
required
optional uint64 catalog_version = 2
required
optional bytes requestor_ts_uuid = 3
required
optional int32 requestor_pg_backend_pid = 4
required
message
master_admin.proto:250optional error = 1
optional 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
master_admin.proto:283optional SysRowEntryType entry_type = 1
optional string entity_id_filter = 2
message
master_admin.proto:294optional error = 1
repeated entries = 2
message
master_admin.proto:299optional SysRowEntryType entry_type = 1
optional string entity_id = 2
optional string pb_debug_string = 3
optional WriteSysCatalogEntryRequestPB.WriteOp op_type = 4
message
master_admin.proto:313optional error = 1
Client->Master RPCs
message
master_backup.proto:36repeated tables = 1
optional bool DEPRECATED_transaction_aware = 2
Can be removed once 2024.2 is out of support (usage removed in D37010).
optional bool add_indexes = 3
Automatically add table indexes into the snapshot.
optional bool imported = 4
Interpet this snapshot as imported: Snapshot will be created as COMPLETE and no tablet operations will be performed.
optional bytes schedule_id = 5
Create snapshot to this schedule. Other fields are ignored.
optional bool add_ud_types = 6
Automatically add used User Defined Types into the snapshot. This is for YCQL only. For YSQL it's no-op currently because YSQL does not use SysUDTypeEntryPB records in the SysCatalog.
optional int32 retention_duration_hours = 7
Number of hours the snapshot needs to be kept around before it is deleted. Set to -1 to retain indefinitely until an explicit delete_snapshot.
message
master_backup.proto:62optional error = 1
optional bytes snapshot_id = 2
rpc ListSnapshots (, )
master_backup.proto:312message
master_backup.proto:126optional bytes snapshot_id = 2
optional bool list_deleted_snapshots = 3
optional bool prepare_for_backup = 4
optional detail_options = 5
message
master_backup.proto:133optional error = 1
repeated snapshots = 3
message
master_backup.proto:166optional bytes snapshot_id = 1
16 bytes UUID
optional bytes restoration_id = 2
16 bytes UUID
message
master_backup.proto:171optional status = 1
repeated restorations = 2
message
master_backup.proto:140optional bytes snapshot_id = 2
optional fixed64 restore_ht = 3
Absolute Timing Option: Max HybridTime, in Micros.
message
master_backup.proto:145optional error = 1
optional bytes restoration_id = 2
16 bytes UUID
message
master_backup.proto:150optional bytes snapshot_id = 2
message
master_backup.proto:154optional error = 1
message
master_backup.proto:158optional bytes restoration_id = 1
16 bytes UUID
message
master_backup.proto:162optional error = 1
message
master_backup.proto:184optional snapshot = 1
message
master_backup.proto:188optional error = 1
repeated tables_meta = 3
message
master_backup.proto:227optional options = 1
message
master_backup.proto:231optional error = 1
optional bytes snapshot_schedule_id = 2
message
master_backup.proto:237optional bytes snapshot_schedule_id = 1
When snapshot_schedule_id is not specified, all schedules are listed.
message
master_backup.proto:248optional error = 1
repeated schedules = 2
message
master_backup.proto:254optional bytes snapshot_schedule_id = 1
message
master_backup.proto:258optional error = 1
message
master_backup.proto:262optional bytes snapshot_schedule_id = 1
optional uint64 interval_sec = 2
optional uint64 retention_duration_sec = 3
message
master_backup.proto:268optional error = 1
optional schedule = 2
message
master_backup.proto:273optional bytes snapshot_schedule_id = 1
optional fixed64 restore_ht = 2
Absolute Timing Option: Max HybridTime, in Micros.
message
master_backup.proto:278optional error = 1
optional bytes snapshot_id = 2
optional bytes restoration_id = 3
16 bytes UUID
message
master_backup.proto:284optional source_namespace = 1
optional fixed64 restore_ht = 2
optional string target_namespace_name = 3
optional string pg_source_owner = 4
optional string pg_target_owner = 5
message
master_backup.proto:292optional error = 1
optional string source_namespace_id = 2
If the call returned without error, then these are the fields to pass to ListClones.
optional uint32 seq_no = 3
rpc ListClones (, )
master_backup.proto:330message
master_backup.proto:299optional string source_namespace_id = 1
optional uint32 seq_no = 2
message
master_backup.proto:304optional error = 1
repeated entries = 2
Client->Master RPCs
message
master_client.proto:107repeated bytes tablet_ids = 1
The tablet IDs about which to fetch info.
optional bytes table_id = 2
If table ID is specified, table's partition_list_version will be included into response.
optional bool include_hidden = 3
If true, then return any hidden tablets as well.
optional bool include_deleted = 4
If true, then return any deleted tablets as well (marked with is_deleted in the returned tablet locations).
message
master_client.proto:122optional error = 1
repeated tablet_locations = 2
optional uint32 partition_list_version = 4
If GetTabletLocationsRequestPB::table_id is set we return table's partition_list_version for this table (see SysTablesEntryPB::partition_list_version).
repeated errors = 3
message
master_client.proto:138required table = 1
optional bytes partition_key_start = 3
Partition-key range.
optional bytes partition_key_end = 4
optional uint32 max_returned_locations = 5
optional bool require_tablets_running = 6
optional bool include_inactive = 7
If true, then return all tablets associated with the table - including parents of splits that have not yet been deleted. Result could have overlapping partition key ranges.
optional bool partitions_only = 8
When set, the TabletLocationsPBs in the response will only have basic fields and partition-related fields set. The fields set are table_id, tablet_id, partition, split_depth, split_parent_tablet_id, and stale.
message
master_client.proto:159optional error = 1
The error, if an error occurred with this request.
repeated tablet_locations = 2
optional TableType table_type = 3
optional uint32 partition_list_version = 4
See SysTablesEntryPB for field with the same name.
optional bool creating = 5
message
master_client.proto:172optional placement = 1
Placement to use when deciding which local transaction tables should be considered. No local transaction tablets will be returned if not set.
message
master_client.proto:178optional error = 1
repeated bytes global_tablet_id = 2
repeated bytes placement_local_tablet_id = 3
For Postgres:
message
master_client.proto:186Reserve Postgres OIDs
optional bytes namespace_id = 1
The namespace ID of the Postgres database.
optional uint32 next_oid = 2
The minimum next OID to reserve.
optional uint32 count = 3
The number of OIDs to attempt to reserve.
optional bool use_secondary_space = 4
use_secondary_space is used by xCluster when a database is a target.
message
master_client.proto:194optional error = 1
The error, if an error occurred with this request.
optional uint32 begin_oid = 2
The beginning oid reserved. Can be higher than requested.
optional uint32 end_oid = 3
The end (exclusive) oid reserved.
optional uint32 oid_cache_invalidations_count = 4
How many universe-wide OID cache invalidations happened before this allocation was done.
message
master_client.proto:203(message has no fields)
message
master_client.proto:206optional error = 1
optional uint64 version = 2
message
master_client.proto:96repeated string index_ids = 1
message
master_client.proto:100optional error = 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 (GetIndexBackfillProgressRequestPB).
Redis Config
message
master_client.proto:211optional string keyword = 1
repeated bytes args = 2
message
master_client.proto:216optional error = 1
message
master_client.proto:220optional string keyword = 1
message
master_client.proto:224optional string keyword = 1
repeated bytes args = 2
optional error = 3
message
master_client.proto:230optional StatefulServiceKind service_kind = 1
message
master_client.proto:244optional error = 1
optional service_info = 2
Administrative/monitoring RPCs
message
master_cluster.proto:27optional bool primary_only = 1
If set to true, return only the tservers which are in the primary/sync cluster.
optional bytes tablespace_id = 2
If replication_info is not provided, tablespace ID will be used to fetch the replication config on user tables that are geo-partitioned within a tablespace.
optional replication_info = 3
Replication config will be used on user tables that are located in geo-partitioned tablepsace to filter TServers based on their placement ID and cloud config.
message
master_cluster.proto:40optional error = 1
repeated servers = 2
message
master_cluster.proto:54optional bool primary_only = 1
If set to true, return only the live tservers which are in the primary/sync cluster.
message
master_cluster.proto:59optional error = 1
repeated servers = 2
message
master_cluster.proto:70optional bytes permanent_uuid = 1
message
master_cluster.proto:74optional error = 1
rpc ListMasters (, )
master_cluster.proto:351message
master_cluster.proto:80ListMastersRequest/Response: get information about all of the known master servers, including this node from the in-memory options.
(message has no fields)
message
master_cluster.proto:83repeated masters = 1
An entry for each individual master server.
optional error = 2
Set only if there's an error in retrieving the list of servers or in getting this server's own local registration information.
message
master_cluster.proto:96ListMasterRaftPeersRequest/Response: get information about all of the known servers which are part of this master's version of the currently active Raft quorum. This also captures any inflight change config operations which are not yet tracked by in-memory options and hence can give a more current picture of peers compared with ListMastersResponse.
(message has no fields)
message
master_cluster.proto:99repeated masters = 1
An entry for each individual master server.
optional error = 2
Set only if there's an error in retrieving the list of servers or in getting this server's own local registration information.
message
master_cluster.proto:110GetMasterRegistrationRequest/Response: get the instance id and HTTP/RPC addresses for this Master server.
(message has no fields)
message
master_cluster.proto:114TODO: Just use ServerRegistration here.
required instance_id = 1
Node instance information is always set.
optional registration = 2
These fields are optional, as they won't be set if there's an error retrieving the host/port information.
optional PeerRole role = 3
This server's role in the consensus configuration.
optional error = 4
Set if there an error retrieving the registration information.
message
master_cluster.proto:266(message has no fields)
message
master_cluster.proto:269required config = 1
optional error = 3
message
master_cluster.proto:285required string max_flag_class = 1
required bool promote_non_runtime_flags = 2
(DEPRECATE_EOL 2025.1)
required bool force = 3
When force is set, the config version is bumped up even if no new flags are eligible for promote.
message
master_cluster.proto:293optional uint32 new_config_version = 1
optional error = 3
optional bool flags_promoted = 4
message
master_cluster.proto:300required uint32 rollback_version = 1
message
master_cluster.proto:304optional uint32 new_config_version = 1
optional bool flags_rolledback = 2
optional error = 3
message
master_cluster.proto:310required string process_name = 1
required string auto_flag_name = 2
message
master_cluster.proto:315optional uint32 new_config_version = 1
optional bool flag_promoted = 2
optional bool non_runtime_flag_promoted = 3
optional error = 4
message
master_cluster.proto:322required string process_name = 1
required string auto_flag_name = 2
message
master_cluster.proto:327optional uint32 new_config_version = 1
optional bool flag_demoted = 2
optional error = 3
message
master_cluster.proto:274required config = 1
optional uint32 min_flag_class = 2
message
master_cluster.proto:279optional error = 1
optional bool valid = 2
optional uint32 config_version = 3
Get the ready status from the catalog manager for this master. NOTE: Should be used only for unit testing purposes.
message
master_cluster.proto:131Get a master's notion being ready as the leader. NOTE: Should be used only for unit testing purposes.
(message has no fields)
message
master_cluster.proto:135When no errors, the master will be deemed ready as per its catalog manager layer.
optional error = 1
rpc DumpState (, )
master_cluster.proto:371Dump master state from all the peers in the current master's quorum
message
master_cluster.proto:141Make the masters dump all their in-memory and on-disk state to their respective log files. Sent to the master leader first, and then propogated to its peers if peers_also is set to true.
optional bool on_disk = 1
Dump on-disk state known to this master - including sys.catalog and raft config related info
optional bool peers_also = 2
If set to true, the leader sends request to all current peers to dump their state too. The on_disk is sent along to peers too.
optional bool return_dump_as_string = 3
If set to true, the dump will be returned back as a string in the response. Else the dump will be saved into the master respective log files.
message
master_cluster.proto:154optional error = 1
optional string dump = 2
message
master_cluster.proto:159optional bool is_enabled = 1
message
master_cluster.proto:163optional error = 1
message
master_cluster.proto:167(message has no fields)
message
master_cluster.proto:170optional error = 1
optional bool is_enabled = 2
message
master_cluster.proto:176Update an ex-peer about its removal from the cluster.
(message has no fields)
message
master_cluster.proto:179optional error = 1
message
master_cluster.proto:183repeated preferred_zones = 1
repeated multi_preferred_zones = 2
message
master_cluster.proto:188optional error = 1
message
master_cluster.proto:192(message has no fields)
message
master_cluster.proto:195optional error = 1
optional cluster_config = 2
message
master_cluster.proto:200(message has no fields)
message
master_cluster.proto:203optional error = 1
optional xcluster_config = 2
message
master_cluster.proto:208optional cluster_config = 1
message
master_cluster.proto:212optional error = 1
message
master_cluster.proto:218Get the percentage of tablet data that got moved as part of a blacklist config change. Handled by the master leader and picked up by new leader on failover.
(message has no fields)
message
master_cluster.proto:234Get the percentage of tablet leadership that got moved as part of a leader blacklist config change. Handled by the master leader and picked up by new leader on failover.
(message has no fields)
message
master_cluster.proto:240When no errors, the master leader will have balanced all the load across the live tservers. The client can send in an optional value for the expected number of servers. If the master finds fewer alive in its snapshot than these, it will consider the load imbalanced.
optional int32 expected_num_servers = 1
message
master_cluster.proto:244optional error = 1
Any error being set implies that the load is not balanced across the servers.
message
master_cluster.proto:250Is load balancer idle.
(message has no fields)
message
master_cluster.proto:254When no errors, load balancer is idle.
optional error = 1
message
master_cluster.proto:258(message has no fields)
message
master_cluster.proto:261optional error = 1
Any error being set implies that the leader load is not balanced across the servers.
message
master_cluster.proto:333(message has no fields)
message
master_cluster.proto:336optional error = 1
optional PeerRole role = 2
optional int64 follower_lag_ms = 3
Only valid if role is not LEADER.
service MasterDcl
master_dcl.proto:125rpc CreateRole (, )
master_dcl.proto:129Authentication and Authorization.
message
master_dcl.proto:27optional string name = 1
optional string salted_hash = 2
optional bool login = 3
optional bool superuser = 4
optional string creator_role_name = 5
Name of the role creating this role.
message
master_dcl.proto:36optional error = 1
The error, if an error occurred with this request.
rpc AlterRole (, )
master_dcl.proto:130message
master_dcl.proto:41optional string name = 1
optional string salted_hash = 2
optional bool login = 3
optional bool superuser = 4
optional string current_role = 5
Name of the role trying to alter the role.
message
master_dcl.proto:51optional error = 1
The error, if an error occurred with this request.
rpc DeleteRole (, )
master_dcl.proto:131message
master_dcl.proto:56optional string name = 1
optional string current_role = 2
Name of the role trying to drop the role.
message
master_dcl.proto:63optional error = 1
The error, if an error occurred with this request.
rpc GrantRevokeRole (, )
master_dcl.proto:132message
master_dcl.proto:68optional string granted_role = 1
optional string recipient_role = 2
optional bool revoke = 3
true if this is a revoke request.
message
master_dcl.proto:76optional error = 1
The error, if an error occurred with this request.
message
master_dcl.proto:81optional PermissionType permission = 1
optional ResourceType resource_type = 2
optional string canonical_resource = 3
optional string resource_name = 4
optional namespace = 5
optional string role_name = 6
optional bool revoke = 7
true if this is a revoke request.
message
master_dcl.proto:93optional error = 1
The error, if an error occurred with this request.
rpc GetPermissions (, )
master_dcl.proto:135message
master_dcl.proto:98optional uint64 if_version_greater_than = 1
Only get the permissions if the cache version in the master is greater than this version.
message
master_dcl.proto:119optional uint64 version = 1
optional error = 2
repeated role_permissions = 3
service MasterDdl
master_ddl.proto:824rpc CreateTable (, )
master_ddl.proto:827message
master_ddl.proto:60Create table request (including index table)
required string name = 1
optional schema = 2
optional int32 num_tablets = 3
Specifies number of tablets to create. If it's not set here 'SchemaPB::TablePropertiesPB::num_tablets' from 'schema' field will be used.
optional partition_schema = 5
optional replication_info = 6
optional TableType table_type = 7
optional namespace = 8
optional index_info = 16
For index table.
optional bytes indexed_table_id = 9
Indexed table id of this index.
optional bool is_local_index = 10
Is a local index?
optional bool is_unique_index = 11
Is a unique index?
optional bool skip_index_backfill = 18
Skip online schema migration for
optional bool is_backfill_deferred = 23
index?
Defer backfill for batching later?
optional string creator_role_name = 12
For RBAC.
optional bytes table_id = 13
For Postgres:
id to assign to this table.
optional bool is_pg_catalog_table = 14
Is this a sys catalog table?
optional bool is_pg_shared_table = 15
Is this a shared table?
optional bool is_colocated_via_database = 17
Is this a colocated table? This field is only applicable for a colocated database.
optional bytes tablegroup_id = 19
This is only applicable for tablegroups. Eventually colocated will be deprecated.
optional uint32 colocation_id = 25
Colocation ID to distinguish a table within a colocation group. Auto-generated by catalog manager if not specified. Only makes sense for colocated tables.
optional transaction = 20
For YSQL tables, transaction used by this DDL. If aborted, table will be removed.
optional bytes tablespace_id = 21
For YSQL tables, this denotes the tablespace that this table is associated with.
repeated partitions = 22
This field should be used to create or restore table with a fixed set of partitions.
optional bool is_matview = 26
optional bytes pg_table_id = 24
In case the table was rewritten, explicitly store the TableId containing the PG table OID (as the table's TableId no longer matches).
repeated StatefulServiceKind hosted_stateful_services = 27
optional bool ysql_yb_ddl_rollback_enabled = 28
optional bytes old_rewrite_table_id = 29
Used during table rewrite - the TableId of the old DocDB table that is being rewritten.
optional bool is_clone = 30
optional bool is_truncate = 31
Set to true when the table is being re-written as part of a TRUNCATE operation.
optional xcluster_table_info = 33
message
master_ddl.proto:141optional error = 1
The error, if an error occurred with this request.
optional bytes table_id = 2
message
master_ddl.proto:148required table = 1
message
master_ddl.proto:152optional error = 1
The error, if an error occurred with this request.
optional bool done = 3
true if the create operation is completed, false otherwise
rpc ListTables (, )
master_ddl.proto:830message
master_ddl.proto:160optional string name_filter = 1
When used, only returns tables that satisfy a substring match on name_filter.
optional namespace = 2
Can be used to list tables for this one particular namespace.
optional bool exclude_system_tables = 3
Exclude system tables.
repeated RelationType relation_type_filter = 4
Can be used to filter tables based on RelationType
optional bool include_not_running = 5
message
master_ddl.proto:176optional error = 1
The error, if an error occurred with this request.
repeated tables = 2
rpc GetTableSchema (, )
master_ddl.proto:831message
master_ddl.proto:201required table = 1
optional bool include_hidden = 2
optional bool check_exists_only = 3
message
master_ddl.proto:263required tablegroup = 1
message
master_ddl.proto:267optional error = 1
The error, if an error occurred with this request.
repeated get_table_schema_response_pbs = 2
List of all tables in this tablegroup.
message
master_ddl.proto:275required parent_colocated_table = 1
message
master_ddl.proto:279optional error = 1
The error, if an error occurred with this request.
repeated get_table_schema_response_pbs = 2
List of all colocated user tables in this colocated database.
rpc TruncateTable (, )
master_ddl.proto:837message
master_ddl.proto:287repeated bytes table_ids = 1
message
master_ddl.proto:291optional error = 1
The error, if an error occurred with this request.
message
master_ddl.proto:296optional bytes table_id = 1
message
master_ddl.proto:300optional error = 1
The error, if an error occurred with this request.
optional bool done = 2
true if the truncate operation is completed, false otherwise
rpc BackfillIndex (, )
master_ddl.proto:840message
master_ddl.proto:308optional index_identifier = 1
The index to backfill. Used for YSQL
message
master_ddl.proto:313optional error = 1
The error, if an error occurred with this request.
optional table_identifier = 2
The indexed table to backfill.
message
master_ddl.proto:321optional table_identifier = 1
The indexed table identifier. Used for YCQL tables from yb-admin.
message
master_ddl.proto:326optional error = 1
The error, if an error occurred with this request.
rpc GetBackfillJobs (, )
master_ddl.proto:843message
master_ddl.proto:331optional table_identifier = 1
The indexed table identifier. Used for YCQL tables from yb-admin.
message
master_ddl.proto:336repeated backfill_jobs = 1
optional error = 2
The error, if an error occurred with this request.
message
master_ddl.proto:342repeated index_tables = 1
A list of index tables whose backfill status should be returned. Either table_id or a pair of table_name and namespace should be specified to identify a table.
message
master_ddl.proto:364optional error = 1
repeated index_status = 2
rpc DeleteTable (, )
master_ddl.proto:846message
master_ddl.proto:370Delete table request (including index table).
required table = 1
optional bool is_index_table = 2
optional transaction = 3
optional bool ysql_yb_ddl_rollback_enabled = 4
message
master_ddl.proto:377optional error = 1
The error, if an error occurred with this request.
optional bytes table_id = 2
table_id for the requested table.
repeated bytes deleted_table_ids = 4
Deleted table ids. Includes the requested table, and also any index tables that it may have.
optional indexed_table = 3
For index table, the indexed table of this index.
message
master_ddl.proto:391required bytes table_id = 1
message
master_ddl.proto:395optional error = 1
The error, if an error occurred with this request.
optional bool done = 2
true if the delete operation is completed, false otherwise
rpc AlterTable (, )
master_ddl.proto:849message
master_ddl.proto:403required table = 1
repeated alter_schema_steps = 2
optional string new_table_name = 3
optional new_namespace = 4
optional alter_properties = 5
optional uint32 wal_retention_secs = 6
optional bool force_send_alter_request = 7
If set to true, SendAlterTableRequest will be sent even if no changes are specified in this request. This is useful to trigger index permissions update.
optional replication_info = 8
Replication information for this table.
optional transaction = 9
This is the transaction performing the Alter operation. This is used by TServers to abort any ongoing DML on the table other than this transaction.
optional string pgschema_name = 10
If set, updates the pgschema_name in SchemaPB.
optional bool increment_schema_version = 11
Used for YSQL to notify DocDB of DDL changes that affect only PG metadata
optional bool ysql_yb_ddl_rollback_enabled = 12
If set, YB-Master will poll the status of 'transaction' and rollback the Alter if failed.
optional bytes cdc_sdk_stream_id = 13
For CDCSDK Stream creation with consistent snapshot
optional bool cdc_sdk_require_history_cutoff = 14
message
master_ddl.proto:480optional error = 1
The error, if an error occurred with this request.
optional uint32 schema_version = 2
rpc IsAlterTableDone (, )
master_ddl.proto:850message
master_ddl.proto:487required table = 1
message
master_ddl.proto:491optional error = 1
The error, if an error occurred with this request.
optional uint32 schema_version = 2
this is the current schema, or the 'new' schema version if an alter is in progress
optional bool done = 3
true if the alter operation is completed, false otherwise
rpc CreateNamespace (, )
master_ddl.proto:852message
master_ddl.proto:521============================================================================ Namespace (default namespace = ANY placement) ============================================================================ Database type is added to metadata entries such that PGSQL clients cannot delete or connect to CQL database_type and vice versa.
optional string name = 1
Namespace name.
optional YQLDatabase database_type = 2
Database type.
optional string creator_role_name = 3
For RBAC.
optional bytes namespace_id = 4
For Postgres:
id to assign to this namespace.
optional bytes source_namespace_id = 5
namespace id of the source database to copy from.
optional uint32 next_pg_oid = 6
Next oid to assign. Ignored when source_namespace_id is given
optional transaction = 8
and the next_pg_oid from source namespace will be used. DDL Dependent upon Transaction success (abort removes). Used by YSQL.
optional bool colocated = 7
True if the namespace is colocated.
message
master_ddl.proto:543optional error = 1
The error, if an error occurred with this request.
optional bytes id = 2
message
master_ddl.proto:550optional namespace = 1
message
master_ddl.proto:554optional error = 1
The error, if an error occurred with this request.
optional bool done = 2
true if the create operation is completed, false otherwise
rpc DeleteNamespace (, )
master_ddl.proto:855message
master_ddl.proto:564Database type is added to metadata entries such that PGSQL clients cannot delete or connect to CQL database_type and vice versa.
optional namespace = 1
optional YQLDatabase database_type = 2
Database type.
message
master_ddl.proto:572optional error = 1
The error, if an error occurred with this request.
message
master_ddl.proto:577optional namespace = 1
message
master_ddl.proto:581optional error = 1
The error, if an error occurred with this request.
optional bool done = 2
true if the delete operation completed, false otherwise
rpc AlterNamespace (, )
master_ddl.proto:858message
master_ddl.proto:589optional namespace = 1
optional string new_name = 2
New name for the namespace in the alter operation.
message
master_ddl.proto:596optional error = 1
The error, if an error occurred with this request.
rpc ListNamespaces (, )
master_ddl.proto:859message
master_ddl.proto:601optional YQLDatabase database_type = 1
optional bool include_nonrunning = 2
message
master_ddl.proto:606optional error = 1
The error, if an error occurred with this request.
repeated namespaces = 2
repeated int32 states = 3
repeated int32 colocated = 4
We use int32 because the repeated bool type is bugged. See https://github.com/yugabyte/yugabyte-db/issues/15868
rpc GetNamespaceInfo (, )
master_ddl.proto:860message
master_ddl.proto:619optional namespace = 1
rpc GetTableDiskSize (, )
master_ddl.proto:862message
master_ddl.proto:502optional table = 1
GetTableDiskSizePB used for YSQL \d+ command
message
master_ddl.proto:507optional error = 1
The error, if an error occurred with this request.
optional int64 size = 2
Size is 0 for colocated tables
optional int32 num_missing_tablets = 3
rpc CreateTablegroup (, )
master_ddl.proto:865For Tablegroup:
message
master_ddl.proto:637required bytes id = 1
required bytes namespace_id = 2
optional string namespace_name = 3
optional transaction = 5
These two fields ensure that YB-Master will poll the status of 'transaction' and delete the tablegroup if aborted.
optional bool ysql_yb_ddl_rollback_enabled = 6
optional bytes tablespace_id = 4
This denotes the tablespace that this tablegroup is associated with.
message
master_ddl.proto:651optional error = 1
The error, if an error occurred with this request.
optional bytes parent_table_id = 2
optional bytes parent_table_name = 3
rpc DeleteTablegroup (, )
master_ddl.proto:866message
master_ddl.proto:659required bytes id = 1
optional transaction = 3
These two fields ensure that YB-Master will first mark the tablegroup for deletion, poll the status of 'transaction' and rollback the marker if failed. Otherwise deletion of the tablegroup will be initiated upon receipt of this request.
optional bool ysql_yb_ddl_rollback_enabled = 4
message
master_ddl.proto:672optional error = 1
The error, if an error occurred with this request.
optional bytes parent_table_id = 2
rpc ListTablegroups (, )
master_ddl.proto:867message
master_ddl.proto:679optional bytes namespace_id = 1
message
master_ddl.proto:683optional error = 1
The error, if an error occurred with this request.
repeated tablegroups = 2
rpc CreateUDType (, )
master_ddl.proto:869message
master_ddl.proto:694optional namespace = 1
optional string name = 2
repeated string field_names = 3
repeated field_types = 4
message
master_ddl.proto:701optional error = 1
The error, if an error occurred with this request.
optional bytes id = 2
rpc DeleteUDType (, )
master_ddl.proto:870message
master_ddl.proto:707optional type = 1
message
master_ddl.proto:711optional error = 1
The error, if an error occurred with this request.
rpc ListUDTypes (, )
master_ddl.proto:871message
master_ddl.proto:716optional namespace = 1
message
master_ddl.proto:720optional error = 1
The error, if an error occurred with this request.
repeated udtypes = 2
rpc GetUDTypeInfo (, )
master_ddl.proto:872message
master_ddl.proto:727optional type = 1
message
master_ddl.proto:731optional error = 1
The error, if an error occurred with this request.
optional udtype = 2
message
master_ddl.proto:741optional bytes transaction_id = 1
The transaction whose status is being reported.
optional bool is_committed = 2
Whether the above transaction is committed or aborted.
message
master_ddl.proto:749optional error = 1
message
master_ddl.proto:753optional transaction = 1
message
master_ddl.proto:757optional error = 1
optional bool done = 2
message
master_ddl.proto:767optional bytes txn_id = 1
optional uint32 subtxn_id = 2
optional bytes session_host_uuid = 3
repeated object_locks = 4
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
master_ddl.proto:779optional error = 1
optional fixed64 propagated_hybrid_time = 2
message
master_ddl.proto:784optional bytes txn_id = 1
optional uint32 subtxn_id = 2
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
optional fixed64 propagated_hybrid_time = 6
optional ash_metadata = 7
optional bool wait_for_completion = 8
Should generally not be used. Only used by yb-admin to manually clear out locks (that may have leaked).
message
master_ddl.proto:799optional error = 1
optional fixed64 propagated_hybrid_time = 2
rpc RefreshYsqlLease (, )
master_ddl.proto:883message
master_ddl.proto:804optional instance = 1
optional bool needs_bootstrap = 2
message
master_ddl.proto:817oneof refresh_ysql_lease_payload
error = 1
info = 2
message
master_encryption.proto:23optional bool encryption_enabled = 1
optional string key_path = 2
optional string version_id = 3
optional bool in_memory = 4
message
master_encryption.proto:30optional error = 1
message
master_encryption.proto:34(message has no fields)
message
master_encryption.proto:37optional bool encryption_enabled = 1
optional string key_id = 2
optional error = 3
message
master_encryption.proto:43optional universe_keys = 1
message
master_encryption.proto:47optional error = 1
message
master_encryption.proto:51(message has no fields)
message
master_encryption.proto:54optional error = 1
optional universe_keys = 2
message
master_encryption.proto:59(message has no fields)
message
master_encryption.proto:62optional error = 1
optional universe_key_registry = 2
message
master_encryption.proto:67optional string version_id = 1
message
master_encryption.proto:71optional bool has_key = 1
optional error = 2
TS->Master RPCs
message
master_heartbeat.proto:197Heartbeat sent from the tablet-server to the master to establish liveness and report back any status changes.
required common = 1
optional registration = 2
Sent upon start-up of the TS, or in response to 'needs_reregister' on a heartbeat response.
optional tablet_report = 3
Sent when the tablet information has changed, or in response to 'needs_full_tablet_report'.
optional int32 num_live_tablets = 4
The number of tablets that are BOOTSTRAPPING or RUNNING. Used by the master to determine load when creating new tablet replicas.
optional int64 config_index = 5
optional metrics = 6
optional int32 leader_count = 7
Number of tablets for which this ts is a leader.
optional int32 cluster_config_version = 8
optional fixed64 ts_physical_time = 10
Physical time on tablet server
optional fixed64 ts_hybrid_time = 11
Hybrid time on tablet server
optional int64 rtt_us = 12
Roundtrip time for previous heartbeat in microseconds.
repeated storage_metadata = 14
Drive metadata. Only set in the metrics heartbeat.
optional bool faulty_drive = 15
Tablet server has at least one faulty drive.
optional uint32 auto_flags_config_version = 17
optional uint32 xcluster_config_version = 18
repeated leader_info = 19
repeated full_compaction_statuses = 20
optional uint64 ysql_db_catalog_versions_fingerprint = 21
optional string universe_uuid = 22
repeated xcluster_consumer_replication_status = 23
message
master_heartbeat.proto:266optional error = 1
optional master_instance = 2
optional bool needs_reregister = 3
Indicates that the server which heartbeated needs to re-register with the master -- i.e send a heartbeat with the 'registration' filled in.
optional bool needs_full_tablet_report = 4
optional tablet_report = 5
Sent when the master receives a TabletReport
optional bool leader_master = 6
Specify whether or not the node is the leader master.
optional master_config = 7
Piggyback the current config as known to the master leader.
repeated tservers = 8
List of all live nodes that the master knows about.
optional string cluster_uuid = 9
Cluster UUID. Sent by the master only after registration.
optional uint64 ysql_catalog_version = 10
Current YSQL catalog schema version. Used by tservers and postgres backends to decide if a cache refresh is needed. In per-db catalog version mode, db_catalog_version_data will be used instead.
optional uint64 ysql_last_breaking_catalog_version = 15
optional db_catalog_version_data = 20
optional db_catalog_inval_messages_data = 28
optional universe_key_registry = 11
optional consumer_registry = 12
optional int32 cluster_config_version = 13
optional int32 tablet_report_limit = 16
optional snapshots_info = 17
optional int64 DEPRECATED_tablet_split_size_threshold_bytes = 14
optional uint64 transaction_tables_version = 18
Version of transaction tables and their placements, so that the TS knows when to update the cached list of status tablet ids in the transaction manager.
optional bool xcluster_enabled_on_producer = 19
Specify whether or not the cluster is a producer of a valid replication stream.
map<string, fixed64> xcluster_namespace_to_safe_time = 21
Map[Local NamespaceId]: xCluster safe read HybridTime
optional auto_flags_config = 22
optional xcluster_producer_registry = 23
optional uint32 xcluster_config_version = 24
optional string universe_uuid = 25
optional bool is_fatal_error = 27
Only set if error is set. When set, indicates that the yb-master believes the server to be in a severe bad state and should be immediately shutdown.
optional uint32 oid_cache_invalidations_count = 29
optional xcluster_heartbeat_info = 30
Tablet-level Replication.
message
master_replication.proto:69optional replication_info = 1
message
master_replication.proto:73optional error = 1
CDC stream RPCs.
message
master_replication.proto:81optional string table_id = 1
repeated options = 3
optional SysCDCStreamEntryPB.State initial_state = 4
optional string db_stream_id = 5
optional bool transactional = 6
[default = false]
optional string namespace_id = 7
optional string cdcsdk_ysql_replication_slot_name = 8
optional CDCSDKSnapshotOption cdcsdk_consistent_snapshot_option = 9
optional string cdcsdk_ysql_replication_slot_plugin_name = 10
optional cdcsdk_stream_create_options = 11
cdcsdk_stream_create_options field should be used for adding more stream creation options related to CDCSDK in future.
message
master_replication.proto:96optional error = 1
The error, if an error occurred with this request.
optional bytes stream_id = 2
optional uint64 cdcsdk_consistent_snapshot_time = 3
message
master_replication.proto:103repeated bytes stream_id = 1
optional bool ignore_errors = 2
optional bool force_delete = 3
repeated string cdcsdk_ysql_replication_slot_name = 4
message
master_replication.proto:110optional error = 1
The error, if an error occurred with this request.
repeated bytes not_found_stream_ids = 2
repeated string not_found_cdcsdk_ysql_replication_slot_names = 3
message
master_replication.proto:122optional string table_id = 1
optional string namespace_id = 2
optional IdTypePB id_type = 3
message
master_replication.proto:128optional error = 1
The error, if an error occurred with this request.
repeated streams = 2
message
master_replication.proto:134required string table_id = 1
message
master_replication.proto:138optional error = 1
The error, if an error occurred with this request.
required bool is_object_part_of_xrepl = 2
message
master_replication.proto:144optional bytes stream_id = 1
optional string cdcsdk_ysql_replication_slot_name = 2
message
master_replication.proto:149optional error = 1
The error, if an error occurred with this request.
optional stream = 2
message
master_replication.proto:155optional bytes db_stream_id = 1
message
master_replication.proto:159optional error = 1
repeated table_info = 2
optional bytes namespace_id = 3
repeated unqualified_table_info = 4
message
master_replication.proto:171optional bytes stream_id = 1
optional entry = 2
repeated streams = 3
For batch update.
message
master_replication.proto:183optional error = 1
message
master_replication.proto:202repeated string table_ids = 1
repeated string stream_ids = 2
message
master_replication.proto:207optional error = 1
repeated results = 2
message
master_replication.proto:216optional namespace = 1
The table namespace (if empty - uses default namespace).
optional bool pg_enum_info = 2
optional bool pg_composite_info = 3
optional uint32 pg_type_oid = 4
if set, metadata only of this type will be fetched.
message
master_replication.proto:263optional error = 1
The error, if an error occurred with this request.
repeated enums = 2
repeated composites = 3
message
master_replication.proto:469repeated bytes stream_ids = 1
optional uint64 target_time = 2
message
master_replication.proto:474optional error = 1
repeated undrained_stream_info = 2
message
master_replication.proto:564required table = 1
optional int64 read_time = 2
message
master_replication.proto:569optional error = 1
The error, if an error occurred with this request.
optional schema = 2
This is the schema that every TS should be able to understand if your alter is keeping the schema compatible. In case of an alter table in progress, this is the previous schema; otherwise it is the latest schema.
optional uint32 version = 3
Table schema version
message
master_replication.proto:280required string replication_id = 1
repeated producer_master_addresses = 2
required producer_namespace = 3
optional bool transactional = 4
Is the created replication group transactionally consistent.
[default = false]
message
master_replication.proto:289optional error = 1
message
master_replication.proto:293optional string replication_group_id = 1
repeated producer_master_addresses = 2
repeated string producer_table_ids = 3
repeated string producer_bootstrap_ids = 4
An id generated by the producer when BootstrapProducer rpc is called.
optional bool transactional = 5
Is the created replication group transactionally consistent.
[default = false]
repeated producer_namespaces = 6
Used for DB Scoped replication. transactional must be set. Both id and name must be set. Only YQL_DATABASE_PGSQL are allowed.
optional bool automatic_ddl_mode = 7
Whether automatic DDL replication is enabled - Creates the yb_xcluster_ddl_replication extension and sequences_data table. Requires DB Scoped replication, transactional and producer_namespace to be set.
[default = false]
message
master_replication.proto:314optional error = 1
optional string universe_uuid = 2
message
master_replication.proto:320optional string replication_group_id = 1
optional bool ignore_errors = 2
optional bool skip_producer_stream_deletion = 3
optional string universe_uuid = 4
Used to validate that the request is sent to the correct universe.
map<string, uint32> producer_namespace_oids = 5
producer_namespace_id -> oid_to_bump_above
message
master_replication.proto:330optional error = 1
repeated warnings = 2
In case force is set, then still return any ignored warnings.
message
master_replication.proto:336optional string replication_group_id = 1
repeated producer_master_addresses = 2
The below options are currently mutually exclusive. Only 1 operation at a time.
repeated string producer_table_ids_to_add = 4
repeated string producer_table_ids_to_remove = 5
optional string DEPRECATED_new_replication_group_id = 7
repeated string producer_bootstrap_ids_to_add = 6
Optional bootstrap ids for the add table operation.
optional bool remove_table_ignore_errors = 8
optional string universe_uuid = 9
Used to validate the requests are sent to the correct universe.
optional producer_namespace_to_add = 10
Used for DB Scoped replication. Both id and name must be set. Only YQL_DATABASE_PGSQL are allowed.
optional string producer_namespace_id_to_remove = 11
message
master_replication.proto:358optional error = 1
message
master_replication.proto:370optional string replication_group_id = 1
optional bool is_enabled = 2
message
master_replication.proto:375optional error = 1
message
master_replication.proto:379repeated string stream_ids = 1
optional bool is_paused = 2
message
master_replication.proto:384optional error = 1
message
master_replication.proto:388optional string replication_group_id = 1
message
master_replication.proto:392optional error = 1
optional entry = 2
message
master_replication.proto:409optional string replication_group_id = 1
message
master_replication.proto:413optional error = 1
optional bool done = 2
True if the bootstrapping is complete, false otherwise.
optional SysUniverseReplicationBootstrapEntryPB.State state = 3
The current state of the bootstrap.
optional bootstrap_error = 4
The more specific error that occurred during replication, or OK if we succeeded.
message
master_replication.proto:397optional string replication_group_id = 1
message
master_replication.proto:401optional error = 1
optional bool done = 2
True if the universe is properly setup for replication, false otherwise.
optional replication_error = 3
The more specific error that occurred during replication, or OK if we succeeded.
message
master_replication.proto:362optional cdc.XClusterRole role = 1
message
master_replication.proto:366optional error = 1
message
master_replication.proto:438optional string replication_group_id = 1
optional string stream_id = 2
optional producer_split_tablet_info = 3
message
master_replication.proto:444optional error = 1
message
master_replication.proto:485optional string replication_group_id = 1
optional string stream_id = 2
optional string consumer_tablet_id = 3
optional producer_change_metadata_request = 4
optional uint32 colocation_id = 5
optional uint32 producer_schema_version = 6
optional uint32 consumer_schema_version = 7
message
master_replication.proto:495optional error = 1
optional bool should_wait = 2
optional uint32 last_compatible_consumer_schema_version = 3
The last Consumer schema version that was EquivalentForDataCopy with the Producer
optional schema_versions = 4
message
master_replication.proto:505optional string replication_group_id = 1
optional string target_parent_table_id = 2
optional uint32 colocation_id = 3
optional uint32 source_schema_version = 4
optional schema = 5
message
master_replication.proto:513optional error = 1
optional uint32 last_compatible_consumer_schema_version = 2
message
master_replication.proto:518optional bytes table_id = 1
If this is an alter on a colocated table, then this is the colocated parent table id, and we also need to specify the colocation_id.
optional packed_schema = 2
optional uint32 current_schema_version = 3
optional uint32 colocation_id = 4
message
master_replication.proto:527optional error = 1
message
master_replication.proto:786optional string namespace_id = 1
message
master_replication.proto:790optional error = 1
repeated string replication_group_ids = 2
message
master_replication.proto:795required string replication_group_id = 1
message
master_replication.proto:799optional error = 1
optional XClusterReplicationType replication_type = 2
optional string source_master_addresses = 3
repeated table_infos = 4
repeated db_scoped_infos = 5
optional bool automatic_ddl_mode = 6
[default = false]
message
master_replication.proto:448optional string replication_group_id = 1
Filters by the replication group if non-empty.
message
master_replication.proto:464optional error = 1
repeated statuses = 2
message
master_replication.proto:531(message has no fields)
message
master_replication.proto:533optional error = 1
repeated namespace_safe_times = 2
message
master_replication.proto:551optional string namespace_id = 1
optional XClusterSafeTimeFilter filter = 2
Ignore safe times from these types of tables. If this filters out all tables, then will return master leader safe time.
message
master_replication.proto:559optional error = 1
optional fixed64 safe_time_ht = 2
message
master_replication.proto:187required YQLDatabase db_type = 1
required string namespace_name = 2
repeated string pg_schema_name = 3
repeated string table_name = 4
message
master_replication.proto:194optional error = 1
repeated string table_ids = 2
repeated bytes bootstrap_ids = 3
optional fixed64 bootstrap_time = 4
Minimum time after which data is available on all the bootstrapped streams.
message
master_replication.proto:583required string replication_group_id = 1
required uint32 auto_flag_config_version = 2
message
master_replication.proto:588optional error = 1
Backfill a replication slot name to an existing CDCSDK stream.
message
master_replication.proto:592optional bytes stream_id = 1
optional string cdcsdk_ysql_replication_slot_name = 2
message
master_replication.proto:597optional error = 1
xClusterOutboundReplicationGroup RPCs.
message
master_replication.proto:601required string replication_group_id = 1
repeated string namespace_ids = 2
optional bool automatic_ddl_mode = 3
[default = false]
message
master_replication.proto:607optional error = 1
message
master_replication.proto:611required string replication_group_id = 1
required string namespace_id = 2
message
master_replication.proto:616optional error = 1
message
master_replication.proto:620required string replication_group_id = 1
required string namespace_id = 2
repeated target_master_addresses = 3
Optional. When set target cluster is also cleaned up.
message
master_replication.proto:628optional error = 1
message
master_replication.proto:632required string replication_group_id = 1
repeated target_master_addresses = 2
Optional. When set target cluster is also cleaned up.
message
master_replication.proto:639optional error = 1
message
master_replication.proto:643required string replication_group_id = 1
required string namespace_id = 2
message
master_replication.proto:648optional error = 1
optional bool not_ready = 2
optional bool initial_bootstrap_required = 3
message
master_replication.proto:654required string replication_group_id = 1
repeated string namespace_ids = 2
message
master_replication.proto:659optional error = 1
message
master_replication.proto:663required string replication_group_id = 1
required string namespace_id = 2
repeated table_infos = 3
Only one of the following fields should be set. If both are empty, return all tables.
repeated bytes source_table_ids = 4
message
master_replication.proto:676optional error = 1
optional bool not_ready = 2
[default = false]
optional bool initial_bootstrap_required = 3
[default = false]
repeated table_infos = 4
message
master_replication.proto:742required string replication_group_id = 1
required bytes table_id = 2
required bytes stream_id = 3
message
master_replication.proto:748optional error = 1
message
master_replication.proto:752required string replication_group_id = 1
required bytes table_id = 2
message
master_replication.proto:757optional error = 1
message
master_replication.proto:761optional string namespace_id = 1
message
master_replication.proto:765optional error = 1
repeated string replication_group_ids = 2
message
master_replication.proto:770required string replication_group_id = 1
message
master_replication.proto:774optional error = 1
repeated namespace_infos = 2
optional bool automatic_ddl_mode = 4
[default = false]
xCluster APIsV2
message
master_replication.proto:691required string replication_group_id = 1
repeated target_master_addresses = 2
message
master_replication.proto:697optional error = 1
message
master_replication.proto:701required string replication_group_id = 1
repeated target_master_addresses = 2
message
master_replication.proto:707optional error = 1
optional bool done = 2
[default = false]
optional replication_error = 3
Only set when done is true. OK if the created succeeded or the error if it failed.
message
master_replication.proto:717required string replication_group_id = 1
repeated target_master_addresses = 2
required string namespace_id = 3
message
master_replication.proto:723optional error = 1
message
master_replication.proto:727required string replication_group_id = 1
repeated target_master_addresses = 2
message
master_replication.proto:732optional error = 1
optional bool done = 2
[default = false]
optional replication_error = 3
Only set when done is true. OK if the created succeeded or the error if it failed.
Introduced for bug (#22876, #22773)
message
master_replication.proto:821optional string stream_id = 1
message
master_replication.proto:825optional error = 1
Introduced for bug (#22876, #22773)
message
master_replication.proto:829optional string stream_id = 1
optional string table_id = 2
message
master_replication.proto:834optional error = 1
Introduced for bug (#22876, #22773)
message
master_replication.proto:838optional string stream_id = 1
message
master_replication.proto:842optional error = 1
repeated string updated_tablet_entries = 2
Introduced for bug (#22876, #22773)
message
master_replication.proto:847optional string stream_id = 1
repeated string table_ids = 2
message
master_replication.proto:852optional error = 1
service MasterTest
master_test.proto:34rpc TestRetry (, )
master_test.proto:38Returns TryAgain error until specified number of calls is done.
message
master_test.proto:22optional string dest_uuid = 1
UUID of server this request is addressed to.
required int32 num_retries = 2
See TestRetry RPC method description below.
message
master_test.proto:30optional error = 1
message
master_ddl.proto:415Used in:
required schema = 1
The schema to add. NOTE: the 'id' field of the schema should not be provided here -- the server will assign an ID.
message
master_ddl.proto:421Used in:
required string name = 1
Name of the column to drop.
message
master_ddl.proto:425Used in:
required string old_name = 1
Name of the column to rename;
required string new_name = 2
message
master_ddl.proto:431Used in:
required string name = 1
Name of the column for which to update the pg_type_oid.
required uint32 pg_type_oid = 2
message
master_ddl.proto:437Used in:
optional StepType type = 1
optional add_column = 2
Exactly one of the following must be set, based on 'type'
optional drop_column = 3
optional rename_column = 4
optional set_column_pg_type = 5
Used in:
UNKNOWN = 0
ADD_COLUMN = 1
DROP_COLUMN = 2
RENAME_COLUMN = 3
SET_COLUMN_PG_TYPE = 5
ALTER_COLUMN = 4
TODO(KUDU-861): this will subsume RENAME_COLUMN, but not yet implemented on the master side.
message
catalog_entity_info.proto:32Used in: ,
repeated indexes = 1
map<string, BackfillJobPB.State> backfill_state = 2
Index's TableId -> State for each index.
optional uint64 num_rows_processed = 4
Number of rows processed for this backfill task (the same for all indexes)
optional uint64 backfilling_timestamp = 3
Used in:
IN_PROGRESS = 0
FAILED = 1
SUCCESS = 2
message
master_backup.proto:23Used in:
optional entry = 1
optional bytes pg_schema_name = 2
Used to disambiguate in case YSQL tables in different schema have same name.
For 'entry.type' == TABLE only.
message
catalog_entity_info.proto:371This is used to mark servers in the load balancer that should be considered for immediate removal of load and also prevented from being assigned any new load.
Used in:
repeated hosts = 1
optional int32 initial_replica_load = 2
Fields to track the number of replicas/leaders in current set of tablets which have a blacklist server/leader. Client should not set this. Set by server side when persisting the blacklist load.
optional int32 initial_leader_load = 3
message
catalog_entity_info.proto:588The on-disk entry specific to CDCSDK streams
Used in:
optional uint64 snapshot_time = 1
optional CDCSDKSnapshotOption consistent_snapshot_option = 2
message
master_replication.proto:29Used in:
optional ReplicationSlotLsnType cdcsdk_ysql_replication_slot_lsn_type = 1
This field stores the type of the LSN being used by the replication slot.
optional ReplicationSlotOrderingMode cdcsdk_ysql_replication_slot_ordering_mode = 2
message
master_replication.proto:38Used in: ,
optional bytes stream_id = 1
repeated bytes table_id = 2
For CDCSDK, table_id contains the qualified list of tables for the stream.
repeated options = 3
optional bytes namespace_id = 4
optional bool transactional = 5
[default = false]
optional string cdcsdk_ysql_replication_slot_name = 6
optional uint64 cdcsdk_consistent_snapshot_time = 7
optional CDCSDKSnapshotOption cdcsdk_consistent_snapshot_option = 8
optional uint64 stream_creation_time = 9
map<string, PgReplicaIdentity> replica_identity_map = 10
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_id and the value is replica identity for that table.
optional string cdcsdk_ysql_replication_slot_plugin_name = 11
optional bool cdcsdk_disable_dynamic_table_addition = 12
Dynamic tables are the tables which are created after the creation of the stream. This field controls if dynamic tables should automatically be added to the CDC stream or not. If set to true, dynamic table wont get added to the CDC stream.
repeated bytes unqualified_table_id = 13
This field stores the list of user created tables that have been removed from CDCSDK stream.
optional cdc_stream_info_options = 14
Field to store all the metadata related to a CDC stream.
message
catalog_entity_info.proto:582Options for CDC stream. This will include details such as: Stream sink: YB Universe / Kafka / Elastic Search. Log retention time: Amount of time to retain logs for CDC. Sink details: For example, Kafka cluster IP, port.
Used in: , ,
optional string key = 1
optional bytes value = 2
message
catalog_entity_info.proto:733Used in:
required uint32 colocation_id = 1
required schema_version_mapping = 2
message
master_ddl.proto:130Used in:
optional bytes xcluster_source_table_id = 1
Set by DDL Replication to link the table to the original table in the source cluster.
optional fixed64 xcluster_backfill_hybrid_time = 2
Set by DDL Replication as a set time to perform index backfill.
message
master_heartbeat.proto:191Used in:
repeated db_catalog_inval_messages = 1
message
catalog_entity_info.proto:568Used in:
optional TableType table_type = 1
optional string namespace_name = 2
optional string namespace_id = 3
optional string table_name = 4
optional string table_id = 5
optional string action = 6
optional fixed64 time = 7
message
catalog_entity_info.proto:381Used in:
optional bool encryption_enabled = 1
optional bytes universe_key_registry_encoded = 2
optional string key_path = 3
optional string latest_version_id = 4
optional bool key_in_memory = 5
message
master_heartbeat.proto:133Used in:
optional bytes tablet_id = 1
optional tablet.FullCompactionState full_compaction_state = 2
Current full compaction state.
optional fixed64 last_full_compaction_time = 3
Time of completion of the last fully completed full compaction. Raw representation of a HybridTime.
message
master_replication.proto:160Used in:
optional bytes stream_id = 1
optional bytes table_id = 2
message
master_cluster.proto:222When no errors, the percent reflects the progress of load removal from the blacklisted tservers.
Used as response type in: MasterCluster.GetLeaderBlacklistCompletion, MasterCluster.GetLoadMoveCompletion
optional error = 1
optional double percent = 2
To be deprecated. Replaced by "100 * (total - remaining) / total".
optional uint64 remaining = 3
optional uint64 total = 4
message
master_admin.proto:274Used in:
optional bytes master_uuid = 1
optional int64 last_heartbeat_delta_ms = 2
message
master_ddl.proto:623Used as response type in: MasterDdl.GetNamespaceInfo
Used as field type in:
optional error = 1
The error, if an error occurred with this request.
optional namespace = 2
optional bool colocated = 3
optional bool legacy_colocated_database = 4
This denotes if a colocated database is a legacy colocated database.
message
master_ddl.proto:207Used as response type in: MasterDdl.GetTableSchema
Used as field type in: , ,
optional error = 1
The error, if an error occurred with this request.
optional schema = 2
This is the schema that every TS should be able to understand if your alter is keeping the schema compatible. In case of an alter table in progress, this is the previous schema; otherwise it is the latest schema.
optional uint32 version = 9
Table schema version
optional partition_schema = 5
The table's partition schema.
optional replication_info = 3
optional bool create_table_done = 6
True if the create operation is completed, false otherwise.
optional TableType table_type = 7
The table type.
optional identifier = 8
Table identifier
repeated indexes = 10
Secondary indexes of the table.
optional bytes OBSOLETE_indexed_table_id = 11
For index table: [to be deprecated and replaced by "index_info"]
Indexed table id of this index.
optional index_info = 12
For index table: information about this index.
optional bool colocated = 13
True if table is colocated (including tablegroups, excluding YSQL system tables).
optional bytes tablegroup_id = 16
optional bool is_compatible_with_previous_version = 14
optional uint32 wal_retention_secs = 15
repeated ysql_ddl_txn_verifier_state = 17
optional bytes pg_table_id = 18
If the table is rewritten, this field explicitly stores the PG table id.
optional bool is_backfilling = 19
Added on Oct 2024 (v2025.1). This will not be set on versions before this change, and there is no direct AutoFlag protecting this, so use with caution.
[default = false]
message
master_client.proto:131Used in:
required bytes tablet_id = 1
required status = 2
message
master_replication.proto:812Used in:
required string target_namespace_id = 1
required string source_namespace_id = 2
message
master_replication.proto:805Used in:
required string target_table_id = 1
required string source_table_id = 2
required string stream_id = 3
message
master_replication.proto:777Used in:
required string namespace_id = 1
map<string, string> table_streams = 2
Map of Source TableId to xCluster StreamId
message
master_replication.proto:534Used in:
optional string namespace_id = 1
optional fixed64 safe_time_ht = 2
optional uint64 safe_time_lag = 3
optional uint64 safe_time_skew = 4
optional string namespace_name = 5
message
master_replication.proto:667Used in:
required string table_name = 1
required string pg_schema_name = 2
message
master_replication.proto:681Used in:
required bytes table_id = 1
required bytes xrepl_stream_id = 2
required string table_name = 3
required string pg_schema_name = 4
message
master_backup.proto:179ID mapping pair: old ID (object ID on external cluster) TO new ID (same object ID on this cluster)
Used in:
optional bytes old_id = 1
optional bytes new_id = 2
Used in:
TABLE_ID = 1
NAMESPACE_ID = 2
message
master_backup.proto:198Per table IDs mapping (IDs on external cluster TO IDs on this cluster).
Used in:
optional namespace_ids = 1
optional table_ids = 2
repeated tablets_ids = 3
optional TableType table_type = 4
repeated ud_types_ids = 5
Used in:
TABLE = 0
COLOCATED_TABLE = 1
PARENT_COLOCATED_TABLE = 2
message
master_ddl.proto:348Used in:
optional index_table = 1
optional error = 2
Contains an error if it's not possible to get backfill_status and index permissions.
optional IndexStatusPB.BackfillStatus backfill_status = 3
Backfill status for the specified index table on base of index permissions. Value absence means either error field is specified, or backfill_status is not present in BackfillStatus enum.
Used in:
BACKFILL_UNKNOWN = 0
Unspecified state.
BACKFILL_SUCCESS = 1
Backfill succeeded.
message
master_replication.proto:208Used in:
optional bytes table_id = 1
optional bool bootstrap_required = 2
message
master_cluster.proto:62Used in:
required instance_id = 1
optional registration = 2
optional bool isFromReadReplica = 3
message
master_backup.proto:118Used in:
optional bool show_namespace_details = 1
Defaults are set to true to support backwards compatibility.
optional bool show_udtype_details = 2
optional bool show_table_details = 3
optional bool show_tablet_details = 4
message
master_ddl.proto:180Used in:
optional bool colocated = 1
optional bytes parent_table_id = 2
message
master_ddl.proto:185Used in:
required bytes id = 1
required string name = 2
optional TableType table_type = 3
optional namespace = 4
optional RelationType relation_type = 5
optional SysTablesEntryPB.State state = 6
optional string pgschema_name = 7
optional colocated_info = 8
optional bool hidden = 9
optional string indexed_table_id = 10
message
master_cluster.proto:43Used in:
required instance_id = 1
optional registration = 2
optional int32 millis_since_heartbeat = 3
optional bool alive = 4
optional metrics = 5
optional lease_info = 6
message
master_types.proto:60Master specific errors use this protobuf.
Used in: , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , , ,
required MasterErrorPB.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.
OBJECT_NOT_FOUND = 3
The requested table or index does not exist
OBJECT_ALREADY_PRESENT = 4
The name requested for the table or index is already in use
TOO_MANY_TABLETS = 5
The number of tablets requested for a new table is over the per TS limit.
CATALOG_MANAGER_NOT_INITIALIZED = 6
Catalog manager is not yet initialized.
NOT_THE_LEADER = 7
The operation attempted can only be invoked against either the leader or a single non-distributed master, which this node isn't.
REPLICATION_FACTOR_TOO_HIGH = 8
The number of replicas requested is greater than the number of live servers in the cluster.
CONFIG_VERSION_MISMATCH = 9
Change config should always be issued with the latest config version set. If the client fails to do so, or there is a concurrent change, we will set this error code.
IN_TRANSITION_CAN_RETRY = 10
If there is an operation in progress causing the current rpc to be in an indeterminate state, we return this error code. Client can retry on a case by case basis as needed.
NAMESPACE_NOT_FOUND = 11
Invalid namespace name or id for the namespace operation.
NAMESPACE_ALREADY_PRESENT = 12
NO_NAMESPACE_USED = 13
NAMESPACE_IS_NOT_EMPTY = 14
INVALID_CLUSTER_CONFIG = 15
Client set some fields incorrectly in the cluster config proto.
CAN_RETRY_LOAD_BALANCE_CHECK = 16
Indicator to client that the load balance operation can be retried.
TYPE_NOT_FOUND = 17
Invalid (User-Defined) Type operation
INVALID_TYPE = 18
TYPE_ALREADY_PRESENT = 19
INVALID_TABLE_TYPE = 20
Snapshot related errors.
TABLE_CREATION_IS_IN_PROGRESS = 21
SNAPSHOT_NOT_FOUND = 22
SNAPSHOT_FAILED = 23
SNAPSHOT_CANCELLED = 24
PARALLEL_SNAPSHOT_OPERATION = 25
SNAPSHOT_IS_NOT_READY = 26
ROLE_ALREADY_PRESENT = 27
Roles and permissions errors.
ROLE_NOT_FOUND = 28
INVALID_REQUEST = 29
NOT_AUTHORIZED = 32
CAN_RETRY_ARE_LEADERS_ON_PREFERRED_ONLY_CHECK = 30
Indicator to client that the are leaders on preferred only operation can be retried.
REDIS_CONFIG_NOT_FOUND = 31
LOAD_BALANCER_RECENTLY_ACTIVE = 33
Indicator to client that load balancer was recently active.
INTERNAL_ERROR = 34
INVALID_TABLE_REPLICATION_INFO = 35
Client set some fields in the table replication info incorrectly.
REACHED_SPLIT_LIMIT = 36
SPLIT_OR_BACKFILL_IN_PROGRESS = 37
TABLET_NOT_RUNNING = 38
Error in case a tablet-level operation was attempted on a tablet which is not running.
TABLE_NOT_RUNNING = 39
TABLE_SCHEMA_CHANGE_IN_PROGRESS = 40
REPLICATION_SLOT_LIMIT_REACHED = 41
The number of existing replication slots have reached `max_replication_slots`.
TABLET_SERVER_NOT_FOUND = 42
message
master_backup.proto:93Used in:
optional bytes id = 1
optional SysRowEntryType type = 2
message
master_types.proto:173Used in: , , , , , , , , , , , , , , , , , , , , ,
optional bytes id = 1
The namespace ID to fetch info.
optional string name = 2
The namespace name to fetch info.
optional YQLDatabase database_type = 3
Database type.
message
master_replication.proto:232Used in:
required uint32 attrelid = 1
required string attname = 2
required uint32 atttypid = 3
required int32 attstattarget = 4
required int32 attlen = 5
required int32 attnum = 6
required int32 attndims = 7
required int32 attcacheoff = 8
required int32 atttypmod = 9
required bool attbyval = 10
required int32 attstorage = 11
required int32 attalign = 12
required bool attnotnull = 13
required bool atthasdef = 14
required bool atthasmissing = 15
required int32 attidentity = 16
required bool attisdropped = 17
required bool attislocal = 18
required int32 attinhcount = 19
required uint32 attcollation = 20
message
master_replication.proto:255Used in:
required uint32 oid = 1
PG composite type oid.
repeated attributes = 2
Attributes of composite type.
message
master_replication.proto:225Used in:
required uint32 oid = 1
PG enum Oid.
required string label = 2
PG enum label.
message
master_replication.proto:426Used in:
required bytes tablet_id = 1
required bytes new_tablet1_id = 2
required bytes new_tablet2_id = 3
required bytes split_partition_key = 4
required bytes split_encoded_key = 5
message
master_ddl.proto:809Used in:
optional bool new_lease = 1
optional uint64 lease_epoch = 2
optional ddl_lock_entries = 3
TODO: If this ends up being too big, consider adding a way to break this up into multiple messages.
Used in: ,
SYSTEM_TABLE_RELATION = 1
USER_TABLE_RELATION = 2
INDEX_TABLE_RELATION = 3
MATVIEW_TABLE_RELATION = 4
COLOCATED_PARENT_TABLE_RELATION = 5
message
master_replication.proto:453Used in:
required ReplicationErrorPb error = 1
required string error_detail = 2
message
master_replication.proto:458Used in:
required bytes table_id = 1
required bytes stream_id = 2
repeated errors = 3
message
master_heartbeat.proto:38Used in:
required bytes tablet_id = 1
optional tablet.RaftGroupStatePB state = 2
optional tablet.TabletDataState tablet_data_state = 6
optional committed_consensus_state = 3
The latest _committed_ consensus state. This will be missing if the tablet is not in a RUNNING state (i.e. if it is BOOTSTRAPPING).
optional error = 4
optional uint32 schema_version = 5
optional bool should_disable_lb_move = 7
Replica is reporting that load balancer moves should be disabled
optional bytes fs_data_dir = 8
optional bool is_hidden = 9
Is the tablet hidden.
map<string, uint32> table_to_version = 11
Mapping of table ids to their respective schema version numbers.
message
master_heartbeat.proto:143Used in:
required bytes tablet_id = 1
optional string state_msg = 2
message
master_dcl.proto:103Used in:
optional string canonical_resource = 1
optional uint32 permissions = 2
Bitmap representing the permissions.
message
catalog_entity_info.proto:457Used in:
optional string resource_name = 1
optional string canonical_resource = 11
optional string namespace_name = 12
optional ResourceType resource_type = 2
repeated PermissionType permissions = 13
message
master_types.proto:195Used in: ,
optional int64 core_count = 1
optional int64 tablet_overhead_ram_in_bytes = 2
The amount of memory the TServer has reserved for tablet overheads.
message
master_backup.proto:112Used in:
optional bytes id = 1
optional entry = 2
Detailed snapshot entries.
message
master_dcl.proto:109Used in:
optional string role = 1
optional uint32 all_keyspaces_permissions = 2
Bitmap representing the permissions for 'ALL KEYSPACES' and 'ALL ROLES'.
optional uint32 all_roles_permissions = 3
repeated resource_permissions = 4
optional string salted_hash = 5
optional bool can_login = 6
message
catalog_entity_info.proto:738optional schema_version_mapping = 1
repeated colocated_schema_versions = 2
message
catalog_entity_info.proto:728Used in: ,
required uint32 producer_schema_version = 1
required uint32 consumer_schema_version = 2
BOOTSTRAP_PRODUCER = 1
CREATE_PRODUCER_SNAPSHOT = 2
IMPORT_SNAPSHOT = 3
CREATE_CONSUMER_SNAPSHOT = 4
TRANSFER_SNAPSHOT = 5
RESTORE_SNAPSHOT = 6
SETUP_REPLICATION = 7
message
master_backup.proto:68Used in: , ,
optional bytes id = 1
optional entry = 2
Detailed snapshot entries.
optional int64 format_version = 3
Specifies what format of snaphot info is provided. The current versions are: Format 0 - latest format (== Format 3 at the moment). Format -1 - old format (no 'namespace_name' in the Table entry). Format 1 - old format (no BackupRowEntryPB. Instead, namespaces, tables, and tablets are stored in SysSnapshotEntryPB entry.entries). Format 2 - Using BackupRowEntryPB wrapper which has pg_schema_name for ysql table entries. Format 3 - Using relfilenode for import snapshot in Ysql databases. This format guarantees that a ysql_dump taken for a backup preserves relfilenode for ysql tables.
repeated backup_entries = 4
Stored extended info about snapshot (1) namespaces (2) tables (3) tablets instead of 'SysRowEntry entry.entries'.
message
master_backup.proto:213Used in:
oneof filter
tables = 1
message
master_backup.proto:242Used in: ,
optional bytes id = 1
optional options = 2
repeated snapshots = 3
message
master_backup.proto:219Used in: ,
optional filter = 1
optional uint64 interval_sec = 2
interval for taking snapshot in seconds.
optional uint64 retention_duration_sec = 3
how long store snapshots in seconds.
optional fixed64 delete_time = 4
hybrid time when this schedule was deleted.
repeated fixed64 restoration_times = 5
list of all restorations of this schedule.
message
master_client.proto:234Used in:
optional bytes permanent_uuid = 1
repeated private_rpc_addresses = 2
repeated broadcast_addresses = 3
optional cloud_info = 4
message
catalog_entity_info.proto:594The data part of a SysRowEntry in the sys.catalog table for a CDC stream.
Used in: ,
repeated string table_id = 1
repeated options = 2
optional SysCDCStreamEntryPB.State state = 3
optional string namespace_id = 4
optional bool transactional = 5
[default = false]
optional string cdcsdk_ysql_replication_slot_name = 6
optional cdcsdk_stream_metadata = 7
optional uint64 stream_creation_time = 8
map<string, PgReplicaIdentity> replica_identity_map = 9
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_id and the value is replica identity for that table.
optional string cdcsdk_ysql_replication_slot_plugin_name = 10
optional bool cdcsdk_disable_dynamic_table_addition = 11
Dynamic tables are the tables which are created after the creation of the stream. This field controls if dynamic tables should automatically be added to the CDC stream or not. If set to true, dynamic table wont get added to the CDC stream.
repeated bytes unqualified_table_id = 12
This field stores the list of user created tables that have been removed from CDCSDK stream.
optional ReplicationSlotLsnType cdcsdk_ysql_replication_slot_lsn_type = 13
optional ReplicationSlotOrderingMode cdcsdk_ysql_replication_slot_ordering_mode = 14
Used in: ,
INITIATED = 3
Used to mark a stream that has been bootstrapped, but hasn't started streaming yet.
ACTIVE = 0
DELETING = 1
DELETED = 2
Currently DELETED is not being used because we delete streams entries from sys catalog.
DELETING_METADATA = 4
Used to handle the stream metadata cleanup as part of drop table.
message
master_admin.proto:288Used in:
optional SysRowEntryType entry_type = 1
optional string entity_id = 2
optional string pb_debug_string = 3
message
catalog_entity_info.proto:692Used in:
optional SysCloneStatePB.State aggregate_state = 1
optional string source_namespace_id = 2
Needed to load the clone state into the CloneStateManager's map.
optional uint32 clone_request_seq_no = 3
optional YQLDatabase database_type = 8
Used for debugging.
optional string target_namespace_name = 4
optional string target_namespace_id = 7
optional string source_namespace_name = 9
optional fixed64 restore_time = 5
optional string abort_message = 6
A reason for why the clone was aborted.
State for clone operation. CLONE_SCHEMA_STARTED: Initial state. CLONE_SCHEMA_STARTED --> CREATING: Once DB objects have been created by ysql_dump (YSQL) or ImportSnapshot (YCQL). Clone tablet RPCs are scheduled for all tablets. CREATING --> RESTORING: All tablets in clone namespace are created and in a running state. Restore snapshot is issued. RESTORING --> COMPLETE (YCQL): Restore snapshot completed and DB is ready to be accessed. RESTORING --> RESTORED (YSQL): Restore snapshot completed. RESTORED --> COMPLETE (YSQL): DB is ready to be accessed.
Used in:
CLONE_SCHEMA_STARTED = 1
CREATING = 2
RESTORING = 3
RESTORED = 4
ABORTED = 5
COMPLETE = 6
message
catalog_entity_info.proto:392The on-disk entry in the sys.catalog table for configuration information that are relevant to the entire cluster. This has a version entry that is used for ensuring that client read-modify-writes are valid.
Used in: ,
optional int32 version = 1
optional string cluster_uuid = 4
optional replication_info = 2
optional server_blacklist = 3
optional leader_blacklist = 7
optional encryption_info = 5
optional consumer_registry = 6
optional string universe_uuid = 8
This field is only generated internally by the master leader in PrepareDefaultClusterConfig (as opposed to cluster_uuid which can be passed in as a flag). If not already set, it is set on the VisitSysCatalog path.
optional uint32 oid_cache_invalidations_count = 9
This field is bumped to invalidate all the TServer OID caches. Note that this is for every database and applies only to YSQL.
message
catalog_entity_info.proto:534Various cluster configuration.
oneof config
security_config = 1
ysql_catalog_config = 2
transaction_tables_config = 3
message
catalog_entity_info.proto:282The data part of a SysRowEntry in the sys.catalog table for a namespace.
There are significant differences between the state machines for YSQL vs non-YSQL. The additional complexity for YSQL is due to the amount of work required for database creation and deletion, requiring async tasks and additional states.
optional bytes name = 1
Namespace name.
optional YQLDatabase database_type = 2
Namespace/Database type.
optional uint32 next_normal_pg_oid = 3
For Postgres:
Next normal space oid to assign.
optional bool colocated = 4
True if the namespace is colocated.
optional transaction = 6
Optional: Namespace dependent upon transaction success (abort removes NS). Used by YSQL.
optional SysNamespaceEntryPB.State state = 5
optional SysNamespaceEntryPB.YsqlNextMajorVersionState ysql_next_major_version_state = 8
optional uint32 clone_request_seq_no = 7
optional uint32 next_secondary_pg_oid = 9
Next secondary space oid to assign.
During the deletion flow a non-YSQL namespace is removed from the maps and sys catalog table directly instead of transitioning to any deletion states.
Used in:
UNKNOWN = 0
PREPARING = 1
FAILED = 2
RUNNING = 3
DELETING = 4
DELETED = 5
During a YSQL major version upgrade, for example from PG11 to PG15, we use the existing namespace entry for both the old and new versions' namespace. However, PG's upgrade process is normally run on a clean unused system, and it does DROP DATABASE and CREATE DATABASE there in order to fully restore the properties of the database. In YB, we simulate PG's environment, by using a separate state for the new major version. NEXT_VER_RUNNING is the initial state. NEXT_VER_RUNNING -> NEXT_VER_DELETING - deletion requested. NEXT_VER_DELETING -> NEXT_VER_DELETED - happy path of deletion. NEXT_VER_DELETING -> NEXT_VER_FAILED - unhappy path of deletion. NEXT_VER_DELETED -> NEXT_VER_RUNNING - re-populated. TODO: Change the initial state to something other than NEXT_VER_RUNNING. Be sure it makes sense for multiple upgrades (e.g., a system that went from PG11 -> PG15 -> PG17). Therefore it may need to be changed from NEXT_VER_RUNNING at some point after the upgrade.
Used in:
NEXT_VER_UNKNOWN = 0
NEXT_VER_FAILED = 1
NEXT_VER_RUNNING = 2
NEXT_VER_DELETING = 3
NEXT_VER_DELETED = 4
message
catalog_entity_info.proto:409map<uint64, > lease_epochs = 1
lease_epoch -> Transaction ...
optional lease_info = 2
map<uint64, > in_progress_release_request = 3
message
catalog_entity_info.proto:431Used in:
optional bool live_lease = 1
Whether the lease is currently live.
optional uint64 lease_epoch = 2
optional int64 instance_seqno = 3
The instance_seqno of the tserver process to which this lease was granted.
message
catalog_entity_info.proto:410Used in:
repeated TableLockType lock_type = 1
message
catalog_entity_info.proto:411Used in:
map<uint64, > objects = 1
object_id -> Locks taken
message
catalog_entity_info.proto:415Used in:
optional uint64 db_id = 1
map<uint32, > subtxns = 2
subtxn -> object locks ...
message
catalog_entity_info.proto:420Used in:
map<string, > transactions = 1
txn_id -> subtxn ...
message
catalog_entity_info.proto:452The data part of a SysRowEntry in the sys.catalog table for Redis Config.
optional string key = 1
repeated bytes args = 2
message
master_backup.proto:98Used in:
optional SysSnapshotEntryPB.State state = 1
repeated tablet_restorations = 2
optional bytes snapshot_id = 8
optional bytes schedule_id = 4
optional bool is_sys_catalog_restored = 5
optional fixed64 restore_at_ht = 6
optional int64 version = 7
optional fixed64 complete_time_ht = 3
Time when restoration finished. Computed on master after received response from the last tablet.
repeated master_metadata = 9
message
catalog_entity_info.proto:465optional bytes role = 1
optional bool can_login = 2
optional bool is_superuser = 3
repeated bytes member_of = 4
optional bytes salted_hash = 5
repeated resources = 7
message
catalog_entity_info.proto:564repeated entries = 1
message
catalog_entity_info.proto:545The actual on disk abstract representation of a row in the sys catalog. This has to respect the fixed schema of the catalog. In case of changes to the schema, this proto must reflect them.
Used in: , ,
optional SysRowEntryType type = 1
The type of entry we are storing. Since the data is serialized, we cannot just store it with the data, as we are not able to read into the appropriate type.
optional string id = 2
The optional ID of the data that we are storing. This can be useful to only read information related to a single item, in the case of tables or tablets, for example. This is optional.
optional bytes data = 3
This is the serialized format of the proto we store. This used to be of the "string" type, but was giving warnings due to non-UTF8 data. This is safe, because "bytes" and "string" are encoded the same way in Protobuf. https://groups.google.com/forum/#!msg/protobuf/au6eQBkRT5s/Bhpctql7Q5sJ
Used in: , , , ,
UNKNOWN = 0
TABLE = 1
TABLET = 2
CLUSTER_CONFIG = 3
NAMESPACE = 4
UDTYPE = 5
ROLE = 6
SNAPSHOT = 7
REDIS_CONFIG = 8
SYS_CONFIG = 9
CDC_STREAM = 10
UNIVERSE_REPLICATION = 11
SNAPSHOT_SCHEDULE = 12
DDL_LOG_ENTRY = 13
SNAPSHOT_RESTORATION = 14
XCLUSTER_SAFE_TIME = 15
XCLUSTER_CONFIG = 16
UNIVERSE_REPLICATION_BOOTSTRAP = 17
XCLUSTER_OUTBOUND_REPLICATION_GROUP = 18
CLONE_STATE = 19
TSERVER_REGISTRATION = 20
OBJECT_LOCK_ENTRY = 21
message
catalog_entity_info.proto:475Cluster security configuration.
Used in:
optional uint64 roles_version = 1
Roles configuration version. Every time a role gets created/deleted, or a permission gets added/removed, we increase the version.
optional bool cassandra_user_created = 2
message
catalog_entity_info.proto:638The on-disk entry in the sys.catalog table ("metadata" column) for snapshots entries.
Used in:
optional SysSnapshotEntryPB.State state = 1
repeated tablet_snapshots = 2
repeated entries = 3
Stored info about snapshot (1) namespaces (2) tables (3) tablets.
optional fixed64 snapshot_hybrid_time = 4
optional int64 version = 5
optional bytes schedule_id = 6
optional fixed64 previous_snapshot_hybrid_time = 7
optional int32 retention_duration_hours = 8
This field specifies the TTL of this snapshot. 1. Not set: the snapshot has no explicit TTL, will be retained until a DeleteSnapshot, and does not block object cleanup. This is used to handle a few special cases: a. Snapshots which are part of a snapshot schedule do not have this field set. This is because their TTL is controlled by the snapshot schedule's retention. b. Snapshots created before D28005 (when this field was introduced). 2. < 0: the snapshot will not be automatically cleaned up until a `DeleteSnapshot`, and might block object cleanup until then. 3. > 0: the snapshot will automatically be cleaned up when now() > snapshot_hybrid_time + retention_duration_hours. 4. 0: explicitly forbidden.
optional bool imported = 9
Whether this is an imported snapshot (part of a restore). Default is false to maintain historical behavior when deciding whether to block object cleanup.
Used in: , , ,
UNKNOWN = 0
CREATING = 1
COMPLETE = 2
DELETING = 3
DELETED = 4
FAILED = 5
CANCELLED = 6
RESTORING = 7
RESTORED = 8
message
catalog_entity_info.proto:656Used in:
optional bytes id = 1
optional State state = 2
message
catalog_entity_info.proto:60The on-disk entry in the sys.catalog table ("metadata" column) for tables entries.
required bytes name = 1
Table name
optional TableType table_type = 10
Table type
optional bytes namespace_id = 11
The table namespace ID.
optional bytes namespace_name = 30
The table namespace name.
required uint32 version = 2
sequence-id for the table metadata. Used on tablet-report to avoid sending "alter-table" notifications.
required schema = 3
Newest table schema (every TS will eventually have it).
optional fully_applied_schema = 4
Last table schema that is guaranteed to have reached every TS, though not necessarily the newest schema. This is the schema provided to the user on client->GetSchema(tableName).
optional partition_schema = 9
The table's partitioning schema.
optional uint32 partition_list_version = 28
The table's partitions version. Incremented each time partitions change.
optional int32 next_column_id = 8
The next column ID to assign to newly added columns in this table. This prevents column ID reuse.
optional replication_info = 5
Replication information for this table.
optional SysTablesEntryPB.State state = 6
Debug state for the table.
optional bytes state_msg = 7
repeated indexes = 12
TODO(neil) OLDER INDEXes will always have the deprecated fields. To remove the old format, we first need to come up with a way to convert existing catalog content to new format. Secondary indexes of the table.
optional bytes indexed_table_id = 13
For index table: [to be deprecated and replaced by "index_info"]
Indexed table id of this index.
optional bool is_local_index = 14
Whether this is a local index.
optional bool is_unique_index = 15
Whether this is a unique index.
optional index_info = 22
For index table: information about this index.
optional bool is_pg_shared_table = 16
For Postgres:
Is this a shared table?
optional uint32 wal_retention_secs = 24
optional bool colocated = 25
True if the table is colocated (including tablegroups, excluding YSQL system tables).
optional bytes parent_table_id = 40
If the table is colocated and is not the parent table of the colocated tablet, contains the table id of the parent table.
optional bool is_matview = 37
For materialized views:
True if the table is a materialized view.
optional bytes pg_table_id = 36
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 fully_applied_schema_version = 23
repeated fully_applied_indexes = 26
optional fully_applied_index_info = 27
optional bool updates_only_index_permissions = 31
During an alter table, which involves no schema change but only updating a permission, is it sometimes acceptable for a client's request (which is prepared with the current schema) to be accepted by a tserver which is still running the previous version. This is typically set during alters that are caused due to index permissions being changed, when the table is backfilled.
repeated backfill_jobs = 32
Keeps track of in-progress backfill jobs. As of Apr 2021, we only have at most one outstanding backfill job, but this restriction may be removed later on. Hence repeated.
optional SysTablesEntryPB.HideState hide_state = 33
optional bytes transaction_table_tablespace_id = 34
Tablespace ID for use with transaction tables only. Normal YSQL tables do not set this field, and tablespace information for such tables are instead fetched by scanning the pg catalog.
optional fixed64 hide_hybrid_time = 35
Time when the table was hidden.
repeated ysql_ddl_txn_verifier_state = 38
State that indicates that this table is being changed by a YSQL transaction. This repeated field contains only a single element as of now. When we support DDL + Savepoints, we will have one element for every savepoint modifying this table in this field.
optional transaction = 29
YSQL transaction that is currently modifying this table state. The changes being performed by it are detailed in 'ysql_ddl_txn_state' above.
repeated StatefulServiceKind hosted_stateful_services = 39
optional fixed64 last_full_compaction_request_time = 41
Time when an admin compaction was last requested. Raw representation of a HybridTime.
optional xcluster_table_info = 42
Used in:
VISIBLE = 0
HIDING = 1
HIDDEN = 2
Used in: ,
UNKNOWN = 0
PREPARING = 1
RUNNING = 2
ALTERING = 3
DELETING = 4
DELETED = 5
message
catalog_entity_info.proto:186Used in:
optional bytes xcluster_source_table_id = 1
Set by DDL Replication to link the table to the original table in the source cluster. Cleared after table creation completes.
repeated xcluster_colocated_old_schema_packings = 2
Stores a list of old schema packings for automatic mode xCluster target colocated tables. These tables are processed before being created and require a source->target packed schema mapping. To handle this, we store processed schemas and insert them as old_schema_packings when the table is created. This allows us to have schema versions to use for the mapping that persists before and after the table is created. This is cleaned up after the table is created.
optional fixed64 xcluster_backfill_hybrid_time = 3
If set, use this time for the index backfill time.
message
catalog_entity_info.proto:986optional int64 instance_seqno = 1
The instance_seqno of a tserver is chosen at process start and is constant throughout the process lifetime. It must be monotonically increased across process restarts for a given UUID.
optional SysTabletServerEntryPB.State state = 2
optional registration = 3
Contains ip addresses, ports, cloud info, and placement_uuid.
optional resources = 5
The resources (cpu & memory) available at the tserver. Used by the tablet limits machinery.
optional bool persisted = 6
If true, this entry has been written to the sys catalog. Because the flag that enables writing these entries to the sys catalog is a runtime flag, this field is used to force tservers which registered in memory before persistence was enabled to re-register and have their entry persisted.
optional version_info = 9
Used in:
UNSPECIFIED = 0
Proto best practices are to include a sentinel as the first enum value. See https://protobuf.dev/programming-guides/dos-donts/#unspecified-enum
LIVE = 1
A heartbeat from the TServer has been ACK'd recently.
UNRESPONSIVE = 2
No heartbeat from the TServer has been ACK'd within at least tserver_unresponsive_timeout_ms.
REPLACED = 3
Another tserver which started more recently has registered with a conflicting address. Heartbeats from this TServer will be ignored until it restarts with a greater instance_seqno. This is currently used to deal with TServers rebooted after a disk wipe. In this case the new TServer process generates a new UUID and is recognized as a new TServer by the master leader. The old TServer entry is put into this state when the new TServer process registers.
REMOVED = 4
The tserver has been removed from the cluster. This state is not persisted to raft, instead the entry is deleted. This state signals to code that holds on to a shared_ptr<TSDescriptor> that the object representing the tablet server is stale and should not be used.
message
catalog_entity_info.proto:209The on-disk entry in the sys.catalog table ("metadata" column) for tablets entries.
optional bytes OBSOLETE_start_key = 1
DEPRECATED. Replaced by 'partition'.
optional bytes OBSOLETE_end_key = 2
optional partition = 7
Tablet partition.
optional committed_consensus_state = 3
The latest committed consensus configuration reported to the Master.
optional SysTabletsEntryPB.State state = 4
Debug state for the tablet.
optional bytes state_msg = 5
required bytes table_id = 6
The table id for the tablet.
repeated bytes table_ids = 8
Table ids for all the tables on this tablet.
optional bool colocated = 9
True if the tablet is colocated.
optional bytes DEPRECATED_backfilled_until = 10
Replaced by the map below.
optional uint64 split_depth = 11
For tablets that are results of splitting we set this to split parent split_depth + 1.
optional bytes split_parent_tablet_id = 13
map<string, bytes> backfilled_until = 12
If the tablet is in the backfilling state, this is used to keep track of how far along backfill has completed. Key corresponds to the table_id for the index table. Value is encoded as the DocKey for the next row to be backfilled.
repeated bytes split_tablet_ids = 14
Tablet IDs for the children of this tablet after splitting. It is possible for a tablet to temporarily exist in this field but not be registered as part of the table or the catalog manager's tablet map.
optional fixed64 hide_hybrid_time = 16
Time when tablet was hidden.
repeated bytes retained_by_snapshot_schedules = 17
If tablet was hidden instead of deleting, here we keep list of schedule ids that prevented actual deletion.
optional bool hosted_tables_mapped_by_parent_id = 18
Describes the persisted mapping scheme for colocated tablets. If set, the table_ids field of this tablet is empty and child tables on this tablet have their parent_table_id field filled. The table_id field of all tablets is filled with the parent table id. So the list of tables hosted on this tablet is computed at load time by finding all child tables of the parent table of this tablet.
optional bool created_by_clone = 19
Whether this tablet was created by DB cloning. If true, we should not try to send CreateTablet requests for this tablet (it should be created by tservers applying the clone op).
Used in:
UNKNOWN = 999
PREPARING = 0
CREATING = 1
RUNNING = 2
REPLACED = 3
DELETED = 4
message
catalog_entity_info.proto:527Metadata about the current state of transaction tables.
Used in:
optional uint64 version = 1
Transaction status tables version. Every time a transaction table is added or has its placement changed, this version gets incremented.
message
catalog_entity_info.proto:361The data part of a SysRowEntry in the sys.catalog table for a User Defined Type.
optional string namespace_id = 1
optional string name = 2
repeated string field_names = 3
repeated field_types = 4
message
catalog_entity_info.proto:825The data part of a SysRowEntry in the sys.catalog table for a universe replication record.
optional SysUniverseReplicationBootstrapEntryPB.State state = 1
optional SysUniverseReplicationBootstrapEntryPB.State failed_on = 2
There's different cleanup tasks depending on which state the flow failed on, and so we store this on failure so that we can cleanup properly.
optional string replication_group_id = 3
repeated producer_master_addresses = 4
map<string, string> table_bootstrap_ids = 5
producer table ID -> producer CDC stream ID map.
optional bytes old_snapshot_id = 6
In the xCluster native bootstrap flow, during the ImportSnapshot step the consumer universe actually creates its own snapshot with a unique ID. In this case, old_snapshot_id is the producer snapshot ID and new_snapshot_id is the consumer snapshot ID.
optional bytes new_snapshot_id = 7
optional bytes restoration_id = 8
optional new_snapshot_objects = 9
Keeps track of newly created objects in case we need to cleanup on failure.
optional bool transactional = 10
Set when consistent transactions are enabled for a replication group.
[default = false]
optional int64 leader_term = 11
According to https://phorge.dev.yugabyte.com/D24796, async tasks that require epoch should retrieve it from the context that initiated the work. These values store the epoch values passed from the initial RPC call to SetupNamespaceReplicationWithBootstrap.
optional int32 pitr_count = 12
message
catalog_entity_info.proto:873The following PBs are used to represent the newly created objects during CatalogManager::ImportSnapshotMeta. Specifically, these are all the required fields used in CatalogManager::DeleteNewSnapshotObjects. We store these PBs in case we need to cleanup on failure.
Used in: , ,
optional string old_id = 1
optional string new_id = 2
message
catalog_entity_info.proto:889Used in:
optional ids = 1
optional YQLDatabase db_type = 2
optional bool existing = 3
message
catalog_entity_info.proto:895Used in:
repeated tables = 1
repeated ud_types = 2
repeated namespaces = 3
Used in: ,
INITIALIZING = 0
Setting up replication.
BOOTSTRAP_PRODUCER = 1
Bootstrapping CDC streams on producer universe.
CREATE_PRODUCER_SNAPSHOT = 2
Creating snapshot on producer universe.
IMPORT_SNAPSHOT = 3
ImportSnapshotMeta on consumer universe.
CREATE_CONSUMER_SNAPSHOT = 4
CreateSnapshot on consumer universe, marking it as imported. This is the same logic that occurs in the yb-admin import_snapshot command.
TRANSFER_SNAPSHOT = 5
Downloading snapshot files from producer to consumer.
RESTORE_SNAPSHOT = 6
Restore snapshot on consumer universe.
SETUP_REPLICATION = 7
Call SetupUniverseReplication on consumer universe.
DONE = 8
Bootstrap is complete.
FAILED = 9
Bootstrap failed on some task.
DELETED = 10
Deleted.
DELETED_ERROR = 11
Error while cleaning up state of deleted entry. This indicates that universe replication has been deleted but there is still some uncleaned up state - for example, there may be left over CDC streams.
DELETING = 12
Unfinished Delete
message
catalog_entity_info.proto:878Used in:
optional ids = 1
optional TableType table_type = 2
optional bytes indexed_table_id = 3
Indexed table id of this index.
message
catalog_entity_info.proto:884Used in:
optional ids = 1
optional bool existing = 2
message
catalog_entity_info.proto:744The data part of a SysRowEntry in the sys.catalog table for a universe replication record.
Used in:
optional string replication_group_id = 1
repeated producer_master_addresses = 2
repeated string tables = 3
producer table IDs.
optional SysUniverseReplicationEntryPB.State state = 4
map<string, string> validated_tables = 5
producer table ID -> consumer table ID map.
map<string, string> table_streams = 6
producer table ID -> producer CDC stream ID map.
optional bool transactional = 11
Set when consistent transactions are enabled for a replication group.
[default = false]
optional uint32 validated_local_auto_flags_config_version = 12
optional db_scoped_info = 13
message
catalog_entity_info.proto:795DB Scoped repication.
Used in:
optional bool automatic_ddl_mode = 1
[default = false]
repeated namespace_infos = 13
map<string, > target_namespace_infos = 2
Target namespace id -> TargetNamespaceInfoPB.
message
catalog_entity_info.proto:804Used in:
repeated old_schema_packings = 1
message
catalog_entity_info.proto:798Used in:
required string consumer_namespace_id = 1
required string producer_namespace_id = 2
message
catalog_entity_info.proto:807Used in:
map<uint32, > colocated_historical_schema_packings = 1
Colocation id to historical schema packings mapping.
Used in:
INITIALIZING = 0
Setting up replication.
VALIDATED = 1
Validated table schemas.
ACTIVE = 2
Active.
FAILED = 3
Failed. Setting up universe replication consists of a sequence of steps like validating schemas, creating CDC streams, starting subscribers. If any of these fail, we set the universe replication state to FAILED.
DISABLED = 6
Disabled.
DELETED = 4
Deleted.
DELETED_ERROR = 5
Error while cleaning up state of deleted entry. This indicates that universe replication has been deleted but there is still some uncleaned up state - for example, there may be left over CDC streams.
DELETING = 7
Unfinished Delete
message
catalog_entity_info.proto:444Used in:
optional uint32 version = 1
optional xcluster_producer_registry = 2
map<string, > xcluster_info_per_namespace = 3
Local NamespaceId -> xCluster info for that namespace.
message
catalog_entity_info.proto:935map<string, > namespace_infos = 1
Namespace Id -> NamespaceInfoPB
optional target_universe_info = 2
optional SysXClusterOutboundReplicationGroupEntryPB.State state = 3
optional bool automatic_ddl_mode = 4
[default = false]
message
catalog_entity_info.proto:936Used in:
required NamespaceInfoPB.State state = 1
map<string, > table_infos = 2
Table id -> TableInfoPB
optional bool initial_bootstrap_required = 3
[default = false]
optional error_status = 4
Set when state is FAILED
Used in:
CHECKPOINTING = 0
READY = 1
FAILED = 2
message
catalog_entity_info.proto:944Used in:
optional bytes stream_id = 1
optional bool is_checkpointing = 2
[default = false]
optional bool is_part_of_initial_bootstrap = 3
Was this stream checkpointed as part of the initial bootstrap, or was it added later by a newly created table?
Used in:
READY = 0
DELETED = 1
message
catalog_entity_info.proto:962Used in:
required bytes universe_uuid = 1
required TargetUniverseInfoPB.State state = 2
optional error_status = 3
Set when status is FAILED
enum SysXClusterOutboundReplicationGroupEntryPB.TargetUniverseInfoPB.State
catalog_entity_info.proto:965Used in:
CREATING_REPLICATION_GROUP = 0
FAILED = 1
REPLICATING = 2
message
catalog_entity_info.proto:507Metadata about the YSQL catalog (current only version).
Used in:
optional uint64 version = 1
YSQL catalog version. Every time the catalog tables are changed (i.e. by DDL statements) this version gets incremented.
optional bool initdb_done = 2
This is true if the master ran initdb and it finished, succesfully or not.
optional string initdb_error = 5
If this is set, initdb has failed.
optional ysql_major_catalog_upgrade_info = 7
optional bool transactional_sys_catalog_enabled = 6
true if transactional system catalogs have been enabled on this cluster. This means all YSQL system catalog tables have been made transactional, both in their schema and in the tablet metadata.
message
master_heartbeat.proto:343Used in:
map<string, > xcluster_info_per_namespace = 1
Local NamespaceId -> xCluster info for that namespace.
message
master_client.proto:33Info about a single tablet server, returned to the client as part of the GetTabletLocations response. This can be used on the client to update the local cache of where each TS UUID is located. In the future we may also want to transmit software version info, load info, topology, etc.
Used in:
required bytes permanent_uuid = 1
repeated private_rpc_addresses = 2
repeated broadcast_addresses = 5
optional cloud_info = 3
optional bytes placement_uuid = 4
message
master_heartbeat.proto:155Used in:
required registration = 1
required tserver_instance = 2
message
master_types.proto:204Sent by the TS when it first heartbeats with a master. This sends the master all of the necessary information about the current instance of the TS.
Used in: , , ,
optional common = 1
optional resources = 3
Resources available at the tserver.
optional version_info = 4
message
master_heartbeat.proto:165Used in:
optional bytes id = 1
16 bytes for UUID.
optional fixed64 complete_time_ht = 2
message
master_heartbeat.proto:160Used in:
optional bytes id = 1
optional fixed64 last_snapshot_hybrid_time = 2
message
master_heartbeat.proto:171Used in:
repeated schedules = 1
optional fixed64 last_restorations_update_ht = 2
Last restorations update hybrid time.
repeated restorations = 3
Restorations info.
message
master_heartbeat.proto:33Common information sent with every request from the tablet server to the master.
Used in:
required ts_instance = 1
The instance of the tablet server sending the heartbeat.
message
master_types.proto:216Used in: ,
optional int64 total_sst_file_size = 1
optional int64 total_ram_usage = 2
optional double read_ops_per_sec = 3
optional double write_ops_per_sec = 4
optional int64 uncompressed_sst_file_size = 5
optional uint64 uptime_seconds = 6
optional uint64 num_sst_files = 7
repeated path_metrics = 8
optional bool disable_tablet_split_if_default_ttl = 9
message
master_types.proto:225Used in:
required bytes path_id = 1
Device path provided by user in --fs_data_dirs
optional uint64 used_space = 2
optional uint64 total_space = 3
message
master_types.proto:184Used in: , , , , , , , , , , , , , , , , , , , , ,
optional bytes table_id = 1
The table ID to fetch info.
optional string table_name = 2
The table name to fetch info.
optional namespace = 3
The table namespace (if empty - using default namespace).
message
master_backup.proto:209Used in:
repeated tables = 1
message
master_ddl.proto:29Used in: ,
optional bytes id = 1
The tablegroup ID to fetch info.
optional string name = 2
The tablegroup name to fetch info.
optional bytes namespace_id = 3
The namespace that the tablegroup is in
message
master_heartbeat.proto:101Used in:
required bytes tablet_id = 1
optional uint64 sst_file_size = 2
optional uint64 wal_file_size = 3
optional uint64 uncompressed_sst_file_size = 4
optional bool may_have_orphaned_post_split_data = 5
message
master_heartbeat.proto:95required bytes tablet_id = 1
optional bytes OBSOLETE_split_partition_key = 2
optional bytes OBSOLETE_split_encoded_key = 3
message
master_heartbeat.proto:109Used in:
required bytes tablet_id = 1
optional consensus.LeaderLeaseStatus leader_lease_status = 2
optional fixed64 ht_lease_expiration = 3
message
master_client.proto:48Used in: , ,
required bytes tablet_id = 1
optional bytes start_key = 2
DEPRECATED.
optional bytes end_key = 3
optional partition = 6
repeated replicas = 4
required bool stale = 5
true if the tablet was running but no tablet server has reported it yet. The set of replicas will be the last one that was hosting the tablet. This should happen on Master restart when the request is issued before the TS has the time to notify the Master about the tablets that is hosting.
optional bytes table_id = 7
repeated bytes table_ids = 8
Table ids for all the tables on this tablet.
optional uint64 split_depth = 9
See SysTabletsEntryPB for fields with the same name.
optional bytes split_parent_tablet_id = 12
repeated bytes split_tablet_ids = 13
optional int32 expected_live_replicas = 10
Number of expected live replicas.
optional int32 expected_read_replicas = 11
Number of expected read replicas.
optional bool is_deleted = 14
Whether or not this tablet has been deleted.
optional int64 raft_config_opid_index = 15
OpId of Committed Raft Config sent back to a tablet server when it requests a meta- -cache refresh. This OpId helps the tablet server determine if its meta-cache entry is stale by comparing this against its current raft_config_opid_index
message
master_client.proto:49Used in:
required ts_info = 1
required PeerRole role = 2
optional consensus.PeerMemberType member_type = 3
optional tablet.RaftGroupStatePB state = 4
message
master_admin.proto:80Used in:
optional bytes ts_id = 1
optional bytes tablet_id = 2
optional fixed64 last_full_compaction_time = 3
Raw representation of a HybridTime.
optional tablet.FullCompactionState full_compaction_state = 4
message
master_heartbeat.proto:64Sent by the tablet server to report the set of tablets hosted by that TS.
Used in:
required bool is_incremental = 1
If false, then this is a full report, and any prior information about tablets hosted by this server should be dropped.
repeated updated_tablets = 2
Tablets for which to update information. If 'is_incremental' is false, then this is the full set of tablets on the server, and any tablets which the master is aware of but not listed in this protobuf should be assumed to have been removed from this server.
repeated bytes removed_tablet_ids = 3
Tablet IDs which the tablet server has removed and should no longer be considered hosted here. This will always be empty in a non-incremental report.
required int32 sequence_number = 4
Every time the TS generates a tablet report, it creates a sequence number. This can be useful in debugging, and also determining which changes have not yet been reported to the master. The first tablet report (non-incremental) is sequence number 0.
optional int32 remaining_tablet_count = 5
Number of tablets that could not be included in this heartbeat. If 0, then all tablets have been reported to the master.
optional int32 full_report_seq_no = 6
When we send full report via multiple RPCs, this field will contain sequence_number of the first RPC.
message
master_heartbeat.proto:149Sent by the Master in response to the TS tablet report (part of the heartbeats)
Used in:
repeated tablets = 1
optional bool processing_truncated = 2
Returns true if the tablet report had to be truncated because master ran out of time.
message
master_backup.proto:88Used in:
optional bytes id = 1
optional SysSnapshotEntryPB.State state = 2
message
master_ddl.proto:40Used in: ,
optional bytes type_id = 1
The table ID to fetch info.
optional string type_name = 2
The table name to fetch info.
optional namespace = 3
The table namespace (if empty - using default namespace).
message
master_ddl.proto:51Used in: ,
optional bytes id = 1
optional string name = 2
repeated string field_names = 3
repeated field_types = 4
optional namespace = 5
message
master_replication.proto:172Used in:
optional bytes stream_id = 1
optional entry = 2
message
master_replication.proto:476Metadata regarding replication status of a stream set up on a tablet.
Used in:
required bytes stream_id = 1
required bytes tablet_id = 2
Used in:
SYS_CATALOG_INSERT = 1
SYS_CATALOG_UPDATE = 2
SYS_CATALOG_DELETE = 3
message
master_heartbeat.proto:127Used in:
required bytes replication_group_id = 1
ReplicationGroupId type represented in bytes.
repeated table_status = 2
message
master_heartbeat.proto:116Used in:
required bytes producer_tablet_id = 1
required int64 consumer_term = 2
required ReplicationErrorPb error = 3
message
master_heartbeat.proto:122Used in:
required bytes consumer_table_id = 1
repeated stream_tablet_status = 2
Used in:
NONE = 1
DDL_QUEUE = 2
message
catalog_entity_info.proto:818map<string, fixed64> safe_time_map = 1
Map[Local NamespaceId]: xCluster safe read HybridTime
message
master_types.proto:235Used in:
optional bool is_live = 1
optional uint64 lease_epoch = 2
message
master_heartbeat.proto:184This matches a row in pg_yb_invalidation_messages table, which has a composite primary key of (db_oid, current_version). For each pair of (db_oid, current_version), there is a list of invalidation messages. The table pg_yb_invalidation_messages also has a message time column that is used to delete old messages from pg_yb_invalidation_messages, but it is not needed by tserver so it is skipped here.
Used in:
optional uint32 db_oid = 1
optional uint64 current_version = 2
optional bytes message_list = 3
Serialized/encoded message list related to PG catalog cache invalidation.
message
catalog_entity_info.proto:49Used in: ,
optional bool contains_create_table_op = 1
optional bool contains_alter_table_op = 2
optional bool contains_drop_table_op = 3
optional previous_schema = 4
optional string previous_table_name = 5
message
catalog_entity_info.proto:482Used in:
optional YsqlMajorCatalogUpgradeInfoPB.State state = 1
optional previous_error = 2
This is set when the state is FAILED.
optional uint32 catalog_version = 3
Set to the current version at time of new universe creation. Updated after the ysql major catalog upgrade is complete. This field is introduced in version 15. So universes that are upgraded will have the default value of 11 (the previous version).
optional bool previous_version_catalog_cleanup_required = 4
[default = false]
Used in:
INVALID = 0
DONE = 1
FAILED = 2
PERFORMING_INIT_DB = 3
PERFORMING_PG_UPGRADE = 4
MONITORING = 5
PERFORMING_ROLLBACK = 6
Used in:
YSQL_MAJOR_CATALOG_UPGRADE_UNINITIALIZED = 0
YSQL_MAJOR_CATALOG_UPGRADE_DONE = 1
YSQL_MAJOR_CATALOG_UPGRADE_PENDING = 2
YSQL_MAJOR_CATALOG_UPGRADE_IN_PROGRESS = 3
YSQL_MAJOR_CATALOG_UPGRADE_PENDING_FINALIZE_OR_ROLLBACK = 4
YSQL_MAJOR_CATALOG_UPGRADE_ROLLBACK_IN_PROGRESS = 5
YSQL_MAJOR_CATALOG_UPGRADE_PENDING_ROLLBACK = 6