Skip to content

impl(spanner): remove deprecated ClientOptions #15849

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

Open
mpeddada1 wants to merge 3 commits into
base: prepare-for-v3.0.0
Choose a base branch
from
+41 −185
Open

impl(spanner): remove deprecated ClientOptions #15849

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8f4fdbf
impl(spanner): remove deprecated ClientOptions
mpeddada1 Dec 29, 2025
db011bd
run check-api-pr;add doc
mpeddada1 Dec 29, 2025
363be8f
fix checkers
mpeddada1 Dec 29, 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
Binary file modified ci/abi-dumps/google_cloud_cpp_spanner.expected.abi.dump.gz
View file
Open in desktop
Binary file not shown.
41 changes: 41 additions & 0 deletions doc/v3-migration-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,4 +125,45 @@ auto limit = google::cloud::bigtable::RowReader::NO_ROWS_LIMIT;

### Spanner

<details>
<summary>Removed <code>spanner::ClientOptions</code> class</summary>

The `spanner::ClientOptions` class has been removed. Use
`google::cloud::Options` instead to set the following as needed:

- `spanner::QueryOptimizerVersionOption`
- `spanner::QueryOptimizerStatisticsPackageOption`
- `spanner::RequestPriorityOption`
- `spanner::RequestTagOption`

**Before:**

```cpp
#include "google/cloud/spanner/client.h"

// ...

namespace spanner = ::google::cloud::spanner;
auto client_options = spanner::ClientOptions().set_query_options(
spanner::QueryOptions().set_optimizer_version("1"));

auto client = spanner::Client(connection, client_options);
```

**After:**

```cpp
#include "google/cloud/spanner/client.h"
#include "google/cloud/spanner/options.h"

// ...

namespace spanner = ::google::cloud::spanner;
auto options = google::cloud::Options{}.set<spanner::QueryOptimizerVersionOption>("1");

auto client = spanner::Client(connection, options);
```

</details>

### Storage
2 changes: 0 additions & 2 deletions google/cloud/spanner/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,6 @@ add_library(
bytes.h
client.cc
client.h
client_options.h
commit_options.cc
commit_options.h
commit_result.h
Expand Down Expand Up @@ -456,7 +455,6 @@ function (spanner_client_define_tests)
# cmake-format: sort
backup_test.cc
bytes_test.cc
client_options_test.cc
client_test.cc
commit_options_test.cc
connection_options_test.cc
Expand Down
6 changes: 0 additions & 6 deletions google/cloud/spanner/client.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SPANNER_CLIENT_H

#include "google/cloud/spanner/batch_dml_result.h"
#include "google/cloud/spanner/client_options.h"
#include "google/cloud/spanner/commit_options.h"
#include "google/cloud/spanner/commit_result.h"
#include "google/cloud/spanner/connection.h"
Expand Down Expand Up @@ -717,14 +716,9 @@ class Client {
StatusOr<PartitionedDmlResult> ExecutePartitionedDml(SqlStatement statement,
Options opts = {});

///@{
/// @name Backwards compatibility for ClientOptions.
explicit Client(std::shared_ptr<Connection> conn, ClientOptions const& opts)
: Client(std::move(conn), Options(opts)) {}
explicit Client(std::shared_ptr<Connection> conn,
std::initializer_list<internal::NonConstructible>)
: Client(std::move(conn)) {}
Comment on lines 719 to 721
Copy link
Contributor

@devbww devbww Dec 30, 2025

Choose a reason for hiding this comment

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

This constructor is part of the ClientOptions backwards compatibility, and should be removed too.

///@}

///@{
/// @name Backwards compatibility for ReadOptions.
Expand Down
Empty file removed google/cloud/spanner/client_options.cc
View file
Open in desktop
Empty file.
82 changes: 0 additions & 82 deletions google/cloud/spanner/client_options.h
View file
Open in desktop

This file was deleted.

73 changes: 0 additions & 73 deletions google/cloud/spanner/client_options_test.cc
View file
Open in desktop

This file was deleted.

20 changes: 0 additions & 20 deletions google/cloud/spanner/client_test.cc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1313,26 +1313,6 @@ TEST(ClientTest, UsesConnectionOptions) {
EXPECT_STATUS_OK(rollback);
}

TEST(ClientTest, UsesClientOptions) {
auto conn = std::make_shared<MockConnection>();
auto txn = MakeReadWriteTransaction();

EXPECT_CALL(*conn, options).WillOnce([] {
return Options{}.set<StringOption>("connection");
});
EXPECT_CALL(*conn, Rollback)
.WillOnce([txn](Connection::RollbackParams const& params) {
auto const& options = internal::CurrentOptions();
EXPECT_THAT(options.get<StringOption>(), Eq("client"));
EXPECT_THAT(params.transaction, Eq(txn));
return Status();
});

Client client(conn, Options{}.set<StringOption>("client"));
auto rollback = client.Rollback(txn, Options{});
EXPECT_STATUS_OK(rollback);
}

TEST(ClientTest, UsesOperationOptions) {
auto conn = std::make_shared<MockConnection>();
auto txn = MakeReadWriteTransaction();
Expand Down
1 change: 0 additions & 1 deletion google/cloud/spanner/google_cloud_cpp_spanner.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ google_cloud_cpp_spanner_hdrs = [
"batch_dml_result.h",
"bytes.h",
"client.h",
"client_options.h",
"commit_options.h",
"commit_result.h",
"connection.h",
Expand Down
1 change: 0 additions & 1 deletion google/cloud/spanner/spanner_client_unit_tests.bzl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,6 @@
spanner_client_unit_tests = [
"backup_test.cc",
"bytes_test.cc",
"client_options_test.cc",
"client_test.cc",
"commit_options_test.cc",
"connection_options_test.cc",
Expand Down