doc(spanner): add `*Client` samples #10145

coryan · 2022-10-31T17:12:15Z

Add examples showing how to override the default endpoint and default authentication.

Fixes #10141 and fixes #10142

This change is

google-cloud-cpp-bot · 2022-10-31T17:14:09Z

Google Cloud Build Logs
For commit: bded4fb97a97d665e36be04ae360763253623620

Public Access Build Logs
Cloud Build Console (requires auth)
Kokoro Logs (requires auth)

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

codecov · 2022-10-31T17:26:18Z

Codecov Report

Base: 93.98% // Head: 93.97% // Decreases project coverage by -0.01% ⚠️

Coverage data is based on head (cc51bea) compared to base (a0d16ae).
Patch coverage: 70.21% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##             main   #10145      +/-   ##
==========================================
- Coverage   93.98%   93.97%   -0.02%     
==========================================
  Files        1525     1526       +1     
  Lines      140517   140564      +47     
==========================================
+ Hits       132065   132092      +27     
- Misses       8452     8472      +20

Impacted Files	Coverage Δ
google/cloud/spanner/samples/client_samples.cc	`70.21% <70.21%> (ø)`
google/cloud/internal/async_connection_ready.cc	`89.36% <0.00%> (-4.26%)`	⬇️
...e/cloud/pubsublite/internal/alarm_registry_impl.cc	`97.05% <0.00%> (-2.95%)`	⬇️
...cloud/pubsub/internal/subscription_session_test.cc	`97.98% <0.00%> (-0.84%)`	⬇️
google/cloud/storage/parallel_upload.cc	`98.28% <0.00%> (-0.35%)`	⬇️
...le/cloud/storage/internal/curl_download_request.cc	`89.63% <0.00%> (+0.33%)`	⬆️
google/cloud/pubsub/subscriber_connection_test.cc	`98.36% <0.00%> (+0.54%)`	⬆️
...integration_tests/schema_admin_integration_test.cc	`100.00% <0.00%> (+1.11%)`	⬆️

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

devbww

@ typo in description.

google/cloud/spanner/doc/spanner-main.dox

google-cloud-cpp-bot · 2022-10-31T18:53:30Z

Google Cloud Build Logs
For commit: a06a840fb56a616af625295774cc8b09352ab9e3

Public Access Build Logs
Cloud Build Console (requires auth)
Kokoro Logs (requires auth)

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

dbolduc · 2022-10-31T20:06:13Z

google/cloud/spanner/samples/client_samples.cc

+  (argv.at(0), argv.at(1), argv.at(2), argv.at(3));
+}
+
+void DatabaseAdminClientSetEndpoint(std::vector<std::string> const& argv) {


same comment about generated Admin APIs having generated samples:

google-cloud-cpp/google/cloud/spanner/admin/samples/database_admin_client_samples.cc

Lines 32 to 44 in 7ddabb9

void SetClientEndpoint(std::vector<std::string> const& argv) {

if (!argv.empty()) {

throw google::cloud::testing_util::Usage{"set-client-endpoint"};

}

//! [set-client-endpoint]

// This configuration is common with Private Google Access:

// https://cloud.google.com/vpc/docs/private-google-access

auto options = google::cloud::Options{}.set<google::cloud::EndpointOption>(

"private.googleapis.com");

auto client = google::cloud::spanner_admin::DatabaseAdminClient(

google::cloud::spanner_admin::MakeDatabaseAdminConnection(options));

//! [set-client-endpoint]

}

I would have expected these InstanceAdminClient and DatabaseAdminClient samples to have disappeared then.

Ooops, fixed now.

google-cloud-cpp-bot · 2022-10-31T20:55:21Z

Google Cloud Build Logs
For commit: 729ac105afc7d47ddb8cf5d9dc9d55fd9efff1d8

Public Access Build Logs
Cloud Build Console (requires auth)
Kokoro Logs (requires auth)

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

google-cloud-cpp-bot · 2022-11-01T12:48:32Z

Google Cloud Build Logs
For commit: 7d1fb566ba64cfec8b0e59f19940ff15f3aaf3a3

Public Access Build Logs
Cloud Build Console (requires auth)
Kokoro Logs (requires auth)

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

dbolduc · 2022-11-01T13:54:41Z

google/cloud/spanner/samples/client_samples.cc

+void ClientSetEndpoint(std::vector<std::string> const& argv) {
+  if (argv.size() != 3) {
+    throw google::cloud::testing_util::Usage{
+        "client-set-endpoint <project-id> <instance-id> <database-id>"};
+  }
+  //! [client-set-endpoint]


If you want to be an unreasonable stickler for consistency, you could rename this to SetClientEndpoint / [set-client-endpoint]...

Yeah ... if we have set-client-endpoint and with-service-account tags in both of the admin samples, then why not the same here?

dbolduc · 2022-11-01T13:55:16Z

google/cloud/spanner/samples/client_samples.cc

+  (argv.at(0), argv.at(1), argv.at(2));
+}
+
+void ClientWithServiceAccount(std::vector<std::string> const& argv) {


and this to WithServiceAccount / [with-service-account]

Add examples showing how to override the default endpoint and default authentication.

google-cloud-cpp-bot · 2022-11-01T14:22:20Z

Google Cloud Build Logs
For commit: cc51bea8049fc4042867908f5bf26d85ba5c5b59

Public Access Build Logs
Cloud Build Console (requires auth)
Kokoro Logs (requires auth)

ℹ️ NOTE: Kokoro logs are linked from "Details" below.

product-auto-label bot added api: spanner Issues related to the Spanner API. samples Issues that are directly related to samples. labels Oct 31, 2022

devbww reviewed Oct 31, 2022

View reviewed changes

google/cloud/spanner/doc/spanner-main.dox Outdated Show resolved Hide resolved

coryan marked this pull request as ready for review October 31, 2022 19:10

coryan requested a review from a team as a code owner October 31, 2022 19:10

dbolduc reviewed Oct 31, 2022

View reviewed changes

coryan force-pushed the doc-spanner-add-client-samples branch from a06a840 to 729ac10 Compare October 31, 2022 20:54

coryan force-pushed the doc-spanner-add-client-samples branch from 729ac10 to 7d1fb56 Compare November 1, 2022 12:47

dbolduc approved these changes Nov 1, 2022

View reviewed changes

coryan added 2 commits November 1, 2022 14:20

doc(spanner): add *Client samples

98b7d05

Add examples showing how to override the default endpoint and default authentication.

Address review comments

cc51bea

coryan force-pushed the doc-spanner-add-client-samples branch from 7d1fb56 to cc51bea Compare November 1, 2022 14:21

coryan enabled auto-merge (squash) November 1, 2022 14:21

devbww approved these changes Nov 1, 2022

View reviewed changes

coryan merged commit 4c9fc8d into googleapis:main Nov 1, 2022

coryan deleted the doc-spanner-add-client-samples branch November 1, 2022 15:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

doc(spanner): add `*Client` samples #10145

doc(spanner): add `*Client` samples #10145

coryan commented Oct 31, 2022 •

edited by dbolduc

Loading

google-cloud-cpp-bot commented Oct 31, 2022

codecov bot commented Oct 31, 2022 •

edited

Loading

devbww left a comment

google-cloud-cpp-bot commented Oct 31, 2022

dbolduc Oct 31, 2022 •

edited

Loading

coryan Oct 31, 2022

devbww Nov 1, 2022

coryan Nov 1, 2022

google-cloud-cpp-bot commented Oct 31, 2022

google-cloud-cpp-bot commented Nov 1, 2022

dbolduc Nov 1, 2022

devbww Nov 1, 2022

coryan Nov 1, 2022

dbolduc Nov 1, 2022

coryan Nov 1, 2022

google-cloud-cpp-bot commented Nov 1, 2022

	void SetClientEndpoint(std::vector<std::string> const& argv) {
	if (!argv.empty()) {
	throw google::cloud::testing_util::Usage{"set-client-endpoint"};
	}
	//! [set-client-endpoint]
	// This configuration is common with Private Google Access:
	// https://cloud.google.com/vpc/docs/private-google-access
	auto options = google::cloud::Options{}.set<google::cloud::EndpointOption>(
	"private.googleapis.com");
	auto client = google::cloud::spanner_admin::DatabaseAdminClient(
	google::cloud::spanner_admin::MakeDatabaseAdminConnection(options));
	//! [set-client-endpoint]
	}

doc(spanner): add *Client samples #10145

doc(spanner): add *Client samples #10145

Conversation

coryan commented Oct 31, 2022 • edited by dbolduc Loading

google-cloud-cpp-bot commented Oct 31, 2022

codecov bot commented Oct 31, 2022 • edited Loading

Codecov Report

devbww left a comment

Choose a reason for hiding this comment

google-cloud-cpp-bot commented Oct 31, 2022

dbolduc Oct 31, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

google-cloud-cpp-bot commented Oct 31, 2022

google-cloud-cpp-bot commented Nov 1, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

google-cloud-cpp-bot commented Nov 1, 2022

doc(spanner): add `*Client` samples #10145

doc(spanner): add `*Client` samples #10145

coryan commented Oct 31, 2022 •

edited by dbolduc

Loading

codecov bot commented Oct 31, 2022 •

edited

Loading

dbolduc Oct 31, 2022 •

edited

Loading