The `oci-databasemigration` package provides a Node.js client for interacting with the Oracle Cloud Infrastructure (OCI) Database Migration Service. It allows developers to programmatically manage resources related to database migrations within the OCI ecosystem, such as creating, managing, and monitoring migration jobs. This module is an integral part of the broader OCI TypeScript SDK and ships with comprehensive TypeScript type definitions, enabling robust development with full type safety. As of version 2.130.0, the SDK is actively maintained, with a rapid release cadence (typically multiple minor versions per month, as evidenced by recent release logs) that consistently introduces support for new OCI services, features, and API endpoints across various OCI components, not solely Database Migration. Its key differentiator is being the official, idiomatic client for OCI services, ensuring seamless compatibility and strict alignment with OCI's continuously evolving API landscape. Successful usage requires an existing OCI account, a configured user with appropriate IAM policies, and an API signing key pair for authentication.
npm install oci-databasemigrationVerified import paths — ran on the pinned version, not inferred.
This quickstart demonstrates how to initialize the OCI Database Migration client and list existing migrations within a specified OCI compartment, using credentials from the default OCI config file.
Refer to the OCI documentation on 'Configuring the SDK' (https://docs.cloud.oracle.com/en-us/iaas/Content/API/SDKDocs/typescriptsdkgettingstarted.htm#Configure) to ensure your `~/.oci/config` file, profile, and API key are correctly set up and permissions are granted in OCI IAM.
Ensure `oci-common` is installed and up-to-date (`npm install oci-common`). When importing shared utilities, always use `import * as common from 'oci-common';`.
Always ensure the `region` parameter in the client constructor matches the region where your OCI resources are deployed. You can retrieve it from `authProvider.getRegion()` if using `ConfigFileAuthenticationDetailsProvider` or explicitly pass the region string (e.g., `'us-ashburn-1'`).
Subscribe to OCI SDK release notes and review the changelog on GitHub for any breaking changes when upgrading major versions or encountering unexpected behavior after an upgrade. Test critical paths in a staging environment before deploying to production.
Verify all details in your `~/.oci/config` file. Ensure the private key file exists at the specified path and has correct permissions. Confirm the public key for the fingerprint is uploaded to your OCI user's API Keys.
Check OCI IAM policies for the user and group. Ensure the policy grants `manage databasemigration-family` or specific verbs/resources within the compartment. Also, double-check the OCID of the resource and compartment.
Change `import { DatabaseMigrationClient } from 'oci-databasemigration';` to `import * as databasemigration from 'oci-databasemigration';` and then use `new databasemigration.DatabaseMigrationClient({...});`.Correct the region name. Ensure it matches one of the valid regions listed in the error message or the OCI documentation for the service. For `ConfigFileAuthenticationDetailsProvider`, check the `region` setting in `~/.oci/config`.
No dependency data recorded yet.