[ksqlDb.RestApi.Client]: added the IgnoreInDDL function to the Fluent API doc sections #93

Author: tomasfabian

docs/modelbuilder.md

@@ -349,13 +349,13 @@ var restApiClientOptions = new KSqlDBRestApiClientOptions
   ShouldPluralizeFromItemName = false,
 };
 
-var restApiClient = new KSqlDbRestApiClient(httpClientFactory, restApiClientOptions);
-
 var modelBuilder = new ModelBuilder();
 modelBuilder.Entity<Actor>()
   .Property(c => c.Name)
   .IgnoreInDML();
 
+var restApiClient = new KSqlDbRestApiClient(httpClientFactory, modelBuilder, restApiClientOptions);
+
 var actor = new Actor { Id = 1, Name = "Matthew David McConaughey" };
 
 var ksql = restApiClient.ToInsertStatement(actor);
@@ -367,3 +367,65 @@ INSERT INTO Actor (Id) VALUES (1);
 ```
 
 `WithHeaders` internally automatically marks the property to be ignored in DML statements.
+
+
+### IgnoreInDDL
+**v6.4.0**
+
+The purpose of the `IgnoreInDDL` function is to exclude specific fields from CREATE statements.
+
+```C#
+using System.ComponentModel.DataAnnotations;
+
+public record Record
+{
+  public int Id { get; set; }
+
+  public string Title { get; set; }
+
+  [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' );
+```

ksqlDb.RestApi.Client/ChangeLog.md

@@ -2,11 +2,13 @@
 
 # 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`.
 
 # 6.3.0
 - added `AsStruct` function to the Fluent API for marking fields as ksqldb `STRUCT` types #89 (proposed by @mrt181)