release-notes.txt

=============
Release Notes
=============

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: twocols

Download the latest {+rel-mig+} binary from the `release page <https://www.mongodb.com/try/download/relational-migrator>`__. 
For installation instructions, see the :ref:`Installation <installation>` page. 

1.12.0 Changelog
----------------

*Released Febuary 3, 2025*

New features:

- Added support for four source databases, using JDBC connectivity to
  enable snapshot-based data migration and database object conversion from:

  - YugabyteDB
  - CockroachDB
  - SAP Sybase IQ (SAP IQ)
  - SAP SQL Anywhere
  
  .. note:: 
    JDBC connection support for these databases is currently in Public Preview.
    Users can also add custom relational database support by creating
    a custom JDBC connector.

- Added support for X.509 certificate authentication for client authentication on
  MongoDB target databases.
- Added information for MongoDB Atlas users attempting large data migrations to
  lower-tier MongoDB Atlas clusters which may result in extended migration time. For 
  large jobs where migration performance is a consideration, users may be able 
  to reduce total migration time by up to 54% by upgrading to a faster Atlas tier. 
- Added optional news section to inform users of new migrator tool capabilities,
  important upgrades and security announcements. This online-only feature can be
  disabled in user properties.
- Improved error reporting when skipping import of unsupported binary data types 
  in Microsoft SQL Server (FILESTREAM type) and Oracle (LONG, LONG RAW and BFILE types).
- Increased the maximum file size of supported DDL schemas file from 4MB to 20MB.

Bug Fixes:

- Fixed an issue where Postgres created a duplicate replication slot in certain 
  scenarios. 



1.11.0 Changelog
----------------

*Released November 25, 2024*

New features:

- New database connection management feature makes it easier to save 
  and manage a large number of database connections, and switch between 
  database environments such as QA, dev or production.
- Improved query conversion by adding the option to use strongly-typed 
  Java entities in the signatures of converted queries.
- Added support for converting Oracle packages and SQL Server functions 
  in query converter.
- Added support for the latest Postgres 17 and MySQL 8.4/9.0 database 
  versions.
- Improved support for connecting to Oracle pluggable databases (PDBs).
- Added support to "Bring Your Own LLM" using a customer-managed LLM 
  service for AI code generation instead of the default MongoDB-hosted 
  service.
- Temporarily disabled the ability to select Atlas clusters from a list 
  when signed in with an Atlas account

Bug Fixes:

- Fixed an issue where a "No foreign key found" error could occur in some 
  cases with multiple foreign key embeddings.

1.10.0 Changelog
----------------

*Released October 2, 2024*

New features:

- New bulk conversion UI and API for Query Converter to automatically 
  convert large numbers of SQL queries, views, and stored procedures. 
  See :ref:`rm-bulk-conversion`.
- Snapshot jobs now create top-level documents using a non-idempotent 
  bulk insert method. This improves performance.
- Added explicit control over idempotent behavior through the 
  ``migrator.engine.transform.idempotency: true`` setting in the 
  ``user.properties`` file.
- Internal indexes used for migration are automatically deleted
  after job completion. This improves performance.
- Updated SQL Server JDBC driver to the latest version.
- Added Basic Authentication support for Kafka.
- Added more detailed logging in the application's log file in the 
  event of migration errors.
- Simplified the structure of Java POJO classes in Code Generation.

Bug fixes:

- Fixed an issue where tables were deselected for import into a 
  project after filtering the table list.
- Fixed a UI issue with the Migration Job Log which prevented it 
  from being resized when it contained a large number of entries.
- Fixed an issue where remote API calls such as query conversions 
  were not routed through the system proxy.
- Fixed an issue where individual rows exceeding the 16MB document 
  limit caused the job to stop immediately, instead of continuing 
  up to the error threshold. 
- Fixed an issue where data verification was unable to detect some 
  issues caused by precision differences between source and target 
  data types.
- Fixed an issue where each query could be imported twice.
- Fixed an issue where converted queries sometimes used incorrect 
  paths for embedded mappings.

1.9.0 Changelog
---------------

*Released August 20, 2024*

New features:

- Query Converter now allows you to test your relational and converted 
  queries and compare the results in the :guilabel:`Test Queries` pane. 
- DB2 LUW database support is now in Public Preview. Users interested in 
  DB2 LUW and mainframe (DB2 for i) support, please contact your MongoDB 
  account representative for full details or a guided evaluation.
- SQL Server connections now default to ``trust server certificate``. 
  This setting can be unchecked in the SSL tab.

Fixes:

- Fixed an issue where connectors failed to upload when starting migration 
  jobs using Confluent Cloud.
- Fixed an issue where migration jobs failed to start for Postgres databases 
  when the credentials were supplied with query string parameters.
- Fixed an issue where multiple synthetic foreign keys between the same 
  tables were not treated as a composite key.
- Fixed an issue where the migration job dialog indicated that the database 
  was not ready if the preflight test failed to run.
- Fixed an issue where query files were not deleted when projects were 
  deleted.
- Fixed an issue where queries could not be imported from a Postgres 
  database when connected as a user who is not the owner.

1.8.0 Changelog
---------------

*Released July 09, 2024*

New features:

- New conditional mapping rules for more advanced transformations:

  - Mapping rule filters to include or exclude documents based on 
    a custom Javascript expression.
  - Array conditions to sort and limit embedded arrays, supporting
    the application of the subset pattern.
  - Improved modeling of foreign keys to support tables with 
    multiple, potentially ambiguous references to a foreign table.

- New light mode in web UI.
- New undo/redo functionality for mapping rule editing.
- Improved stored procedure conversion for Postgres and MySQL database 
  by adding procedure headers.

1.7.0 Changelog
---------------

*Released May 20, 2024*

New features:

- More detailed statistics while running a migration job, including viewing 
  percentage complete, estimated time to completion, and which table is 
  currently being processed.
- Users can now recover a continuous migration job if the {+rel-mig+} 
  application is restarted while a migration job is running.
- :ref:`New Job Management REST API <rm-rest-api>`. The REST API allows 
  users to start, stop and monitor migration jobs programmatically.

Bug Fixes:

- Fixed an issue where Atlas Sign In sessions expired 
  after {+rel-mig+} was idle for a short amount of time.
- Fixed an issue where it was not possible to import queries from 
  Oracle databases where the schema or database name contained dots.
- Fixed an issue where generated Java POJO classes used incorrect types 
  for date-typed fields. 
- Fixed an issue where verification could be aborted for schemas with 
  composite keys when some key fields are excluded.
- Fixed an issue where jobs stall without progress if no tables 
  for the schema were found in the source database. 

1.6.0 Changelog
---------------

*Released April 18, 2024*

New features:

- Users can :ref:`migrate time series data <rm-timeseries>` into MongoDB
  with native Time Series support.
- Users can migrate data from TimescaleDB Hybertables.
- Users can migrate from a database that has a name
  different from the name used when creating the corresponding project.
- Migration performance improves by setting write concern to 1 by
  default (can be overridden in MongoDB URI).
- More detailed job logging.

Bug fixes:

- It is now possible to create projects and run migration jobs when the
  database name or schema name contains dot characters.
- Fixed an issue where it was not possible to create a calculated field
  with the same name as an excluded regular field.
- Miscellaneous quality improvements to the query converter.

1.5.0 Changelog
---------------

*Released March 6, 2024*

New features:

- Query converter is now in public preview. For details, 
  see :ref:`rm-enable-query-converter`.
- Query converter now requires you to sign into a MongoDB Atlas 
  account. When you sign into Atlas, the process for
  selecting Atlas clusters in a migration job is dynamically populated.
- Query converter now supports conversion of relational database DML 
  triggers to :ref:`Atlas Triggers <triggers>`.

Improvements:

- Query converter now allows you to convert SQL queries and views 
  to C#, Java, or JavaScript.

Bug fixes:

- Minor improvements to job recoverability and metrics.

1.4.6 Changelog
---------------

*Released February 12, 2024*

Improvements:

- Added support for Oracle 11g as a source database.
- New status indicator on the project page that shows if a 
  migration is running.
- Improved permissions checks against MongoDB database when starting 
  a new migration.
- Improvements to :ref:`Query Converter private preview <rm-query-converter>`.

Bug fixes:

- Fixed an issue where completed migrations could not mark themselves 
  as complete in web interface.

1.4.4 Changelog
---------------

*Released January 29, 2024*

Improvements:

- Improved synthetic foreign keys to be preserved after schema refresh.
- Fix for fully-offline deployments in airgapped environments. 
- Fix for certain combinations of mappings, specifically two different
  mappings at the same level of embedding. 
- Various minor fixes and improvements to Sybase database support, CDC
  stage metrics, verification stage, database exports, and logging.

1.4.3 Changelog
---------------

*Released December 11, 2023*

New features:

- `Sybase ASE database 
  <https://www.sap.com/products/acquired-brands/what-is-sybase.html>`__ 
  support is now available for one-time snapshot migration jobs and 
  stored procedure conversion.
- `Confluent-hosted Kafka support <https://www.confluent.io/>`__ 
  for participants in the Kafka early access program. This release 
  adds prebuilt support for connecting to a Kafka cluster managed by 
  the Confluent hosting provider. 
  
  .. note::

    Kafka is an open-source platform for distributed, 
    high-availability workloads. To gain access to {+rel-mig+} 
    with Kafka support, contact your MongoDB account team to sign up 
    for the Kafka Early Access Program.

- Integration supported with `Hackolade <https://hackolade.com/>`__. 

  .. include:: /includes/fact-hackolade-integration.rst

Improvements:

- Improved SQL query conversion quality for the Query Converter 
  (private preview). For details on how to join the Query Converter 
  early access program, see :ref:`rm-query-converter`.
- Improved application performance through expanded use of available 
  memory in suitable server environments.

1.3.3 Changelog
---------------

*Released November 7, 2023*

Improvements:

- Performance improvements for migration jobs that create large arrays.
- Fixed an issue where schema discovery failed on schema names 
  that contain the dash character.

1.3.2 Changelog
---------------

*Released October 25, 2023*

Improvements:

- Improved performance when {+rel-mig+} analyzes large 
  relational schemas.
- {+rel-mig+} now integrates with the Windows certificate store 
  for SSL connections. 

New features:

- New installer and binaries for Mac M1 architectures.
- Mapping rules now show the original column and type used to generate 
  an ``_id`` field.
- Improved error messages in query converter (private preview).

1.3.1 Changelog
---------------

*Released October 10, 2023*

New features:

- Ability to select ``C#``, ``Java``, and ``JavaScript`` target languages
  for stored procedure conversions in the query converter (private preview).

- Query conversions are now included when you export/import projects.

Bug fixes:

- Fixed an issue where update events could return errors in CDC jobs.
- Fixed an issue where {+rel-mig+} could hang while trying to 
  detect if a new version was available.
- Fixed an issue where all tables could be unexpectedly unchecked 
  when selecting tables for a project.
- Improvements to execution of migration jobs under the Kafka deployment 
  model (private preview).

1.3.0 Changelog
---------------

*Released September 26, 2023*

New features:

- The Query Converter feature is now in private preview. To 
  request private preview access, use the sign-up form within the
  {+rel-mig+} application:

  .. include:: /includes/fact-request-private-preview.rst

Bug fixes:

- SQL Server connections now require a database name, which 
  resolves some issues caused by inferring the database name.
- Improvements to the Mac and Windows installers.

1.2.0 Changelog
---------------

*Released September 4, 2023*

New features:

- Ability to change the data type for migrated fields.
- Ability to control how null values are represented in the migrated data.
- Ability to use calculated fields for a collection's ``_id`` value.
- Diagnostic dump includes configuration files to help streamline support. 

Bug fixes:

- Improves to validation and error handling in mapping rules.
- Improves ability to parse a wider range of Oracle DDL files.
- Fixes an issue where tables were lost when refreshing a schema using SQL Server and Windows authentication. 
- Fixes an issue where CDC updates may target the wrong document when tables do not have a primary key.
- Fixes an issue where database passwords can be incorrectly saved to the browser's password library. 

1.1.3 Changelog
---------------

*Released July 26, 2023*

New features:

- Support for connecting to a SQL Server named instance.
- Collection names now show for JSON schema files created from the :guilabel:`Code Generation` screen.

Bug fixes:

- Fixes a post-migration job issue where data verification sometimes stops 
  or displays as not started.
- Fixes an issue where JSON columns containing top-level arrays cannot be migrated.
- Fixes an issue where excluded fields can overwrite calculated fields 
  with the same name.
- Fixes an issue where calculated fields based on decimal column values 
  return ``NaN``.
- Fixes an issue where some diagram view fields are cut off after you 
  change the project level key handling option.

1.1.2 Changelog
---------------

*Released Jun 22, 2023*

{+rel-mig+} 1.1.2 is now generally available. 
{+rel-mig+} assists in migrating your relational workloads to MongoDB.