An idiomatic C++ client library for theAlloyDB API. AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance.
AlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.
While this library isGA, please note that the Google Cloud C++ client libraries donotfollowSemantic Versioning.
Quickstart
The following shows the code that you'll run in thegoogle/cloud/alloydb/quickstart/directory, which should give you a taste of the AlloyDB API C++ client library API.
#include "google/cloud/alloydb/v1/alloy_db_admin_client.h"
#include "google/cloud/location.h"
#include <iostream>
int main(int argc, char* argv[]) try {
if (argc != 2) {
std::cerr << "Usage: " << argv[0] << " project-id\n";
return 1;
}
auto const location = google::cloud::Location(argv[1], "-");
namespace alloydb = ::google::cloud::alloydb_v1;
auto client =
alloydb::AlloyDBAdminClient(alloydb::MakeAlloyDBAdminConnection());
for (auto c : client.ListClusters(location.FullName())) {
if (!c) throw std::move(c).status();
std::cout << c->DebugString() << "\n";
}
return 0;
} catch (google::cloud::Status const& status) {
std::cerr << "google::cloud::Status thrown: " << status << "\n";
return 1;
}
Main classes
The main class in this library isalloydb_v1::AlloyDBAdminClient. All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mockalloydb_v1::AlloyDBAdminClientwhen testing your application.
More Information
Error Handling- describes how the library reports errors.
[[["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-09-04 UTC."],[[["\u003cp\u003eThis webpage provides documentation for the AlloyDB API C++ client library, which is a Google Cloud service offering an open-source compatible database.\u003c/p\u003e\n"],["\u003cp\u003eThe AlloyDB API is GA but does not follow semantic versioning, offering a powerful database service that is faster than standard PostgreSQL for transactional and analytical workloads.\u003c/p\u003e\n"],["\u003cp\u003eThe main class for interacting with the AlloyDB API is \u003ccode\u003ealloydb_v1::AlloyDBAdminClient\u003c/code\u003e, with RPCs exposed as member functions.\u003c/p\u003e\n"],["\u003cp\u003eThe documentation includes a quickstart example and information on error handling, overriding default settings, and using environment variables to configure the library.\u003c/p\u003e\n"],["\u003cp\u003eThe latest release candidate version available is 2.37.0-rc, and multiple versions of the documentation are available, ranging from 2.11.0 up to 2.36.0.\u003c/p\u003e\n"]]],[],null,["Version 2.23.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/alloydb/latest)\n- [2.41.0](/cpp/docs/reference/alloydb/2.41.0)\n- [2.40.0](/cpp/docs/reference/alloydb/2.40.0)\n- [2.39.0](/cpp/docs/reference/alloydb/2.39.0)\n- [2.38.0](/cpp/docs/reference/alloydb/2.38.0)\n- [2.37.0](/cpp/docs/reference/alloydb/2.37.0)\n- [2.36.0](/cpp/docs/reference/alloydb/2.36.0)\n- [2.35.0](/cpp/docs/reference/alloydb/2.35.0)\n- [2.34.0](/cpp/docs/reference/alloydb/2.34.0)\n- [2.33.0](/cpp/docs/reference/alloydb/2.33.0)\n- [2.32.0](/cpp/docs/reference/alloydb/2.32.0)\n- [2.31.0](/cpp/docs/reference/alloydb/2.31.0)\n- [2.30.0](/cpp/docs/reference/alloydb/2.30.0)\n- [2.29.0](/cpp/docs/reference/alloydb/2.29.0)\n- [2.28.0](/cpp/docs/reference/alloydb/2.28.0)\n- [2.27.0](/cpp/docs/reference/alloydb/2.27.0)\n- [2.26.0](/cpp/docs/reference/alloydb/2.26.0)\n- [2.25.1](/cpp/docs/reference/alloydb/2.25.1)\n- [2.24.0](/cpp/docs/reference/alloydb/2.24.0)\n- [2.23.0](/cpp/docs/reference/alloydb/2.23.0)\n- [2.22.1](/cpp/docs/reference/alloydb/2.22.1)\n- [2.21.0](/cpp/docs/reference/alloydb/2.21.0)\n- [2.20.0](/cpp/docs/reference/alloydb/2.20.0)\n- [2.19.0](/cpp/docs/reference/alloydb/2.19.0)\n- [2.18.0](/cpp/docs/reference/alloydb/2.18.0)\n- [2.17.0](/cpp/docs/reference/alloydb/2.17.0)\n- [2.16.0](/cpp/docs/reference/alloydb/2.16.0)\n- [2.15.1](/cpp/docs/reference/alloydb/2.15.1)\n- [2.14.0](/cpp/docs/reference/alloydb/2.14.0)\n- [2.13.0](/cpp/docs/reference/alloydb/2.13.0)\n- [2.12.0](/cpp/docs/reference/alloydb/2.12.0)\n- [2.11.0](/cpp/docs/reference/alloydb/2.11.0) \n\nAlloyDB API C++ Client Library\n==============================\n\nAn idiomatic C++ client library for the [AlloyDB API](https://cloud.google.com/alloydb). AlloyDB for PostgreSQL is an open source-compatible database service that provides a powerful option for migrating, modernizing, or building commercial-grade applications. It offers full compatibility with standard PostgreSQL, and is more than 4x faster for transactional workloads and up to 100x faster for analytical queries than standard PostgreSQL in our performance tests. AlloyDB for PostgreSQL offers a 99.99 percent availability SLA inclusive of maintenance.\n\nAlloyDB is optimized for the most demanding use cases, allowing you to build new applications that require high transaction throughput, large database sizes, or multiple read resources; scale existing PostgreSQL workloads with no application changes; and modernize legacy proprietary databases.\n\nWhile this library is **GA** , please note that the Google Cloud C++ client libraries do **not** follow [Semantic Versioning](https://semver.org/).\n\n### Quickstart\n\nThe following shows the code that you'll run in the `google/cloud/alloydb/quickstart/` directory, which should give you a taste of the AlloyDB API C++ client library API. \n\n #include \"google/cloud/alloydb/v1/alloy_db_admin_client.h\"\n #include \"google/cloud/location.h\"\n #include \u003ciostream\u003e\n\n int main(int argc, char* argv[]) try {\n if (argc != 2) {\n std::cerr \u003c\u003c \"Usage: \" \u003c\u003c argv[0] \u003c\u003c \" project-id\\n\";\n return 1;\n }\n\n auto const location = google::cloud::Location(argv[1], \"-\");\n\n namespace alloydb = ::google::cloud::alloydb_v1;\n auto client =\n alloydb::AlloyDBAdminClient(alloydb::MakeAlloyDBAdminConnection());\n\n for (auto c : client.ListClusters(location.FullName())) {\n if (!c) throw std::move(c).status();\n std::cout \u003c\u003c c-\u003eDebugString() \u003c\u003c \"\\n\";\n }\n\n return 0;\n } catch (google::cloud::Status const& status) {\n std::cerr \u003c\u003c \"google::cloud::Status thrown: \" \u003c\u003c status \u003c\u003c \"\\n\";\n return 1;\n }\n\n### Main classes\n\nThe main class in this library is [`alloydb_v1::AlloyDBAdminClient`](/cpp/docs/reference/alloydb/2.23.0/classgoogle_1_1cloud_1_1alloydb__v1_1_1AlloyDBAdminClient). All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mock [`alloydb_v1::AlloyDBAdminClient`](/cpp/docs/reference/alloydb/2.23.0/classgoogle_1_1cloud_1_1alloydb__v1_1_1AlloyDBAdminClient) when testing your application.\n\n### More Information\n\n- [Error Handling](https://cloud.google.com/cpp/docs/reference/common/latest/common-error-handling.html) - describes how the library reports errors.\n- [How to Override the Default Endpoint](/cpp/docs/reference/alloydb/2.23.0/alloydb-override-endpoint) - describes how to override the default endpoint.\n- [How to Override the Authentication Credentials](/cpp/docs/reference/alloydb/2.23.0/alloydb-override-authentication) - describes how to change the authentication credentials used by the library.\n- [Override Retry, Backoff, and Idempotency Policies](/cpp/docs/reference/alloydb/2.23.0/alloydb-override-retry) - describes how to change the default retry policies.\n- [Environment Variables](/cpp/docs/reference/alloydb/2.23.0/alloydb-env) - describes environment variables that can configure the behavior of the library."]]