Showing content from https://cloud.google.com/cpp/docs/reference/spanner/2.39.0/spanner-env below:
C++ Client Libraries | Google Cloud
Skip to main content
- Overview
-
Library reference docs
- Cloud Spanner C++ Client Library
-
Namespaces
-
google::cloud::spanner
- Overview
-
Classes
-
Structs
-
ExcludeTransactionFromChangeStreamsOption
-
QueryOptimizerStatisticsPackageOption
-
SessionPoolActionOnExhaustionOption
-
SessionPoolKeepAliveIntervalOption
-
SessionPoolMaxIdleSessionsOption
-
SessionPoolMaxSessionsPerChannelOption
-
StreamingResumabilityBufferSizeOption
-
Functions
- ToInteger(Decimal< Mode > const &, int)
- MakeNumeric(std::string)
- MakeNumeric(double)
- MakeNumeric(T, int)
- MakePgNumeric(std::string)
- MakePgNumeric(double)
- MakePgNumeric(T, int)
- MakeBackup(std::string const &)
- MakeConnection(spanner::Database const &, Options)
- MakeConnection(Database const &, ConnectionOptions const &, SessionPoolOptions)
- MakeConnection(Database const &, ConnectionOptions const &, SessionPoolOptions, std::unique_ptr< RetryPolicy >, std::unique_ptr< BackoffPolicy >)
- MakeDatabase(std::string const &)
- MakeDatabaseAdminConnection(Options)
- MakeDatabaseAdminConnection(ConnectionOptions const &)
- MakeDatabaseAdminConnection(ConnectionOptions const &, std::unique_ptr< RetryPolicy >, std::unique_ptr< BackoffPolicy >, std::unique_ptr< PollingPolicy >)
- MakeInstance(std::string const &)
- MakeInstanceAdminConnection(Options)
- MakeInstanceAdminConnection(ConnectionOptions const &)
- MakeInstanceAdminConnection(ConnectionOptions const &, std::unique_ptr< RetryPolicy >, std::unique_ptr< BackoffPolicy >, std::unique_ptr< PollingPolicy >)
- MakeInterval(absl::string_view)
- JustifyDays(Interval)
- JustifyHours(Interval)
- JustifyInterval(Interval)
- MakeKey(Ts &&...)
- MakeKeyBoundClosed(Ts &&...)
- MakeKeyBoundOpen(Ts &&...)
- MakeInsertMutation(std::string, std::vector< std::string >, Ts &&...)
- MakeUpdateMutation(std::string, std::vector< std::string >, Ts &&...)
- MakeInsertOrUpdateMutation(std::string, std::vector< std::string >, Ts &&...)
- MakeReplaceMutation(std::string, std::vector< std::string >, Ts &&...)
- MakeDeleteMutation(std::string, KeySet)
- MakeDecimal(std::string)
- MakeDecimal(double)
- MakeDecimal(T, int)
- ToDouble(Decimal< Mode > const &)
- ToOptions(PartitionOptions const &)
- ToPartitionOptions(Options const &)
- SerializeQueryPartition(QueryPartition const &)
- DeserializeQueryPartition(std::string const &)
- ToOptions(ReadOptions const &)
- ToReadOptions(Options const &)
- SerializeReadPartition(ReadPartition const &)
- DeserializeReadPartition(std::string const &)
- MakeTestRow(std::vector< std::pair< std::string, Value > >)
- MakeTestRow(Ts &&...)
- StreamOf(RowRange &&)
- GetSingularRow(RowRange)
- MakeTimestamp(absl::Time)
- MakeTimestamp(protobuf::Timestamp const &)
- MakeTimestamp(sys_time< Duration > const &)
- MakeReadOnlyTransaction(Transaction::ReadOnlyOptions)
- MakeReadWriteTransaction(Transaction::ReadWriteOptions)
- MakeReadWriteTransaction(Transaction const &, Transaction::ReadWriteOptions)
- MakeUuid(absl::string_view)
- MakeNullValue()
- VersionMajor()
- VersionMinor()
- VersionPatch()
- VersionPreRelease()
- Version()
- VersionString()
-
Operators
- operator==(Json const &, Json const &)
- operator!=(Json const &, Json const &)
- operator==(JsonB const &, JsonB const &)
- operator!=(JsonB const &, JsonB const &)
- operator==(ReplicaSelection const &, ReplicaSelection const &)
- operator!=(ReplicaSelection const &, ReplicaSelection const &)
- operator<<(std::ostream &, Json const &)
- operator<<(std::ostream &, JsonB const &)
- operator<<(std::ostream &, PgOid const &)
- operator==(PartitionOptions const &, PartitionOptions const &)
- operator!=(PartitionOptions const &, PartitionOptions const &)
- operator==(ReadOptions const &, ReadOptions const &)
- operator!=(ReadOptions const &, ReadOptions const &)
-
google::cloud::spanner_admin
- Overview
-
Classes
-
DatabaseAdminClient
- Overview
-
Functions
- ListDatabases(std::string const &, Options)
- ListDatabases(google::spanner::admin::database::v1::ListDatabasesRequest, Options)
- CreateDatabase(std::string const &, std::string const &, Options)
- CreateDatabase(NoAwaitTag, std::string const &, std::string const &, Options)
- CreateDatabase(google::spanner::admin::database::v1::CreateDatabaseRequest const &, Options)
- CreateDatabase(NoAwaitTag, google::spanner::admin::database::v1::CreateDatabaseRequest const &, Options)
- CreateDatabase(google::longrunning::Operation const &, Options)
- GetDatabase(std::string const &, Options)
- GetDatabase(google::spanner::admin::database::v1::GetDatabaseRequest const &, Options)
- UpdateDatabase(google::spanner::admin::database::v1::Database const &, google::protobuf::FieldMask const &, Options)
- UpdateDatabase(NoAwaitTag, google::spanner::admin::database::v1::Database const &, google::protobuf::FieldMask const &, Options)
- UpdateDatabase(google::spanner::admin::database::v1::UpdateDatabaseRequest const &, Options)
- UpdateDatabase(NoAwaitTag, google::spanner::admin::database::v1::UpdateDatabaseRequest const &, Options)
- UpdateDatabase(google::longrunning::Operation const &, Options)
- UpdateDatabaseDdl(std::string const &, std::vector< std::string > const &, Options)
- UpdateDatabaseDdl(NoAwaitTag, std::string const &, std::vector< std::string > const &, Options)
- UpdateDatabaseDdl(google::spanner::admin::database::v1::UpdateDatabaseDdlRequest const &, Options)
- UpdateDatabaseDdl(NoAwaitTag, google::spanner::admin::database::v1::UpdateDatabaseDdlRequest const &, Options)
- UpdateDatabaseDdl(google::longrunning::Operation const &, Options)
- DropDatabase(std::string const &, Options)
- DropDatabase(google::spanner::admin::database::v1::DropDatabaseRequest const &, Options)
- GetDatabaseDdl(std::string const &, Options)
- GetDatabaseDdl(google::spanner::admin::database::v1::GetDatabaseDdlRequest const &, Options)
- SetIamPolicy(std::string const &, google::iam::v1::Policy const &, Options)
- SetIamPolicy(std::string const &, IamUpdater const &, Options)
- SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)
- GetIamPolicy(std::string const &, Options)
- GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)
- TestIamPermissions(std::string const &, std::vector< std::string > const &, Options)
- TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)
- CreateBackup(std::string const &, google::spanner::admin::database::v1::Backup const &, std::string const &, Options)
- CreateBackup(NoAwaitTag, std::string const &, google::spanner::admin::database::v1::Backup const &, std::string const &, Options)
- CreateBackup(google::spanner::admin::database::v1::CreateBackupRequest const &, Options)
- CreateBackup(NoAwaitTag, google::spanner::admin::database::v1::CreateBackupRequest const &, Options)
- CreateBackup(google::longrunning::Operation const &, Options)
- CopyBackup(std::string const &, std::string const &, std::string const &, google::protobuf::Timestamp const &, Options)
- CopyBackup(NoAwaitTag, std::string const &, std::string const &, std::string const &, google::protobuf::Timestamp const &, Options)
- CopyBackup(google::spanner::admin::database::v1::CopyBackupRequest const &, Options)
- CopyBackup(NoAwaitTag, google::spanner::admin::database::v1::CopyBackupRequest const &, Options)
- CopyBackup(google::longrunning::Operation const &, Options)
- GetBackup(std::string const &, Options)
- GetBackup(google::spanner::admin::database::v1::GetBackupRequest const &, Options)
- UpdateBackup(google::spanner::admin::database::v1::Backup const &, google::protobuf::FieldMask const &, Options)
- UpdateBackup(google::spanner::admin::database::v1::UpdateBackupRequest const &, Options)
- DeleteBackup(std::string const &, Options)
- DeleteBackup(google::spanner::admin::database::v1::DeleteBackupRequest const &, Options)
- ListBackups(std::string const &, Options)
- ListBackups(google::spanner::admin::database::v1::ListBackupsRequest, Options)
- RestoreDatabase(std::string const &, std::string const &, std::string const &, Options)
- RestoreDatabase(NoAwaitTag, std::string const &, std::string const &, std::string const &, Options)
- RestoreDatabase(google::spanner::admin::database::v1::RestoreDatabaseRequest const &, Options)
- RestoreDatabase(NoAwaitTag, google::spanner::admin::database::v1::RestoreDatabaseRequest const &, Options)
- RestoreDatabase(google::longrunning::Operation const &, Options)
- ListDatabaseOperations(std::string const &, Options)
- ListDatabaseOperations(google::spanner::admin::database::v1::ListDatabaseOperationsRequest, Options)
- ListBackupOperations(std::string const &, Options)
- ListBackupOperations(google::spanner::admin::database::v1::ListBackupOperationsRequest, Options)
- ListDatabaseRoles(std::string const &, Options)
- ListDatabaseRoles(google::spanner::admin::database::v1::ListDatabaseRolesRequest, Options)
- AddSplitPoints(std::string const &, std::vector< google::spanner::admin::database::v1::SplitPoints > const &, Options)
- AddSplitPoints(google::spanner::admin::database::v1::AddSplitPointsRequest const &, Options)
- CreateBackupSchedule(std::string const &, google::spanner::admin::database::v1::BackupSchedule const &, std::string const &, Options)
- CreateBackupSchedule(google::spanner::admin::database::v1::CreateBackupScheduleRequest const &, Options)
- GetBackupSchedule(std::string const &, Options)
- GetBackupSchedule(google::spanner::admin::database::v1::GetBackupScheduleRequest const &, Options)
- UpdateBackupSchedule(google::spanner::admin::database::v1::BackupSchedule const &, google::protobuf::FieldMask const &, Options)
- UpdateBackupSchedule(google::spanner::admin::database::v1::UpdateBackupScheduleRequest const &, Options)
- DeleteBackupSchedule(std::string const &, Options)
- DeleteBackupSchedule(google::spanner::admin::database::v1::DeleteBackupScheduleRequest const &, Options)
- ListBackupSchedules(std::string const &, Options)
- ListBackupSchedules(google::spanner::admin::database::v1::ListBackupSchedulesRequest, Options)
- ListOperations(std::string const &, std::string const &, Options)
- ListOperations(google::longrunning::ListOperationsRequest, Options)
- GetOperation(std::string const &, Options)
- GetOperation(google::longrunning::GetOperationRequest const &, Options)
- DeleteOperation(std::string const &, Options)
- DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
- CancelOperation(std::string const &, Options)
- CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
-
DatabaseAdminConnectionIdempotencyPolicy
-
DatabaseAdminLimitedErrorCountRetryPolicy
-
DatabaseAdminLimitedTimeRetryPolicy
-
InstanceAdminClient
- Overview
-
Functions
- ListInstanceConfigs(std::string const &, Options)
- ListInstanceConfigs(google::spanner::admin::instance::v1::ListInstanceConfigsRequest, Options)
- GetInstanceConfig(std::string const &, Options)
- GetInstanceConfig(google::spanner::admin::instance::v1::GetInstanceConfigRequest const &, Options)
- CreateInstanceConfig(std::string const &, google::spanner::admin::instance::v1::InstanceConfig const &, std::string const &, Options)
- CreateInstanceConfig(NoAwaitTag, std::string const &, google::spanner::admin::instance::v1::InstanceConfig const &, std::string const &, Options)
- CreateInstanceConfig(google::spanner::admin::instance::v1::CreateInstanceConfigRequest const &, Options)
- CreateInstanceConfig(NoAwaitTag, google::spanner::admin::instance::v1::CreateInstanceConfigRequest const &, Options)
- CreateInstanceConfig(google::longrunning::Operation const &, Options)
- UpdateInstanceConfig(google::spanner::admin::instance::v1::InstanceConfig const &, google::protobuf::FieldMask const &, Options)
- UpdateInstanceConfig(NoAwaitTag, google::spanner::admin::instance::v1::InstanceConfig const &, google::protobuf::FieldMask const &, Options)
- UpdateInstanceConfig(google::spanner::admin::instance::v1::UpdateInstanceConfigRequest const &, Options)
- UpdateInstanceConfig(NoAwaitTag, google::spanner::admin::instance::v1::UpdateInstanceConfigRequest const &, Options)
- UpdateInstanceConfig(google::longrunning::Operation const &, Options)
- DeleteInstanceConfig(std::string const &, Options)
- DeleteInstanceConfig(google::spanner::admin::instance::v1::DeleteInstanceConfigRequest const &, Options)
- ListInstanceConfigOperations(std::string const &, Options)
- ListInstanceConfigOperations(google::spanner::admin::instance::v1::ListInstanceConfigOperationsRequest, Options)
- ListInstances(std::string const &, Options)
- ListInstances(google::spanner::admin::instance::v1::ListInstancesRequest, Options)
- ListInstancePartitions(std::string const &, Options)
- ListInstancePartitions(google::spanner::admin::instance::v1::ListInstancePartitionsRequest, Options)
- GetInstance(std::string const &, Options)
- GetInstance(google::spanner::admin::instance::v1::GetInstanceRequest const &, Options)
- CreateInstance(std::string const &, std::string const &, google::spanner::admin::instance::v1::Instance const &, Options)
- CreateInstance(NoAwaitTag, std::string const &, std::string const &, google::spanner::admin::instance::v1::Instance const &, Options)
- CreateInstance(google::spanner::admin::instance::v1::CreateInstanceRequest const &, Options)
- CreateInstance(NoAwaitTag, google::spanner::admin::instance::v1::CreateInstanceRequest const &, Options)
- CreateInstance(google::longrunning::Operation const &, Options)
- UpdateInstance(google::spanner::admin::instance::v1::Instance const &, google::protobuf::FieldMask const &, Options)
- UpdateInstance(NoAwaitTag, google::spanner::admin::instance::v1::Instance const &, google::protobuf::FieldMask const &, Options)
- UpdateInstance(google::spanner::admin::instance::v1::UpdateInstanceRequest const &, Options)
- UpdateInstance(NoAwaitTag, google::spanner::admin::instance::v1::UpdateInstanceRequest const &, Options)
- UpdateInstance(google::longrunning::Operation const &, Options)
- DeleteInstance(std::string const &, Options)
- DeleteInstance(google::spanner::admin::instance::v1::DeleteInstanceRequest const &, Options)
- SetIamPolicy(std::string const &, google::iam::v1::Policy const &, Options)
- SetIamPolicy(std::string const &, IamUpdater const &, Options)
- SetIamPolicy(google::iam::v1::SetIamPolicyRequest const &, Options)
- GetIamPolicy(std::string const &, Options)
- GetIamPolicy(google::iam::v1::GetIamPolicyRequest const &, Options)
- TestIamPermissions(std::string const &, std::vector< std::string > const &, Options)
- TestIamPermissions(google::iam::v1::TestIamPermissionsRequest const &, Options)
- GetInstancePartition(std::string const &, Options)
- GetInstancePartition(google::spanner::admin::instance::v1::GetInstancePartitionRequest const &, Options)
- CreateInstancePartition(std::string const &, google::spanner::admin::instance::v1::InstancePartition const &, std::string const &, Options)
- CreateInstancePartition(NoAwaitTag, std::string const &, google::spanner::admin::instance::v1::InstancePartition const &, std::string const &, Options)
- CreateInstancePartition(google::spanner::admin::instance::v1::CreateInstancePartitionRequest const &, Options)
- CreateInstancePartition(NoAwaitTag, google::spanner::admin::instance::v1::CreateInstancePartitionRequest const &, Options)
- CreateInstancePartition(google::longrunning::Operation const &, Options)
- DeleteInstancePartition(std::string const &, Options)
- DeleteInstancePartition(google::spanner::admin::instance::v1::DeleteInstancePartitionRequest const &, Options)
- UpdateInstancePartition(google::spanner::admin::instance::v1::InstancePartition const &, google::protobuf::FieldMask const &, Options)
- UpdateInstancePartition(NoAwaitTag, google::spanner::admin::instance::v1::InstancePartition const &, google::protobuf::FieldMask const &, Options)
- UpdateInstancePartition(google::spanner::admin::instance::v1::UpdateInstancePartitionRequest const &, Options)
- UpdateInstancePartition(NoAwaitTag, google::spanner::admin::instance::v1::UpdateInstancePartitionRequest const &, Options)
- UpdateInstancePartition(google::longrunning::Operation const &, Options)
- ListInstancePartitionOperations(std::string const &, Options)
- ListInstancePartitionOperations(google::spanner::admin::instance::v1::ListInstancePartitionOperationsRequest, Options)
- MoveInstance(google::spanner::admin::instance::v1::MoveInstanceRequest const &, Options)
- MoveInstance(NoAwaitTag, google::spanner::admin::instance::v1::MoveInstanceRequest const &, Options)
- MoveInstance(google::longrunning::Operation const &, Options)
- ListOperations(std::string const &, std::string const &, Options)
- ListOperations(google::longrunning::ListOperationsRequest, Options)
- GetOperation(std::string const &, Options)
- GetOperation(google::longrunning::GetOperationRequest const &, Options)
- DeleteOperation(std::string const &, Options)
- DeleteOperation(google::longrunning::DeleteOperationRequest const &, Options)
- CancelOperation(std::string const &, Options)
- CancelOperation(google::longrunning::CancelOperationRequest const &, Options)
-
InstanceAdminConnectionIdempotencyPolicy
-
InstanceAdminLimitedErrorCountRetryPolicy
-
InstanceAdminLimitedTimeRetryPolicy
-
Structs
-
DatabaseAdminBackoffPolicyOption
-
DatabaseAdminConnectionIdempotencyPolicyOption
-
DatabaseAdminPollingPolicyOption
-
InstanceAdminBackoffPolicyOption
-
InstanceAdminConnectionIdempotencyPolicyOption
-
InstanceAdminPollingPolicyOption
-
google::cloud::spanner_admin_mocks
-
google::cloud::spanner_experimental
Stay organized with collections Save and categorize content based on your preferences.
Environment Variables
A number of environment variables can be used to configure the behavior of the library. There are also functions to configure this behavior in code. The environment variables are convenient when troubleshooting problems.
Endpoint Overrides
GOOGLE_CLOUD_CPP_SPANNER_DEFAULT_ENDPOINT=...
: changes the default endpoint (spanner.googleapis.com) for the library. Intended for testing only.
SPANNER_EMULATOR_HOST=host:port
: tells the library to connect to the specified emulator rather than the default endpoint. Intended for testing only.
See Also
google::cloud::EndpointOption
Default behaviors
SPANNER_OPTIMIZER_VERSION=n
: sets the default query optimizer version to use in Client::ExecuteQuery()
calls.
See Also
google::cloud::spanner::QueryOptimizerVersionOption
SPANNER_OPTIMIZER_STATISTICS_PACKAGE=...
: specifies a statistics package for the query optimizer to use when compiling a SQL query.
See Also
google::cloud::spanner::QueryOptimizerStatisticsPackageOption
Logging
GOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc
: turns on tracing for most gRPC calls. The library injects an additional Stub decorator that prints each gRPC request and response. Unless you have configured your own logging backend, you should also set GOOGLE_CLOUD_CPP_ENABLE_CLOG
to produce any output on the program's console.
See Also
google::cloud::LoggingComponentsOption
GOOGLE_CLOUD_CPP_TRACING_OPTIONS=...
: modifies the behavior of gRPC tracing, including whether messages will be output on multiple lines, or whether string/bytes fields will be truncated.
See Also
google::cloud::GrpcTracingOptionsOption
GOOGLE_CLOUD_CPP_ENABLE_CLOG=yes
: turns on logging in the library, basically the library always "logs" but the logging infrastructure has no backend to actually print anything until the application sets a backend or they set this environment variable.
See Also
google::cloud::LogBackend
See Also
google::cloud::LogSink
Other Environment Variables
GOOGLE_CLOUD_PROJECT=...
: is used in examples and integration tests to configure the GCP project. This has no effect in the library.
GOOGLE_CLOUD_CPP_SPANNER_TEST_INSTANCE_ID=...
is used in examples and integration tests to, well, configure the spanner instance. This has no effect in the library.
GOOGLE_CLOUD_CPP_SPANNER_TEST_SERVICE_ACCOUNT=...
: is used in examples and integration tests to set the service account for testing IAM operations. This has no effect in the library.
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."],[],[]]
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