AlloyDB API: Node.js Client
AlloyDB API client for Node.js
A comprehensive list of changes in each version may be found in the CHANGELOG .
- AlloyDB API Node.js Client API Reference
- AlloyDB API Documentation
- github.com/googleapis/google-cloud-node/packages/google-cloud-alloydb
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
- 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
Using the client library
/**
* This snippet has been automatically generated and should be regarded as a code template only.
* It will require modifications to work.
* It may require correct/in-range values for request initialization.
* TODO(developer): Uncomment these variables before running the sample.
*/
/**
* Required. The name of the parent resource. The required format is:
* * projects/{project}/locations/{location}
* Regardless of the parent specified here, as long it is contains a valid
* project and location, the service will return a static list of supported
* flags resources. Note that we do not yet support region-specific
* flags.
*/
// const parent = 'abc123'
/**
* Requested page size. Server may return fewer items than requested.
* If unspecified, server will pick an appropriate default.
*/
// const pageSize = 1234
/**
* A token identifying a page of results the server should return.
*/
// const pageToken = 'abc123'
// Imports the Alloydb library
const {AlloyDBAdminClient} = require(' @google-cloud/alloydb
').v1alpha;
// Instantiates a client
const alloydbClient = new AlloyDBAdminClient
();
async function callListSupportedDatabaseFlags() {
// Construct request
const request = {
parent,
};
// Run request
const iterable =
await alloydbClient.listSupportedDatabaseFlagsAsync(request);
for await (const response of iterable) {
console.log(response);
}
}
callListSupportedDatabaseFlags();
Samples
Samples are in the samples/
directory. Each sample's README.md
has instructions for running its sample.
| Sample | Source Code | Try it |
|---|---|---|
|
Alloy_d_b_admin.batch_create_instances
|
source code | 
|
|
Alloy_d_b_admin.create_backup
|
source code |
|
|
Alloy_d_b_admin.create_cluster
|
source code |
|
|
Alloy_d_b_admin.create_instance
|
source code |
|
|
Alloy_d_b_admin.create_secondary_cluster
|
source code |
|
|
Alloy_d_b_admin.create_secondary_instance
|
source code |
|
|
Alloy_d_b_admin.create_user
|
source code |
|
|
Alloy_d_b_admin.delete_backup
|
source code |
|
|
Alloy_d_b_admin.delete_cluster
|
source code |
|
|
Alloy_d_b_admin.delete_instance
|
source code |
|
|
Alloy_d_b_admin.delete_user
|
source code |
|
|
Alloy_d_b_admin.execute_sql
|
source code |
|
|
Alloy_d_b_admin.failover_instance
|
source code |
|
|
Alloy_d_b_admin.generate_client_certificate
|
source code |
|
|
Alloy_d_b_admin.get_backup
|
source code |
|
|
Alloy_d_b_admin.get_cluster
|
source code |
|
|
Alloy_d_b_admin.get_connection_info
|
source code |
|
|
Alloy_d_b_admin.get_instance
|
source code |
|
|
Alloy_d_b_admin.get_user
|
source code |
|
|
Alloy_d_b_admin.inject_fault
|
source code |
|
|
Alloy_d_b_admin.list_backups
|
source code |
|
|
Alloy_d_b_admin.list_clusters
|
source code |
|
|
Alloy_d_b_admin.list_databases
|
source code |
|
|
Alloy_d_b_admin.list_instances
|
source code |
|
|
Alloy_d_b_admin.list_supported_database_flags
|
source code |
|
|
Alloy_d_b_admin.list_users
|
source code |
|
|
Alloy_d_b_admin.promote_cluster
|
source code |
|
|
Alloy_d_b_admin.restart_instance
|
source code |
|
|
Alloy_d_b_admin.restore_cluster
|
source code |
|
|
Alloy_d_b_admin.switchover_cluster
|
source code |
|
|
Alloy_d_b_admin.update_backup
|
source code |
|
|
Alloy_d_b_admin.update_cluster
|
source code |
|
|
Alloy_d_b_admin.update_instance
|
source code |
|
|
Alloy_d_b_admin.update_user
|
source code |
|
|
Alloy_d_b_admin.batch_create_instances
|
source code |
|
|
Alloy_d_b_admin.create_backup
|
source code |
|
|
Alloy_d_b_admin.create_cluster
|
source code |
|
|
Alloy_d_b_admin.create_instance
|
source code |
|
|
Alloy_d_b_admin.create_secondary_cluster
|
source code |
|
|
Alloy_d_b_admin.create_secondary_instance
|
source code |
|
|
Alloy_d_b_admin.create_user
|
source code |
|
|
Alloy_d_b_admin.delete_backup
|
source code |
|
|
Alloy_d_b_admin.delete_cluster
|
source code |
|
|
Alloy_d_b_admin.delete_instance
|
source code |
|
|
Alloy_d_b_admin.delete_user
|
source code |
|
|
Alloy_d_b_admin.execute_sql
|
source code |
|
|
Alloy_d_b_admin.failover_instance
|
source code |
|
|
Alloy_d_b_admin.generate_client_certificate
|
source code |
|
|
Alloy_d_b_admin.get_backup
|
source code |
|
|
Alloy_d_b_admin.get_cluster
|
source code |
|
|
Alloy_d_b_admin.get_connection_info
|
source code |
|
|
Alloy_d_b_admin.get_instance
|
source code |
|
|
Alloy_d_b_admin.get_user
|
source code |
|
|
Alloy_d_b_admin.inject_fault
|
source code |
|
|
Alloy_d_b_admin.list_backups
|
source code |
|
|
Alloy_d_b_admin.list_clusters
|
source code |
|
|
Alloy_d_b_admin.list_databases
|
source code |
|
|
Alloy_d_b_admin.list_instances
|
source code |
|
|
Alloy_d_b_admin.list_supported_database_flags
|
source code |
|
|
Alloy_d_b_admin.list_users
|
source code |
|
|
Alloy_d_b_admin.promote_cluster
|
source code |
|
|
Alloy_d_b_admin.restart_instance
|
source code |
|
|
Alloy_d_b_admin.restore_cluster
|
source code |
|
|
Alloy_d_b_admin.switchover_cluster
|
source code |
|
|
Alloy_d_b_admin.update_backup
|
source code |
|
|
Alloy_d_b_admin.update_cluster
|
source code |
|
|
Alloy_d_b_admin.update_instance
|
source code |
|
|
Alloy_d_b_admin.update_user
|
source code |
|
|
Alloy_d_b_admin.upgrade_cluster
|
source code |
|
|
Alloy_d_b_admin.batch_create_instances
|
source code |
|
|
Alloy_d_b_admin.create_backup
|
source code |
|
|
Alloy_d_b_admin.create_cluster
|
source code |
|
|
Alloy_d_b_admin.create_instance
|
source code |
|
|
Alloy_d_b_admin.create_secondary_cluster
|
source code |
|
|
Alloy_d_b_admin.create_secondary_instance
|
source code |
|
|
Alloy_d_b_admin.create_user
|
source code |
|
|
Alloy_d_b_admin.delete_backup
|
source code |
|
|
Alloy_d_b_admin.delete_cluster
|
source code |
|
|
Alloy_d_b_admin.delete_instance
|
source code |
|
|
Alloy_d_b_admin.delete_user
|
source code |
|
|
Alloy_d_b_admin.execute_sql
|
source code |
|
|
Alloy_d_b_admin.failover_instance
|
source code |
|
|
Alloy_d_b_admin.generate_client_certificate
|
source code |
|
|
Alloy_d_b_admin.get_backup
|
source code |
|
|
Alloy_d_b_admin.get_cluster
|
source code |
|
|
Alloy_d_b_admin.get_connection_info
|
source code |
|
|
Alloy_d_b_admin.get_instance
|
source code |
|
|
Alloy_d_b_admin.get_user
|
source code |
|
|
Alloy_d_b_admin.inject_fault
|
source code |
|
|
Alloy_d_b_admin.list_backups
|
source code |
|
|
Alloy_d_b_admin.list_clusters
|
source code |
|
|
Alloy_d_b_admin.list_databases
|
source code |
|
|
Alloy_d_b_admin.list_instances
|
source code |
|
|
Alloy_d_b_admin.list_supported_database_flags
|
source code |
|
|
Alloy_d_b_admin.list_users
|
source code |
|
|
Alloy_d_b_admin.promote_cluster
|
source code |
|
|
Alloy_d_b_admin.restart_instance
|
source code |
|
|
Alloy_d_b_admin.restore_cluster
|
source code |
|
|
Alloy_d_b_admin.switchover_cluster
|
source code |
|
|
Alloy_d_b_admin.update_backup
|
source code |
|
|
Alloy_d_b_admin.update_cluster
|
source code |
|
|
Alloy_d_b_admin.update_instance
|
source code |
|
|
Alloy_d_b_admin.update_user
|
source code |
|
|
Alloy_d_b_admin.upgrade_cluster
|
source code |
|
|
Quickstart
|
source code |
|
The AlloyDB API Node.js Client API Reference documentation also contains samples.
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 .
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 stablelibraries are addressed with the highest priority.
More Information: Google Cloud Platform Launch Stages
Contributing
Contributions welcome! See the Contributing Guide .
Please note that this README.md
, the samples/README.md
,
and a variety of configuration files in this repository (including .nycrc
and tsconfig.json
)
are generated from a central template. To edit one of these files, make an edit
to its templates in directory
.
License
Apache Version 2.0
See LICENSE
