Skip to content

Commit a50bc09

Browse files
authored
impl(spanner): remove deprecated ClientOptions (googleapis#15849)
* impl(spanner): remove deprecated ClientOptions
1 parent 344198f commit a50bc09

10 files changed

Lines changed: 42 additions & 189 deletions
-456 Bytes
Binary file not shown.

doc/v3-migration-guide.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,6 +263,48 @@ guide:
263263
### Spanner
264264

265265
<details>
266+
<summary>Removed <code>spanner::ClientOptions</code> class</summary>
267+
268+
The `spanner::ClientOptions` class has been removed. Use
269+
`google::cloud::Options` instead to set the following as needed:
270+
271+
- `spanner::QueryOptimizerVersionOption`
272+
- `spanner::QueryOptimizerStatisticsPackageOption`
273+
- `spanner::RequestPriorityOption`
274+
- `spanner::RequestTagOption`
275+
276+
**Before:**
277+
278+
```cpp
279+
#include "google/cloud/spanner/client.h"
280+
281+
// ...
282+
283+
namespace spanner = ::google::cloud::spanner;
284+
auto client_options = spanner::ClientOptions().set_query_options(
285+
spanner::QueryOptions().set_optimizer_version("1"));
286+
287+
auto client = spanner::Client(connection, client_options);
288+
```
289+
290+
**After:**
291+
292+
```cpp
293+
#include "google/cloud/spanner/client.h"
294+
#include "google/cloud/spanner/options.h"
295+
296+
// ...
297+
298+
namespace spanner = ::google::cloud::spanner;
299+
auto options = google::cloud::Options{}.set<spanner::QueryOptimizerVersionOption>("1");
300+
301+
auto client = spanner::Client(connection, options);
302+
```
303+
304+
</details>
305+
306+
<details>
307+
266308
<summary>Removed <code>admin/retry_traits.h</code> file</summary>
267309

268310
The library no longer exposes `google/cloud/spanner/admin/retry_traits.h` header

google/cloud/spanner/CMakeLists.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,6 @@ add_library(
9696
bytes.h
9797
client.cc
9898
client.h
99-
client_options.h
10099
commit_options.cc
101100
commit_options.h
102101
commit_result.h
@@ -455,7 +454,6 @@ function (spanner_client_define_tests)
455454
# cmake-format: sort
456455
backup_test.cc
457456
bytes_test.cc
458-
client_options_test.cc
459457
client_test.cc
460458
commit_options_test.cc
461459
connection_options_test.cc

google/cloud/spanner/client.h

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@
1616
#define GOOGLE_CLOUD_CPP_GOOGLE_CLOUD_SPANNER_CLIENT_H
1717

1818
#include "google/cloud/spanner/batch_dml_result.h"
19-
#include "google/cloud/spanner/client_options.h"
2019
#include "google/cloud/spanner/commit_options.h"
2120
#include "google/cloud/spanner/commit_result.h"
2221
#include "google/cloud/spanner/connection.h"
@@ -717,15 +716,6 @@ class Client {
717716
StatusOr<PartitionedDmlResult> ExecutePartitionedDml(SqlStatement statement,
718717
Options opts = {});
719718

720-
///@{
721-
/// @name Backwards compatibility for ClientOptions.
722-
explicit Client(std::shared_ptr<Connection> conn, ClientOptions const& opts)
723-
: Client(std::move(conn), Options(opts)) {}
724-
explicit Client(std::shared_ptr<Connection> conn,
725-
std::initializer_list<internal::NonConstructible>)
726-
: Client(std::move(conn)) {}
727-
///@}
728-
729719
///@{
730720
/// @name Backwards compatibility for ReadOptions.
731721
/**

google/cloud/spanner/client_options.cc

Whitespace-only changes.

google/cloud/spanner/client_options.h

Lines changed: 0 additions & 82 deletions
This file was deleted.

google/cloud/spanner/client_options_test.cc

Lines changed: 0 additions & 73 deletions
This file was deleted.

google/cloud/spanner/client_test.cc

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1313,26 +1313,6 @@ TEST(ClientTest, UsesConnectionOptions) {
13131313
EXPECT_STATUS_OK(rollback);
13141314
}
13151315

1316-
TEST(ClientTest, UsesClientOptions) {
1317-
auto conn = std::make_shared<MockConnection>();
1318-
auto txn = MakeReadWriteTransaction();
1319-
1320-
EXPECT_CALL(*conn, options).WillOnce([] {
1321-
return Options{}.set<StringOption>("connection");
1322-
});
1323-
EXPECT_CALL(*conn, Rollback)
1324-
.WillOnce([txn](Connection::RollbackParams const& params) {
1325-
auto const& options = internal::CurrentOptions();
1326-
EXPECT_THAT(options.get<StringOption>(), Eq("client"));
1327-
EXPECT_THAT(params.transaction, Eq(txn));
1328-
return Status();
1329-
});
1330-
1331-
Client client(conn, Options{}.set<StringOption>("client"));
1332-
auto rollback = client.Rollback(txn, Options{});
1333-
EXPECT_STATUS_OK(rollback);
1334-
}
1335-
13361316
TEST(ClientTest, UsesOperationOptions) {
13371317
auto conn = std::make_shared<MockConnection>();
13381318
auto txn = MakeReadWriteTransaction();

google/cloud/spanner/google_cloud_cpp_spanner.bzl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,6 @@ google_cloud_cpp_spanner_hdrs = [
5050
"batch_dml_result.h",
5151
"bytes.h",
5252
"client.h",
53-
"client_options.h",
5453
"commit_options.h",
5554
"commit_result.h",
5655
"connection.h",

google/cloud/spanner/spanner_client_unit_tests.bzl

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
spanner_client_unit_tests = [
2020
"backup_test.cc",
2121
"bytes_test.cc",
22-
"client_options_test.cc",
2322
"client_test.cc",
2423
"commit_options_test.cc",
2524
"connection_options_test.cc",

0 commit comments

Comments
 (0)