Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature Request: BatchWrite across entities #312

Open
yamatatsu opened this issue Oct 15, 2023 · 2 comments
Open

Feature Request: BatchWrite across entities #312

yamatatsu opened this issue Oct 15, 2023 · 2 comments

Comments

@yamatatsu
Copy link

I know ElectroDB have a feature transaction.write().
But when using put() and delete(), we want to use BatchWriteItem because it is less cost and higher performance.

The interface will be like following:

// create a user and attach to a tenant
await service.batchWrite
  .user.put({ userId: "", registrationCode: "" })
  .userTenantMap.put({ userId: "", tenantId: "" })
  .registrationCode.delete({ registrationCode: "" })
  .go()

or

// create a user and attach to a tenant
await service.batchWrite([
  service.entities.user.put({ userId: "", registrationCode: "" }),
  service.entities.userTenantMap.put({ userId: "", tenantId: "" }),
  service.entities.registrationCode.delete({ registrationCode: "" }),
]).go()

Actually, BatchWriteItem can effect to multiple table, but if following ElectroDB service concept, it is enough to provide the feature BatchWriteItem only for entities closed in service I think.

@yamatatsu
Copy link
Author

The interface of transaction.write() is so cool! BatchWriteItem feature can follow this interface.

https://electrodb.dev/en/mutations/transact-write/#performing-write-transactions

await yourService.batch
  .write(({ entity1, entity2 }) => [
    entity1
      .put({ prop1: "value1", prop2: "value2" })
      .commit(),

    entity2
      .delete({ prop1: "value1", prop2: "value2" })
      .commit(),
  ])
  .go();

@tywalch
Copy link
Owner

tywalch commented Oct 15, 2023

Hey @yamatatsu 👋

Thanks for putting this together! It might be a little while before I can address this, but it makes sense and would be a great addition 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants