Cloud Database Migration Service: Node.js Client

release level npm version

Cloud Database Migration API 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:


Before you begin

  1. Select or create a Cloud Platform project.
  2. Enable billing for your project.
  3. Enable the Cloud Database Migration Service 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/dms

Using the client library

// Imports the Google Cloud client library
const {DataMigrationServiceClient} = require('@google-cloud/dms');

// const parent = 'projects/my-project', // Project to list service usage for.

// Creates a client
const client = new DataMigrationServiceClient();
async function listMigrationJobs() {
  for await (const migration of client.listMigrationJobsAsync({
    parent: `projects/${projectId}/locations/${location}`,
  })) {`${} ${migration.state}`);


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

SampleSource CodeTry it
Data_migration_service.create_connection_profilesource codeOpen in Cloud Shell
Data_migration_service.create_migration_jobsource codeOpen in Cloud Shell
Data_migration_service.delete_connection_profilesource codeOpen in Cloud Shell
Data_migration_service.delete_migration_jobsource codeOpen in Cloud Shell
Data_migration_service.generate_ssh_scriptsource codeOpen in Cloud Shell
Data_migration_service.get_connection_profilesource codeOpen in Cloud Shell
Data_migration_service.get_migration_jobsource codeOpen in Cloud Shell
Data_migration_service.list_connection_profilessource codeOpen in Cloud Shell
Data_migration_service.list_migration_jobssource codeOpen in Cloud Shell
Data_migration_service.promote_migration_jobsource codeOpen in Cloud Shell
Data_migration_service.restart_migration_jobsource codeOpen in Cloud Shell
Data_migration_service.resume_migration_jobsource codeOpen in Cloud Shell
Data_migration_service.start_migration_jobsource codeOpen in Cloud Shell
Data_migration_service.stop_migration_jobsource codeOpen in Cloud Shell
Data_migration_service.update_connection_profilesource codeOpen in Cloud Shell
Data_migration_service.update_migration_jobsource codeOpen in Cloud Shell
Data_migration_service.verify_migration_jobsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell
Quickstartsource codeOpen in Cloud Shell

The Cloud Database Migration Service 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/dms@legacy-8 installs client libraries for versions compatible with Node.js 8.


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 stable libraries are addressed with the highest priority.

More Information: Google Cloud Platform Launch Stages


Contributions welcome! See the Contributing Guide.

Please note that this, the samples/, 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.


Apache Version 2.0