# @google-cloud/dataform 中文文档

规范地址：https://npmcn.com/package/%40google-cloud/dataform/

版本：3\.6\.0
npm 元数据更新时间：2026-11-09T17:09:13.241Z
中文译文更新时间：2026-11-16T19:52:30.063Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40google-cloud/dataform
原文对照：https://npmcn.com/package/%40google-cloud/dataform/?lang=original
项目主页：https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-dataform
源码仓库：https://github.com/googleapis/google-cloud-node

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：8.2 MB，29 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=22
- 运行依赖：1 个
- 首次发布：2022-07-22T21:29:59.936Z
- 最新版本发布：2026-11-09T17:09:13.018Z
- 近 30 天下载量：410988（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：30（近 12 个月 12 个）

## 中文简介

节点的 API 客户端

## 安装

```sh
npm install @google-cloud/dataform
```

也可以使用：`pnpm add @google-cloud/dataform`、`yarn add @google-cloud/dataform`、`bun add @google-cloud/dataform`

## README

![Google Cloud Platform logo](https://avatars2.githubusercontent.com/u/2810941?v=3&s=96 "Google Cloud Platform")

# [数据窗体 API: 节点客户端](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform)

这个库被认为是在 **预览**这意味着它仍然是 工作正在进行中,正在积极发展。 任何释放均须遵守 随时向后不相容的变化.

[![npm version](https://img.shields.io/npm/v/@google-cloud/dataform.svg)](https://www.npmjs.org/package/@google-cloud/dataform)

节点的 API 客户端

各版本的更改一览表载于 [变化](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/CHANGELOG.md)。 。 。 .

-   [Dataform API 节点客户端 API 参考](https://cloud.google.com/nodejs/docs/reference/dataform/latest)
-   [Dataform API 文档](https://cloud.google.com/dataform/docs/overview)

更多信息,请访问Cloud APIs的客户端库,包括老年人 Google APIs 客户端图书馆, in [客户端图书馆解释](https://cloud.google.com/apis/docs/client-libraries-explained)。 。 。 .

**目录 :**

-   [快速启动](https://npmcn.com/package/%40google-cloud/dataform/#readme-quickstart)
    
    -   [在你开始之前](https://npmcn.com/package/%40google-cloud/dataform/#readme-before-you-begin)
    -   [安装客户端库](https://npmcn.com/package/%40google-cloud/dataform/#readme-installing-the-client-library)
-   [版本](https://npmcn.com/package/%40google-cloud/dataform/#readme-versioning)
    
-   [捐款](https://npmcn.com/package/%40google-cloud/dataform/#readme-contributing)
    
-   [许可证](https://npmcn.com/package/%40google-cloud/dataform/#readme-license)
    

## 快速启动

### 在你开始之前

1.  [选择或创建云平台项目](https://console.cloud.google.com/project)。 。 。 .
2.  [启用您的工程计费](https://support.google.com/cloud/answer/6293499#enable-billing)。 。 。 .
3.  [启用数据窗体 API API](https://console.cloud.google.com/flows/enableapi?apiid=dataform.googleapis.com)。 。 。 .
4.  [设置认证](https://cloud.google.com/docs/authentication/external/set-up-adc-local) 这样你就可以访问 当地工作站的API.

### 安装客户端库

```bash
npm install @google-cloud/dataform
```

## 样本

样本在 [`samples/`](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples) 目录。 每个样本 `README.md` 有运行样本的指示.

| 样本 | 源代码 |
| --- | --- |
| 取消工作流程引用 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.cancel_workflow_invocation.js) |
| 执行仓库更改 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.commit_repository_changes.js) |
| 执行工作空间更改 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.commit_workspace_changes.js) |
| 计算寄存器访问符状态 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.compute_repository_access_token_status.js) |
| 创建编译结果 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.create_compilation_result.js) |
| 创建文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.create_folder.js) |
| 创建释放配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.create_release_config.js) |
| 创建仓库 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.create_repository.js) |
| 创建团队文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.create_team_folder.js) |
| 创建工作流程配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.create_workflow_config.js) |
| 创建工作流程引用 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.create_workflow_invocation.js) |
| 创建工作空间 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.create_workspace.js) |
| 删除文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.delete_folder.js) |
| 删除文件夹树 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.delete_folder_tree.js) |
| 删除释放配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.delete_release_config.js) |
| 删除仓库 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.delete_repository.js) |
| 删除团队文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.delete_team_folder.js) |
| 删除团队文件夹树 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.delete_team_folder_tree.js) |
| 删除工作流程配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.delete_workflow_config.js) |
| 删除工作流程引用 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.delete_workflow_invocation.js) |
| 删除工作空间 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.delete_workspace.js) |
| 获取文件 diff | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.fetch_file_diff.js) |
| 获取文件 git 状态 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.fetch_file_git_statuses.js) |
| 将 git 放在后面 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.fetch_git_ahead_behind.js) |
| 获取远程分支 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.fetch_remote_branches.js) |
| 获取仓库历史 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.fetch_repository_history.js) |
| 获得汇编结果 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.get_compilation_result.js) |
| 获得配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.get_config.js) |
| 获取文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.get_folder.js) |
| 拿到保险单 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.get_iam_policy.js) |
| 获得发布配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.get_release_config.js) |
| 获取仓库 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.get_repository.js) |
| 获取团队文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.get_team_folder.js) |
| 获得工作流程配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.get_workflow_config.js) |
| 获得工作流程引用 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.get_workflow_invocation.js) |
| 获得工作空间 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.get_workspace.js) |
| 安装 npm 包 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.install_npm_packages.js) |
| 列表汇编结果 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.list_compilation_results.js) |
| 列表释放配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.list_release_configs.js) |
| 列表寄存器 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.list_repositories.js) |
| 列表工作流程配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.list_workflow_configs.js) |
| 列表工作流程引用 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.list_workflow_invocations.js) |
| 列表工作空间 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.list_workspaces.js) |
| 制作目录 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.make_directory.js) |
| 移动目录 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.move_directory.js) |
| 移动文件 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.move_file.js) |
| 移动文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.move_folder.js) |
| 移动仓库 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.move_repository.js) |
| 拉出承诺 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.pull_git_commits.js) |
| 推动 git 承诺 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.push_git_commits.js) |
| 查询汇编结果行动 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.query_compilation_result_actions.js) |
| 查询目录内容 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.query_directory_contents.js) |
| 查询文件夹内容 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.query_folder_contents.js) |
| 查询仓库目录内容 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.query_repository_directory_contents.js) |
| 查询团队文件夹内容 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.query_team_folder_contents.js) |
| 查询用户根内容 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.query_user_root_contents.js) |
| 查询工作流程引用动作 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.query_workflow_invocation_actions.js) |
| 读取文件 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.read_file.js) |
| 读取仓库文件 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.read_repository_file.js) |
| 删除目录 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.remove_directory.js) |
| 删除文件 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.remove_file.js) |
| 重置工作空间变化 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.reset_workspace_changes.js) |
| 搜索文件 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.search_files.js) |
| 搜索组文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.search_team_folders.js) |
| 设置 iam 策略 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.set_iam_policy.js) |
| 测试 iam 权限 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.test_iam_permissions.js) |
| 更新配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.update_config.js) |
| 更新文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.update_folder.js) |
| 更新发布配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.update_release_config.js) |
| 更新仓库 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.update_repository.js) |
| 更新团队文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.update_team_folder.js) |
| 更新工作流程配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.update_workflow_config.js) |
| 写入文件 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1/dataform.write_file.js) |
| 取消工作流程引用 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.cancel_workflow_invocation.js) |
| 执行仓库更改 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.commit_repository_changes.js) |
| 执行工作空间更改 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.commit_workspace_changes.js) |
| 计算寄存器访问符状态 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.compute_repository_access_token_status.js) |
| 创建编译结果 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_compilation_result.js) |
| 创建文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_folder.js) |
| 创建释放配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_release_config.js) |
| 创建仓库 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_repository.js) |
| 创建团队文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_team_folder.js) |
| 创建工作流程配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_workflow_config.js) |
| 创建工作流程引用 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_workflow_invocation.js) |
| 创建工作空间 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.create_workspace.js) |
| 删除文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.delete_folder.js) |
| 删除释放配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.delete_release_config.js) |
| 删除仓库 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.delete_repository.js) |
| 删除团队文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.delete_team_folder.js) |
| 删除工作流程配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.delete_workflow_config.js) |
| 删除工作流程引用 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.delete_workflow_invocation.js) |
| 删除工作空间 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.delete_workspace.js) |
| 获取文件 diff | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.fetch_file_diff.js) |
| 获取文件 git 状态 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.fetch_file_git_statuses.js) |
| 将 git 放在后面 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.fetch_git_ahead_behind.js) |
| 获取远程分支 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.fetch_remote_branches.js) |
| 获取仓库历史 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.fetch_repository_history.js) |
| 获得汇编结果 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_compilation_result.js) |
| 获得配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_config.js) |
| 获取文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_folder.js) |
| 拿到保险单 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_iam_policy.js) |
| 获得发布配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_release_config.js) |
| 获取仓库 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_repository.js) |
| 获取团队文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_team_folder.js) |
| 获得工作流程配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_workflow_config.js) |
| 获得工作流程引用 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_workflow_invocation.js) |
| 获得工作空间 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.get_workspace.js) |
| 安装 npm 包 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.install_npm_packages.js) |
| 列表汇编结果 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.list_compilation_results.js) |
| 列表释放配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.list_release_configs.js) |
| 列表寄存器 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.list_repositories.js) |
| 列表工作流程配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.list_workflow_configs.js) |
| 列表工作流程引用 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.list_workflow_invocations.js) |
| 列表工作空间 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.list_workspaces.js) |
| 制作目录 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.make_directory.js) |
| 移动目录 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.move_directory.js) |
| 移动文件 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.move_file.js) |
| 移动文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.move_folder.js) |
| 移动仓库 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.move_repository.js) |
| 拉出承诺 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.pull_git_commits.js) |
| 推动 git 承诺 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.push_git_commits.js) |
| 查询汇编结果行动 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.query_compilation_result_actions.js) |
| 查询目录内容 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.query_directory_contents.js) |
| 查询文件夹内容 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.query_folder_contents.js) |
| 查询仓库目录内容 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.query_repository_directory_contents.js) |
| 查询团队文件夹内容 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.query_team_folder_contents.js) |
| 查询用户根内容 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.query_user_root_contents.js) |
| 查询工作流程引用动作 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.query_workflow_invocation_actions.js) |
| 读取文件 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.read_file.js) |
| 读取仓库文件 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.read_repository_file.js) |
| 删除目录 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.remove_directory.js) |
| 删除文件 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.remove_file.js) |
| 重置工作空间变化 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.reset_workspace_changes.js) |
| 搜索文件 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.search_files.js) |
| 搜索组文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.search_team_folders.js) |
| 设置 iam 策略 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.set_iam_policy.js) |
| 测试 iam 权限 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.test_iam_permissions.js) |
| 更新配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.update_config.js) |
| 更新文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.update_folder.js) |
| 更新发布配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.update_release_config.js) |
| 更新仓库 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.update_repository.js) |
| 更新团队文件夹 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.update_team_folder.js) |
| 更新工作流程配置 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.update_workflow_config.js) |
| 写入文件 | [源代码](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-dataform/samples/generated/v1beta1/dataform.write_file.js) |

## 支持的节点.js版本

我们的客户端图书馆跟着 [节点.js发布时间表](https://github.com/nodejs/release#release-schedule)。 。 。 . 图书馆兼容所有当前 _活动_ 财务报告和审定财务报表 _维修_ 版本 节点.js. 如果你在使用"节点"(Node.js)的报废版本,我们建议你更新 尽快到积极支持的LTS版本.

Google 的客户端库支持在 a 上的 Node.js runtimes 的遗留版本 以下列警告为依据:

-   后遗症版本不进行连续整合测试.
-   一些安全补丁和特性不能被后移植.
-   依赖关系不能不断更新.

设有针对Node.js的一些报废版本的客户端图书馆,以及 可以通过 npm 安装 [秒数](https://docs.npmjs.com/cli/dist-tag)。 。 。 . 立面遵循命名惯例 `legacy-(version)`。 。 。 . 譬如说, `npm install @google-cloud/dataform@legacy-8` 安装客户端库 用于兼容Node.js 8的版本.

## 版本

这个图书馆跟随 [语义版本](http://semver.org/)。 。 。 .

更多信息 : [谷歌云平台启动阶段](https://cloud.google.com/terms/launch-stages)

## 捐款

欢迎捐款! 见 [贡献指南](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md)。 。 。 .

请注意: `README.md` 和该寄存器中的各种配置文件(包括 `.nycrc` 财务报告和审定财务报表 `tsconfig.json`(中文(简体) ) 从中央模板生成.

## 许可证

Apache 版本 2.0

见 [自由主义](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)

## 常见问题

### @google-cloud/dataform 是什么？

节点的 API 客户端

### 如何安装 @google-cloud/dataform？

在项目目录运行 npm install @google-cloud/dataform，或使用 pnpm add / yarn add / bun add。

### @google-cloud/dataform 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @google-cloud/dataform 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @google-cloud/dataform 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=22。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @google-cloud/dataform 可以商用吗？

@google-cloud/dataform 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @google-cloud/dataform 的下载量有多少？

根据 npm 官方下载统计，@google-cloud/dataform 在 2026/10/17 – 2026/11/15 这 30 天内被下载 410,988 次，日均约 13,700 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @google-cloud/dataform 还在维护吗？

最新版本 3\.6\.0 发布于 2026/11/10（7 天前）；至今共发布 30 个版本，其中过去 12 个月发布了 12 个；首次发布于 2022/07/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

