Installation

Installation

Get started with FxMap in just a few minutes. Install the core package and any additional data providers or transports you need.

Install FxMap Core

The core FxMap package provides the foundational FluentAPI-based mapping functionality.

.NET CLI

dotnet add package FxMap

Package Manager

Install-Package FxMap

.NET 8.0, 9.0 & 10.0 Support

FxMap supports .NET 8.0, .NET 9.0, and .NET 10.0.

Add a Data Provider

Choose a data provider based on your database technology.

Entity Framework Core

For applications using Entity Framework Core with SQL Server, PostgreSQL, MySQL, or SQLite.

dotnet add package FxMap.EntityFrameworkCore

MongoDB

For applications using MongoDB as the primary database.

dotnet add package FxMap.MongoDb

Add a Transport (Optional)

For microservices architectures, install a transport package to enable cross-service data fetching.

RabbitMQ

Popular AMQP message broker

dotnet add package FxMap.RabbitMq

NATS

Lightweight cloud-native messaging

dotnet add package FxMap.Nats

Kafka

High-throughput distributed streaming

dotnet add package FxMap.Kafka

gRPC

High-performance RPC framework

dotnet add package FxMap.gRPC

Azure Service Bus

Enterprise cloud messaging

dotnet add package FxMap.Azure.ServiceBus

AWS SQS

Fully managed message queuing

dotnet add package FxMap.Aws.Sqs

GraphQL Integration (Optional)

For GraphQL APIs using HotChocolate.

HotChocolate

Seamlessly integrate FxMap with HotChocolate GraphQL server.

dotnet add package FxMap.HotChocolate

Version Compatibility

Important

All FxMap.* packages must have the same version to ensure compatibility. Mixing versions can lead to runtime errors.

Example: Installing matching versions

# Install all packages with version <latest>
dotnet add package FxMap --version <latest>
dotnet add package FxMap.EntityFrameworkCore --version <latest>
dotnet add package FxMap.RabbitMq --version <latest>

Minimum versions of the dependencies

Since 4.1.4 every package is free of known vulnerable dependencies. The minimum versions of three dependencies were raised, so an application that pins an older one has to upgrade it:

Package	Dependency	Minimum
FxMap.MongoDb	MongoDB.Driver	3.9.0
FxMap.HotChocolate	HotChocolate.AspNetCore	15.1.14
FxMap.EntityFrameworkCore	Microsoft.Extensions.Caching.Memory	8.0.1

Upgrading from an older version? Some releases have breaking changes: see the migration guides.

Verify Installation

After installation, verify the packages are correctly installed.

dotnet list package

You should see the FxMap packages listed in the output:

Project 'YourProject' has the following package references [net9.0]: Top-level Package Requested Resolved

FxMap FxMap.EntityFrameworkCore FxMap.RabbitMq

---

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