objectbox-dart icon indicating copy to clipboard operation
objectbox-dart copied to clipboard

Ability to pass ID to Box creation

Open gryznar opened this issue 1 year ago • 3 comments

Is there an existing issue?

Use case

I have one entity used for dynamically created data categories. Each of these categories is independent and handled by a separate isolate.

Proposed solution

Allow an optional identifier to be passed to the Box object when it is created:

final fooBox = store.box<CommonEntity>(id: 'foo')
final barBox = store.box<CommonEntity>(id: 'bar')

Describe alternatives you've considered

  1. One Box for all categories. This has few big downsides:

    • concurrent access via separate Isolates (or threads in future Dart version) is not efficient and performant due to need of lock mechanism / transactions
    • data size is larger (every entry would have to have an additional parameter, assigning it to a separate category)
    • accessing data from single category unnecessary complicates the query (this additional param have to be included). This also slows down read, because whole data from different categories is kept in one place
  2. Separate store for each category. This is overkill to have one store-one box setup

  3. Create separate entity for each category. This is not possible, because amount of categories and categories themselves are dynamic

Additional context

Hive supports that: image

gryznar avatar Oct 13 '24 12:10 gryznar

Thanks for reporting! ObjectBox does not really work well with a dynamic data model as its main purpose is to map a fixed data model to Dart classes.

Anyhow, option 1 is also what I would recommend on first thought. Obviously, there are up- and downsides which you seem to have analyzed pretty well (though I'm not sure how valid the concurrent access issue is). Based on that you will have to make a decision if this data model or even ObjectBox works for your use case.

Note: I labeled this issue with "more info required" so it will auto-close in a few days if there are no follow-up comments.

greenrobot-team avatar Oct 14 '24 06:10 greenrobot-team

As far as I understand, implementing such feature does not work well with fixed-data design?

gryznar avatar Oct 14 '24 07:10 gryznar

Yes, that's basically the summary of what I said and why it is unlikely ObjectBox will ever support this.

greenrobot-team avatar Oct 15 '24 07:10 greenrobot-team