Learn More — Back to Learn More Index
DocumentDB for VS Code provides a powerful and extensible data migration framework that enables seamless data movement between different database systems, cloud platforms, and local environments. This feature is designed to simplify complex migration scenarios while maintaining full control over the migration process.
⚠️ Experimental Feature
Data migrations are currently an experimental feature in active development. The API and user interface may change as we refine the functionality based on community feedback. Once the API stabilizes, it will be published to npm for easier integration.
Interested in the preview? We’re looking for early adopters to help shape this feature. If you’d like to join the preview phase, please reach out to us through our GitHub discussions or create an issue.
The migration system in DocumentDB for VS Code is built on a provider-based architecture. Each migration provider is a specialized extension that understands how to handle migrations for specific platforms, tools, or migration scenarios.
When you initiate the migration feature from your database connection, the extension will:
Once you’ve selected a migration provider, one of two things will happen:
Migration providers implement their own:
Once a migration action has been started, the provider takes full control of the migration process. This allows each provider to provide specialized functionality tailored to specific migration scenarios, database types, and target platforms while maintaining a consistent entry point through the DocumentDB extension.
The migration system is designed to be extensible, allowing third-party developers to create custom migration providers that integrate seamlessly with the DocumentDB extension. Each provider can provide unique migration capabilities while maintaining a consistent user experience through the extension’s provider framework.
Migration providers receive full context about your database connection, including:
This context allows providers to offer intelligent, targeted migration options based on your current selection and connection state.
⚠️ Preview Phase Restrictions
During the experimental phase, access to the Migration API is restricted to whitelisted extensions. This ensures stability and allows us to gather focused feedback from early adopters.
To access the API, your extension must be added to the whitelist in the DocumentDB extension. Reach out to us with your extension id and a brief description of your migration provider to join the preview phase.
Once the experimental phase concludes, the API will be open to all extensions without restrictions.
For detailed API documentation, plugin development information, and technical specifications, please refer to:
The API documentation includes: