@google-cloud/dataplex

中文文档
6.2.0发布于 2026/10/13Apache-2.0TypeScriptCommonJS近 30 天下载 2万

dataplex client for Node.js

原始使用文档
文档目录8 节
  1. Quickstart
  2. Before you begin
  3. Installing the client library
  4. Samples
  5. Supported Node.js Versions
  6. Versioning
  7. Contributing
  8. License

Google Cloud Platform logo

Cloud Dataplex API: Nodejs Client

This library is considered to be stable. The code surface will not change in backwards-incompatible ways unless absolutely necessary (e.g. because of critical security issues) or with an extensive deprecation period. Issues and requests against stable libraries are addressed with the highest priority

npm version

Cloud Dataplex API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart

Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Cloud Dataplex API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/dataplex

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

SampleSource Code
create glossarysource code
create glossary categorysource code
create glossary termsource code
delete glossarysource code
delete glossary categorysource code
delete glossary termsource code
get glossarysource code
get glossary categorysource code
get glossary termsource code
list glossariessource code
list glossary categoriessource code
list glossary termssource code
update glossarysource code
update glossary categorysource code
update glossary termsource code
cancel metadata jobsource code
create aspect typesource code
create entrysource code
create entry groupsource code
create entry linksource code
create entry typesource code
create metadata feedsource code
create metadata jobsource code
delete aspect typesource code
delete entrysource code
delete entry groupsource code
delete entry linksource code
delete entry typesource code
delete metadata feedsource code
get aspect typesource code
get entrysource code
get entry groupsource code
get entry linksource code
get entry typesource code
get metadata feedsource code
get metadata jobsource code
list aspect typessource code
list entriessource code
list entry groupssource code
list entry typessource code
list metadata feedssource code
list metadata jobssource code
lookup contextsource code
lookup entrysource code
lookup entry linkssource code
modify entrysource code
search entriessource code
update aspect typesource code
update entrysource code
update entry groupsource code
update entry linksource code
update entry typesource code
update metadata feedsource code
create encryption configsource code
delete encryption configsource code
get encryption configsource code
list encryption configssource code
update encryption configsource code
create data assetsource code
create data productsource code
delete data assetsource code
delete data productsource code
get data assetsource code
get data productsource code
list data assetssource code
list data productssource code
request data product accesssource code
update data assetsource code
update data productsource code
cancel data scan jobsource code
create data scansource code
delete data scansource code
generate data quality rulessource code
get data scansource code
get data scan jobsource code
list data scan jobssource code
list data scanssource code
run data scansource code
update data scansource code
create data attributesource code
create data attribute bindingsource code
create data taxonomysource code
delete data attributesource code
delete data attribute bindingsource code
delete data taxonomysource code
get data attributesource code
get data attribute bindingsource code
get data taxonomysource code
list data attribute bindingssource code
list data attributessource code
list data taxonomiessource code
update data attributesource code
update data attribute bindingsource code
update data taxonomysource code
cancel jobsource code
create assetsource code
create lakesource code
create tasksource code
create zonesource code
delete assetsource code
delete lakesource code
delete tasksource code
delete zonesource code
get assetsource code
get jobsource code
get lakesource code
get tasksource code
get zonesource code
list asset actionssource code
list assetssource code
list jobssource code
list lake actionssource code
list lakessource code
list taskssource code
list zone actionssource code
list zonessource code
run tasksource code
update assetsource code
update lakesource code
update tasksource code
update zonesource code
create entitysource code
create partitionsource code
delete entitysource code
delete partitionsource code
get entitysource code
get partitionsource code
list entitiessource code
list partitionssource code
update entitysource code

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

  • Legacy versions are not tested in continuous integration.
  • Some security patches and features cannot be backported.
  • Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/dataplex@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template.

License

Apache Version 2.0

See LICENSE

版本与发布记录

@google-cloud/dataplex 共发布 46 个版本,首次发布于 2022/02/08;过去 12 个月发布了 8 个版本。

版本发布日期距今
6.2.0latest2026/10/131 个月前
6.1.12026/09/291 个月前
6.1.02026/09/092 个月前
6.0.02026/08/113 个月前
5.6.0legacy-182026/06/055 个月前
5.5.12026/05/026 个月前

其他发布通道:legacy-10 → 1.2.0,legacy-12 → 2.4.0,legacy-18 → 5.6.0。

关于 @google-cloud/dataplex 的常见问题

@google-cloud/dataplex 是什么?

dataplex client for Node.js

如何安装 @google-cloud/dataplex?

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

@google-cloud/dataplex 支持 TypeScript 吗?

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

@google-cloud/dataplex 支持 ESM 还是 CommonJS?

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

@google-cloud/dataplex 需要什么版本的 Node.js?

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

@google-cloud/dataplex 可以商用吗?

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

@google-cloud/dataplex 的下载量有多少?

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

@google-cloud/dataplex 还在维护吗?

最新版本 6.2.0 发布于 2026/10/13(1 个月前);至今共发布 46 个版本,其中过去 12 个月发布了 8 个;首次发布于 2022/02/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。