Skip to content

feat: add Idempotency to Cloud Bigtable MutateRowsRequest API #30709

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
aandreassa merged 4 commits into from
Jul 22, 2025
Merged

feat: add Idempotency to Cloud Bigtable MutateRowsRequest API #30709

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2dd4e78
docs: Sync generated comments from the API Protos
gcf-owl-bot[bot] Jul 21, 2025
c56a8c9
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Jul 21, 2025
ad548c5
feat: add Idempotency to Cloud Bigtable MutateRowsRequest API
gcf-owl-bot[bot] Jul 22, 2025
99695de
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Jul 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion google-cloud-bigtable-v2/lib/google/bigtable/v2/bigtable_pb.rb
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions google-cloud-bigtable-v2/lib/google/bigtable/v2/bigtable_services_pb.rb
View file
Open in desktop

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

17 changes: 9 additions & 8 deletions google-cloud-bigtable-v2/lib/google/cloud/bigtable/v2/bigtable/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,8 +504,8 @@ def sample_row_keys request, options = nil
# are applied in order, meaning that earlier mutations can be masked by later
# ones. Must contain at least one entry and at most 100000.
# @param idempotency [::Google::Cloud::Bigtable::V2::Idempotency, ::Hash]
# Optional parameter for ensuring a MutateRow request is only applied once.
# Currently applicable only for certain aggregate types.
# If set consistently across retries, prevents this mutation from being
# double applied to aggregate column families within a 15m window.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::Bigtable::V2::MutateRowResponse]
Expand Down Expand Up @@ -960,7 +960,8 @@ def ping_and_warm request, options = nil
# @param rules [::Array<::Google::Cloud::Bigtable::V2::ReadModifyWriteRule, ::Hash>]
# Required. Rules specifying how the specified row's contents are to be
# transformed into writes. Entries are applied in order, meaning that earlier
# rules will affect the results of later ones.
# rules will affect the results of later ones. At least one entry must be
# specified, and there can be at most 100000 rules.
#
# @yield [response, operation] Access the result along with the RPC operation
# @yieldparam response [::Google::Cloud::Bigtable::V2::ReadModifyWriteRowResponse]
Expand Down Expand Up @@ -1035,10 +1036,10 @@ def read_modify_write_row request, options = nil
end

##
# NOTE: This API is intended to be used by Apache Beam BigtableIO.
# Returns the current list of partitions that make up the table's
# change stream. The union of partitions will cover the entire keyspace.
# Partitions can be read with `ReadChangeStream`.
# NOTE: This API is only intended to be used by Apache Beam BigtableIO.
#
# @overload generate_initial_change_stream_partitions(request, options = nil)
# Pass arguments to `generate_initial_change_stream_partitions` via a request object, either of type
Expand Down Expand Up @@ -1133,10 +1134,10 @@ def generate_initial_change_stream_partitions request, options = nil
end

##
# NOTE: This API is intended to be used by Apache Beam BigtableIO.
# Reads changes from a table's change stream. Changes will
# reflect both user-initiated mutations and mutations that are caused by
# garbage collection.
# NOTE: This API is only intended to be used by Apache Beam BigtableIO.
#
# @overload read_change_stream(request, options = nil)
# Pass arguments to `read_change_stream` via a request object, either of type
Expand Down Expand Up @@ -1177,10 +1178,10 @@ def generate_initial_change_stream_partitions request, options = nil
# the position. Tokens are delivered on the stream as part of `Heartbeat`
# and `CloseStream` messages.
#
# If a single token is provided, the token’s partition must exactly match
# the request’s partition. If multiple tokens are provided, as in the case
# If a single token is provided, the token's partition must exactly match
# the request's partition. If multiple tokens are provided, as in the case
# of a partition merge, the union of the token partitions must exactly
# cover the request’s partition. Otherwise, INVALID_ARGUMENT will be
# cover the request's partition. Otherwise, INVALID_ARGUMENT will be
# returned.
#
# Note: The following parameters are mutually exclusive: `continuation_tokens`, `start_time`. At most one of these parameters can be set. If more than one is set, only one will be used, and it is not defined which one.
Expand Down
75 changes: 34 additions & 41 deletions google-cloud-bigtable-v2/proto_docs/google/bigtable/v2/bigtable.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,25 +109,11 @@ module RequestStatsView
# key, allowing the client to skip that work on a retry.
# @!attribute [rw] request_stats
# @return [::Google::Cloud::Bigtable::V2::RequestStats]
# If requested, provide enhanced query performance statistics. The semantics
# dictate:
# * request_stats is empty on every (streamed) response, except
# * request_stats has non-empty information after all chunks have been
# streamed, where the ReadRowsResponse message only contains
# request_stats.
# * For example, if a read request would have returned an empty
# response instead a single ReadRowsResponse is streamed with empty
# chunks and request_stats filled.
#
# Visually, response messages will stream as follows:
# ... -> \\{chunks: [...]} -> \\{chunks: [], request_stats: \\{...}}
# \______________________/ \________________________________/
# Primary response Trailer of RequestStats info
#
# Or if the read did not return any values:
# \\{chunks: [], request_stats: \\{...}}
# \________________________________/
# Trailer of RequestStats info
# If requested, return enhanced query performance statistics. The field
# request_stats is empty in a streamed response unless the ReadRowsResponse
# message contains request_stats in the last message of the stream. Always
# returned when requested, even when the read request returns an empty
# response.
class ReadRowsResponse
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -280,8 +266,8 @@ class SampleRowKeysResponse
# ones. Must contain at least one entry and at most 100000.
# @!attribute [rw] idempotency
# @return [::Google::Cloud::Bigtable::V2::Idempotency]
# Optional parameter for ensuring a MutateRow request is only applied once.
# Currently applicable only for certain aggregate types.
# If set consistently across retries, prevents this mutation from being
# double applied to aggregate column families within a 15m window.
class MutateRowRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -332,6 +318,10 @@ class MutateRowsRequest
# Required. Changes to be atomically applied to the specified row.
# Mutations are applied in order, meaning that earlier mutations can be
# masked by later ones. You must specify at least one mutation.
# @!attribute [rw] idempotency
# @return [::Google::Cloud::Bigtable::V2::Idempotency]
# If set consistently across retries, prevents this mutation from being
# double applied to aggregate column families within a 15m window.
class Entry
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -385,7 +375,7 @@ class Entry
# target load should be 80. After adjusting, the client should ignore
# `factor` until another `period` has passed.
#
# The client can measure its load using any unit that's comparable over time
# The client can measure its load using any unit that's comparable over time.
# For example, QPS can be used as long as each request involves a similar
# amount of work.
class RateLimitInfo
Expand Down Expand Up @@ -499,7 +489,8 @@ class PingAndWarmResponse
# @return [::Array<::Google::Cloud::Bigtable::V2::ReadModifyWriteRule>]
# Required. Rules specifying how the specified row's contents are to be
# transformed into writes. Entries are applied in order, meaning that earlier
# rules will affect the results of later ones.
# rules will affect the results of later ones. At least one entry must be
# specified, and there can be at most 100000 rules.
class ReadModifyWriteRowRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -573,10 +564,10 @@ class GenerateInitialChangeStreamPartitionsResponse
# the position. Tokens are delivered on the stream as part of `Heartbeat`
# and `CloseStream` messages.
#
# If a single token is provided, the token’s partition must exactly match
# the request’s partition. If multiple tokens are provided, as in the case
# If a single token is provided, the token's partition must exactly match
# the request's partition. If multiple tokens are provided, as in the case
# of a partition merge, the union of the token partitions must exactly
# cover the request’s partition. Otherwise, INVALID_ARGUMENT will be
# cover the request's partition. Otherwise, INVALID_ARGUMENT will be
# returned.
#
# Note: The following fields are mutually exclusive: `continuation_tokens`, `start_time`. If a field in that set is populated, all other fields in the set will automatically be cleared.
Expand Down Expand Up @@ -696,8 +687,8 @@ class ChunkInfo
# An estimate of the commit timestamp that is usually lower than or equal
# to any timestamp for a record that will be delivered in the future on the
# stream. It is possible that, under particular circumstances that a future
# record has a timestamp is is lower than a previously seen timestamp. For
# an example usage see
# record has a timestamp that is lower than a previously seen timestamp.
# For an example usage see
# https://beam.apache.org/documentation/basics/#watermarks
class DataChange
include ::Google::Protobuf::MessageExts
Expand Down Expand Up @@ -731,8 +722,8 @@ module Type
# An estimate of the commit timestamp that is usually lower than or equal
# to any timestamp for a record that will be delivered in the future on the
# stream. It is possible that, under particular circumstances that a future
# record has a timestamp is is lower than a previously seen timestamp. For
# an example usage see
# record has a timestamp that is lower than a previously seen timestamp.
# For an example usage see
# https://beam.apache.org/documentation/basics/#watermarks
class Heartbeat
include ::Google::Protobuf::MessageExts
Expand All @@ -745,17 +736,19 @@ class Heartbeat
# If `continuation_tokens` & `new_partitions` are present, then a change in
# partitioning requires the client to open a new stream for each token to
# resume reading. Example:
# [B, D) ends
# |
# v
# new_partitions: [A, C) [C, E)
# continuation_tokens.partitions: [B,C) [C,D)
# ^---^ ^---^
# ^ ^
# | |
# | StreamContinuationToken 2
# |
# StreamContinuationToken 1
#
# [B, D) ends
# |
# v
# new_partitions: [A, C) [C, E)
# continuation_tokens.partitions: [B,C) [C,D)
# ^---^ ^---^
# ^ ^
# | |
# | StreamContinuationToken 2
# |
# StreamContinuationToken 1
#
# To read the new partition [A,C), supply the continuation tokens whose
# ranges cover the new partition, for example ContinuationToken[A,B) &
# ContinuationToken[B,C).
Expand Down
1 change: 1 addition & 0 deletions google-cloud-bigtable-v2/proto_docs/google/bigtable/v2/data.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,7 @@ class Cell
# @!attribute [rw] float_value
# @return [::Float]
# Represents a typed value transported as a floating point number.
# Does not support NaN or infinities.
#
# Note: The following fields are mutually exclusive: `float_value`, `raw_value`, `raw_timestamp_micros`, `bytes_value`, `string_value`, `int_value`, `bool_value`, `timestamp_value`, `date_value`, `array_value`. If a field in that set is populated, all other fields in the set will automatically be cleared.
# @!attribute [rw] timestamp_value
Expand Down
3 changes: 1 addition & 2 deletions google-cloud-bigtable-v2/proto_docs/google/bigtable/v2/request_stats.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,8 +88,7 @@ class FullReadStatsView

# RequestStats is the container for additional information pertaining to a
# single request, helpful for evaluating the performance of the sent request.
# Currently, there are the following supported methods:
# * google.bigtable.v2.ReadRows
# Currently, the following method is supported: google.bigtable.v2.ReadRows
# @!attribute [rw] full_read_stats_view
# @return [::Google::Cloud::Bigtable::V2::FullReadStatsView]
# Available with the ReadRowsRequest.RequestStatsView.REQUEST_STATS_FULL
Expand Down
3 changes: 0 additions & 3 deletions google-cloud-bigtable-v2/proto_docs/google/bigtable/v2/response_params.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,6 @@ module Cloud
module Bigtable
module V2
# Response metadata proto
# This is an experimental feature that will be used to get zone_id and
# cluster_id from response trailers to tag the metrics. This should not be
# used by customers directly
# @!attribute [rw] zone_id
# @return [::String]
# The cloud bigtable zone associated with the cluster.
Expand Down
Loading