package yb.docdb

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: KeyValueWriteBatchPB

• optional bytes transaction_id = 1

• optional SubtxnSetPB aborted_subtransactions = 3

• optional fixed64 commit_hybrid_time = 2

• optional bytes filter_start_key = 4

  Defaults to empty string, which is the full key range.

• optional bytes filter_end_key = 5

• optional bytes key = 1

  Apply should be continued from this key in reverse index.

• optional uint32 write_id = 2

  Write id for first continued record.

• optional fixed64 commit_ht = 3

  Transaction commit hybrid time.

• optional OpIdPB apply_op_id = 5

  Transaction apply op id.

• optional SubtxnSetPB aborted = 4

  Set of aborted subtransactions.

• optional OpIdPB op_id = 1

• optional fixed64 hybrid_time = 2

• optional fixed64 primary_cutoff_ht = 3

  History cutoff of all the tables of this tablet. On the master, this field is used for the sys catalog table. For cotables (i.e. ysql system tables) for which the cotables_history_cutoff field is used. On tservers, this field is used for everything i.e. both colocated and non colocated tables and the cotables_history_cutoff field is invalid.

• optional fixed64 hybrid_time_filter = 4

  Filter applies to all the entries of the sst file. Only set for the largest frontier.

• optional fixed64 max_value_level_ttl_expiration_time = 5

• repeated TableSchemaVersionPB table_schema_version = 6

• repeated PerDbFilterPB db_oid_to_ht_filter = 7

  Used only for sys catalog tablet during PITR restores to selectively restore some databases. Only set for the largest frontier.

• optional fixed64 cotables_cutoff_ht = 8

  Set only on the master for cotables.

• optional bool backfill_done = 9

• optional bytes backfill_key = 10

Used in: KeyValueWriteBatchPB, LockPairPB

• optional bytes key = 1

• optional bytes value = 2

• optional fixed64 external_hybrid_time = 3

A set of key/value pairs to be written into RocksDB.

Used in: tablet.WritePB, tserver.WriteRequestPB

• repeated KeyValuePairPB write_pairs = 1

• optional TransactionMetadataPB transaction = 2

• optional SubTransactionMetadataPB subtransaction = 8

• optional bool DEPRECATED_may_have_metadata = 3

• repeated KeyValuePairPB read_pairs = 5

  Used by serializable isolation transactions and row locking statements to store read intents. In case of read-modify-write operation both read_pairs and write_pairs could present.

• optional RowMarkType row_mark_type = 6

  Even though there can be multiple write_pairs we have only one row_mark_type/ wait_policy since currently we don't batch read RPCs from YSQL (which are the only ones that can set these 2 fields). And hence, only a singular value is sufficient.

• optional WaitPolicy wait_policy = 10

  wait_policy is used only for explicit row-locking to identify 3 possibilities: WAIT_BLOCK, WAIT_SKIP, or WAIT_ERROR. See WaitPolicy for detailed information. If this request has read_pairs but row_mark_type is not set, then wait_policy should not be set. Such a situation can occur when read intents are to be written as part of SERIALIZABLE isolation level.

• repeated ApplyExternalTransactionPB apply_external_transactions = 7

• optional int64 ttl = 9

• repeated TableSchemaVersionPB table_schema_version = 11

  Table schema version used by this write batch. We could have writes to multiple cotables in a single write batch.

• repeated LockPairPB lock_pairs = 13

  Advisory locks.

• optional bytes background_transaction_id = 14

  Used to prevent conflicts between session-level and transaction-level advisory locks within the same session. - For session-level advisory lock requests: background_transaction_id points to the in-progress DocDB transaction, if any. - For transaction-level advisory lock requests: background_transaction_id points to the session-level transaction, if exists.

• optional string background_txn_status_tablet = 16

• optional uint64 pg_session_req_version = 15

  Only relevant when the write op was launched for a session advisory lock request. Used by the wait-queue to resume deadlocked requests.

• optional bytes delete_vector_ids = 17

Used in: KeyValueWriteBatchPB

• optional KeyValuePairPB lock = 1

• optional dockv.DocdbLockMode mode = 2

• optional bool is_lock = 3

  lock or unlock.

This message is currently only being used for table level locks, which is protected under a test gflag that is disabled by default. The message shouldn't be re-used for production code.

Used in: master.AcquireObjectLocksGlobalRequestPB, tserver.AcquireObjectLockRequestPB

• optional uint64 database_oid = 1

• optional uint64 object_oid = 2

• optional TableLockType lock_type = 3

Used in: ConsensusFrontierPB

• optional uint32 db_oid = 1

• optional fixed64 ht_filter = 2

Used in: ConsensusFrontierPB, KeyValueWriteBatchPB

• optional bytes table_id = 1

• optional uint32 schema_version = 2