Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mongodb/mongo-efcore-provider
MongoDB Entity Framework Core Provider
https://github.com/mongodb/mongo-efcore-provider
csharp entity-framework entity-framework-core mongodb
Last synced: 5 days ago
JSON representation
MongoDB Entity Framework Core Provider
- Host: GitHub
- URL: https://github.com/mongodb/mongo-efcore-provider
- Owner: mongodb
- License: other
- Created: 2023-05-12T13:10:14.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-10-29T00:26:09.000Z (about 2 months ago)
- Last Synced: 2024-10-29T14:20:39.948Z (about 1 month ago)
- Topics: csharp, entity-framework, entity-framework-core, mongodb
- Language: C#
- Homepage: https://www.nuget.org/packages/MongoDB.EntityFrameworkCore
- Size: 7.92 MB
- Stars: 327
- Watchers: 30
- Forks: 30
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
- awesome-mongodb - mongo-efcore-provider - Official Entity Framework (EF) Core provider for MongoDB (Libraries / C#/.NET ###)
README
# MongoDB Entity Framework Core Provider
[](https://www.nuget.org/packages/MongoDB.EntityFrameworkCore/)
The MongoDB EF Core Provider requires Entity Framework Core 8 on .NET 8 or later and a MongoDB database server 5.0 or later, preferably in a transaction-enabled configuration.
## Getting Started
Setup a DbContext with your desired entities and configuration
```csharp
internal class PlanetDbContext : DbContext
{
public DbSet Planets { get; init; }
public static PlanetDbContext Create(IMongoDatabase database) =>
new(new DbContextOptionsBuilder()
.UseMongoDB(database.Client, database.DatabaseNamespace.DatabaseName)
.Options);
public PlanetDbContext(DbContextOptions options)
: base(options)
{
}
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
base.OnModelCreating(modelBuilder);
modelBuilder.Entity().ToCollection("planets");
}
}
```
To get going with the DbContext:
```csharp
var mongoConnectionString = Environment.GetEnvironmentVariable("MONGODB_URI");
var mongoClient = new MongoClient(mongoConnectionString);
var db = PlanetDbContext.Create(mongoClient.GetDatabase("planets"));
db.Database.EnsureCreated();
```
## Supported Features
Entity Framework Core and MongoDB have a wide variety of features. This provider supports a subset of the functionality available in both, specifically:
- Querying with `Where`, `Find`, `First`, `Single`, `OrderBy`, `ThenBy`, `Skip`, `Take` etc.
- Top-level aggregates of `Any`, `Count`, `LongCount`
- Mapping properties to BSON elements using `[Column]` or `[BsonElement]` attributes or `HasElementName("name")` method
- Mapping entities to collections using `[Table("name")]` attribute or `ToCollection("name")` method
- Single or composite keys of standard types including string, `Guid` and `ObjectId`
- Properties with typical CLR types (`int`, `string`, `Guid`, `decimal`, `DateOnly` etc.) & MongoDB types (`ObjectId`, `Decimal128`)
- Properties of `Dictionary` type
- Properties containing arrays and lists of simple CLR types
- Owned entities (aka value types, sub-documents, embedded documents) both directly and within collections
- `BsonIgnore`, `BsonId`, `BsonDateTimeOptions`, `BsonElement`, `BsonRepresentation` and `BsonRequired` support
- Value converters using `HasConversion`
- Query and update logging including MQL (sensitive mode only)
- Some mapping configuration options for `DateTime`
- `EnsureCreated` & `EnsureDeleted` operations
- Optimistic concurrency support through `IsConcurrencyToken`/`ConcurrencyCheckAttribute` & `IsRowVersion`/`TimestampAttribute`
- AutoTransactional `SaveChanges` & `SaveChangesAsync` - all changes committed or rolled-back together
- `CamelCaseElementNameConvention` for helping map Pascal-cased C# properties to came-cased BSON elements
- Type discriminators including `OfType` and `Where(e => e is T)`
## Limitations
A number of Entity Framework Core features are not currently supported but planned for future release. If you require use of these facilities
in the mean-time consider using the existing [MongoDB C# Driver's](https://github.com/mongodb/mongo-csharp-driver) LINQ provider which supports them.
### Planned for upcoming releases
- Select projections with client-side operations
- Sum, Average, Min, Max etc. support at top level
### Not supported but considering for future releases
- ExecuteUpdate & ExecuteDelete
- Binary/byte array properties
- Additional CLR types (DateOnly, TimeOnly etc).
- EF shadow properties
- GroupBy operations
- Relationships between entities
- Includes/joins
- Foreign keys and navigation traversal
### Not supported & out-of-scope features
- Keyless entity types
- Schema migrations
- Database-first & model-first
- Alternate keys
- Document (table) splitting
- Temporal tables
- Spacial data
- Timeseries
- Atlas search
- GridFS
## Breaking changes
This project's version-numbers are aligned with Entity Framework Core and as-such we can not use the semver convention of constraining breaking changes solely to major version numbers. Please keep an eye on our [Breaking Changes](/BREAKING-CHANGES.md) document before upgrading to a new version of this provider.
## Documentation
- [MongoDB](https://www.mongodb.com/docs)
- [EF Provider Guide](https://www.mongodb.com/docs/entity-framework/current/)
- [EF Provider API Docs](https://mongodb.github.io/mongo-efcore-provider/8.0.0/api/index.html)
## Questions/Bug Reports
- [Forums](https://www.mongodb.com/community/forums/)
- [Jira](https://jira.mongodb.org/projects/EF/)
If you’ve identified a security vulnerability in a driver or any other MongoDB project, please report it according to the [instructions here](https://www.mongodb.com/docs/manual/tutorial/create-a-vulnerability-report).
## Contributing
Please see our [guidelines](CONTRIBUTING.md) for contributing to the driver.
Thank you to [everyone](https://github.com/mongodb/mongo-efcore-provider/graphs/contributors) who has contributed to this project.