[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
[//]: # "The comments you see below are used to generate those parts of the template in later states."

[Database Migration API: Nodejs Client][homepage]

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


Database Migration API client for Node.js

[//]: # "partials.introduction"

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

* Database Migration API Nodejs Client API Reference

Read more about the client libraries for Cloud APIs, including the older
Google APIs Client Libraries, in [Client Libraries Explained][explained].

[explained]: https://cloud.google.com/apis/docs/client-libraries-explained

Table of contents:

* Quickstart
* Before you begin
* Installing the client library

* Versioning
* Contributing
* License

Quickstart

$3

1. [Select or create a Cloud Platform project][projects].
1. [Enable billing for your project][billing].
1. [Enable the Database Migration API API][enable_api].
1. [Set up authentication][auth] so you can access the
API from your local workstation.

$3

``bash
npm install @google-cloud/dms
`

[//]: # "partials.body"

Samples

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

| Sample | Source Code |
| --------------------------- | --------------------------------- |
| apply conversion workspace | source code |
| commit conversion workspace | source code |
| convert conversion workspace | source code |
| create connection profile | source code |
| create conversion workspace | source code |
| create mapping rule | source code |
| create migration job | source code |
| create private connection | source code |
| delete connection profile | source code |
| delete conversion workspace | source code |
| delete mapping rule | source code |
| delete migration job | source code |
| delete private connection | source code |
| describe conversion workspace revisions | source code |
| describe database entities | source code |
| fetch static ips | source code |
| generate ssh script | source code |
| generate tcp proxy script | source code |
| get connection profile | source code |
| get conversion workspace | source code |
| get mapping rule | source code |
| get migration job | source code |
| get private connection | source code |
| import mapping rules | source code |
| list connection profiles | source code |
| list conversion workspaces | source code |
| list mapping rules | source code |
| list migration jobs | source code |
| list private connections | source code |
| promote migration job | source code |
| restart migration job | source code |
| resume migration job | source code |
| rollback conversion workspace | source code |
| search background jobs | source code |
| seed conversion workspace | source code |
| start migration job | source code |
| stop migration job | source code |
| update connection profile | source code |
| update conversion workspace | source code |
| update migration job | source code |
| verify migration job | 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/dms@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][launch_stages]

[launch_stages]: https://cloud.google.com/terms/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

[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
[projects]: https://console.cloud.google.com/project
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=datamigration.googleapis.com
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples
[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/CHANGELOG.md
[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms