Skip to content

Commit

Permalink
chore: Update TableReference protobuf documentation (#6350)
Browse files Browse the repository at this point in the history
This clarifies that `ticket` does not need to be an export ticket, and
that `batch_offset` will still work if it refers to an intermediate
operation which has been exported.
  • Loading branch information
devinrsmith authored Nov 8, 2024
1 parent f4b6a28 commit f1105da
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 4 deletions.
7 changes: 5 additions & 2 deletions go/internal/proto/table/table.pb.go

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -276,9 +276,13 @@ service TableService {

message TableReference {
oneof ref {
// an exported ticket
// A ticket to resolve to get the table. It's preferable to use export tickets in order to avoid races that are
// possible with tickets controlled by the server, but any ticket type will suffice as long as it resolves to a
// table.
Ticket ticket = 1;
// an offset into a BatchRequest -- used to reference a result that will not be exported

// An offset into a BatchRequest's ops field, used to reference an intermediate operation which may not have been
// exported. Only valid to set when used in the context of a BatchRequest.
sint32 batch_offset = 2;
}
}
Expand Down

0 comments on commit f1105da

Please sign in to comment.