@google-cloud/alloydb

AlloyDB 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

AlloyDB API client for Node.js

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

• AlloyDB API Nodejs Client API Reference
• AlloyDB API Documentation

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 AlloyDB API API.
• Set up authentication so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/alloydb

Samples

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

Sample	Source Code
batch create instances	source code
create backup	source code
create cluster	source code
create instance	source code
create secondary cluster	source code
create secondary instance	source code
create user	source code
delete backup	source code
delete cluster	source code
delete instance	source code
delete user	source code
execute sql	source code
export cluster	source code
failover instance	source code
generate client certificate	source code
get backup	source code
get cluster	source code
get connection info	source code
get instance	source code
get user	source code
import cluster	source code
inject fault	source code
list backups	source code
list clusters	source code
list databases	source code
list instances	source code
list supported database flags	source code
list users	source code
promote cluster	source code
restart instance	source code
restore cluster	source code
switchover cluster	source code
update backup	source code
update cluster	source code
update instance	source code
update user	source code
upgrade cluster	source code
restore from cloud s q l	source code
cloud	source code
batch create instances	source code
create backup	source code
create cluster	source code
create database	source code
create instance	source code
create secondary cluster	source code
create secondary instance	source code
create user	source code
delete backup	source code
delete cluster	source code
delete instance	source code
delete user	source code
execute sql	source code
export cluster	source code
failover instance	source code
generate client certificate	source code
get backup	source code
get cluster	source code
get connection info	source code
get instance	source code
get user	source code
import cluster	source code
inject fault	source code
list backups	source code
list clusters	source code
list databases	source code
list instances	source code
list supported database flags	source code
list users	source code
promote cluster	source code
restart instance	source code
restore cluster	source code
switchover cluster	source code
update backup	source code
update cluster	source code
update instance	source code
update user	source code
upgrade cluster	source code
restore from cloud s q l	source code
cloud	source code
batch create instances	source code
create backup	source code
create cluster	source code
create database	source code
create instance	source code
create secondary cluster	source code
create secondary instance	source code
create user	source code
delete backup	source code
delete cluster	source code
delete instance	source code
delete user	source code
execute sql	source code
export cluster	source code
failover instance	source code
generate client certificate	source code
get backup	source code
get cluster	source code
get connection info	source code
get instance	source code
get user	source code
import cluster	source code
inject fault	source code
list backups	source code
list clusters	source code
list databases	source code
list instances	source code
list supported database flags	source code
list users	source code
promote cluster	source code
restart instance	source code
restore cluster	source code
switchover cluster	source code
update backup	source code
update cluster	source code
update instance	source code
update user	source code
upgrade cluster	source code
restore from cloud s q l	source code
cloud	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/alloydb@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