@google-cloud/sql

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

Cloud SQL Admin API client for Node.js

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

• Cloud SQL Admin API Nodejs Client API Reference

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
  • Installing the client library

• Versioning

• Contributing

• License

Quickstart

Before you begin

• Select or create a Cloud Platform project.
• Enable billing for your project.
• Enable the Cloud SQL Admin API API.
• 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.

Sample	Source Code
cloud	source code
delete	source code
get	source code
insert	source code
list	source code
create backup	source code
delete backup	source code
get backup	source code
list backups	source code
update backup	source code
generate ephemeral cert	source code
get connect settings	source code
delete	source code
get	source code
insert	source code
list	source code
patch	source code
update	source code
list	source code
acquire ssrs lease	source code
add entra id certificate	source code
add server ca	source code
add server certificate	source code
clone	source code
create ephemeral	source code
delete	source code
demote	source code
demote master	source code
execute sql	source code
export	source code
failover	source code
get	source code
get disk shrink config	source code
get latest recovery time	source code
import	source code
insert	source code
list	source code
list entra id certificates	source code
list server cas	source code
list server certificates	source code
patch	source code
perform disk shrink	source code
point in time restore	source code
pre check major version upgrade	source code
promote replica	source code
reencrypt	source code
release ssrs lease	source code
reschedule maintenance	source code
reset replica size	source code
reset ssl config	source code
restart	source code
restore backup	source code
rotate entra id certificate	source code
rotate server ca	source code
rotate server certificate	source code
start external sync	source code
start replica	source code
stop replica	source code
switchover	source code
truncate log	source code
update	source code
verify external sync settings	source code
cancel	source code
get	source code
list	source code
delete	source code
get	source code
insert	source code
list	source code
list	source code
delete	source code
get	source code
insert	source code
list	source code
update	source code
cloud	source code
delete	source code
get	source code
insert	source code
list	source code
create backup	source code
delete backup	source code
get backup	source code
list backups	source code
update backup	source code
generate ephemeral cert	source code
get connect settings	source code
delete	source code
get	source code
insert	source code
list	source code
patch	source code
update	source code
list	source code
acquire ssrs lease	source code
add entra id certificate	source code
add server ca	source code
add server certificate	source code
clone	source code
create ephemeral	source code
delete	source code
demote	source code
demote master	source code
execute sql	source code
export	source code
failover	source code
get	source code
get disk shrink config	source code
get latest recovery time	source code
import	source code
insert	source code
list	source code
list entra id certificates	source code
list server cas	source code
list server certificates	source code
patch	source code
perform disk shrink	source code
point in time restore	source code
pre check major version upgrade	source code
promote replica	source code
reencrypt	source code
release ssrs lease	source code
reschedule maintenance	source code
reset replica size	source code
reset ssl config	source code
restart	source code
restore backup	source code
rotate entra id certificate	source code
rotate server ca	source code
rotate server certificate	source code
start external sync	source code
start replica	source code
stop replica	source code
switchover	source code
truncate log	source code
update	source code
verify external sync settings	source code
cancel	source code
get	source code
list	source code
delete	source code
get	source code
insert	source code
list	source code
list	source code
delete	source code
get	source code
insert	source code
list	source code
update	source 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