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_SQL_AVAILABLE_DATABASE_VERSIONS_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlAvailableDatabaseVersionsServiceConnection().
GOOGLE_CLOUD_CPP_SQL_BACKUP_RUNS_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlBackupRunsServiceConnection().
GOOGLE_CLOUD_CPP_SQL_CONNECT_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlConnectServiceConnection().
GOOGLE_CLOUD_CPP_SQL_DATABASES_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlDatabasesServiceConnection().
GOOGLE_CLOUD_CPP_SQL_EVENTS_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlEventsServiceConnection().
GOOGLE_CLOUD_CPP_SQL_FLAGS_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlFlagsServiceConnection().
GOOGLE_CLOUD_CPP_SQL_IAM_POLICIES_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlIamPoliciesServiceConnection().
GOOGLE_CLOUD_CPP_SQL_INSTANCES_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlInstancesServiceConnection().
GOOGLE_CLOUD_CPP_SQL_INSTANCE_NAMES_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlInstanceNamesServiceConnection().
GOOGLE_CLOUD_CPP_SQL_OPERATIONS_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlOperationsServiceConnection().
GOOGLE_CLOUD_CPP_SQL_REGIONS_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlRegionsServiceConnection().
GOOGLE_CLOUD_CPP_SQL_SSL_CERTS_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlSslCertsServiceConnection().
GOOGLE_CLOUD_CPP_SQL_TIERS_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlTiersServiceConnection().
GOOGLE_CLOUD_CPP_SQL_USERS_SERVICE_ENDPOINT=... overrides the EndpointOption (which defaults to "sqladmin.googleapis.com") used by MakeSqlUsersServiceConnection().
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::LoggingComponentsOptionGOOGLE_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::GrpcTracingOptionsOptionGOOGLE_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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-14 UTC."],[[["\u003cp\u003eThis document details environment variables and configuration options for the Google Cloud C++ SQL library, with versioning ranging from 2.11.0 to the release candidate 2.37.0-rc.\u003c/p\u003e\n"],["\u003cp\u003eThe library supports overriding default endpoints for various SQL services, such as database versions, backup runs, and IAM policies, using specific environment variables.\u003c/p\u003e\n"],["\u003cp\u003eYou can enable detailed tracing for gRPC calls using \u003ccode\u003eGOOGLE_CLOUD_CPP_ENABLE_TRACING=rpc\u003c/code\u003e, and you can adjust the behavior of this tracing with \u003ccode\u003eGOOGLE_CLOUD_CPP_TRACING_OPTIONS\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eLogging within the library is controlled by \u003ccode\u003eGOOGLE_CLOUD_CPP_ENABLE_CLOG\u003c/code\u003e, which allows you to direct the logs to the console once enabled.\u003c/p\u003e\n"],["\u003cp\u003eWhile \u003ccode\u003eGOOGLE_CLOUD_PROJECT\u003c/code\u003e is used in examples and tests, it does not influence the behavior of the library itself.\u003c/p\u003e\n"]]],[],null,["Version 2.31.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/sql/latest/sql-env)\n- [2.41.0](/cpp/docs/reference/sql/2.41.0/sql-env)\n- [2.40.0](/cpp/docs/reference/sql/2.40.0/sql-env)\n- [2.39.0](/cpp/docs/reference/sql/2.39.0/sql-env)\n- [2.38.0](/cpp/docs/reference/sql/2.38.0/sql-env)\n- [2.37.0](/cpp/docs/reference/sql/2.37.0/sql-env)\n- [2.36.0](/cpp/docs/reference/sql/2.36.0/sql-env)\n- [2.35.0](/cpp/docs/reference/sql/2.35.0/sql-env)\n- [2.34.0](/cpp/docs/reference/sql/2.34.0/sql-env)\n- [2.33.0](/cpp/docs/reference/sql/2.33.0/sql-env)\n- [2.32.0](/cpp/docs/reference/sql/2.32.0/sql-env)\n- [2.31.0](/cpp/docs/reference/sql/2.31.0/sql-env)\n- [2.30.0](/cpp/docs/reference/sql/2.30.0/sql-env)\n- [2.29.0](/cpp/docs/reference/sql/2.29.0/sql-env)\n- [2.28.0](/cpp/docs/reference/sql/2.28.0/sql-env)\n- [2.27.0](/cpp/docs/reference/sql/2.27.0/sql-env)\n- [2.26.0](/cpp/docs/reference/sql/2.26.0/sql-env)\n- [2.25.1](/cpp/docs/reference/sql/2.25.1/sql-env)\n- [2.24.0](/cpp/docs/reference/sql/2.24.0/sql-env)\n- [2.23.0](/cpp/docs/reference/sql/2.23.0/sql-env)\n- [2.22.1](/cpp/docs/reference/sql/2.22.1/sql-env)\n- [2.21.0](/cpp/docs/reference/sql/2.21.0/sql-env)\n- [2.20.0](/cpp/docs/reference/sql/2.20.0/sql-env)\n- [2.19.0](/cpp/docs/reference/sql/2.19.0/sql-env)\n- [2.18.0](/cpp/docs/reference/sql/2.18.0/sql-env)\n- [2.17.0](/cpp/docs/reference/sql/2.17.0/sql-env)\n- [2.16.0](/cpp/docs/reference/sql/2.16.0/sql-env)\n- [2.15.1](/cpp/docs/reference/sql/2.15.1/sql-env)\n- [2.14.0](/cpp/docs/reference/sql/2.14.0/sql-env)\n- [2.13.0](/cpp/docs/reference/sql/2.13.0/sql-env)\n- [2.12.0](/cpp/docs/reference/sql/2.12.0/sql-env)\n- [2.11.0](/cpp/docs/reference/sql/2.11.0/sql-env) \n\nEnvironment Variables\n=====================\n\nA 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.\n\nEndpoint Overrides\n------------------\n\n- `GOOGLE_CLOUD_CPP_SQL_AVAILABLE_DATABASE_VERSIONS_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlAvailableDatabaseVersionsServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_SQL_BACKUP_RUNS_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlBackupRunsServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_SQL_CONNECT_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlConnectServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_SQL_DATABASES_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlDatabasesServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_SQL_EVENTS_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlEventsServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_SQL_FLAGS_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlFlagsServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_SQL_IAM_POLICIES_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlIamPoliciesServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_SQL_INSTANCES_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlInstancesServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_SQL_INSTANCE_NAMES_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlInstanceNamesServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_SQL_OPERATIONS_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlOperationsServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_SQL_REGIONS_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlRegionsServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_SQL_SSL_CERTS_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlSslCertsServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_SQL_TIERS_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlTiersServiceConnection()`.\n- `GOOGLE_CLOUD_CPP_SQL_USERS_SERVICE_ENDPOINT=...` overrides the `EndpointOption` (which defaults to \"sqladmin.googleapis.com\") used by `MakeSqlUsersServiceConnection()`.\n\n###### See Also\n\n[`google::cloud::EndpointOption`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1EndpointOption.html)\n\nLogging\n-------\n\n`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.\n\n###### See Also\n\n[`google::cloud::LoggingComponentsOption`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1LoggingComponentsOption.html)`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.\n\n###### See Also\n\n[`google::cloud::GrpcTracingOptionsOption`](https://cloud.google.com/cpp/docs/reference/common/latest/structgoogle_1_1cloud_1_1GrpcTracingOptionsOption.html)`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.\n\n###### See Also\n\n[`google::cloud::LogBackend`](https://cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1LogBackend.html)\n\n###### See Also\n\n[`google::cloud::LogSink`](https://cloud.google.com/cpp/docs/reference/common/latest/classgoogle_1_1cloud_1_1LogSink.html)\n\nSetting the Default Project\n---------------------------\n\n`GOOGLE_CLOUD_PROJECT=...`: is used in examples and integration tests to configure the GCP project. This has no effect in the library."]]
