Skip to content

Don't route to leader for single-use transactions #199

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

Closed
wants to merge 1 commit into from
Closed

Don't route to leader for single-use transactions #199

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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-spanner/lib/google/cloud/spanner/client.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -484,7 +484,7 @@ def execute_query sql, params: nil, types: nil, single_use: nil,
request_options = Convert.to_request_options request_options,
tag_type: :request_tag
single_use_tx = single_use_transaction single_use
route_to_leader = LARHeaders.execute_query true
route_to_leader = LARHeaders.execute_query !single_use_tx
Copy link
Member

@viacheslav-rostovtsev viacheslav-rostovtsev Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I am pretty sure it should be just false. If it's single-use (as specified by the caller) it's RO explicitly; if nil is specified by the caller, the default case for execute_streaming_sql is a "temporary read-only transaction with strong concurrency" https://github.com/googleapis/googleapis/blob/53af3b727f84acc34e31c23f3b6e7b8aa4b7e837/google/spanner/v1/spanner.proto#L716-L717

results = nil
@pool.with_session do |session|
results = session.execute_query \
Expand Down
51 changes: 50 additions & 1 deletion ...cloud-spanner/test/google/cloud/spanner/leader_aware_routing/client/execute_query_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@
mock.verify
end

it "sends header x-goog-spanner-route-to-leader when LAR is enabled" do
it "sends header x-goog-spanner-route-to-leader with true for queries without single_use when LAR is enabled" do
mock = Minitest::Mock.new
mock.expect :create_session, session_grpc do |request, gapic_options|
gapic_options.metadata["x-goog-spanner-route-to-leader"] == 'true'
Expand All @@ -75,4 +75,53 @@

mock.verify
end

it "sends header x-goog-spanner-route-to-leader with false for queries with single_use strong option when LAR is enabled" do
mock = Minitest::Mock.new
mock.expect :create_session, session_grpc do |request, gapic_options|
gapic_options.metadata["x-goog-spanner-route-to-leader"] == 'true'
end
mock.expect :execute_streaming_sql, results_enum do |request, gapic_options|
gapic_options.metadata["x-goog-spanner-route-to-leader"] == 'false'
Copy link
Contributor Author

@michaelherold michaelherold Nov 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: I'm unsure if "false" here or not emitting it would be better, but the helper specifies "false" so that's what I went with.

end
spanner.service.mocked_service = mock

spanner.service.enable_leader_aware_routing = true
results = client.execute_query "SELECT 1", single_use: { strong: true }

mock.verify
end

it "sends header x-goog-spanner-route-to-leader with false for queries with single_use staleness option when LAR is enabled" do
mock = Minitest::Mock.new
mock.expect :create_session, session_grpc do |request, gapic_options|
gapic_options.metadata["x-goog-spanner-route-to-leader"] == 'true'
end
mock.expect :execute_streaming_sql, results_enum do |request, gapic_options|
gapic_options.metadata["x-goog-spanner-route-to-leader"] == 'false'
end
spanner.service.mocked_service = mock

spanner.service.enable_leader_aware_routing = true
results = client.execute_query "SELECT 1", single_use: { staleness: 60 }

mock.verify
end

it "sends header x-goog-spanner-route-to-leader with false for queries with single_use timestamp option when LAR is enabled" do
mock = Minitest::Mock.new
mock.expect :create_session, session_grpc do |request, gapic_options|
gapic_options.metadata["x-goog-spanner-route-to-leader"] == 'true'
end
mock.expect :execute_streaming_sql, results_enum do |request, gapic_options|
gapic_options.metadata["x-goog-spanner-route-to-leader"] == 'false'
end
spanner.service.mocked_service = mock

spanner.service.enable_leader_aware_routing = true
timestamp = Time.now - 60
results = client.execute_query "SELECT 1", single_use: { timestamp: timestamp }

mock.verify
end
end
Loading