change database.exclude to include tables and columns

Author: pwelter34

README.md

@@ -155,6 +155,28 @@ Entity Framework Core Generator supports generating [Read](https://efg.loresoft.
 
 ## Change Log
 
+### Version 7.0
+
+- support for .net 9
+- update project to use nullable reference types
+- Breaking change to configuration file.  The `database.exclude` section now has a `database.exclude.tables` and `database.exclude.columns` section.  
+
+configuration file update example:
+
+```YAML
+database:
+  # exclude tables or columns
+  exclude:
+    # list of expressions for tables to exclude, source is Schema.TableName
+    tables:
+      - exact: dbo.SchemaVersions
+      - regex: dbo\.SchemaVersions$
+    # list of expressions for columns to exclude, source is Schema.TableName.ColumnName
+    columns:
+      - exact: dbo.User.Password
+      - regex: dbo\.User\.Password$
+```
+
 ### Version 6.0
 
 - upgrade to .net 8

docs/configuration.md

@@ -46,10 +46,17 @@ database:
   schemas:
     - dbo
 
-  # list of expressions for tables to exclude, source is Schema.TableName
+  # exclude tables or columns: Changed in v7.x
   exclude:
-    - exact: dbo.SchemaVersions
-    - regex: dbo\.SchemaVersions$
+    # list of expressions for tables to exclude, source is Schema.TableName
+    tables:
+      - exact: dbo.SchemaVersions
+      - regex: dbo\.SchemaVersions$
+    # list of expressions for columns to exclude, source is Schema.TableName.ColumnName
+    columns:
+      - exact: dbo.User.Password
+      - regex: dbo\.User\.Password$
+
 
   # table naming hint for how existing tables are named.  Default: Singular
   tableNaming: Mixed|Plural|Singular

sample/Tracker/Tracker.Core/generation.yml

@@ -7,7 +7,8 @@ database:
   provider: SqlServer
   connectionString: Data Source=(local);Initial Catalog=Tracker;Integrated Security=True;TrustServerCertificate=True
   exclude:
-    - exact: 'dbo.SchemaVersions'
+    tables:
+      - exact: 'dbo.SchemaVersions'
 data:
   context:
     name: '{Database.Name}Context'

src/EntityFrameworkCore.Generator.Core/ModelGenerator.cs

@@ -67,7 +67,7 @@ public EntityContext Generate(GeneratorOptions options, DatabaseModel databaseMo
 
         foreach (var table in tables)
         {
-            if (IsIgnored(table, _options.Database.Exclude))
+            if (IsIgnored(table, _options.Database.Exclude.Tables))
             {
                 _logger.LogDebug("  Skipping Table : {schema}.{name}", table.Schema, table.Name);
                 continue;
@@ -175,6 +175,11 @@ private void CreateProperties(Entity entity, DatabaseTable tableSchema)
         foreach (var column in columns)
         {
             var table = column.Table;
+            if (IsIgnored(column, _options.Database.Exclude.Columns))
+            {
+                _logger.LogDebug("  Skipping Column : {Schema}.{Table}.{Column}", table.Schema, table.Name, column.Name);
+                continue;
+            }
 
             var mapping = column.StoreType.HasValue() ? _typeMapper.FindMapping(column.StoreType) : null;
             if (mapping == null)
@@ -309,7 +314,7 @@ private void CreateRelationships(EntityContext entityContext, Entity entity, Dat
         foreach (var foreignKey in tableSchema.ForeignKeys)
         {
             // skip relationship if principal table is ignored
-            if (IsIgnored(foreignKey.PrincipalTable, _options.Database.Exclude))
+            if (IsIgnored(foreignKey.PrincipalTable, _options.Database.Exclude.Tables))
             {
                 _logger.LogDebug("  Skipping Relationship : {name}", foreignKey.Name);
                 continue;
@@ -728,6 +733,16 @@ private static bool IsIgnored(DatabaseTable table, IEnumerable<MatchOptions> exc
         return IsIgnored(name, excludeExpressions, includeExpressions);
     }
 
+    private static bool IsIgnored(DatabaseColumn column, IEnumerable<MatchOptions> exclude)
+    {
+        var table = column.Table;
+        var name = $"{table.Schema}.{table.Name}.{column.Name}";
+        var includeExpressions = Enumerable.Empty<MatchOptions>();
+        var excludeExpressions = exclude ?? [];
+
+        return IsIgnored(name, excludeExpressions, includeExpressions);
+    }
+
     private static bool IsIgnored<TOption>(Property property, TOption options, SharedModelOptions sharedOptions)
         where TOption : ModelOptionsBase
     {

src/EntityFrameworkCore.Generator.Core/OptionMapper.cs

@@ -186,11 +186,8 @@ private static void MapDatabase(DatabaseOptions option, DatabaseModel database)
 
         MapList(option.Tables, database.Tables);
         MapList(option.Schemas, database.Schemas);
-        MapList(option.Exclude, database.Exclude, (match) =>
-        {
-            var prefix = OptionsBase.AppendPrefix(option.Prefix, $"Exclude{option.Exclude.Count:0000}");
-            return MapMatch(option.Variables, match, prefix);
-        });
+
+        MapDatabaseMatch(option.Exclude, database.Exclude);
     }
 
     private static void MapProject(ProjectOptions option, ProjectModel project)
@@ -201,6 +198,23 @@ private static void MapProject(ProjectOptions option, ProjectModel project)
         option.FileScopedNamespace = project.FileScopedNamespace;
     }
 
+    private static void MapDatabaseMatch(DatabaseMatchOptions option, DatabaseMatchModel? match)
+    {
+        if (match == null)
+            return;
+
+        MapList(option.Tables, match.Tables, (match) =>
+        {
+            var prefix = OptionsBase.AppendPrefix(option.Prefix, $"Table{option.Tables?.Count:0000}");
+            return MapMatch(option.Variables, match, prefix);
+        });
+
+        MapList(option.Columns, match.Columns, (match) =>
+        {
+            var prefix = OptionsBase.AppendPrefix(option.Prefix, $"Column{option.Columns?.Count:0000}");
+            return MapMatch(option.Variables, match, prefix);
+        });
+    }
 
     private static void MapList<T>(IList<T> targetList, IList<T>? sourceList)
     {

src/EntityFrameworkCore.Generator.Core/Options/DatabaseMatchOptions.cs

@@ -0,0 +1,37 @@
+using EntityFrameworkCore.Generator.Serialization;
+
+namespace EntityFrameworkCore.Generator.Options;
+
+/// <summary>
+/// Represents options for matching database tables and columns during a database operation.
+/// </summary>
+public class DatabaseMatchOptions : OptionsBase
+{
+    /// <summary>
+    /// Represents options for matching database tables and columns during a database operation.
+    /// </summary>
+    /// <param name="variables">A dictionary of variables used to configure the matching options. Cannot be null.</param>
+    /// <param name="prefix">An optional prefix used to filter or qualify the matching criteria. Can be null.</param>
+    public DatabaseMatchOptions(VariableDictionary variables, string? prefix)
+        : base(variables, prefix)
+    {
+        Tables = [];
+        Columns = [];
+    }
+
+    /// <summary>
+    /// Gets or sets a list of regular expression of tables to ignore.
+    /// </summary>
+    /// <value>
+    /// The list of regular expression of tables to ignore.
+    /// </value>
+    public List<MatchOptions> Tables { get; set; }
+
+    /// <summary>
+    /// Gets or sets a list of regular expression of columns to ignore.
+    /// </summary>
+    /// <value>
+    /// The list of regular expression of columns to ignore.
+    /// </value>
+    public List<MatchOptions> Columns { get; set; }
+}

src/EntityFrameworkCore.Generator.Core/Options/DatabaseOptions.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+// Ignore Spelling: Schemas
+
 using System.ComponentModel;
 
 namespace EntityFrameworkCore.Generator.Options;
@@ -20,7 +21,7 @@ public DatabaseOptions(VariableDictionary variables, string? prefix)
         TableNaming = TableNaming.Singular;
         Tables = [];
         Schemas = [];
-        Exclude = [];
+        Exclude = new DatabaseMatchOptions(Variables, Prefix);
     }
 
     /// <summary>
@@ -104,6 +105,6 @@ public string? Name
     /// <value>
     /// The exclude table options.
     /// </value>
-    public List<MatchOptions> Exclude { get; }
+    public DatabaseMatchOptions Exclude { get; }
 
 }

src/EntityFrameworkCore.Generator.Core/Serialization/DatabaseMatchModel.cs

@@ -0,0 +1,23 @@
+namespace EntityFrameworkCore.Generator.Serialization;
+
+/// <summary>
+/// Represents a model that specifies patterns for tables and columns to be ignored during processing.
+/// </summary>
+public class DatabaseMatchModel
+{
+    /// <summary>
+    /// Gets or sets a list of regular expression of tables to ignore.
+    /// </summary>
+    /// <value>
+    /// The list of regular expression of tables to ignore.
+    /// </value>
+    public List<MatchModel>? Tables { get; set; }
+
+    /// <summary>
+    /// Gets or sets a list of regular expression of columns to ignore.
+    /// </summary>
+    /// <value>
+    /// The list of regular expression of columns to ignore.
+    /// </value>
+    public List<MatchModel>? Columns { get; set; }
+}

src/EntityFrameworkCore.Generator.Core/Serialization/DatabaseModel.cs

@@ -72,11 +72,7 @@ public class DatabaseModel
     public List<string>? Schemas { get; set; }
 
     /// <summary>
-    /// Gets or sets the exclude table options.
+    /// Gets or sets the model that specifies which elements should be ignored during processing.
     /// </summary>
-    /// <value>
-    /// The exclude table options.
-    /// </value>
-    public List<MatchModel>? Exclude { get; set; }
-
+    public DatabaseMatchModel? Exclude { get; set; }
 }

src/EntityFrameworkCore.Generator/GenerateCommand.cs

@@ -76,7 +76,7 @@ protected override int OnExecute(CommandLineApplication application)
         if (Validator.HasValue)
             configuration.Model.Validator.Generate = Validator.Value;
 
-        // conver to options format to support variables
+        // convert to options format to support variables
         var options = OptionMapper.Map(configuration);
 
         var result = _codeGenerator.Generate(options);