シャドウ プロパティShadow Properties

シャドウ プロパティは、.NET のエンティティ クラスで定義されていないが、EF Core モデルでは、そのエンティティ型に対して定義されているプロパティ。Shadow properties are properties that are not defined in your .NET entity class but are defined for that entity type in the EF Core model. 純粋な変更の追跡ツールでは、値とこれらのプロパティの状態が維持されます。The value and state of these properties is maintained purely in the Change Tracker.

シャドウ プロパティは、マップされたエンティティ型で公開してはなりませんが、データベース内のデータがある場合に便利です。Shadow properties are useful when there is data in the database that should not be exposed on the mapped entity types. 外部キー プロパティ、2 つのエンティティ間のリレーションシップは、データベース内の外部キー値によって表されますが、リレーションシップがエンティティ型の間のナビゲーション プロパティを使用して、エンティティ型で管理されている、最もよく使用されます。They are most often used for foreign key properties, where the relationship between two entities is represented by a foreign key value in the database, but the relationship is managed on the entity types using navigation properties between the entity types.

シャドウ プロパティの値を入手して使用して変更することができます、 ChangeTracker API。Shadow property values can be obtained and changed through the ChangeTracker API.

   context.Entry(myBlog).Property("LastUpdated").CurrentValue = DateTime.Now;

シャドウ プロパティを使用した LINQ クエリで参照できます、EF.Property静的メソッド。Shadow properties can be referenced in LINQ queries via the EF.Property static method.

var blogs = context.Blogs
    .OrderBy(b => EF.Property<DateTime>(b, "LastUpdated"));

規約Conventions

リレーションシップが検出されますが、依存エンティティ クラスの外部キー プロパティが見つからないときに、慣例シャドウ プロパティを作成できます。Shadow properties can be created by convention when a relationship is discovered but no foreign key property is found in the dependent entity class. この場合、影の外部キー プロパティが導入されます。In this case, a shadow foreign key property will be introduced. シャドウの外部キー プロパティの名前は<navigation property name><principal key property name>(プリンシパル エンティティを指す、依存エンティティのナビゲーションは、名前付けの使用)。The shadow foreign key property will be named <navigation property name><principal key property name> (the navigation on the dependent entity, which points to the principal entity, is used for the naming). かどうかには、プリンシパルのキー プロパティの名前には、ナビゲーション プロパティの名前が含まれていますし、名前になります<principal key property name>します。If the principal key property name includes the name of the navigation property, then the name will just be <principal key property name>. 依存エンティティにナビゲーション プロパティがない場合、プリンシパルの種類名は、その代わりに使用されます。If there is no navigation property on the dependent entity, then the principal type name is used in its place.

たとえば、次のコード リストになります。、BlogIdシャドウ プロパティがに導入される、Postエンティティ。For example, the following code listing will result in a BlogId shadow property being introduced to the Post entity.

class MyContext : DbContext
{
    public DbSet<Blog> Blogs { get; set; }
    public DbSet<Post> Posts { get; set; }
}

public class Blog
{
    public int BlogId { get; set; }
    public string Url { get; set; }

    public List<Post> Posts { get; set; }
}

public class Post
{
    public int PostId { get; set; }
    public string Title { get; set; }
    public string Content { get; set; }

    public Blog Blog { get; set; }
}

データの注釈Data Annotations

シャドウ プロパティを作成して、データ注釈を使用したことはできません。Shadow properties can not be created with data annotations.

Fluent APIFluent API

Fluent API を使用して、シャドウ プロパティを構成することができます。You can use the Fluent API to configure shadow properties. 文字列のオーバー ロードを呼び出した後Property他のプロパティの構成の呼び出しを連結することができます。Once you have called the string overload of Property you can chain any of the configuration calls you would for other properties.

名前が指定されている場合、Propertyメソッド (シャドウ プロパティまたはエンティティ クラスで定義されているいずれか)、既存のプロパティの名前に一致し、コードでは新しいシャドウ プロパティを導入するのではなく、その既存のプロパティを設定します。If the name supplied to the Property method matches the name of an existing property (a shadow property or one defined on the entity class), then the code will configure that existing property rather than introducing a new shadow property.

class MyContext : DbContext
{
    public DbSet<Blog> Blogs { get; set; }

    protected override void OnModelCreating(ModelBuilder modelBuilder)
    {
        modelBuilder.Entity<Blog>()
            .Property<DateTime>("LastUpdated");
    }
}

public class Blog
{
    public int BlogId { get; set; }
    public string Url { get; set; }
}