An idiomatic C++ client library for theDataform API.
Service to develop, version control, and operationalize SQL pipelines in BigQuery.
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/dataform/quickstart/directory, which should give you a taste of the Dataform API C++ client library API.
The main class in this library isdataform_v1::DataformClient. All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mockdataform_v1::DataformClientwhen 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."],[],[],null,["Version latestkeyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/dataform/latest)\n- [2.41.0](/cpp/docs/reference/dataform/2.41.0)\n- [2.40.0](/cpp/docs/reference/dataform/2.40.0)\n- [2.39.0](/cpp/docs/reference/dataform/2.39.0)\n- [2.38.0](/cpp/docs/reference/dataform/2.38.0) \n\nDataform API C++ Client Library\n===============================\n\nAn idiomatic C++ client library for the [Dataform API](https://cloud.google.com/dataform/docs).\n\nService to develop, version control, and operationalize SQL pipelines in BigQuery.\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/dataform/quickstart/` directory, which should give you a taste of the Dataform API C++ client library API. \n\n #include \"google/cloud/dataform/v1/dataform_client.h\"\n #include \"google/cloud/location.h\"\n #include \u003ciostream\u003e\n\n int main(int argc, char* argv[]) try {\n if (argc != 3) {\n std::cerr \u003c\u003c \"Usage: \" \u003c\u003c argv[0] \u003c\u003c \" project-id location-id\\n\";\n return 1;\n }\n\n auto const location = google::cloud::Location(argv[1], argv[2]);\n\n namespace dataform = ::google::cloud::dataform_v1;\n auto client = dataform::DataformClient(dataform::MakeDataformConnection());\n\n for (auto r : client.ListRepositories(location.FullName())) {\n if (!r) throw std::move(r).status();\n std::cout \u003c\u003c r-\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 [`dataform_v1::DataformClient`](/cpp/docs/reference/dataform/latest/classgoogle_1_1cloud_1_1dataform__v1_1_1DataformClient). All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mock [`dataform_v1::DataformClient`](/cpp/docs/reference/dataform/latest/classgoogle_1_1cloud_1_1dataform__v1_1_1DataformClient) 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/dataform/latest/dataform-override-endpoint) - describes how to override the default endpoint.\n- [How to Override the Authentication Credentials](/cpp/docs/reference/dataform/latest/dataform-override-authentication) - describes how to change the authentication credentials used by the library.\n- [Override Retry, Backoff, and Idempotency Policies](/cpp/docs/reference/dataform/latest/dataform-override-retry) - describes how to change the default retry policies.\n- [Environment Variables](/cpp/docs/reference/dataform/latest/dataform-env) - describes environment variables that can configure the behavior of the library."]]