@google-cloud/sql

中文文档
0.32.0发布于 2026/11/10Apache-2.0TypeScriptCommonJS近 30 天下载 1333.2万

Sql 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 SQL Admin 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 SQL Admin 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 SQL Admin API API.
  4. Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/sql

Samples

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

SampleSource Code
deletesource code
getsource code
insertsource code
listsource code
create backupsource code
delete backupsource code
get backupsource code
list backupssource code
update backupsource code
generate ephemeral certsource code
get connect settingssource code
deletesource code
getsource code
insertsource code
listsource code
patchsource code
updatesource code
listsource code
acquire ssrs leasesource code
add entra id certificatesource code
add server casource code
add server certificatesource code
clonesource code
create ephemeralsource code
deletesource code
demotesource code
demote mastersource code
execute sqlsource code
exportsource code
failoversource code
getsource code
get disk shrink configsource code
get latest recovery timesource code
importsource code
insertsource code
listsource code
list entra id certificatessource code
list server cassource code
list server certificatessource code
patchsource code
perform disk shrinksource code
point in time restoresource code
pre check major version upgradesource code
promote replicasource code
reencryptsource code
release ssrs leasesource code
reschedule maintenancesource code
reset replica sizesource code
reset ssl configsource code
restartsource code
restore backupsource code
rotate entra id certificatesource code
rotate server casource code
rotate server certificatesource code
start external syncsource code
start replicasource code
stop replicasource code
switchoversource code
truncate logsource code
updatesource code
verify external sync settingssource code
cancelsource code
getsource code
listsource code
deletesource code
getsource code
insertsource code
listsource code
listsource code
deletesource code
getsource code
insertsource code
listsource code
updatesource code
deletesource code
getsource code
insertsource code
listsource code
create backupsource code
delete backupsource code
get backupsource code
list backupssource code
update backupsource code
generate ephemeral certsource code
get connect settingssource code
resolve connect settingssource code
stream sql datasource code
deletesource code
getsource code
insertsource code
listsource code
patchsource code
updatesource code
listsource code
acquire ssrs leasesource code
add entra id certificatesource code
add server casource code
add server certificatesource code
clonesource code
create ephemeralsource code
deletesource code
demotesource code
demote mastersource code
execute sqlsource code
exportsource code
failoversource code
getsource code
get disk shrink configsource code
get latest recovery timesource code
importsource code
insertsource code
listsource code
list entra id certificatessource code
list server cassource code
list server certificatessource code
patchsource code
perform disk shrinksource code
point in time restoresource code
pre check major version upgradesource code
promote replicasource code
reencryptsource code
release ssrs leasesource code
reschedule maintenancesource code
reset replica sizesource code
reset ssl configsource code
restartsource code
restore backupsource code
rotate entra id certificatesource code
rotate server casource code
rotate server certificatesource code
start external syncsource code
start replicasource code
stop replicasource code
switchoversource code
truncate logsource code
updatesource code
verify external sync settingssource code
cancelsource code
getsource code
listsource code
deletesource code
getsource code
insertsource code
listsource code
listsource code
deletesource code
getsource code
insertsource code
listsource code
updatesource 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/sql@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/sql 共发布 36 个版本,首次发布于 2023/09/07;过去 12 个月发布了 11 个版本。

版本发布日期距今
0.32.0latest2026/11/107 天前
0.30.02026/10/091 个月前
0.29.12026/09/291 个月前
0.29.02026/09/241 个月前
0.28.02026/09/092 个月前
0.27.02026/08/113 个月前

其他发布通道:legacy-18 → 0.26.0。

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

@google-cloud/sql 是什么?

Sql client for Node.js

如何安装 @google-cloud/sql?

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

@google-cloud/sql 支持 TypeScript 吗?

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

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

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

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

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

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

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

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

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

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

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