Merge pull request #106 from mrt181/docs/as-struct

test: tests and docs for nested arrays that should be marked as structs

Author: tomasfabian

Tests/ksqlDB.RestApi.Client.Tests/KSql/RestApi/Generators/StatementGeneratorTests.cs

@@ -193,6 +193,97 @@ public void CreateTable_UseModelBuilder_WithFieldAsStruct()
 	Headers ARRAY<STRUCT<Key VARCHAR, Value BYTES>>
 ) WITH ( KAFKA_TOPIC='my_topic', VALUE_FORMAT='Json', PARTITIONS='3' );".ReplaceLineEndings());
   }
+
+  private record Child : Record
+  {
+    public First[] Firsts { get; init; } = null!;
+  }
+
+  private record First
+  {
+    public Second[] Seconds { get; init; } = null!;
+  }
+
+  private record Second
+  {
+    public string Test { get; init; } = null!;
+  }
+
+  [Test]
+  public void CreateTable_UseModelBuilder_WithNestedArrayFieldAsStruct()
+  {
+    //Arrange
+    var modelBuilder = new ModelBuilder();
+    modelBuilder.Entity<Child>().Property(b => b.Headers).AsStruct();
+    modelBuilder.Entity<Child>().Property(b => b.Firsts).AsStruct();
+    modelBuilder.Entity<Child>().Property(b => b.Firsts.FirstOrDefault()!.Seconds).AsStruct();
+
+    var creationMetadata = new EntityCreationMetadata("my_topic", partitions: 3);
+
+    //Act
+    var statement = new StatementGenerator(modelBuilder).CreateTable<Child>(
+      creationMetadata,
+      ifNotExists: true
+    );
+
+    //Assert
+    statement
+      .Should()
+      .Be(
+        @"CREATE TABLE IF NOT EXISTS Children (
+	Firsts ARRAY<STRUCT<Seconds ARRAY<STRUCT<Test VARCHAR>>>>,
+	Headers ARRAY<STRUCT<Key VARCHAR, Value BYTES>>
+) WITH ( KAFKA_TOPIC='my_topic', VALUE_FORMAT='Json', PARTITIONS='3' );".ReplaceLineEndings()
+      );
+  }
+
+  private class Child2
+  {
+    public First2[] Firsts { get; set; }
+  }
+
+  private class First2
+  {
+    public Second2[] Seconds { get; set; }
+  }
+
+  private class Second2
+  {
+    public Third[] Thirds { get; set; }
+  }
+
+  private class Third
+  {
+    public string Test1 { get; set; }
+    public string Test2 { get; set; }
+  }
+
+  [Test]
+  public void CreateTable_UseModelBuilder_WithNestedArrayFieldAsStruct_2()
+  {
+    //Arrange
+    var modelBuilder = new ModelBuilder();
+    modelBuilder.Entity<Child2>().Property(b => b.Firsts).AsStruct();
+    modelBuilder.Entity<Child2>().Property(b => b.Firsts.FirstOrDefault()!.Seconds).AsStruct();
+    modelBuilder.Entity<Child2>().Property(b => b.Firsts.FirstOrDefault()!.Seconds.FirstOrDefault()!.Thirds).AsStruct();
+
+    var creationMetadata = new EntityCreationMetadata("my_topic", partitions: 3);
+
+    //Act
+    var statement = new StatementGenerator(modelBuilder).CreateTable<Child2>(
+      creationMetadata,
+      ifNotExists: true
+    );
+
+    //Assert
+    statement
+      .Should()
+      .Be(
+        @"CREATE TABLE IF NOT EXISTS Child2s (
+	Firsts ARRAY<STRUCT<Seconds ARRAY<STRUCT<Thirds ARRAY<STRUCT<Test1 VARCHAR, Test2 VARCHAR>>>>>>
+) WITH ( KAFKA_TOPIC='my_topic', VALUE_FORMAT='Json', PARTITIONS='3' );".ReplaceLineEndings()
+      );
+  }
 }
 
 internal class Port

docs/modelbuilder.md

@@ -318,6 +318,38 @@ CREATE TABLE IF NOT EXISTS Records (
 ) WITH ( KAFKA_TOPIC='my_topic', VALUE_FORMAT='Json', PARTITIONS='3' );
 ```
 
+For array fields that contain a type that is a struct and that again contains a type that is a struct, it's necessary to mark the inner type as a struct type as well:
+```C#
+
+private record Child : Record
+{
+  public First[] Firsts { get; init; } = null!;
+}
+
+private record First
+{
+  public Second[] Seconds { get; init; } = null!;
+}
+
+private record Second
+{
+  public string Test { get; init; } = null!;
+}
+```
+```C#
+ModelBuilder builder = new();
+
+builder.Entity<Child>()
+        .Property(b => b.Headers)
+        .AsStruct();
+builder.Entity<Child>()
+        .Property(b => b.Firsts)
+        .AsStruct();
+builder.Entity<Child>()
+        .Property(b => b.Firsts.FirstOrDefault()!.Seconds)
+        .AsStruct();
+```
+
 ### IgnoreInDML
 **v6.4.0**
 
@@ -417,4 +449,4 @@ Valid pseudocolumn names are:
 - Headers
 - RowOffset
 - RowPartition
-- RowTime 
+- RowTime