CosmosDB
Published 14 February 2025
- Status: Preview
- Flyway configuration: Native Connectors only
- Verified Versions: 7.0
- Maintainer: Redgate
Supported Versions and Support Levels
- For information regarding the supported version and support levels available, please see Supported Databases for Flyway
- For information regarding the Flyway features available, please see Flyway feature summary
Driver
| Item | Details |
|---|---|
| URL format | mongodb://ip address:port number/database_name |
| SSL support | Yes |
| Ships with Flyway Command-line | JSON migrations: Yes. Javascript migrations requires Mongosh to be installed separately |
| Maven Central coordinates | n/a |
Using Flyway with MongoDB Native Connectors
- Whilst this is in preview, you will need to set the environment variable
FLYWAY_NATIVE_CONNECTORS=trueon Redgate editions of Flyway. - If you are using javascript migrations then you'll need
mongoshto be installed. - There is a tutorial available here.
Observations
CosmosDB aims to be MongoDB compatible - as such we use the Flyway MongoDB infrastructure and can only verify that Flyway's verb testing works.
- We saw this error:
The request did not complete due to a high rate of metadata requests.which was overcome by enablingServer Side Retryon theSettings/Featurespage on the CosmosDB management tool.
Limitations
The Flyway Native Connectors blog post describes more of the details of the Native Connectors changes.
- Transactions are only available with JSON migrations (these use the API and not Mongosh)
- Dry run is not available
Terminology
We have to map Flyway concepts and language rooted in the relational database world to MongoDB - this is how Flyway sees the mapping:
| MongoDB Concept | Flyway Concept |
|---|---|
| database | database/schema |
| collection | table |
| row | document |
| transaction | transaction |
