[ksqlDb.RestApi.Client]: a RowTime field or property in the registered entities will be automatically marked to be ignored in DDL statements. #93

Author: tomasfabian

Tests/ksqlDB.RestApi.Client.Tests/FluentAPI/Builders/ModelBuilderTests.cs

@@ -101,6 +101,26 @@ public void Property_IgnoreInDDL()
       entityMetadata!.FieldsMetadata.First(c => c.MemberInfo.Name == nameof(Payment.Description)).IgnoreInDDL.Should().BeTrue();
     }
 
+    public class RecordExt : ksqlDB.RestApi.Client.KSql.Query.Record
+    {
+      public string Title { get; set; }
+    }
+
+    [Test]
+    public void RowTime_PropertyConvention_IgnoreInDDL()
+    {
+      //Arrange
+
+      //Act
+      var fieldTypeBuilder = builder.Entity<RecordExt>();
+
+      //Assert
+      fieldTypeBuilder.Should().NotBeNull();
+      var entityMetadata = ((IMetadataProvider)builder).GetEntities().FirstOrDefault(c => c.Type == typeof(RecordExt));
+      entityMetadata.Should().NotBeNull();
+      entityMetadata!.FieldsMetadata.First(c => c.MemberInfo.Name == nameof(RecordExt.RowTime)).IgnoreInDDL.Should().BeTrue();
+    }
+
     [Test]
     public void Property_HasColumnName()
     {
@@ -141,6 +161,30 @@ public void MultiplePropertiesForSameType()
       entityMetadata.FieldsMetadata.First(c => c.MemberInfo.Name == nameof(Payment.Amount)).Ignore.Should().BeTrue();
     }
 
+    [Test]
+    public void MultipleMappingsForSameProperty()
+    {
+      //Arrange
+      string columnName = "alter";
+
+      //Act
+      var fieldTypeBuilder = builder.Entity<Payment>()
+        .Property(b => b.Description)
+        .HasColumnName(columnName);
+
+      builder.Entity<Payment>()
+        .Property(b => b.Description)
+        .IgnoreInDML();
+
+      //Assert
+      fieldTypeBuilder.Should().NotBeNull();
+      var entityMetadata = ((IMetadataProvider)builder).GetEntities().FirstOrDefault(c => c.Type == typeof(Payment));
+      entityMetadata.Should().NotBeNull();
+      var fieldMetadata = entityMetadata!.FieldsMetadata.First(c => c.MemberInfo.Name == nameof(Payment.Description));
+      fieldMetadata.ColumnName.Should().Be(columnName);
+      fieldMetadata.IgnoreInDML.Should().BeTrue();
+    }
+
     [Test]
     public void Property_IgnoreNestedField()
     {

docs/modelbuilder.md

@@ -369,63 +369,25 @@ INSERT INTO Actor (Id) VALUES (1);
 `WithHeaders` internally automatically marks the property to be ignored in DML statements.
 
 
-### IgnoreInDDL
+### RowTime
 **v6.4.0**
 
-The purpose of the `IgnoreInDDL` function is to exclude specific fields from CREATE statements.
+The `RowTime` property in the registered `Record` entity will be automatically excluded from `CREATE` statements based on its name convention and `long` type.
 
 ```C#
-using System.ComponentModel.DataAnnotations;
+using ksqlDB.RestApi.Client.KSql.RestApi.Statements.Annotations;
 
-public record Record
+public class Record
 {
-  public int Id { get; set; }
-
-  public string Title { get; set; }
-
+  /// <summary>
+  /// Row timestamp, inferred from the underlying Kafka record if not overridden.
+  /// </summary>
   [PseudoColumn]
   public long RowTime { get; set; }
 }
 ```
 
 ```C#
-using ksqlDb.RestApi.Client.FluentAPI.Builders;
-using ksqlDB.RestApi.Client.KSql.Query.Context;
-using ksqlDB.RestApi.Client.KSql.RestApi;
-using ksqlDB.RestApi.Client.KSql.RestApi.Http;
-
-var ksqlDbUrl = "http://localhost:8088";
-
-var httpClientFactory = new HttpClientFactory(new HttpClient() { BaseAddress = new Uri(ksqlDbUrl) });
-
-var restApiClientOptions = new KSqlDBRestApiClientOptions
-{
-  ShouldPluralizeFromItemName = false,
-};
-
 var modelBuilder = new ModelBuilder();
-modelBuilder.Entity<Record>()
-  .HasKey(c => c.Id);
-
-modelBuilder.Entity<Record>()
-  .Property(c => c.RowTime)
-  .IgnoreInDDL();
-
-var restApiClient = new KSqlDbRestApiClient(httpClientFactory, modelBuilder, restApiClientOptions);
-
-EntityCreationMetadata metadata = new(kafkaTopic: nameof(Record))
-{
-  Partitions = 3,
-  Replicas = 3
-};
-
-var httpResponseMessage = await restApiClient.CreateOrReplaceStreamAsync<Record>(metadata);
-```
-
-Generated DDL:
-```SQL
-CREATE OR REPLACE STREAM Record (
-	Id INT KEY,
-	Title VARCHAR
-) WITH ( KAFKA_TOPIC='Record', VALUE_FORMAT='Json', PARTITIONS='3', REPLICAS='3' );
+modelBuilder.Entity<Record>();
 ```

ksqlDb.RestApi.Client/ChangeLog.md

@@ -2,14 +2,14 @@
 
 # 6.4.0
 - added the `IgnoreInDML` function to the Fluent API to exclude fields from INSERT statements #90 (proposed by @mrt181)
-- added the `IgnoreInDDL` function to the Fluent API to exclude fields from INSERT statements with a corresponding `IgnoreInDDLAttribute` #93
 - added `IgnoreAttribute` to prevent properties or fields from being included in both DDL and DML statement
 - `Headers` property was marked as obsolete in the `Record` type
 
 ## BugFix
 - `IgnoreByInsertsAttribute` no longer excludes fields or properties from DDL statements. For this purpose, a new `IgnoreAttribute` has been introduced.
-- the `Record` type's fields `RowOffset` and `RowPartition` were decorated with `IgnoreAttribute` instead of `IgnoreByInsertsAttribute`, and `RowTime` was decorated with `IgnoreInDDLAttribute` instead of `IgnoreByInsertsAttribute`.
- 
+- the `Record` type's fields `RowOffset` and `RowPartition` are decorated with `IgnoreAttribute` instead of `IgnoreByInsertsAttribute`
+- the `Record` type's field `RowTime` is decorated with an internal `IgnoreInDDLAttribute` instead of `IgnoreByInsertsAttribute`
+
 # 6.3.0
 - added `AsStruct` function to the Fluent API for marking fields as ksqldb `STRUCT` types #89 (proposed by @mrt181)
 

ksqlDb.RestApi.Client/FluentAPI/Builders/EntityTypeBuilder.cs

@@ -1,4 +1,6 @@
 using System.Linq.Expressions;
+using System.Reflection;
+using ksqlDB.RestApi.Client.KSql.Query;
 using ksqlDb.RestApi.Client.Metadata;
 
 namespace ksqlDb.RestApi.Client.FluentAPI.Builders
@@ -37,6 +39,8 @@ internal sealed class EntityTypeBuilder<TEntity> : EntityTypeBuilder, IEntityTyp
     public EntityTypeBuilder()
     {
       Metadata.Type = typeof(TEntity);
+
+      IgnoreRowTime();
     }
 
     public IEntityTypeBuilder<TEntity> HasKey<TProperty>(Expression<Func<TEntity, TProperty>> getProperty)
@@ -54,12 +58,16 @@ public IFieldTypeBuilder<TProperty> Property<TProperty>(Expression<Func<TEntity,
       foreach (var (memberName, memberInfo) in members)
       {
         path += memberName;
-        var fieldMetadata = new FieldMetadata()
+
+        if (!Metadata.FieldsMetadataDict.TryGetValue(memberInfo, out var fieldMetadata))
         {
-          MemberInfo = memberInfo,
-          Path = memberName,
-          FullPath = path,
-        };
+          fieldMetadata = new FieldMetadata()
+          {
+            MemberInfo = memberInfo,
+            Path = memberName,
+            FullPath = path,
+          };
+        }
 
         switch (typeof(TProperty))
         {
@@ -84,5 +92,45 @@ public IFieldTypeBuilder<TProperty> Property<TProperty>(Expression<Func<TEntity,
 
       return builder;
     }
+
+    private readonly BindingFlags bindingFlags = BindingFlags.Public | BindingFlags.Instance;
+    private readonly Type longType = typeof(long);
+    private readonly string rowTime = nameof(Record.RowTime);
+
+    internal void IgnoreRowTime()
+    {
+      var props = Metadata.Type.GetProperties(bindingFlags)
+        .Where(p => p.Name == rowTime && p.PropertyType == longType);
+
+      MemberInfo? propertyInfo = props.FirstOrDefault();
+      if (propertyInfo != null)
+      {
+        AddFieldMetadata(propertyInfo);
+        return;
+      }
+
+      var fields = Metadata.Type.GetFields(bindingFlags)
+        .Where(p => p.Name == rowTime && p.FieldType == longType);
+
+      MemberInfo? fieldInfo = fields.FirstOrDefault();
+
+      if (fieldInfo != null)
+      {
+        AddFieldMetadata(fieldInfo);
+      }
+    }
+
+    private void AddFieldMetadata(MemberInfo memberInfo)
+    {
+      var fieldMetadata = new FieldMetadata
+      {
+        MemberInfo = memberInfo,
+        Path = memberInfo.Name,
+        FullPath = memberInfo.Name,
+        IgnoreInDDL = true
+      };
+
+      Metadata.FieldsMetadataDict[memberInfo] = fieldMetadata;
+    }
   }
 }

ksqlDb.RestApi.Client/FluentAPI/Builders/FieldTypeBuilder.cs

@@ -19,7 +19,7 @@ public interface IFieldTypeBuilder<TProperty>
     /// Marks the field to be excluded from data manipulation operations, preventing it from being included in DML statements such as INSERT.
     /// </summary>
     /// <returns>The field type builder for chaining additional configuration.</returns>
-    public IFieldTypeBuilder<TProperty> IgnoreInDML();
+    internal IFieldTypeBuilder<TProperty> IgnoreInDML();
 
     /// <summary>
     /// Marks the field to be excluded from data definition operations, preventing it from being included in DDL statements such as CREATE STREAM or TABLE.

ksqlDb.RestApi.Client/KSql/RestApi/Statements/Annotations/IgnoreInDDLAttribute.cs

@@ -1,4 +1,4 @@
 [AttributeUsage(AttributeTargets.Field | AttributeTargets.Property, AllowMultiple = false, Inherited = true)]
-public sealed class IgnoreInDDLAttribute : Attribute
+internal sealed class IgnoreInDDLAttribute : Attribute
 {
 }

ksqlDb.RestApi.Client/Metadata/FieldMetadata.cs

@@ -20,7 +20,7 @@ public FieldMetadata(FieldMetadata fieldMetadata)
     internal MemberInfo MemberInfo { get; init; } = null!;
     public bool Ignore { get; internal set; }
     public bool IgnoreInDML { get; internal set; }
-    public bool IgnoreInDDL { get; internal set; }
+    internal bool IgnoreInDDL { get; set; }
     public bool HasHeaders { get; internal set; }
     internal bool IsStruct { get; set; }
     internal string Path { get; init; } = null!;