From 6fd0d90ddc4b0ba2106e5d91964c5962c83c25ae Mon Sep 17 00:00:00 2001 From: maliming Date: Wed, 22 May 2024 13:30:08 +0800 Subject: [PATCH] Document the `AbpEntityChangeOptions`. Resolve #19894 --- docs/en/Local-Event-Bus.md | 7 +++++++ docs/zh-Hans/Local-Event-Bus.md | 8 ++++++++ 2 files changed, 15 insertions(+) diff --git a/docs/en/Local-Event-Bus.md b/docs/en/Local-Event-Bus.md index 81c0c5a1717..5c5d967f5fd 100644 --- a/docs/en/Local-Event-Bus.md +++ b/docs/en/Local-Event-Bus.md @@ -235,6 +235,13 @@ Pre-build events are published when you save changes to the database; * For EF Core, they are published on `DbContext.SaveChanges`. * For MongoDB, they are published when you call repository's `InsertAsync`, `UpdateAsync` or `DeleteAsync` methods (since MongoDB has not a change tracking system). +#### AbpEntityChangeOptions + +There is a `PublishEntityUpdatedEventWhenNavigationChanges` option in the `AbpEntityChangeOptions` class with a default value of `true`. +If you set it to `false`, the `EntityUpdatedEventData` will not be published when a navigation property changes. + +> This option is only used for the EF Core. + ## See Also * [Distributed Event Bus](Distributed-Event-Bus.md) diff --git a/docs/zh-Hans/Local-Event-Bus.md b/docs/zh-Hans/Local-Event-Bus.md index 7a842a9e98d..ebdb3f20a68 100644 --- a/docs/zh-Hans/Local-Event-Bus.md +++ b/docs/zh-Hans/Local-Event-Bus.md @@ -211,6 +211,14 @@ namespace AbpDemo * 对于 EF Core, 他们在 `DbContext.SaveChanges` 发布. * 对于 MongoDB, 在你调用仓储的 `InsertAsync`, `UpdateAsync` 或 `DeleteAsync` 方法发布(因为MongoDB没有更改追踪系统). + +#### AbpEntityChangeOptions + +`AbpEntityChangeOptions`类中有一个`PublishEntityUpdatedEventWhenNavigationChanges`选项,默认值为`true`。 +如果将其设置为`false`,则当导航属性更改时,将不会发布`EntityUpdatedEventData`事件。 + +> 此选项仅用于EF Core + ## 另请参阅 * [分布式事件总线](Distributed-Event-Bus.md) \ No newline at end of file