ChangeTracker クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
コンテキストが追跡しているエンティティ インスタンスの変更追跡情報と操作へのアクセスを提供します。 このクラスのインスタンスは通常、 ChangeTracker から取得され、アプリケーション コードで直接構築するようには設計されていません。
public class ChangeTracker : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.ChangeTracking.Internal.IStateManager>
[System.Runtime.CompilerServices.Nullable(0)]
public class ChangeTracker : Microsoft.EntityFrameworkCore.Infrastructure.IResettableService
public class ChangeTracker : Microsoft.EntityFrameworkCore.Infrastructure.IInfrastructure<Microsoft.EntityFrameworkCore.ChangeTracking.Internal.IStateManager>, Microsoft.EntityFrameworkCore.Infrastructure.IResettableService
public class ChangeTracker : Microsoft.EntityFrameworkCore.Infrastructure.IResettableService
type ChangeTracker = class
interface IInfrastructure<IStateManager>
[<System.Runtime.CompilerServices.Nullable(0)>]
type ChangeTracker = class
interface IResettableService
type ChangeTracker = class
interface IInfrastructure<IStateManager>
interface IResettableService
type ChangeTracker = class
interface IResettableService
Public Class ChangeTracker
Implements IInfrastructure(Of IStateManager)
Public Class ChangeTracker
Implements IResettableService
Public Class ChangeTracker
Implements IInfrastructure(Of IStateManager), IResettableService
- 継承
-
ChangeTracker
- 属性
- 実装
-
IInfrastructure<Microsoft.EntityFrameworkCore.ChangeTracking.Internal.IStateManager> IResettableService
注釈
詳細と例については、 EF Core の変更追跡 を参照してください。
コンストラクター
| Name | 説明 |
|---|---|
| ChangeTracker(DbContext, IStateManager, IChangeDetector, IModel, IEntityEntryGraphIterator) |
これは、パブリック API と同じ互換性標準の対象ではなく、Entity Framework Core インフラストラクチャをサポートする内部 API です。 これは、任意のリリースで予告なしに変更または削除される可能性があります。 コード内で直接使用する場合は、細心の注意を払う必要があります。これを行うと、新しいEntity Framework Core リリースに更新するときにアプリケーションのエラーが発生する可能性があることを認識してください。 |
| ChangeTracker(DbContext) |
この API はEntity Framework Core インフラストラクチャをサポートしており、コードから直接使用するためのものではありません。 この API は、将来のリリースで変更または削除される可能性があります。 |
| ChangeTracker(IStateManager, IChangeDetector, IEntityEntryGraphIterator, DbContext) |
この API はEntity Framework Core インフラストラクチャをサポートしており、コードから直接使用するためのものではありません。 この API は、将来のリリースで変更または削除される可能性があります。 |
プロパティ
| Name | 説明 |
|---|---|
| AutoDetectChangesEnabled |
DbContextおよび関連クラスのメソッドによってDetectChanges() メソッドが自動的に呼び出されるかどうかを示す値を取得または設定します。 |
| CascadeDeleteTiming |
親/プリンシパル エンティティがDeletedとしてマークされた後、依存/子エンティティの状態がDeletedに設定されるタイミングを示す値を取得または設定します。 既定値はImmediateです。 |
| Context |
この変更トラッカーが属するコンテキストを取得します。 |
| DebugView |
デバッガーでこのプロパティを展開して、追跡対象のエンティティを人間が判読できるようにします。 警告: デバッグ文字列の形式に依存しないでください。 これらはデバッグ専用に設計されており、リリース間で任意に変更される可能性があります。 詳細と例については、 EF Core の変更追跡 を参照してください。 |
| DeleteOrphansTiming |
親/プリンシパル エンティティから、ナビゲーションまたは外部キー プロパティが null に設定されると、依存/子エンティティの状態が Deleted に設定されるタイミングを示す値を取得または設定します。 既定値は Immediate です。 |
| LazyLoadingEnabled |
追跡対象エンティティのナビゲーション プロパティを最初のアクセス時に読み込むかどうかを示す値を取得または設定します。 |
| QueryTrackingBehavior |
コンテキストに対して実行される LINQ クエリの追跡動作を取得または設定します。 変更の追跡を無効にすると、エンティティ インスタンスごとに変更追跡を設定するオーバーヘッドが回避されるため、読み取り専用のシナリオに役立ちます。 エンティティ インスタンスを操作し、 SaveChanges()を使用してそれらの変更をデータベースに保持する場合は、変更の追跡を無効にしないでください。 |
メソッド
| Name | 説明 |
|---|---|
| AcceptAllChanges() |
コンテキスト内のエンティティに加えられたすべての変更を受け入れます。 追跡対象エンティティは、データベースの現在の状態を表すと想定されます。 通常、このメソッドは、変更がデータベースに正常に保存された後、 SaveChanges() によって呼び出されます。 |
| CascadeChanges() |
子/依存エンティティが必要な親/プリンシパル エンティティから切断された場合、または必要な親/プリンシパル エンティティ自体が削除された場合に、子/依存エンティティの即時連鎖削除を強制します。 DeleteBehaviorを参照してください。 |
| Clear() |
現在追跡されているすべてのエンティティの追跡を停止します。 |
| DetectChanges() |
追跡対象のエンティティ インスタンスをスキャンして、インスタンス データに加えられた変更を検出します。 DetectChanges() は通常、up-to-date 情報が必要な場合 ( SaveChanges() の前と変更追跡情報を返すとき) にコンテキストによって自動的に呼び出されます。 通常、このメソッドを呼び出す必要があるのは、 AutoDetectChangesEnabledを無効にした場合のみです。 |
| Entries() |
コンテキストによって追跡される各エンティティの EntityEntry を返します。 エントリは、各エンティティの変更追跡情報と操作へのアクセスを提供します。 |
| Entries<TEntity>() |
コンテキストによって追跡されている特定の型のすべてのエンティティの EntityEntry を取得します。 エントリは、各エンティティの変更追跡情報と操作へのアクセスを提供します。 |
| GetEntriesForState(Boolean, Boolean, Boolean, Boolean) |
特定の状態を持つコンテキストによって追跡される各エンティティの EntityEntry を取得します。 エントリは、各エンティティの変更追跡情報と操作へのアクセスを提供します。 |
| GetEntriesForState<TEntity>(Boolean, Boolean, Boolean, Boolean) |
特定の状態を持つコンテキストによって追跡されている特定の型の各エンティティの EntityEntry<TEntity> を取得します。 エントリは、各エンティティの変更追跡情報と操作へのアクセスを提供します。 |
| HasChanges() |
SaveChanges()またはSaveChangesAsync(CancellationToken)が呼び出された場合に、これらの変更がデータベースに送信されるように、新しいエンティティ、削除されたエンティティ、または変更されたエンティティが追跡されているかどうかを確認します。 |
| TrackGraph(Object, Action<EntityEntryGraphNode>) |
ナビゲーション プロパティを走査して、エンティティと到達可能なエンティティの追跡を開始します。
トラバーサルは再帰的であるため、検出されたエンティティのナビゲーション プロパティもスキャンされます。
検出されたエンティティごとに指定された |
| TrackGraph<TState>(Object, TState, Func<EntityEntryGraphNode,TState,Boolean>) |
ナビゲーション プロパティを走査することで、エンティティと到達可能なエンティティの追跡を開始します。
トラバーサルは再帰的であるため、検出されたエンティティのナビゲーション プロパティもスキャンされます。
検出されたエンティティごとに指定された このメソッドは、エンティティがコンテキストの 1 つのインスタンスを使用して取得され、変更がコンテキストの別のインスタンスを使用して保存される、切断されたシナリオで使用するように設計されています。 たとえば、1 つのサービス呼び出しがデータベースからエンティティを取得し、別のサービス呼び出しでエンティティに対する変更が保持される Web サービスがあります。 各サービス呼び出しでは、呼び出しが完了したときに破棄されるコンテキストの新しいインスタンスが使用されます。 通常、グラフのトラバーサルは、既に追跡されているエンティティが検出されたとき、または追跡すべきでないエンティティに到達するたびに停止する必要があります。 この一般的な動作では、 TrackGraph(Object, Action<EntityEntryGraphNode>) オーバーロードを使用します。 一方、このオーバーロードを使用すると、コールバックはトラバーサルがいつ終了するかを決定できますが、トラバーサルが無限ループに入らないようにするために、onus が呼び出し元にあります。 |
| TrackGraph<TState>(Object, TState, Func<EntityEntryGraphNode<TState>,Boolean>) |
ナビゲーション プロパティを走査して、エンティティと到達可能なエンティティの追跡を開始します。
トラバーサルは再帰的であるため、検出されたエンティティのナビゲーション プロパティもスキャンされます。
検出されたエンティティごとに指定された |
イベント
| Name | 説明 |
|---|---|
| DetectedAllChanges |
DetectChanges()の明示的な呼び出しを通じてエンティティ グラフに対する変更が検出された場合、またはSaveChanges()またはSaveChangesAsync(CancellationToken)の実行の一部など、自動的に発生するイベント。 |
| DetectedEntityChanges |
DetectChanges()またはDetectChanges()の明示的な呼び出しを通じて、またはSaveChanges()またはSaveChangesAsync(CancellationToken)の実行の一部など、自動的に、1 つのエンティティに対する変更が検出されたときに発生するイベント。 |
| DetectingAllChanges |
DetectChanges()を明示的に呼び出すか、SaveChanges()またはSaveChangesAsync(CancellationToken)の実行の一部など、自動的に、エンティティ グラフへの変更を検出するときに発生するイベント。 |
| DetectingEntityChanges |
1 つのエンティティへの変更を検出するときに発生するイベントは、 DetectChanges() または DetectChanges()を明示的に呼び出すか、 SaveChanges() または SaveChangesAsync(CancellationToken)の実行の一部など、自動的に発生します。 |
| StateChanged |
関連付けられた DbContext によって追跡されるエンティティが、ある EntityState から別のに移動したときに発生するイベント。 |
| StateChanging |
関連付けられた DbContext によって追跡されるエンティティが、ある EntityState から別のに移動しているときに発生するイベント。 |
| Tracked |
エンティティが追跡クエリから返されたか、コンテキストにアタッチまたは追加されたために、エンティティがコンテキストによって追跡されたときに発生するイベント。 |
| Tracking |
エンティティが追跡クエリから返されるか、コンテキストにアタッチまたは追加されているために、エンティティがコンテキストによって追跡されようとしているときに発生します。 |
明示的なインターフェイスの実装
| Name | 説明 |
|---|---|
| IInfrastructure<IStateManager>.Instance |
古い.
追跡対象エンティティに関する情報を格納するために使用される内部状態マネージャーを取得します。 このプロパティは、拡張メソッドで使用するためのものです。 これは、アプリケーション コードで使用することを意図したものではありません。 |
| IResettableService.ResetState() |
プールから使用できるようにサービスをリセットします。 |
| IResettableService.ResetStateAsync(CancellationToken) |
コンテキストが追跡しているエンティティ インスタンスの変更追跡情報と操作へのアクセスを提供します。 このクラスのインスタンスは通常、 ChangeTracker から取得され、アプリケーション コードで直接構築するようには設計されていません。 |
拡張メソッド
| Name | 説明 |
|---|---|
| GetInfrastructure<T>(IInfrastructure<T>) |
IInfrastructure<T>を使用して非表示になっているプロパティから値を取得します。 このメソッドは、通常、データベース プロバイダー (およびその他の拡張機能) によって使用されます。 通常、アプリケーション コードでは使用されません。 |
| ToDebugString(ChangeTracker, ChangeTrackerDebugStringOptions, Int32) |
指定されたメタデータの人間が判読できる表現を作成します。 警告: 返される文字列の形式に依存しないでください。 デバッグ専用に設計されており、リリース間で任意に変更される可能性があります。 |