Cloud SQL Admin API: Node.js Client
Sql 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
- Select or create a Cloud Platform project.
- Enable billing for your project.
- Enable the Cloud SQL Admin API API.
- Set up authentication with a service account so you can access the API from your local workstation.
Installing the client library
npm install @google-cloud/sql
Using the client library
// Imports the Sql library
const sqladmin = require('@google-cloud/sql').v1;
// Instantiates a client. Use HTTP/1.1 fallback mode instead of gRPC.
const instancesClient = new sqladmin.SqlInstancesServiceClient({
fallback: 'rest',
});
async function callList() {
// Get project ID
const project = await instancesClient.getProjectId();
// Construct request
const request = {
project: project,
};
// Run request
const response = await instancesClient.list(request);
console.log(response);
}
callList();
Samples
Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.
| Sample | Source Code | Try it |
|---|---|---|
| Sql_backup_runs_service.delete | source code |  |
| Sql_backup_runs_service.get | source code | |
| Sql_backup_runs_service.insert | source code | |
| Sql_backup_runs_service.list | source code | |
| Sql_connect_service.generate_ephemeral_cert | source code | |
| Sql_connect_service.get_connect_settings | source code | |
| Sql_databases_service.delete | source code | |
| Sql_databases_service.get | source code | |
| Sql_databases_service.insert | source code | |
| Sql_databases_service.list | source code | |
| Sql_databases_service.patch | source code | |
| Sql_databases_service.update | source code | |
| Sql_flags_service.list | source code | |
| Sql_instances_service.add_server_ca | source code | |
| Sql_instances_service.clone | source code | |
| Sql_instances_service.create_ephemeral | source code | |
| Sql_instances_service.delete | source code | |
| Sql_instances_service.demote | source code | |
| Sql_instances_service.demote_master | source code | |
| Sql_instances_service.export | source code | |
| Sql_instances_service.failover | source code | |
| Sql_instances_service.get | source code | |
| Sql_instances_service.get_disk_shrink_config | source code | |
| Sql_instances_service.get_latest_recovery_time | source code | |
| Sql_instances_service.import | source code | |
| Sql_instances_service.insert | source code | |
| Sql_instances_service.list | source code | |
| Sql_instances_service.list_server_cas | source code | |
| Sql_instances_service.patch | source code | |
| Sql_instances_service.perform_disk_shrink | source code | |
| Sql_instances_service.promote_replica | source code | |
| Sql_instances_service.reencrypt | source code | |
| Sql_instances_service.reschedule_maintenance | source code | |
| Sql_instances_service.reset_replica_size | source code | |
| Sql_instances_service.reset_ssl_config | source code | |
| Sql_instances_service.restart | source code | |
| Sql_instances_service.restore_backup | source code | |
| Sql_instances_service.rotate_server_ca | source code | |
| Sql_instances_service.start_external_sync | source code | |
| Sql_instances_service.start_replica | source code | |
| Sql_instances_service.stop_replica | source code | |
| Sql_instances_service.switchover | source code | |
| Sql_instances_service.truncate_log | source code | |
| Sql_instances_service.update | source code | |
| Sql_instances_service.verify_external_sync_settings | source code | |
| Sql_operations_service.cancel | source code | |
| Sql_operations_service.get | source code | |
| Sql_operations_service.list | source code | |
| Sql_ssl_certs_service.delete | source code | |
| Sql_ssl_certs_service.get | source code | |
| Sql_ssl_certs_service.insert | source code | |
| Sql_ssl_certs_service.list | source code | |
| Sql_tiers_service.list | source code | |
| Sql_users_service.delete | source code | |
| Sql_users_service.get | source code | |
| Sql_users_service.insert | source code | |
| Sql_users_service.list | source code | |
| Sql_users_service.update | source code | |
| Sql_backup_runs_service.delete | source code | |
| Sql_backup_runs_service.get | source code | |
| Sql_backup_runs_service.insert | source code | |
| Sql_backup_runs_service.list | source code | |
| Sql_connect_service.generate_ephemeral_cert | source code | |
| Sql_connect_service.get_connect_settings | source code | |
| Sql_databases_service.delete | source code | |
| Sql_databases_service.get | source code | |
| Sql_databases_service.insert | source code | |
| Sql_databases_service.list | source code | |
| Sql_databases_service.patch | source code | |
| Sql_databases_service.update | source code | |
| Sql_flags_service.list | source code | |
| Sql_instances_service.add_server_ca | source code | |
| Sql_instances_service.clone | source code | |
| Sql_instances_service.create_ephemeral | source code | |
| Sql_instances_service.delete | source code | |
| Sql_instances_service.demote | source code | |
| Sql_instances_service.demote_master | source code | |
| Sql_instances_service.export | source code | |
| Sql_instances_service.failover | source code | |
| Sql_instances_service.get | source code | |
| Sql_instances_service.get_disk_shrink_config | source code | |
| Sql_instances_service.get_latest_recovery_time | source code | |
| Sql_instances_service.import | source code | |
| Sql_instances_service.insert | source code | |
| Sql_instances_service.list | source code | |
| Sql_instances_service.list_server_cas | source code | |
| Sql_instances_service.patch | source code | |
| Sql_instances_service.perform_disk_shrink | source code | |
| Sql_instances_service.promote_replica | source code | |
| Sql_instances_service.reencrypt | source code | |
| Sql_instances_service.reschedule_maintenance | source code | |
| Sql_instances_service.reset_replica_size | source code | |
| Sql_instances_service.reset_ssl_config | source code | |
| Sql_instances_service.restart | source code | |
| Sql_instances_service.restore_backup | source code | |
| Sql_instances_service.rotate_server_ca | source code | |
| Sql_instances_service.start_external_sync | source code | |
| Sql_instances_service.start_replica | source code | |
| Sql_instances_service.stop_replica | source code | |
| Sql_instances_service.switchover | source code | |
| Sql_instances_service.truncate_log | source code | |
| Sql_instances_service.update | source code | |
| Sql_instances_service.verify_external_sync_settings | source code | |
| Sql_operations_service.cancel | source code | |
| Sql_operations_service.get | source code | |
| Sql_operations_service.list | source code | |
| Sql_ssl_certs_service.delete | source code | |
| Sql_ssl_certs_service.get | source code | |
| Sql_ssl_certs_service.insert | source code | |
| Sql_ssl_certs_service.list | source code | |
| Sql_tiers_service.list | source code | |
| Sql_users_service.delete | source code | |
| Sql_users_service.get | source code | |
| Sql_users_service.insert | source code | |
| Sql_users_service.list | source code | |
| Sql_users_service.update | source code | |
| Quickstart | source code | |
The Cloud SQL Admin 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/sql@legacy-8 installs client libraries
for versions compatible with Node.js 8.
Versioning
This library follows Semantic Versioning.
This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.
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