Merge pull request #787 from sekikn/786-add-decimal-scale-option

atextor · web-flow · commit dff85b8be112 · 2025-07-11T14:28:37.000+02:00
Add a new option to the SQL generator for specifying decimal's scale
diff --git a/core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/sql/databricks/AspectModelDatabricksDenormalizedSqlVisitor.java b/core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/sql/databricks/AspectModelDatabricksDenormalizedSqlVisitor.java
@@ -87,8 +87,9 @@ public AspectModelDatabricksDenormalizedSqlVisitor( final DatabricksSqlGeneratio
       databricksTypeMap = ImmutableMap.<String, DatabricksType> builder()
             .put( XSD.xstring.getURI(), DatabricksType.STRING )
             .put( XSD.xboolean.getURI(), DatabricksType.BOOLEAN )
-            .put( XSD.decimal.getURI(), new DatabricksType.DatabricksDecimal( Optional.of( config.decimalPrecision() ) ) )
-            .put( XSD.integer.getURI(), new DatabricksType.DatabricksDecimal() )
+            .put( XSD.decimal.getURI(), new DatabricksType.DatabricksDecimal( Optional.of( config.decimalPrecision() ),
+                    Optional.of( config.decimalScale() ) ) )
+            .put( XSD.integer.getURI(), new DatabricksType.DatabricksDecimal( Optional.of( config.decimalPrecision() ) ) )
             .put( XSD.xdouble.getURI(), DatabricksType.DOUBLE )
             .put( XSD.xfloat.getURI(), DatabricksType.FLOAT )
             .put( XSD.date.getURI(), DatabricksType.STRING )
@@ -110,7 +111,7 @@ public AspectModelDatabricksDenormalizedSqlVisitor( final DatabricksSqlGeneratio
             .put( XSD.unsignedByte.getURI(), DatabricksType.SMALLINT )
             .put( XSD.unsignedShort.getURI(), DatabricksType.INT )
             .put( XSD.unsignedInt.getURI(), DatabricksType.BIGINT )
-            .put( XSD.unsignedLong.getURI(), new DatabricksType.DatabricksDecimal() )
+            .put( XSD.unsignedLong.getURI(), new DatabricksType.DatabricksDecimal( Optional.of( config.decimalPrecision() ) ) )
             .put( XSD.positiveInteger.getURI(), new DatabricksType.DatabricksDecimal( Optional.of( config.decimalPrecision() ) ) )
             .put( XSD.nonNegativeInteger.getURI(), new DatabricksType.DatabricksDecimal( Optional.of( config.decimalPrecision() ) ) )
             .put( XSD.negativeInteger.getURI(), new DatabricksType.DatabricksDecimal( Optional.of( config.decimalPrecision() ) ) )
diff --git a/core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/sql/databricks/DatabricksSqlGenerationConfig.java b/core/esmf-aspect-model-document-generators/src/main/java/org/eclipse/esmf/aspectmodel/generator/sql/databricks/DatabricksSqlGenerationConfig.java
@@ -38,20 +38,23 @@ public record DatabricksSqlGenerationConfig(
       boolean includeColumnComments,
       Locale commentLanguage,
       int decimalPrecision,
+      int decimalScale,
       List<DatabricksColumnDefinition> customColumns
 ) implements SqlGenerationConfig.DialectSpecificConfig {
    public static final String DEFAULT_TABLE_COMMAND_PREFIX = "CREATE TABLE IF NOT EXISTS";
    // As defined in https://docs.databricks.com/en/sql/language-manual/data-types/decimal-type.html
    public static final int DECIMAL_DEFAULT_PRECISION = 10;
    // As defined in https://docs.databricks.com/en/sql/language-manual/data-types/decimal-type.html
    public static final int DECIMAL_MAX_PRECISION = 38;
+   // As defined in https://docs.databricks.com/en/sql/language-manual/data-types/decimal-type.html
+   public static final int DECIMAL_DEFAULT_SCALE = 0;
    public static final boolean DEFAULT_INCLUDE_TABLE_COMMENT = true;
    public static final boolean DEFAULT_INCLUDE_COLUMN_COMMENTS = true;
    public static final Locale DEFAULT_COMMENT_LANGUAGE = Locale.ENGLISH;
 
    public DatabricksSqlGenerationConfig() {
       this( DEFAULT_TABLE_COMMAND_PREFIX, DEFAULT_INCLUDE_TABLE_COMMENT, DEFAULT_INCLUDE_COLUMN_COMMENTS, DEFAULT_COMMENT_LANGUAGE,
-            DECIMAL_DEFAULT_PRECISION, List.of() );
+            DECIMAL_DEFAULT_PRECISION, DECIMAL_DEFAULT_SCALE, List.of() );
    }
 
    public DatabricksSqlGenerationConfig {
@@ -64,6 +67,12 @@ public DatabricksSqlGenerationConfig() {
       if ( decimalPrecision > DECIMAL_MAX_PRECISION ) {
          decimalPrecision = DECIMAL_MAX_PRECISION;
       }
+      if ( decimalScale < 0 ) {
+         decimalScale = DECIMAL_DEFAULT_SCALE;
+      }
+      if ( decimalScale > decimalPrecision ) {
+         decimalScale = decimalPrecision;
+      }
       if ( commentLanguage == null ) {
          commentLanguage = DEFAULT_COMMENT_LANGUAGE;
       }
diff --git a/core/esmf-aspect-model-document-generators/src/test/java/org/eclipse/esmf/aspectmodel/generator/sql/AspectModelSqlGeneratorTest.java b/core/esmf-aspect-model-document-generators/src/test/java/org/eclipse/esmf/aspectmodel/generator/sql/AspectModelSqlGeneratorTest.java
@@ -24,6 +24,7 @@
 import org.eclipse.esmf.test.TestAspect;
 import org.eclipse.esmf.test.TestResources;
 
+import org.junit.jupiter.api.Test;
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.EnumSource;
 
@@ -70,4 +71,22 @@ void testDatabricksGenerationExcludeComments( final TestAspect testAspect ) {
          assertThat( result ).doesNotContain( "COMMENT" );
       } ).doesNotThrowAnyException();
    }
+
+   @Test
+   void testDatabricksGenerationDecimalPrecisionAndScale() {
+      final Aspect aspect = TestResources.load( TestAspect.ASPECT_WITH_SIMPLE_TYPES ).aspect();
+      assertThatCode( () -> {
+         final DatabricksSqlGenerationConfig dialectSpecificConfig = DatabricksSqlGenerationConfigBuilder.builder()
+                 .decimalPrecision( 38 )
+                 .decimalScale( 38 )
+                 .build();
+         final SqlArtifact sqlArtifact = new AspectModelSqlGenerator( aspect, SqlGenerationConfigBuilder.builder()
+                 .dialect( SqlGenerationConfig.Dialect.DATABRICKS )
+                 .dialectSpecificConfig( dialectSpecificConfig )
+                 .build() ).singleResult();
+         final String result = sqlArtifact.getContent();
+
+         assertThat( result ).contains( "DECIMAL(38,38)" );
+      } ).doesNotThrowAnyException();
+   }
 }
diff --git a/core/esmf-aspect-model-document-generators/src/test/java/org/eclipse/esmf/aspectmodel/generator/sql/databricks/AspectModelDatabricksDenormalizedSqlVisitorTest.java b/core/esmf-aspect-model-document-generators/src/test/java/org/eclipse/esmf/aspectmodel/generator/sql/databricks/AspectModelDatabricksDenormalizedSqlVisitorTest.java
@@ -189,7 +189,7 @@ void testAspectWithEntityInstanceWithScalarListProperty() {
       assertThat( sql( TestAspect.ASPECT_WITH_ENTITY_INSTANCE_WITH_SCALAR_LIST_PROPERTY ) ).isEqualTo( """
             CREATE TABLE IF NOT EXISTS aspect_with_entity_instance_with_scalar_list_property (
               test_property__code SMALLINT NOT NULL,
-              test_property__test_list ARRAY<DECIMAL> NOT NULL
+              test_property__test_list ARRAY<DECIMAL(10)> NOT NULL
             )
             TBLPROPERTIES ('x-samm-aspect-model-urn'='urn:samm:org.eclipse.esmf.test:1.0.0#AspectWithEntityInstanceWithScalarListProperty');
             """ );
@@ -369,7 +369,7 @@ CREATE TABLE IF NOT EXISTS aspect_with_operation (
    void testAspectWithOptionalProperties() {
       assertThat( sql( TestAspect.ASPECT_WITH_OPTIONAL_PROPERTIES ) ).isEqualTo( """
             CREATE TABLE IF NOT EXISTS aspect_with_optional_properties (
-              number_property DECIMAL,
+              number_property DECIMAL(10),
               timestamp_property TIMESTAMP NOT NULL
             )
             TBLPROPERTIES ('x-samm-aspect-model-urn'='urn:samm:org.eclipse.esmf.test:1.0.0#AspectWithOptionalProperties');
@@ -446,7 +446,7 @@ CREATE TABLE IF NOT EXISTS aspect_with_simple_types (
               date_time_property TIMESTAMP NOT NULL,
               date_time_stamp_property TIMESTAMP NOT NULL,
               day_time_duration STRING NOT NULL,
-              decimal_property DECIMAL(10) NOT NULL,
+              decimal_property DECIMAL(10,0) NOT NULL,
               double_property DOUBLE NOT NULL,
               duration_property STRING NOT NULL,
               float_property FLOAT NOT NULL,
@@ -457,7 +457,7 @@ decimal_property DECIMAL(10) NOT NULL,
               g_year_property STRING NOT NULL,
               hex_binary_property BINARY NOT NULL,
               int_property INT NOT NULL,
-              integer_property DECIMAL NOT NULL,
+              integer_property DECIMAL(10) NOT NULL,
               lang_string_property STRING NOT NULL,
               long_property BIGINT NOT NULL,
               negative_integer_property DECIMAL(10) NOT NULL,
@@ -469,7 +469,7 @@ positive_integer_property DECIMAL(10) NOT NULL,
               time_property STRING NOT NULL,
               unsigned_byte_property SMALLINT NOT NULL,
               unsigned_int_property BIGINT NOT NULL,
-              unsigned_long_property DECIMAL NOT NULL,
+              unsigned_long_property DECIMAL(10) NOT NULL,
               unsigned_short_property INT NOT NULL,
               year_month_duration_property STRING NOT NULL
             )
diff --git a/documentation/developer-guide/modules/tooling-guide/examples/GenerateSql.java b/documentation/developer-guide/modules/tooling-guide/examples/GenerateSql.java
@@ -49,6 +49,7 @@ public void generate() {
                   .includeTableComment( true )       // optional
                   .includeColumnComments( true )     // optional
                   .decimalPrecision( 10 )            // optional
+                  .decimalScale( 0 )                 // optional
                   .customColumns( List.of(           // optional
                         DatabricksColumnDefinitionBuilder.builder()
                               .name( "custom_column" )
diff --git a/documentation/developer-guide/modules/tooling-guide/pages/samm-cli.adoc b/documentation/developer-guide/modules/tooling-guide/pages/samm-cli.adoc
@@ -196,6 +196,9 @@ of model resolution] for more information.
                                    | _--decimal-precision, -dp_ : The precision to use for Databricks decimal columns
                                      (default: 10). See also notes in
                                      the xref:java-aspect-tooling.adoc#databricks-type-mapping[Databricks type mapping].     |
+                                   | _--decimal-scale, -ds_ : The scale to use for Databricks decimal columns
+                                     (default: 0). See also notes in
+                                     the xref:java-aspect-tooling.adoc#databricks-type-mapping[Databricks type mapping].     |
                                    | _--custom-column, -col_ : Additional custom column definition, e.g. for databricks following the pattern `column_name DATATYPE [NOT NULL] [COMMENT 'custom']`. This parameter can be repeated for multiple columns.                                                  | `samm aspect AspectModel.ttl to sql --custom-column "column_name STRING NOT NULL COMMENT 'custom'"`
 .5+| [[aspect-to-aas]] aspect <model> to aas | Generate an Asset Administration Shell (AAS) submodel template from an
                                      Aspect Model                                                                            | `samm aspect AspectModel.ttl to aas`
diff --git a/tools/samm-cli/src/main/java/org/eclipse/esmf/aspect/to/AspectToSqlCommand.java b/tools/samm-cli/src/main/java/org/eclipse/esmf/aspect/to/AspectToSqlCommand.java
@@ -89,6 +89,12 @@ public class AspectToSqlCommand extends AbstractCommand {
          description = "The precision to use for Databricks decimal columns, between 1 and 38. (default: ${DEFAULT-VALUE})" )
    private int decimalPrecision = DatabricksSqlGenerationConfig.DECIMAL_DEFAULT_PRECISION;
 
+   @CommandLine.Option(
+           names = { "--decimal-scale", "-ds" },
+           description =
+                   "The scale to use for Databricks decimal columns, between 0 and the value of precision. (default: ${DEFAULT-VALUE})" )
+   private int decimalScale = DatabricksSqlGenerationConfig.DECIMAL_DEFAULT_SCALE;
+
    @CommandLine.Option(
          names = { "--custom-column", "-col" },
          description = "Custom column to add to the table, can be repeated for multiple columns",
@@ -130,6 +136,7 @@ public void run() {
                   .includeColumnComments( includeColumnComments )
                   .createTableCommandPrefix( tableCommandPrefix )
                   .decimalPrecision( decimalPrecision )
+                  .decimalScale( decimalScale )
                   .customColumns( customColumns )
                   .build();
       final SqlGenerationConfig sqlConfig = new SqlGenerationConfig( dialect, strategy, generatorConfig );
