Fix Databricks SQL generation to work with multiline comments

Author: atextor

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/sql/databricks/AspectModelDatabricksDenormalizedSqlVisitor.java

@@ -165,17 +165,12 @@ public String visitStructureElement( final StructureElement structureElement, fi
       return result.toString();
    }
 
-   private String escapeComment( final String comment ) {
-      return comment.replace( "'", "\\'" );
-   }
-
    @Override
    public String visitAspect( final Aspect aspect, final Context context ) {
-
       final String columnDeclarations = visitStructureElement( aspect, context );
       final String comment = config.includeTableComment()
             ? Optional.ofNullable( aspect.getDescription( config.commentLanguage() ) ).map( description ->
-            "COMMENT '" + escapeComment( description ) + "'\n" ).orElse( "" )
+            new DatabricksCommentDefinition( description ) + "\n" ).orElse( "" )
             : "";
       return "%s %s (\n%s%s)\n%sTBLPROPERTIES ('%s'='%s');\n".formatted(
             config.createTableCommandPrefix(),
@@ -242,7 +237,7 @@ public String visitCharacteristic( final Characteristic characteristic, final Co
 
    private String column( final String columnName, final String columnType, final boolean isNullable, final Optional<String> comment ) {
       return "%s %s%s".formatted( columnName, columnType, isNullable ? "" : " NOT NULL" )
-            + comment.map( args -> " COMMENT '%s'".formatted( escapeComment( args ) ) ).orElse( "" );
+            + comment.map( args -> " " + new DatabricksCommentDefinition( args ) ).orElse( "" );
    }
 
    @Override

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/sql/databricks/DatabricksColumnDefinition.java

@@ -38,6 +38,6 @@ public String toString() {
             name(),
             type(),
             nullable ? "" : " NOT NULL",
-            comment.map( c -> " COMMENT '" + c.replaceAll( "'", "\\\\'" ) + "'" ).orElse( "" ) );
+            comment.map( theComment -> " " + new DatabricksCommentDefinition( theComment ) ).orElse( "" ) );
    }
 }

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/sql/databricks/DatabricksCommentDefinition.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright (c) 2025 Robert Bosch Manufacturing Solutions GmbH
+ *
+ * See the AUTHORS file(s) distributed with this work for additional
+ * information regarding authorship.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ */
+
+package org.eclipse.esmf.aspectmodel.generator.sql.databricks;
+
+public record DatabricksCommentDefinition( String comment ) {
+   @Override
+   public String toString() {
+      return "COMMENT '" + comment
+            .replace( "'", "\\'" )
+            .replace( "\n", "\\n" )
+            + "'";
+   }
+}

core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/sql/databricks/DatabricksType.java

@@ -80,7 +80,7 @@ record DatabricksStructEntry( String name, DatabricksType type, boolean nullable
       @Override
       public String toString() {
          return name + ": " + type + ( nullable ? "" : " NOT NULL" )
-               + comment.map( c -> " COMMENT '%s'".formatted( c.replace( "'", "\\'" ) ) ).orElse( "" );
+               + comment.map( theComment -> " " + new DatabricksCommentDefinition( theComment ) ).orElse( "" );
       }
    }
 

core/esmf-aspect-model-document-generators/src/test/java/org/eclipse/esmf/aspectmodel/generator/sql/databricks/DatabricksColumnDefinitionParserTest.java

@@ -32,9 +32,7 @@ void testMinimalDefinition() {
    }
 
    @ParameterizedTest
-   @EnumSource( value = TestAspect.class, mode = EnumSource.Mode.EXCLUDE, names = {
-         "ASPECT_WITH_MARKDOWN_DESCRIPTION"
-   } )
+   @EnumSource( value = TestAspect.class )
    void testParseSqlForAspectModel( final TestAspect testAspect ) {
       final String sql = sql( testAspect );
       final String parsedAndSerializedSql = sql.lines()