Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
milandjurdjevic committed May 21, 2024
1 parent 7e2d0f3 commit 0544dd9
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 10 deletions.
2 changes: 1 addition & 1 deletion src/Audentity.Benchmarks/Executor.cs
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ public Executor()
[Benchmark]
public void Collect()
{
foreach (Trace _ in _database.ChangeTracker.Entries().Traces())
foreach (Trace _ in _database.ChangeTracker.Entries().Collect())
{
// Ignore.
}
Expand Down
2 changes: 1 addition & 1 deletion src/Audentity.Tests/CollectTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public class CollectTest

private Task VerifyCollected()
{
IEnumerable<Trace> traces = _database.ChangeTracker.Entries().Traces();
IEnumerable<Trace> traces = _database.ChangeTracker.Entries().Collect();
return VerifyJson(Serializer.Serialize(traces));
}

Expand Down
2 changes: 1 addition & 1 deletion src/Audentity.Tests/MergeTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ public Task EntityAdded_Merges()
IEnumerable<Trace> traces = _database
.ChangeTracker
.Entries()
.Traces()
.Collect()
.Merge();

return VerifyJson(Serializer.Serialize(traces));
Expand Down
2 changes: 1 addition & 1 deletion src/Audentity/Extensions.fs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ open Microsoft.EntityFrameworkCore.ChangeTracking
type Extensions() =

[<Extension>]
static member Traces(entries: EntityEntry seq) = Collect.Traces entries
static member Collect(entries: EntityEntry seq) = Collect.Traces entries

[<Extension>]
static member Merge(traces: Trace seq) = Merge.Traces traces
13 changes: 7 additions & 6 deletions src/Audentity/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,23 +15,23 @@ public class MyDbContext : DbContext
{
public override async Task<int> SaveChangesAsync(CancellationToken cancellationToken = new())
{
EntityTrace[] traces = Collect.Entities(ChangeTracker.Entries()).ToArray();
EntityTrace[] traces = Collect.Traces(ChangeTracker.Entries()).ToArray();
int result = await base.SaveChangesAsync(cancellationToken);
// Process traces...
return result;
}
}
```

### Transforming Trace Ownership
### Merging Owned Traces

Some traces can be owned by another trace
([see more](https://learn.microsoft.com/en-us/ef/core/modeling/owned-entities)). Trace collection can be transformed to
show owned trace properties inside the owner trace property collection.

```csharp
EntityTrace[] traces = Collect.Entities(ChangeTracker.Entries()).ToArray();
EntityTrace[] transformed = Transform.Ownership(traces).ToArray();
EntityTrace[] traces = Collect.Traces(ChangeTracker.Entries()).ToArray();
EntityTrace[] transformed = Merge.Traces(traces).ToArray();
```

### Shadow Entries
Expand Down Expand Up @@ -64,7 +64,8 @@ Those entities, even if they are not defined in the code itself, will still end
To exclude them from traces, you can filter all entries by their CLR type before collecting traces.

```csharp
Collect.Entities(ChangeTracker.Entries())
ChangeTracker
.Entries()
.Where(e => e.Type != typeof(Dictionary<string, object>))
.Select(EntityTrace.FromEntry);
.Collect();
```

0 comments on commit 0544dd9

Please sign in to comment.