Cloud SQL Admin API: Nodejs Client

This library is considered to bestable. The code surface will not change in backwards-incompatible waysunless absolutely necessary (e.g. because of critical security issues) or withan extensive deprecation period. Issues and requests againststable librariesare 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 inthe CHANGELOG.

Read more about the client libraries for Cloud APIs, including the olderGoogle APIs Client Libraries, inClient 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 theAPI from your local workstation.### Installing the client library
npm install @google-cloud/sql

Samples

Samples are in thesamples/ directory. Each sample'sREADME.md has instructions for running its sample.

SampleSource Code
cloudsource code
deletesource code
getsource code
insertsource code
listsource 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 server casource code
clonesource code
create ephemeralsource code
deletesource code
demotesource code
demote mastersource code
exportsource code
failoversource code
getsource code
get disk shrink configsource code
get latest recovery timesource code
importsource code
insertsource code
listsource code
list server cassource code
patchsource code
perform disk shrinksource 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 server casource 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
cloudsource code
deletesource code
getsource code
insertsource code
listsource 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 server casource code
clonesource code
create ephemeralsource code
deletesource code
demotesource code
demote mastersource code
exportsource code
failoversource code
getsource code
get disk shrink configsource code
get latest recovery timesource code
importsource code
insertsource code
listsource code
list server cassource code
patchsource code
perform disk shrinksource 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 server casource 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 theNode.js release schedule.Libraries are compatible with all currentactive andmaintenance versions ofNode.js.If you are using an end-of-life version of Node.js, we recommend that you updateas soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on abest-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, andcan be installed through npmdist-tags.The dist-tags follow the naming conventionlegacy-(version).For example,npm install @google-cloud/sql@legacy-8 installs client librariesfor versions compatible with Node.js 8.

Versioning

This library followsSemantic Versioning.

More Information:Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See theContributing Guide.

Please note that thisREADME.mdand a variety of configuration files in this repository (including.nycrc andtsconfig.json)are generated from a central template.

License

Apache Version 2.0

SeeLICENSE

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-03 UTC.