Library reference docs
Namespaces
google::cloud::spanner
Classes
Client
Functions
DatabaseAdminClient
Functions
LimitedErrorCountTransactionRerunPolicy
LimitedTimeTransactionRerunPolicy
Structs
Functions
Operators
google::cloud::spanner_admin
Classes
DatabaseAdminClient
Functions
DatabaseAdminConnectionIdempotencyPolicy
DatabaseAdminLimitedErrorCountRetryPolicy
DatabaseAdminLimitedTimeRetryPolicy
InstanceAdminClient
Functions
InstanceAdminConnectionIdempotencyPolicy
InstanceAdminLimitedErrorCountRetryPolicy
InstanceAdminLimitedTimeRetryPolicy
Structs
google::cloud::spanner_admin_mocks
Stay organized with collections Save and categorize content based on your preferences.
In general, the library returns a StatusOr if an error is possible. Some functions return objects that are not wrapped in a StatusOr<T>
but will themselves return a StatusOr<T>
to signal an error. For example, wrappers for asynchronous operations return future<StatusOr<T>>
.
Applications should check if the StatusOr<T>
contains a value before using it, much like how you might check that a pointer is not null before dereferencing it. Indeed, a StatusOr<T>
object can be used like a smart-pointer to T
, with the main difference being that when it does not hold a T
it will instead hold a Status
object with extra information about the error.
You can check that a StatusOr<T>
contains a value by calling the .ok()
method, or by using operator bool()
(like with other smart pointers). If there is no value, you can access the contained Status
object using the .status()
member. If there is a value, you may access it by dereferencing with operator*()
or operator->()
. As with all smart pointers, callers must first check that the StatusOr<T>
contains a value before dereferencing and accessing the contained value. Alternatively, callers may instead use the .value()
member function which is defined to throw a RuntimeStatusError if there is no value.
.value()
on a StatusOr<T>
that does not contain a value will terminate the program instead of throwing. Example
namespace spanner = ::google::cloud::spanner;
[](spanner::Client client) {
auto rows = client.Read("Albums", spanner::KeySet::All(), {"AlbumTitle"});
// The actual type of `row` is google::cloud::StatusOr<spanner::Row>, but
// we expect it'll most often be declared with auto like this.
for (auto const& row : rows) {
// Use `row` like a smart pointer; check it before dereferencing
if (!row) {
// `row` doesn't contain a value, so `.status()` will contain error info
std::cerr << row.status();
break;
}
// The actual type of `song` is google::cloud::StatusOr<std::string>, but
// again we expect it'll be commonly declared with auto as we show here.
auto song = row->get<std::string>("AlbumTitle");
// Instead of checking then dereferencing `song` as we did with `row`
// above, here we demonstrate use of the `.value()` member, which will
// return a reference to the contained `T` if it exists, otherwise it
// will throw an exception (or terminate if compiled without exceptions).
std::cout << "SongName: " << song.value() << "\n";
}
}
See Also
See Also
google::cloud::Status
the class used to describe errors.
google::cloud::future
for more details on the type returned by asynchronous operations.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["This page details error handling in the Spanner C++ library, primarily through the use of `StatusOr`, which can hold either a valid value or an error status."],["You can check if a `StatusOr` object contains a value using `.ok()` or `operator bool()`, and if it doesn't, the error information is accessible via the `.status()` member."],["Values within a `StatusOr` object can be accessed by dereferencing with `operator*()` or `operator-\u003e()` after confirming the presence of a value, or by using the `.value()` member function which throws an exception (or terminates the program if exceptions are disabled) if there is no value."],["The page also has links to various versions of the documentation, ranging from version 2.11.0 to version 2.37.0-rc."],["Asynchronous operations will return `future\u003cStatusOr\u003cT\u003e\u003e`, which can be used to handle errors within asynchronous tasks."]]],[]]
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4