Created factory methods in IEntityPropertiesProvider to get better IntelliSense support.

Author: PawelGerr

samples/Thinktecture.EntityFrameworkCore.SqlServer.Samples/Program.cs

@@ -193,7 +193,7 @@ private static async Task DoBulkInsertSpecifiedColumnsIntoRealTableAsync(DemoDbC
       // alternative ways to specify the column:
       // * c => new { c.Id }
       // * c => c.Id
-      // * new SqlBulkInsertOptions { PropertiesProvider = PropertiesProvider.From<Customer>(c => new { c.Id })}
+      // * new SqlServerBulkInsertOptions { PropertiesToInsert = IPropertiesProvider.Include<Customer>(c => new { c.Id })}
       await ctx.BulkInsertAsync(new[] { customersToInsert }, c => new { c.Id });
 
       var insertedCustomer = await ctx.Customers.FirstAsync(c => c.Id == customersToInsert.Id);

samples/Thinktecture.EntityFrameworkCore.Sqlite.Samples/Program.cs

@@ -1,5 +1,6 @@
 using Microsoft.Extensions.DependencyInjection;
 using Thinktecture.Database;
+using Thinktecture.EntityFrameworkCore.BulkOperations;
 
 namespace Thinktecture;
 
@@ -139,7 +140,7 @@ private static async Task DoBulkInsertSpecifiedColumnsIntoRealTableAsync(DemoDbC
       // alternative ways to specify the column:
       // * c => new { c.Id }
       // * c => c.Id
-      // * new SqlBulkInsertOptions { PropertiesProvider = PropertiesProvider.From<Customer>(c => new { c.Id })}
+      // * new SqliteBulkInsertOptions { PropertiesToInsert = IPropertiesProvider.Include<Customer>(c => new { c.Id })}
       await ctx.BulkInsertAsync(new[] { customersToInsert }, c => new { c.Id, c.FirstName, c.LastName });
 
       var insertedCustomer = await ctx.Customers.FirstAsync(c => c.Id == customersToInsert.Id);

src/Thinktecture.EntityFrameworkCore.BulkOperations/EntityFrameworkCore/BulkOperations/DefaultPropertiesEntityPropertiesProvider.cs

@@ -0,0 +1,51 @@
+using Microsoft.EntityFrameworkCore.Metadata;
+using Thinktecture.EntityFrameworkCore.Data;
+
+namespace Thinktecture.EntityFrameworkCore.BulkOperations;
+
+internal class DefaultPropertiesEntityPropertiesProvider : IEntityPropertiesProvider
+{
+   public IReadOnlyList<PropertyWithNavigations> GetPropertiesForTempTable(IEntityType entityType, bool? inlinedOwnTypes)
+   {
+      return DetermineProperties(entityType, inlinedOwnTypes, IEntityPropertiesProvider.TempTableFilter);
+   }
+
+   public IReadOnlyList<PropertyWithNavigations> GetKeyProperties(IEntityType entityType, bool? inlinedOwnTypes)
+   {
+      var pk = entityType.FindPrimaryKey()?.Properties;
+
+      if (pk is null or { Count: 0 })
+         throw new InvalidOperationException($"The entity '{entityType.Name}' has no primary key. Please provide key properties to perform JOIN/match on.");
+
+      return pk.Select(p => new PropertyWithNavigations(p, Array.Empty<INavigation>())).ToList();
+   }
+
+   public IReadOnlyList<PropertyWithNavigations> GetPropertiesForInsert(IEntityType entityType, bool? inlinedOwnTypes)
+   {
+      return DetermineProperties(entityType, inlinedOwnTypes, IEntityPropertiesProvider.InsertAndUpdateFilter);
+   }
+
+   public IReadOnlyList<PropertyWithNavigations> GetPropertiesForUpdate(IEntityType entityType, bool? inlinedOwnTypes)
+   {
+      return DetermineProperties(entityType, inlinedOwnTypes, IEntityPropertiesProvider.InsertAndUpdateFilter);
+   }
+
+   private static IReadOnlyList<PropertyWithNavigations> DetermineProperties(
+      IEntityType entityType,
+      bool? inlinedOwnTypes,
+      Func<IProperty, IReadOnlyList<INavigation>, bool> filter)
+   {
+      var properties = entityType.GetProperties()
+                                 .Where(p => filter(p, Array.Empty<INavigation>()))
+                                 .Select(p => new PropertyWithNavigations(p, Array.Empty<INavigation>()))
+                                 .ToList();
+
+      foreach (var navigation in entityType.GetOwnedTypesProperties(inlinedOwnTypes))
+      {
+         var navigations = new[] { navigation };
+         properties.AddPropertiesAndOwnedTypesRecursively(navigation.TargetEntityType, navigations, inlinedOwnTypes, filter);
+      }
+
+      return properties;
+   }
+}

src/Thinktecture.EntityFrameworkCore.BulkOperations/EntityFrameworkCore/BulkOperations/EntityPropertiesProvider.cs

@@ -1,75 +1,13 @@
 using System.Linq.Expressions;
-using System.Reflection;
-using Microsoft.EntityFrameworkCore.Metadata;
-using Thinktecture.EntityFrameworkCore.Data;
 
 namespace Thinktecture.EntityFrameworkCore.BulkOperations;
 
 /// <summary>
-/// Provides entity properties to work with.
+/// Obsolete class for backwards compatibility.
 /// </summary>
-public sealed class EntityPropertiesProvider : IEntityPropertiesProvider
+[Obsolete($"This class is obsolete. Please use factory methods defined on '{nameof(IEntityPropertiesProvider)}' instead.", DiagnosticId = "TTEF1000")]
+public sealed class EntityPropertiesProvider
 {
-   private readonly IReadOnlyList<MemberInfo> _members;
-
-   /// <summary>
-   /// <see cref="IEntityPropertiesProvider"/> with 0 properties.
-   /// </summary>
-   public static readonly IEntityPropertiesProvider Empty = new EntityPropertiesProvider(Array.Empty<MemberInfo>());
-
-   /// <summary>
-   /// Initializes new instance of <see cref="EntityPropertiesProvider"/>.
-   /// </summary>
-   /// <param name="members">Members to use.</param>
-   public EntityPropertiesProvider(IReadOnlyList<MemberInfo> members)
-   {
-      _members = members ?? throw new ArgumentNullException(nameof(members));
-   }
-
-   /// <inheritdoc />
-   public IReadOnlyList<PropertyWithNavigations> GetPropertiesForTempTable(
-      IEntityType entityType,
-      bool? inlinedOwnTypes,
-      Func<IProperty, IReadOnlyList<INavigation>, bool> filter)
-   {
-      return GetProperties(entityType, inlinedOwnTypes, filter);
-   }
-
-   /// <inheritdoc />
-   public IReadOnlyList<PropertyWithNavigations> GetKeyProperties(
-      IEntityType entityType,
-      bool? inlinedOwnTypes,
-      Func<IProperty, IReadOnlyList<INavigation>, bool> filter)
-   {
-      return GetProperties(entityType, inlinedOwnTypes, filter);
-   }
-
-   /// <inheritdoc />
-   public IReadOnlyList<PropertyWithNavigations> GetPropertiesForInsert(
-      IEntityType entityType,
-      bool? inlinedOwnTypes,
-      Func<IProperty, IReadOnlyList<INavigation>, bool> filter)
-   {
-      return GetProperties(entityType, inlinedOwnTypes, filter);
-   }
-
-   /// <inheritdoc />
-   public IReadOnlyList<PropertyWithNavigations> GetPropertiesForUpdate(
-      IEntityType entityType,
-      bool? inlinedOwnTypes,
-      Func<IProperty, IReadOnlyList<INavigation>, bool> filter)
-   {
-      return GetProperties(entityType, inlinedOwnTypes, filter);
-   }
-
-   private IReadOnlyList<PropertyWithNavigations> GetProperties(
-      IEntityType entityType,
-      bool? inlinedOwnTypes,
-      Func<IProperty, IReadOnlyList<INavigation>, bool> filter)
-   {
-      return _members.ConvertToEntityProperties(entityType, inlinedOwnTypes, filter);
-   }
-
    /// <summary>
    /// Extracts members from the provided <paramref name="projection"/>.
    /// </summary>
@@ -79,12 +17,9 @@ private IReadOnlyList<PropertyWithNavigations> GetProperties(
    /// <exception cref="ArgumentNullException"><paramref name="projection"/> is <c>null</c>.</exception>
    /// <exception cref="ArgumentException">No members couldn't be extracted.</exception>
    /// <exception cref="NotSupportedException">The <paramref name="projection"/> contains unsupported expressions.</exception>
+   [Obsolete($"This method is obsolete. Please use '{nameof(IEntityPropertiesProvider)}.{nameof(IEntityPropertiesProvider.Include)}' instead.", DiagnosticId = "TTEF1000")]
    public static IEntityPropertiesProvider From<T>(Expression<Func<T, object?>> projection)
    {
-      ArgumentNullException.ThrowIfNull(projection);
-
-      var members = projection.ExtractMembers();
-
-      return members.Count == 0 ? Empty : new EntityPropertiesProvider(members);
+      return IEntityPropertiesProvider.Include(projection);
    }
 }

src/Thinktecture.EntityFrameworkCore.BulkOperations/EntityFrameworkCore/BulkOperations/ExcludingEntityPropertiesProvider.cs

@@ -0,0 +1,41 @@
+using System.Reflection;
+using Microsoft.EntityFrameworkCore.Metadata;
+using Thinktecture.EntityFrameworkCore.Data;
+
+namespace Thinktecture.EntityFrameworkCore.BulkOperations;
+
+internal sealed class ExcludingEntityPropertiesProvider : IEntityPropertiesProvider
+{
+   private readonly IReadOnlyList<MemberInfo> _members;
+
+   public ExcludingEntityPropertiesProvider(IReadOnlyList<MemberInfo> members)
+   {
+      _members = members ?? throw new ArgumentNullException(nameof(members));
+   }
+
+   public IReadOnlyList<PropertyWithNavigations> GetPropertiesForTempTable(IEntityType entityType, bool? inlinedOwnTypes)
+   {
+      return Filter(IEntityPropertiesProvider.Default.GetPropertiesForTempTable(entityType, inlinedOwnTypes));
+   }
+
+   private IReadOnlyList<PropertyWithNavigations> Filter(IReadOnlyList<PropertyWithNavigations> properties)
+   {
+      return properties.Where(p => _members.All(m => m != p.Property.PropertyInfo && m != p.Property.FieldInfo))
+                       .ToList();
+   }
+
+   public IReadOnlyList<PropertyWithNavigations> GetKeyProperties(IEntityType entityType, bool? inlinedOwnTypes)
+   {
+      return Filter(IEntityPropertiesProvider.Default.GetKeyProperties(entityType, inlinedOwnTypes));
+   }
+
+   public IReadOnlyList<PropertyWithNavigations> GetPropertiesForInsert(IEntityType entityType, bool? inlinedOwnTypes)
+   {
+      return Filter(IEntityPropertiesProvider.Default.GetPropertiesForInsert(entityType, inlinedOwnTypes));
+   }
+
+   public IReadOnlyList<PropertyWithNavigations> GetPropertiesForUpdate(IEntityType entityType, bool? inlinedOwnTypes)
+   {
+      return Filter(IEntityPropertiesProvider.Default.GetPropertiesForUpdate(entityType, inlinedOwnTypes));
+   }
+}

src/Thinktecture.EntityFrameworkCore.BulkOperations/EntityFrameworkCore/BulkOperations/IEntityPropertiesProvider.cs

@@ -1,3 +1,5 @@
+using System.Linq.Expressions;
+using System.Reflection;
 using Microsoft.EntityFrameworkCore.Metadata;
 using Thinktecture.EntityFrameworkCore.Data;
 
@@ -8,51 +10,101 @@ namespace Thinktecture.EntityFrameworkCore.BulkOperations;
 /// </summary>
 public interface IEntityPropertiesProvider
 {
+   /// <summary>
+   /// An <see cref="IEntityPropertiesProvider"/> with 0 properties.
+   /// </summary>
+   public static readonly IEntityPropertiesProvider Empty = new IncludingEntityPropertiesProvider(Array.Empty<MemberInfo>());
+
+   /// <summary>
+   /// An <see cref="IEntityPropertiesProvider"/> with all properties of an entity.
+   /// </summary>
+   public static readonly IEntityPropertiesProvider Default = new DefaultPropertiesEntityPropertiesProvider();
+
+   /// <summary>
+   /// Creates a new <see cref="IEntityPropertiesProvider"/> with specified <paramref name="members"/>.
+   /// </summary>
+   /// <param name="members">Members to create the provider for.</param>
+   /// <returns>A new instance of <see cref="IEntityPropertiesProvider"/>.</returns>
+   public static IEntityPropertiesProvider Include(IReadOnlyList<MemberInfo> members)
+   {
+      return new IncludingEntityPropertiesProvider(members);
+   }
+
+   /// <summary>
+   /// Extracts members from the provided <paramref name="projection"/> and creates an <see cref="IEntityPropertiesProvider"/>
+   /// which provides the specified members to the callers.
+   /// </summary>
+   /// <param name="projection">Projection to extract the members from.</param>
+   /// <typeparam name="T">Type of the entity.</typeparam>
+   /// <returns>An instance of <see cref="IEntityPropertiesProvider"/> containing members extracted from <paramref name="projection"/>.</returns>
+   /// <exception cref="ArgumentNullException"><paramref name="projection"/> is <c>null</c>.</exception>
+   /// <exception cref="ArgumentException">No members couldn't be extracted.</exception>
+   /// <exception cref="NotSupportedException">The <paramref name="projection"/> contains unsupported expressions.</exception>
+   public static IEntityPropertiesProvider Include<T>(Expression<Func<T, object?>> projection)
+   {
+      ArgumentNullException.ThrowIfNull(projection);
+
+      var members = projection.ExtractMembers();
+
+      return members.Count == 0 ? Empty : new IncludingEntityPropertiesProvider(members);
+   }
+
+   /// <summary>
+   /// Extracts members from the provided <paramref name="projection"/> and creates an <see cref="IEntityPropertiesProvider"/>
+   /// which provides all properties of the corresponding entity besides the specified members.
+   /// </summary>
+   /// <param name="projection"></param>
+   /// <typeparam name="T"></typeparam>
+   /// <returns></returns>
+   public static IEntityPropertiesProvider Exclude<T>(Expression<Func<T, object?>> projection)
+   {
+      ArgumentNullException.ThrowIfNull(projection);
+
+      var members = projection.ExtractMembers();
+
+      return members.Count == 0 ? Default : new ExcludingEntityPropertiesProvider(members);
+   }
+
    /// <summary>
    /// Determines properties to include into a temp table into.
    /// </summary>
    /// <param name="entityType">Entity type.</param>
    /// <param name="inlinedOwnTypes">Indication whether inlined (<c>true</c>), separated (<c>false</c>) or all owned types to return.</param>
-   /// <param name="filter">Filter.</param>
    /// <returns>Properties to include into a temp table.</returns>
-   IReadOnlyList<PropertyWithNavigations> GetPropertiesForTempTable(
-      IEntityType entityType,
-      bool? inlinedOwnTypes,
-      Func<IProperty, IReadOnlyList<INavigation>, bool> filter);
+   IReadOnlyList<PropertyWithNavigations> GetPropertiesForTempTable(IEntityType entityType, bool? inlinedOwnTypes);
 
    /// <summary>
    /// Determines properties to include into a temp table into.
    /// </summary>
    /// <param name="entityType">Entity type.</param>
    /// <param name="inlinedOwnTypes">Indication whether inlined (<c>true</c>), separated (<c>false</c>) or all owned types to return.</param>
-   /// <param name="filter">Filter.</param>
    /// <returns>Properties to include into a temp table.</returns>
-   IReadOnlyList<PropertyWithNavigations> GetKeyProperties(
-      IEntityType entityType,
-      bool? inlinedOwnTypes,
-      Func<IProperty, IReadOnlyList<INavigation>, bool> filter);
+   IReadOnlyList<PropertyWithNavigations> GetKeyProperties(IEntityType entityType, bool? inlinedOwnTypes);
 
    /// <summary>
    /// Determines properties to insert into a (temp) table.
    /// </summary>
    /// <param name="entityType">Entity type.</param>
    /// <param name="inlinedOwnTypes">Indication whether inlined (<c>true</c>), separated (<c>false</c>) or all owned types to return.</param>
-   /// <param name="filter">Filter.</param>
    /// <returns>Properties to insert into a (temp) table.</returns>
-   IReadOnlyList<PropertyWithNavigations> GetPropertiesForInsert(
-      IEntityType entityType,
-      bool? inlinedOwnTypes,
-      Func<IProperty, IReadOnlyList<INavigation>, bool> filter);
+   IReadOnlyList<PropertyWithNavigations> GetPropertiesForInsert(IEntityType entityType, bool? inlinedOwnTypes);
 
    /// <summary>
    /// Determines properties to use in update of a table.
    /// </summary>
    /// <param name="entityType">Entity type.</param>
    /// <param name="inlinedOwnTypes">Indication whether inlined (<c>true</c>), separated (<c>false</c>) or all owned types to return.</param>
-   /// <param name="filter">Filter.</param>
    /// <returns>Properties to use in update of a table.</returns>
-   IReadOnlyList<PropertyWithNavigations> GetPropertiesForUpdate(
-      IEntityType entityType,
-      bool? inlinedOwnTypes,
-      Func<IProperty, IReadOnlyList<INavigation>, bool> filter);
+   IReadOnlyList<PropertyWithNavigations> GetPropertiesForUpdate(IEntityType entityType, bool? inlinedOwnTypes);
+
+   internal static bool TempTableFilter(IProperty property, IReadOnlyList<INavigation> navigations)
+   {
+      return navigations.Count == 0 || !property.IsKey();
+   }
+
+   internal static bool InsertAndUpdateFilter(IProperty property, IReadOnlyList<INavigation> navigations)
+   {
+      return property.GetBeforeSaveBehavior() != PropertySaveBehavior.Ignore &&
+             (navigations.Count == 0 || !navigations[^1].IsInlined() || !property.IsKey());
+   }
 }

src/Thinktecture.EntityFrameworkCore.BulkOperations/EntityFrameworkCore/BulkOperations/IncludingEntityPropertiesProvider.cs

@@ -0,0 +1,43 @@
+using System.Reflection;
+using Microsoft.EntityFrameworkCore.Metadata;
+using Thinktecture.EntityFrameworkCore.Data;
+
+namespace Thinktecture.EntityFrameworkCore.BulkOperations;
+
+internal sealed class IncludingEntityPropertiesProvider : IEntityPropertiesProvider
+{
+   private readonly IReadOnlyList<MemberInfo> _members;
+
+   public IncludingEntityPropertiesProvider(IReadOnlyList<MemberInfo> members)
+   {
+      _members = members ?? throw new ArgumentNullException(nameof(members));
+   }
+
+   public IReadOnlyList<PropertyWithNavigations> GetPropertiesForTempTable(IEntityType entityType, bool? inlinedOwnTypes)
+   {
+      return GetProperties(entityType, inlinedOwnTypes, IEntityPropertiesProvider.TempTableFilter);
+   }
+
+   public IReadOnlyList<PropertyWithNavigations> GetKeyProperties(IEntityType entityType, bool? inlinedOwnTypes)
+   {
+      return GetProperties(entityType, inlinedOwnTypes, static (_, _) => true);
+   }
+
+   public IReadOnlyList<PropertyWithNavigations> GetPropertiesForInsert(IEntityType entityType, bool? inlinedOwnTypes)
+   {
+      return GetProperties(entityType, inlinedOwnTypes, IEntityPropertiesProvider.InsertAndUpdateFilter);
+   }
+
+   public IReadOnlyList<PropertyWithNavigations> GetPropertiesForUpdate(IEntityType entityType, bool? inlinedOwnTypes)
+   {
+      return GetProperties(entityType, inlinedOwnTypes, IEntityPropertiesProvider.InsertAndUpdateFilter);
+   }
+
+   private IReadOnlyList<PropertyWithNavigations> GetProperties(
+      IEntityType entityType,
+      bool? inlinedOwnTypes,
+      Func<IProperty, IReadOnlyList<INavigation>, bool> filter)
+   {
+      return _members.ConvertToEntityProperties(entityType, inlinedOwnTypes, filter);
+   }
+}