Skip to content

Migration Overview

quyvu edited this page Oct 15, 2026 · 3 revisions

Migration Guides

Every release with a breaking change has a guide here: what stops working, how to find it in your code, and how to change it.

Guides

  • Upgrade to 5.1 (from 5.0) What breaks: the configuration is published by interfaces (IMapConfigurator, IKafkaConfigurator...); the expression engine and other internals are no longer public; the retry policy behaves differently. What to do: replace the configurator types the compiler rejects with their interfaces, recompile your packages, and check your retry policy.
  • Upgrade to 5.0 (from 4.x) What breaks: the indexer [...] and the filter Collection(condition) are removed from the expression language; text left after an expression is an error; a few public types are removed. What to do: rewrite expressions with :where, :orderBy, :offset, :limit, :first and :last, and deploy the services that exchange them together.
  • Migrate from OfX (from OfX) What breaks: mapping attributes become ProfileOf<T> and EntityConfigureOf<T>; packages and a few registration methods are renamed. What to do: swap the packages, replace the attributes, and rename the registration calls.

Before You Upgrade

  • Read the release notes of the version you move to. Each release has a changelog with a Breaking changes section and, when needed, a Migration section.
  • Move every FxMap.* package of a service to the same version. A mix of versions is not supported.
  • Install FxMap.Analyzers. It reports expressions that are no longer valid when you build, before they fail at runtime. See Analyzers.
  • Services exchange expressions as text, and the service that owns the data parses them. When a release changes the expression language, upgrade the owners and the consumers in the same window. Each guide says if this applies.
  • Run your tests against the new version on a copy of the environment before you deploy.

Versions at a Glance

Move Breaking? Guide
4.1.3 → 4.1.4 → 4.1.5 No API change. Fixes, the Kafka partition settings, and raised minimum versions of MongoDB.Driver, HotChocolate and Microsoft.Extensions.Caching.Memory: an application that pins an older one has to upgrade it. Release notes
4.x → 5.0 Yes. The expression language changed. Upgrade to 5.0
5.0 → 5.1 Source-compatible for the usual use. A type that left the public API breaks the code that names it, and the retry policy changed. Upgrade to 5.1
OfX → FxMap Yes. A new package family and a fluent API. Migrate from OfX

Source: https://fxmapper.net/docs/migration/ — the website is always the most up to date version.

Clone this wiki locally