@google-cloud/dms 4.1.0 → 4.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +69 -111
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,24 +1,25 @@
|
|
|
1
1
|
[//]: # "This README.md file is auto-generated, all changes to this file will be lost."
|
|
2
|
-
[//]: # "
|
|
2
|
+
[//]: # "The comments you see below are used to generate those parts of the template in later states."
|
|
3
3
|
<img src="https://avatars2.githubusercontent.com/u/2810941?v=3&s=96" alt="Google Cloud Platform logo" title="Google Cloud Platform" align="right" height="96" width="96"/>
|
|
4
4
|
|
|
5
|
-
# [
|
|
6
|
-
|
|
7
|
-
[](https://cloud.google.com/terms/launch-stages)
|
|
8
|
-
[](https://www.npmjs.org/package/@google-cloud/dms)
|
|
9
|
-
|
|
5
|
+
# [Database Migration API: Nodejs Client][homepage]
|
|
10
6
|
|
|
7
|
+
This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways
|
|
8
|
+
unless absolutely necessary (e.g. because of critical security issues) or with
|
|
9
|
+
an extensive deprecation period. Issues and requests against **stable** libraries
|
|
10
|
+
are addressed with the highest priority
|
|
11
11
|
|
|
12
|
+
[](https://www.npmjs.org/package/@google-cloud/dms)
|
|
12
13
|
|
|
13
|
-
|
|
14
|
+
Database Migration API client for Node.js
|
|
14
15
|
|
|
16
|
+
[//]: # "partials.introduction"
|
|
15
17
|
|
|
16
18
|
A comprehensive list of changes in each version may be found in
|
|
17
|
-
[the CHANGELOG]
|
|
19
|
+
[the CHANGELOG][homepage_changelog].
|
|
20
|
+
|
|
21
|
+
* [Database Migration API Nodejs Client API Reference](https://cloud.google.com/nodejs/docs/reference/clouddms/latest)
|
|
18
22
|
|
|
19
|
-
* [Cloud Database Migration Service Node.js Client API Reference][client-docs]
|
|
20
|
-
* [Cloud Database Migration Service Documentation][product-docs]
|
|
21
|
-
* [github.com/googleapis/google-cloud-node/packages/google-cloud-clouddms](https://github.com/googleapis/google-cloud-node/tree/main/packages/google-cloud-clouddms)
|
|
22
23
|
|
|
23
24
|
Read more about the client libraries for Cloud APIs, including the older
|
|
24
25
|
Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
|
@@ -27,109 +28,79 @@ Google APIs Client Libraries, in [Client Libraries Explained][explained].
|
|
|
27
28
|
|
|
28
29
|
**Table of contents:**
|
|
29
30
|
|
|
30
|
-
|
|
31
31
|
* [Quickstart](#quickstart)
|
|
32
32
|
* [Before you begin](#before-you-begin)
|
|
33
33
|
* [Installing the client library](#installing-the-client-library)
|
|
34
|
-
|
|
35
|
-
* [Samples](#samples)
|
|
34
|
+
|
|
36
35
|
* [Versioning](#versioning)
|
|
37
36
|
* [Contributing](#contributing)
|
|
38
37
|
* [License](#license)
|
|
39
38
|
|
|
40
39
|
## Quickstart
|
|
41
|
-
|
|
42
40
|
### Before you begin
|
|
43
41
|
|
|
44
42
|
1. [Select or create a Cloud Platform project][projects].
|
|
45
43
|
1. [Enable billing for your project][billing].
|
|
46
|
-
1. [Enable the
|
|
44
|
+
1. [Enable the Database Migration API API][enable_api].
|
|
47
45
|
1. [Set up authentication][auth] so you can access the
|
|
48
46
|
API from your local workstation.
|
|
49
|
-
|
|
50
47
|
### Installing the client library
|
|
51
48
|
|
|
52
49
|
```bash
|
|
53
50
|
npm install @google-cloud/dms
|
|
54
51
|
```
|
|
55
52
|
|
|
56
|
-
|
|
57
|
-
### Using the client library
|
|
58
|
-
|
|
59
|
-
```javascript
|
|
60
|
-
// Imports the Google Cloud client library
|
|
61
|
-
const {DataMigrationServiceClient} = require('@google-cloud/dms');
|
|
62
|
-
|
|
63
|
-
// const parent = 'projects/my-project', // Project to list service usage for.
|
|
64
|
-
|
|
65
|
-
// Creates a client
|
|
66
|
-
const client = new DataMigrationServiceClient();
|
|
67
|
-
async function listMigrationJobs() {
|
|
68
|
-
for await (const migration of client.listMigrationJobsAsync({
|
|
69
|
-
parent: `projects/${projectId}/locations/${location}`,
|
|
70
|
-
})) {
|
|
71
|
-
console.info(`${migration.name} ${migration.state}`);
|
|
72
|
-
}
|
|
73
|
-
}
|
|
74
|
-
listMigrationJobs();
|
|
75
|
-
|
|
76
|
-
```
|
|
77
|
-
|
|
78
|
-
|
|
53
|
+
[//]: # "partials.body"
|
|
79
54
|
|
|
80
55
|
## Samples
|
|
81
56
|
|
|
82
|
-
Samples are in the [`samples/`]
|
|
83
|
-
|
|
84
|
-
| Sample | Source Code |
|
|
85
|
-
| --------------------------- | --------------------------------- |
|
|
86
|
-
|
|
|
87
|
-
|
|
|
88
|
-
|
|
|
89
|
-
|
|
|
90
|
-
|
|
|
91
|
-
|
|
|
92
|
-
|
|
|
93
|
-
|
|
|
94
|
-
|
|
|
95
|
-
|
|
|
96
|
-
|
|
|
97
|
-
|
|
|
98
|
-
|
|
|
99
|
-
|
|
|
100
|
-
|
|
|
101
|
-
|
|
|
102
|
-
|
|
|
103
|
-
|
|
|
104
|
-
|
|
|
105
|
-
|
|
|
106
|
-
|
|
|
107
|
-
|
|
|
108
|
-
|
|
|
109
|
-
|
|
|
110
|
-
|
|
|
111
|
-
|
|
|
112
|
-
|
|
|
113
|
-
|
|
|
114
|
-
|
|
|
115
|
-
|
|
|
116
|
-
|
|
|
117
|
-
|
|
|
118
|
-
|
|
|
119
|
-
|
|
|
120
|
-
|
|
|
121
|
-
|
|
|
122
|
-
|
|
|
123
|
-
|
|
|
124
|
-
|
|
|
125
|
-
|
|
|
126
|
-
|
|
|
127
|
-
|
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
The [Cloud Database Migration Service Node.js Client API Reference][client-docs] documentation
|
|
132
|
-
also contains samples.
|
|
57
|
+
Samples are in the [`samples/`][homepage_samples] directory. Each sample's `README.md` has instructions for running its sample.
|
|
58
|
+
|
|
59
|
+
| Sample | Source Code |
|
|
60
|
+
| --------------------------- | --------------------------------- |
|
|
61
|
+
| apply conversion workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.apply_conversion_workspace.js) |
|
|
62
|
+
| commit conversion workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.commit_conversion_workspace.js) |
|
|
63
|
+
| convert conversion workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.convert_conversion_workspace.js) |
|
|
64
|
+
| create connection profile | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.create_connection_profile.js) |
|
|
65
|
+
| create conversion workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.create_conversion_workspace.js) |
|
|
66
|
+
| create mapping rule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.create_mapping_rule.js) |
|
|
67
|
+
| create migration job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.create_migration_job.js) |
|
|
68
|
+
| create private connection | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.create_private_connection.js) |
|
|
69
|
+
| delete connection profile | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.delete_connection_profile.js) |
|
|
70
|
+
| delete conversion workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.delete_conversion_workspace.js) |
|
|
71
|
+
| delete mapping rule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.delete_mapping_rule.js) |
|
|
72
|
+
| delete migration job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.delete_migration_job.js) |
|
|
73
|
+
| delete private connection | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.delete_private_connection.js) |
|
|
74
|
+
| describe conversion workspace revisions | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.describe_conversion_workspace_revisions.js) |
|
|
75
|
+
| describe database entities | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.describe_database_entities.js) |
|
|
76
|
+
| fetch static ips | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.fetch_static_ips.js) |
|
|
77
|
+
| generate ssh script | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.generate_ssh_script.js) |
|
|
78
|
+
| generate tcp proxy script | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.generate_tcp_proxy_script.js) |
|
|
79
|
+
| get connection profile | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.get_connection_profile.js) |
|
|
80
|
+
| get conversion workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.get_conversion_workspace.js) |
|
|
81
|
+
| get mapping rule | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.get_mapping_rule.js) |
|
|
82
|
+
| get migration job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.get_migration_job.js) |
|
|
83
|
+
| get private connection | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.get_private_connection.js) |
|
|
84
|
+
| import mapping rules | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.import_mapping_rules.js) |
|
|
85
|
+
| list connection profiles | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.list_connection_profiles.js) |
|
|
86
|
+
| list conversion workspaces | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.list_conversion_workspaces.js) |
|
|
87
|
+
| list mapping rules | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.list_mapping_rules.js) |
|
|
88
|
+
| list migration jobs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.list_migration_jobs.js) |
|
|
89
|
+
| list private connections | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.list_private_connections.js) |
|
|
90
|
+
| promote migration job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.promote_migration_job.js) |
|
|
91
|
+
| restart migration job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.restart_migration_job.js) |
|
|
92
|
+
| resume migration job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.resume_migration_job.js) |
|
|
93
|
+
| rollback conversion workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.rollback_conversion_workspace.js) |
|
|
94
|
+
| search background jobs | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.search_background_jobs.js) |
|
|
95
|
+
| seed conversion workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.seed_conversion_workspace.js) |
|
|
96
|
+
| start migration job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.start_migration_job.js) |
|
|
97
|
+
| stop migration job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.stop_migration_job.js) |
|
|
98
|
+
| update connection profile | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.update_connection_profile.js) |
|
|
99
|
+
| update conversion workspace | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.update_conversion_workspace.js) |
|
|
100
|
+
| update migration job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.update_migration_job.js) |
|
|
101
|
+
| verify migration job | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/data_migration_service.verify_migration_job.js) |
|
|
102
|
+
| cloud | [source code](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples/generated/v1/snippet_metadata_google.cloud.clouddms.v1.json) |
|
|
103
|
+
|
|
133
104
|
|
|
134
105
|
## Supported Node.js Versions
|
|
135
106
|
|
|
@@ -156,42 +127,29 @@ for versions compatible with Node.js 8.
|
|
|
156
127
|
|
|
157
128
|
This library follows [Semantic Versioning](http://semver.org/).
|
|
158
129
|
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
This library is considered to be **stable**. The code surface will not change in backwards-incompatible ways
|
|
162
|
-
unless absolutely necessary (e.g. because of critical security issues) or with
|
|
163
|
-
an extensive deprecation period. Issues and requests against **stable** libraries
|
|
164
|
-
are addressed with the highest priority.
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
130
|
More Information: [Google Cloud Platform Launch Stages][launch_stages]
|
|
172
131
|
|
|
173
132
|
[launch_stages]: https://cloud.google.com/terms/launch-stages
|
|
174
133
|
|
|
175
134
|
## Contributing
|
|
176
135
|
|
|
177
|
-
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/CONTRIBUTING.md).
|
|
136
|
+
Contributions welcome! See the [Contributing Guide](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/CONTRIBUTING.md).
|
|
178
137
|
|
|
179
|
-
Please note that this `README.md
|
|
138
|
+
Please note that this `README.md`
|
|
180
139
|
and a variety of configuration files in this repository (including `.nycrc` and `tsconfig.json`)
|
|
181
|
-
are generated from a central template.
|
|
182
|
-
to its templates in
|
|
183
|
-
[directory](https://github.com/googleapis/synthtool).
|
|
140
|
+
are generated from a central template.
|
|
184
141
|
|
|
185
142
|
## License
|
|
186
143
|
|
|
187
144
|
Apache Version 2.0
|
|
188
145
|
|
|
189
|
-
See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/LICENSE)
|
|
146
|
+
See [LICENSE](https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/LICENSE)
|
|
190
147
|
|
|
191
|
-
[client-docs]: https://cloud.google.com/nodejs/docs/reference/dms/latest
|
|
192
|
-
[product-docs]: https://cloud.google.com/database-migration/
|
|
193
148
|
[shell_img]: https://gstatic.com/cloudssh/images/open-btn.png
|
|
194
149
|
[projects]: https://console.cloud.google.com/project
|
|
195
150
|
[billing]: https://support.google.com/cloud/answer/6293499#enable-billing
|
|
196
151
|
[enable_api]: https://console.cloud.google.com/flows/enableapi?apiid=datamigration.googleapis.com
|
|
197
152
|
[auth]: https://cloud.google.com/docs/authentication/external/set-up-adc-local
|
|
153
|
+
[homepage_samples]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/samples
|
|
154
|
+
[homepage_changelog]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms/CHANGELOG.md
|
|
155
|
+
[homepage]: https://github.com/googleapis/google-cloud-node/blob/main/packages/google-cloud-clouddms
|