OData $select not returning any response when used with MongoDB.Driver

Mohsin_Rizvi · 2024-11-11T04:09:36.242Z

I am using MongoDB.Driver with OData in a c# web api. My end point is working fine with $filter clause but when i use $select to retrieve a single property, my api crashes (screenshot attached).

image1275×492 16.3 KB

NuGet Packages I am using

Microsoft.AspNetCore.OData – 9.0.0
MongoDB.Driver – 3.0.0

Controller

[ApiController]
[Route(“api/[controller]”)]
public class BooksController : ODataController
{
private readonly BooksService _booksService;

public BooksController(BooksService booksService) =>
    _booksService = booksService;

[HttpGet]
[EnableQuery]
public IQueryable<Book> Get()
{
    return _booksService.GetAsync();
}

}

Books Service

public class BooksService
{
private readonly IMongoCollection _booksCollection;

public BooksService(
    IOptions<BookStoreDatabaseSettings> bookStoreDatabaseSettings)
{
    var mongoClient = new MongoClient(
        bookStoreDatabaseSettings.Value.ConnectionString);

    var mongoDatabase = mongoClient.GetDatabase(
        bookStoreDatabaseSettings.Value.DatabaseName);

    _booksCollection = mongoDatabase.GetCollection<Book>(
        bookStoreDatabaseSettings.Value.BooksCollectionName);
}

public IQueryable<Book> GetAsync() 
{
    return _booksCollection.AsQueryable();
}

}

Program.cs

        var builder = WebApplication.CreateBuilder(args);

        // Add services to the container.
        builder.Services.Configure<BookStoreDatabaseSettings>(
builder.Configuration.GetSection("BookStoreDatabase"));

        builder.Services.AddSingleton<BooksService>();

        var modelBuilder = new ODataConventionModelBuilder();
        var model = modelBuilder.EntitySet<Book>("Books").EntityType;
        model.HasKey(e => e.Id);

        builder.Services.AddControllers().AddOData(options =>
        {
            options.Select().Filter().OrderBy().Expand().Count().SetMaxTop(100).AddRouteComponents("odata", modelBuilder.GetEdmModel());
        });

        var app = builder.Build();

        app.UseHttpsRedirection();

        app.UseRouting();
        app.UseEndpoints(endpoints => endpoints.MapControllers());
        //app.MapControllers();

        app.Run();

Rishit_Bhatia · 2024-11-12T13:28:32.260Z

Hi @Mohsin_Rizvi ,

Welcome to the MongoDB Community Forums! In order to use $select and $expand in your requests, you’ll need to use the MongoDB.AspNetCore.OData package. All you need to do after that is replace EnableQuery with MongoEnableQuery. The following resources might also help:

Using ASP.NET Core OData with MongoDB Atlas - DEV Community
OData using the MongoDB C# Driver

Hope that helps.

Thanks,

Rishit.

Bogdan_Grosu · 2024-11-26T22:51:19.756Z

Hi Rishit,

I think there is a breaking change in MongoDriver 3.0.0 and as long as we migrate to this version we get this error:


"error": "Could not load type 'MongoDB.Driver.Linq.IMongoQueryable' from assembly 'MongoDB.Driver, Version=3.0.0.0, Culture=neutral, PublicKeyToken=94992a530f44e321'.",

As it seems that MongoDB.AspNetCore.OData is no longer copatible with v3.0 of the driver because IMongoQueryable is no longer available and now the approach would be to use IQueryable. Most likely the latest supported version for MongoDB.AspNetCore.OData is MongoDriver 2.30

Rishit_Bhatia · 2024-12-06T15:12:45.473Z

Hi @Bogdan_Grosu,

Welcome to the MongoDB Community Forums! You’re right, the current version of the MongoDB.AspeNetCore.OData package is not compatible with the v3.0 of the driver. The work is being tracked here. We’ll be aiming to address this in the coming weeks.

Thanks,

Rishit.

Oleksandr_Poliakov · 2024-12-26T17:36:46.036Z

Hi all,

We have released the MongoDB.AspNetCore.OData version 1.1.0 compatible with CSharp Driver 3.0.