Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@google-cloud/sql

Package Overview
Dependencies
Maintainers
2
Versions
19
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@google-cloud/sql

Sql client for Node.js

  • 0.8.0
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
30K
increased by10.93%
Maintainers
2
Weekly downloads
 
Created
Source

Google Cloud Platform logo

Cloud SQL Admin API: Node.js Client

release level npm version

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

  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 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.

SampleSource CodeTry it
Sql_backup_runs_service.deletesource codeOpen in Cloud Shell
Sql_backup_runs_service.getsource codeOpen in Cloud Shell
Sql_backup_runs_service.insertsource codeOpen in Cloud Shell
Sql_backup_runs_service.listsource codeOpen in Cloud Shell
Sql_connect_service.generate_ephemeral_certsource codeOpen in Cloud Shell
Sql_connect_service.get_connect_settingssource codeOpen in Cloud Shell
Sql_databases_service.deletesource codeOpen in Cloud Shell
Sql_databases_service.getsource codeOpen in Cloud Shell
Sql_databases_service.insertsource codeOpen in Cloud Shell
Sql_databases_service.listsource codeOpen in Cloud Shell
Sql_databases_service.patchsource codeOpen in Cloud Shell
Sql_databases_service.updatesource codeOpen in Cloud Shell
Sql_flags_service.listsource codeOpen in Cloud Shell
Sql_instances_service.add_server_casource codeOpen in Cloud Shell
Sql_instances_service.clonesource codeOpen in Cloud Shell
Sql_instances_service.create_ephemeralsource codeOpen in Cloud Shell
Sql_instances_service.deletesource codeOpen in Cloud Shell
Sql_instances_service.demotesource codeOpen in Cloud Shell
Sql_instances_service.demote_mastersource codeOpen in Cloud Shell
Sql_instances_service.exportsource codeOpen in Cloud Shell
Sql_instances_service.failoversource codeOpen in Cloud Shell
Sql_instances_service.getsource codeOpen in Cloud Shell
Sql_instances_service.get_disk_shrink_configsource codeOpen in Cloud Shell
Sql_instances_service.get_latest_recovery_timesource codeOpen in Cloud Shell
Sql_instances_service.importsource codeOpen in Cloud Shell
Sql_instances_service.insertsource codeOpen in Cloud Shell
Sql_instances_service.listsource codeOpen in Cloud Shell
Sql_instances_service.list_server_cassource codeOpen in Cloud Shell
Sql_instances_service.patchsource codeOpen in Cloud Shell
Sql_instances_service.perform_disk_shrinksource codeOpen in Cloud Shell
Sql_instances_service.promote_replicasource codeOpen in Cloud Shell
Sql_instances_service.reencryptsource codeOpen in Cloud Shell
Sql_instances_service.reschedule_maintenancesource codeOpen in Cloud Shell
Sql_instances_service.reset_replica_sizesource codeOpen in Cloud Shell
Sql_instances_service.reset_ssl_configsource codeOpen in Cloud Shell
Sql_instances_service.restartsource codeOpen in Cloud Shell
Sql_instances_service.restore_backupsource codeOpen in Cloud Shell
Sql_instances_service.rotate_server_casource codeOpen in Cloud Shell
Sql_instances_service.start_external_syncsource codeOpen in Cloud Shell
Sql_instances_service.start_replicasource codeOpen in Cloud Shell
Sql_instances_service.stop_replicasource codeOpen in Cloud Shell
Sql_instances_service.switchoversource codeOpen in Cloud Shell
Sql_instances_service.truncate_logsource codeOpen in Cloud Shell
Sql_instances_service.updatesource codeOpen in Cloud Shell
Sql_instances_service.verify_external_sync_settingssource codeOpen in Cloud Shell
Sql_operations_service.cancelsource codeOpen in Cloud Shell
Sql_operations_service.getsource codeOpen in Cloud Shell
Sql_operations_service.listsource codeOpen in Cloud Shell
Sql_ssl_certs_service.deletesource codeOpen in Cloud Shell
Sql_ssl_certs_service.getsource codeOpen in Cloud Shell
Sql_ssl_certs_service.insertsource codeOpen in Cloud Shell
Sql_ssl_certs_service.listsource codeOpen in Cloud Shell
Sql_tiers_service.listsource codeOpen in Cloud Shell
Sql_users_service.deletesource codeOpen in Cloud Shell
Sql_users_service.getsource codeOpen in Cloud Shell
Sql_users_service.insertsource codeOpen in Cloud Shell
Sql_users_service.listsource codeOpen in Cloud Shell
Sql_users_service.updatesource codeOpen in Cloud Shell
Sql_backup_runs_service.deletesource codeOpen in Cloud Shell
Sql_backup_runs_service.getsource codeOpen in Cloud Shell
Sql_backup_runs_service.insertsource codeOpen in Cloud Shell
Sql_backup_runs_service.listsource codeOpen in Cloud Shell
Sql_connect_service.generate_ephemeral_certsource codeOpen in Cloud Shell
Sql_connect_service.get_connect_settingssource codeOpen in Cloud Shell
Sql_databases_service.deletesource codeOpen in Cloud Shell
Sql_databases_service.getsource codeOpen in Cloud Shell
Sql_databases_service.insertsource codeOpen in Cloud Shell
Sql_databases_service.listsource codeOpen in Cloud Shell
Sql_databases_service.patchsource codeOpen in Cloud Shell
Sql_databases_service.updatesource codeOpen in Cloud Shell
Sql_flags_service.listsource codeOpen in Cloud Shell
Sql_instances_service.add_server_casource codeOpen in Cloud Shell
Sql_instances_service.clonesource codeOpen in Cloud Shell
Sql_instances_service.create_ephemeralsource codeOpen in Cloud Shell
Sql_instances_service.deletesource codeOpen in Cloud Shell
Sql_instances_service.demotesource codeOpen in Cloud Shell
Sql_instances_service.demote_mastersource codeOpen in Cloud Shell
Sql_instances_service.exportsource codeOpen in Cloud Shell
Sql_instances_service.failoversource codeOpen in Cloud Shell
Sql_instances_service.getsource codeOpen in Cloud Shell
Sql_instances_service.get_disk_shrink_configsource codeOpen in Cloud Shell
Sql_instances_service.get_latest_recovery_timesource codeOpen in Cloud Shell
Sql_instances_service.importsource codeOpen in Cloud Shell
Sql_instances_service.insertsource codeOpen in Cloud Shell
Sql_instances_service.listsource codeOpen in Cloud Shell
Sql_instances_service.list_server_cassource codeOpen in Cloud Shell
Sql_instances_service.patchsource codeOpen in Cloud Shell
Sql_instances_service.perform_disk_shrinksource codeOpen in Cloud Shell
Sql_instances_service.promote_replicasource codeOpen in Cloud Shell
Sql_instances_service.reencryptsource codeOpen in Cloud Shell
Sql_instances_service.reschedule_maintenancesource codeOpen in Cloud Shell
Sql_instances_service.reset_replica_sizesource codeOpen in Cloud Shell
Sql_instances_service.reset_ssl_configsource codeOpen in Cloud Shell
Sql_instances_service.restartsource codeOpen in Cloud Shell
Sql_instances_service.restore_backupsource codeOpen in Cloud Shell
Sql_instances_service.rotate_server_casource codeOpen in Cloud Shell
Sql_instances_service.start_external_syncsource codeOpen in Cloud Shell
Sql_instances_service.start_replicasource codeOpen in Cloud Shell
Sql_instances_service.stop_replicasource codeOpen in Cloud Shell
Sql_instances_service.switchoversource codeOpen in Cloud Shell
Sql_instances_service.truncate_logsource codeOpen in Cloud Shell
Sql_instances_service.updatesource codeOpen in Cloud Shell
Sql_instances_service.verify_external_sync_settingssource codeOpen in Cloud Shell
Sql_operations_service.cancelsource codeOpen in Cloud Shell
Sql_operations_service.getsource codeOpen in Cloud Shell
Sql_operations_service.listsource codeOpen in Cloud Shell
Sql_ssl_certs_service.deletesource codeOpen in Cloud Shell
Sql_ssl_certs_service.getsource codeOpen in Cloud Shell
Sql_ssl_certs_service.insertsource codeOpen in Cloud Shell
Sql_ssl_certs_service.listsource codeOpen in Cloud Shell
Sql_tiers_service.listsource codeOpen in Cloud Shell
Sql_users_service.deletesource codeOpen in Cloud Shell
Sql_users_service.getsource codeOpen in Cloud Shell
Sql_users_service.insertsource codeOpen in Cloud Shell
Sql_users_service.listsource codeOpen in Cloud Shell
Sql_users_service.updatesource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

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

Keywords

FAQs

Package last updated on 12 Mar 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc