Merge pull request #55 from plantbreeding/34-improve-the-generation-of-sql-from-json-schema2

guydavenport · web-flow · commit 3d2e96c016b0 · 2026-02-06T20:12:25.000+13:00
34 improve the generation of sql from json schema2
diff --git a/java/cli/src/main/java/org/brapi/schematools/cli/ValidateSubCommand.java b/java/cli/src/main/java/org/brapi/schematools/cli/ValidateSubCommand.java
@@ -3,7 +3,6 @@
 import org.brapi.schematools.core.brapischema.BrAPISchemaReader;
 import org.brapi.schematools.core.brapischema.BrAPISchemaReaderOptions;
 import org.brapi.schematools.core.model.BrAPIClass;
-import org.brapi.schematools.core.openapi.generator.options.OpenAPIGeneratorOptions;
 import org.brapi.schematools.core.response.Response;
 import picocli.CommandLine;
 
diff --git a/java/core/src/main/java/org/brapi/schematools/core/brapischema/BrAPISchemaReader.java b/java/core/src/main/java/org/brapi/schematools/core/brapischema/BrAPISchemaReader.java
@@ -31,9 +31,7 @@
 import static java.util.Collections.singletonList;
 import static org.brapi.schematools.core.response.Response.fail;
 import static org.brapi.schematools.core.response.Response.success;
-import static org.brapi.schematools.core.utils.BrAPITypeUtils.unwrapType;
-import static org.brapi.schematools.core.utils.BrAPITypeUtils.validateBrAPIMetadata;
-import static org.brapi.schematools.core.utils.BrAPITypeUtils.mergeMetadata;
+import static org.brapi.schematools.core.utils.BrAPITypeUtils.*;
 import static org.brapi.schematools.core.utils.StringUtils.toSingular;
 
 /**
diff --git a/java/core/src/main/java/org/brapi/schematools/core/ontmodel/options/OntModelGeneratorOptions.java b/java/core/src/main/java/org/brapi/schematools/core/ontmodel/options/OntModelGeneratorOptions.java
@@ -5,9 +5,9 @@
 import lombok.NoArgsConstructor;
 import lombok.Setter;
 import lombok.experimental.Accessors;
+import org.brapi.schematools.core.ontmodel.OntModelGenerator;
 import org.brapi.schematools.core.options.AbstractMainGeneratorOptions;
 import org.brapi.schematools.core.utils.ConfigurationUtils;
-import org.brapi.schematools.core.ontmodel.OntModelGenerator;
 
 import java.io.IOException;
 import java.io.InputStream;
diff --git a/java/core/src/main/java/org/brapi/schematools/core/r/options/RGeneratorOptions.java b/java/core/src/main/java/org/brapi/schematools/core/r/options/RGeneratorOptions.java
@@ -10,9 +10,9 @@
 import org.brapi.schematools.core.options.AbstractMainGeneratorOptions;
 import org.brapi.schematools.core.options.LinkType;
 import org.brapi.schematools.core.options.PropertiesOptions;
+import org.brapi.schematools.core.r.RGenerator;
 import org.brapi.schematools.core.utils.ConfigurationUtils;
 import org.brapi.schematools.core.validiation.Validation;
-import org.brapi.schematools.core.r.RGenerator;
 
 import java.io.IOException;
 import java.io.InputStream;
diff --git a/java/core/src/main/java/org/brapi/schematools/core/sql/ANSICreateTableDDLGenerator.java b/java/core/src/main/java/org/brapi/schematools/core/sql/ANSICreateTableDDLGenerator.java
@@ -26,6 +26,7 @@
 import static org.brapi.schematools.core.utils.StringUtils.removeCarriageReturns;
 import static org.brapi.schematools.core.utils.StringUtils.toPlural;
 import static org.brapi.schematools.core.utils.StringUtils.toSentenceCase;
+import static org.brapi.schematools.core.utils.StringUtils.toSnakeCase;
 
 @Slf4j
 public class ANSICreateTableDDLGenerator implements CreateTableDDLGenerator {
@@ -73,7 +74,7 @@ public Response<String> generate() {
             }
 
             return createTableDefinition(
-                createTableName(brAPIObjectType),
+                createTableNameFullName(brAPIObjectType),
                 () -> createTableDescription(brAPIObjectType),
                 () -> createColumnDefinitions(brAPIObjectType),
                 getTableDescription(brAPIObjectType),
@@ -195,8 +196,23 @@ private void dedent() {
             indent -= options.getIndentSize() ;
         }
 
+        private String createTableNameFullName(BrAPIObjectType brAPIObjectType) {
+            return metadata.getTablePrefix() != null ?
+                metadata.getTablePrefix() + createTableName(brAPIObjectType) : createTableName(brAPIObjectType);
+        }
+
         private String createTableName(BrAPIObjectType brAPIObjectType) {
-            return metadata.getTablePrefix() != null ? metadata.getTablePrefix() + brAPIObjectType.getName() : brAPIObjectType.getName();
+            String name = brAPIObjectType.getName() ;
+
+            if (options.isUsingPluralTableNames()) {
+                name = toPlural(name) ;
+            }
+
+            if (options.isUsingSnakeCaseTableNames()) {
+                name = toSnakeCase(name) ;
+            }
+
+            return name ;
         }
 
         private String getTableDescription(BrAPIObjectType brAPIObjectType) {
@@ -319,7 +335,13 @@ private String createLinkTableFullName(LinkTable linkedTable) {
         }
 
         private String createLinkTableName(LinkTable linkedTable) {
-            return linkedTable.getDereferencedItemType().getName() + "By" + linkedTable.getParentType().getName();
+            String name = linkedTable.getDereferencedItemType().getName() + "By" + linkedTable.getParentType().getName();
+
+            if (options.isUsingSnakeCaseTableNames()) {
+                name = toSnakeCase(name) ;
+            }
+
+            return name ;
         }
 
         private Response<String> createColumnDefinitions(LinkTable linkTable) {
@@ -387,20 +409,30 @@ private Response<String> appendControlledVocabularyDefinitions(String ddl) {
 
         private Response<String> appendControlledVocabularyDefinition(ControlledVocabularyTable controlledVocabularyTable) {
             return createTableDefinition(
-                createControlledVocabularyFullName(controlledVocabularyTable),
+                createControlledVocabularyFullTableName(controlledVocabularyTable),
                 () -> createTableDescription(controlledVocabularyTable),
                 () -> createColumnDefinitions(controlledVocabularyTable),
                 getTableComment(controlledVocabularyTable),
                 findClusterColumns(controlledVocabularyTable));
         }
 
-        private String createControlledVocabularyFullName(ControlledVocabularyTable controlledVocabularyTable) {
+        private String createControlledVocabularyFullTableName(ControlledVocabularyTable controlledVocabularyTable) {
             return metadata.getTablePrefix() != null ? 
-                metadata.getTablePrefix() + createControlledVocabularyName(controlledVocabularyTable) : createControlledVocabularyName(controlledVocabularyTable);
+                metadata.getTablePrefix() + createControlledVocabularyTableName(controlledVocabularyTable) : createControlledVocabularyTableName(controlledVocabularyTable);
         }
 
-        private String createControlledVocabularyName(ControlledVocabularyTable controlledVocabularyTable) {
-            return toSentenceCase(toPlural(controlledVocabularyTable.getProperty().getName())) ;
+        private String createControlledVocabularyTableName(ControlledVocabularyTable controlledVocabularyTable) {
+            String name = toSentenceCase(controlledVocabularyTable.getProperty().getName()) ;
+
+            if (options.isUsingPluralTableNames()) {
+                name = toPlural(name) ;
+            }
+
+            if (options.isUsingSnakeCaseTableNames()) {
+                name = toSnakeCase(name) ;
+            }
+
+            return name ;
         }
 
         private Response<String> createColumnDefinitions(ControlledVocabularyTable controlledVocabularyTable) {
diff --git a/java/core/src/main/java/org/brapi/schematools/core/sql/options/SQLGeneratorOptions.java b/java/core/src/main/java/org/brapi/schematools/core/sql/options/SQLGeneratorOptions.java
@@ -46,6 +46,8 @@ public class SQLGeneratorOptions extends AbstractMainGeneratorOptions {
     @Setter(AccessLevel.PRIVATE)
     private ControlledVocabularyOptions controlledVocabulary;
     private Boolean generateLinkTables;
+    private Boolean snakeCaseTableNames;
+    private Boolean pluralTableNames;
 
     /**
      * Load the default options
@@ -169,6 +171,14 @@ public SQLGeneratorOptions override(SQLGeneratorOptions overrideOptions) {
             generateLinkTables = overrideOptions.generateLinkTables;
         }
 
+        if (overrideOptions.snakeCaseTableNames != null) {
+            snakeCaseTableNames = overrideOptions.snakeCaseTableNames;
+        }
+
+        if (overrideOptions.pluralTableNames != null) {
+            pluralTableNames = overrideOptions.pluralTableNames;
+        }
+
         return this;
     }
 
@@ -270,10 +280,31 @@ public boolean isAddingDropTable() {
      * Determines if the Generator create link tables for many-to-many relationships when the
      * link type is {@link org.brapi.schematools.core.options.LinkType#SUB_QUERY}
      *
-     * @return {@code true} if the Generator should add a 'DROP TABLE;, {@code false} otherwise
+     * @return {@code true} if the Generator create link tables for many-to-many relationships when the
+     * link type is {@link org.brapi.schematools.core.options.LinkType#SUB_QUERY}, {@code false} otherwise
      */
     @JsonIgnore
     public boolean isGeneratingLinkTables() {
         return generateLinkTables != null && generateLinkTables ;
     }
+
+    /**
+     * Determines if the Generator should use snake_case table names for all tables
+     *
+     * @return {@code true} if the Generator should use snake_case table names for all tables, {@code false} otherwise
+     */
+    @JsonIgnore
+    public boolean isUsingSnakeCaseTableNames() {
+        return snakeCaseTableNames != null && snakeCaseTableNames ;
+    }
+
+    /**
+     * Determines if the Generator should use plural table names for entity tables
+     *
+     * @return {@code true} if the Generator should use plural table names for /** tables, {@code false} otherwise
+     */
+    @JsonIgnore
+    public boolean isUsingPluralTableNames() {
+        return pluralTableNames != null && pluralTableNames ;
+    }
 }
diff --git a/java/core/src/main/resources/sql-options.yaml b/java/core/src/main/resources/sql-options.yaml
@@ -7,6 +7,8 @@ addGeneratorComments: true
 indent: 2
 descriptionFormat: TODO Description for %s
 generateLinkTables : true
+snakeCaseTableNames : false
+pluralTableNames : true
 generateFor:
     AlleleMatrix: false
     MarkerPosition: false
diff --git a/java/core/src/test/java/org/brapi/schematools/core/brapischema/BrAPISchemaReaderTest.java b/java/core/src/test/java/org/brapi/schematools/core/brapischema/BrAPISchemaReaderTest.java
@@ -11,20 +11,12 @@
 import java.nio.file.Files;
 import java.nio.file.Path;
 import java.nio.file.Paths;
-import java.util.HashSet;
-import java.util.List;
-import java.util.Map;
-import java.util.Objects;
-import java.util.Set;
+import java.util.*;
 import java.util.function.Function;
 import java.util.stream.Collectors;
 
 import static graphql.Assert.assertNull;
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertFalse;
-import static org.junit.jupiter.api.Assertions.assertNotNull;
-import static org.junit.jupiter.api.Assertions.assertTrue;
-import static org.junit.jupiter.api.Assertions.fail;
+import static org.junit.jupiter.api.Assertions.*;
 
 @Slf4j
 class BrAPISchemaReaderTest {
diff --git a/java/core/src/test/java/org/brapi/schematools/core/utils/BrAPITypeUtilsTest.java b/java/core/src/test/java/org/brapi/schematools/core/utils/BrAPITypeUtilsTest.java
@@ -11,7 +11,11 @@
 import java.util.Collections;
 import java.util.List;
 
-import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertNull;
+import static org.junit.jupiter.api.Assertions.assertSame;
+import static org.junit.jupiter.api.Assertions.assertTrue;
 
 class BrAPITypeUtilsTest {
 
diff --git a/java/core/src/test/resources/SQLGenerator/ANSI/CallSet.sql b/java/core/src/test/resources/SQLGenerator/ANSI/CallSet.sql
@@ -2,7 +2,7 @@
 /* 
 A CallSet is a collection of Calls that were generated by the same analysis of the same Sample
  */
-CREATE TABLE brapi_CallSet (
+CREATE TABLE brapi_CallSets (
   additionalInfo MAP<STRING,STRING> COMMENT 'A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.',
   callSetDbId STRING COMMENT 'The ID which uniquely identifies a CallSet within the given database server',
   callSetName STRING COMMENT 'The human readable name which identifies a germplasm within the given database server',
diff --git a/java/core/src/test/resources/SQLGenerator/ANSI/Study-clustering-and-table-properties.sql b/java/core/src/test/resources/SQLGenerator/ANSI/Study-clustering-and-table-properties.sql
@@ -2,7 +2,7 @@
 /* 
 A Study represents an experiment that has taken place at a single location. The Study contains metadata about the parameters and design of the experiment. It can also be used to group results and data sets generated from the experiment. A Trial can represent a collection of one or more Studies.
  */
-CREATE TABLE brapi_Study (
+CREATE TABLE brapi_Studies (
   active BOOLEAN COMMENT 'A flag to indicate if a Study is currently active and ongoing',
   additionalInfo MAP<STRING,STRING> COMMENT 'A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.',
   commonCropName STRING COMMENT 'Common name for the crop associated with this study',
diff --git a/java/core/src/test/resources/SQLGenerator/ANSI/Study-clustering.sql b/java/core/src/test/resources/SQLGenerator/ANSI/Study-clustering.sql
@@ -2,7 +2,7 @@
 /* 
 A Study represents an experiment that has taken place at a single location. The Study contains metadata about the parameters and design of the experiment. It can also be used to group results and data sets generated from the experiment. A Trial can represent a collection of one or more Studies.
  */
-CREATE TABLE brapi_Study (
+CREATE TABLE brapi_Studies (
   active BOOLEAN COMMENT 'A flag to indicate if a Study is currently active and ongoing',
   additionalInfo MAP<STRING,STRING> COMMENT 'A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.',
   commonCropName STRING COMMENT 'Common name for the crop associated with this study',
diff --git a/java/core/src/test/resources/SQLGenerator/ANSI/Study-drop-table.sql b/java/core/src/test/resources/SQLGenerator/ANSI/Study-drop-table.sql
@@ -2,8 +2,8 @@
 /* 
 A Study represents an experiment that has taken place at a single location. The Study contains metadata about the parameters and design of the experiment. It can also be used to group results and data sets generated from the experiment. A Trial can represent a collection of one or more Studies.
  */
-DROP TABLE brapi_Study; 
-CREATE TABLE brapi_Study (
+DROP TABLE brapi_Studies; 
+CREATE TABLE brapi_Studies (
   active BOOLEAN COMMENT 'A flag to indicate if a Study is currently active and ongoing',
   additionalInfo MAP<STRING,STRING> COMMENT 'A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.',
   commonCropName STRING COMMENT 'Common name for the crop associated with this study',
diff --git a/java/core/src/test/resources/SQLGenerator/ANSI/Study-if-not-exists.sql b/java/core/src/test/resources/SQLGenerator/ANSI/Study-if-not-exists.sql
@@ -2,7 +2,7 @@
 /* 
 A Study represents an experiment that has taken place at a single location. The Study contains metadata about the parameters and design of the experiment. It can also be used to group results and data sets generated from the experiment. A Trial can represent a collection of one or more Studies.
  */
-CREATE TABLE IF NOT EXISTS brapi_Study (
+CREATE TABLE IF NOT EXISTS brapi_Studies (
   active BOOLEAN COMMENT 'A flag to indicate if a Study is currently active and ongoing',
   additionalInfo MAP<STRING,STRING> COMMENT 'A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.',
   commonCropName STRING COMMENT 'Common name for the crop associated with this study',
diff --git a/java/core/src/test/resources/SQLGenerator/ANSI/Study-table-properties.sql b/java/core/src/test/resources/SQLGenerator/ANSI/Study-table-properties.sql
@@ -2,7 +2,7 @@
 /* 
 A Study represents an experiment that has taken place at a single location. The Study contains metadata about the parameters and design of the experiment. It can also be used to group results and data sets generated from the experiment. A Trial can represent a collection of one or more Studies.
  */
-CREATE TABLE brapi_Study (
+CREATE TABLE brapi_Studies (
   active BOOLEAN COMMENT 'A flag to indicate if a Study is currently active and ongoing',
   additionalInfo MAP<STRING,STRING> COMMENT 'A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.',
   commonCropName STRING COMMENT 'Common name for the crop associated with this study',
diff --git a/java/core/src/test/resources/SQLGenerator/ANSI/Study-using-and-clustering-and-table-properties.sql b/java/core/src/test/resources/SQLGenerator/ANSI/Study-using-and-clustering-and-table-properties.sql
@@ -2,7 +2,7 @@
 /* 
 A Study represents an experiment that has taken place at a single location. The Study contains metadata about the parameters and design of the experiment. It can also be used to group results and data sets generated from the experiment. A Trial can represent a collection of one or more Studies.
  */
-CREATE TABLE brapi_Study (
+CREATE TABLE brapi_Studies (
   active BOOLEAN COMMENT 'A flag to indicate if a Study is currently active and ongoing',
   additionalInfo MAP<STRING,STRING> COMMENT 'A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.',
   commonCropName STRING COMMENT 'Common name for the crop associated with this study',
diff --git a/java/core/src/test/resources/SQLGenerator/ANSI/Study-using-and-clustering.sql b/java/core/src/test/resources/SQLGenerator/ANSI/Study-using-and-clustering.sql
@@ -2,7 +2,7 @@
 /* 
 A Study represents an experiment that has taken place at a single location. The Study contains metadata about the parameters and design of the experiment. It can also be used to group results and data sets generated from the experiment. A Trial can represent a collection of one or more Studies.
  */
-CREATE TABLE brapi_Study (
+CREATE TABLE brapi_Studies (
   active BOOLEAN COMMENT 'A flag to indicate if a Study is currently active and ongoing',
   additionalInfo MAP<STRING,STRING> COMMENT 'A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.',
   commonCropName STRING COMMENT 'Common name for the crop associated with this study',
diff --git a/java/core/src/test/resources/SQLGenerator/ANSI/Study-using-and-table-properties.sql b/java/core/src/test/resources/SQLGenerator/ANSI/Study-using-and-table-properties.sql
@@ -2,7 +2,7 @@
 /* 
 A Study represents an experiment that has taken place at a single location. The Study contains metadata about the parameters and design of the experiment. It can also be used to group results and data sets generated from the experiment. A Trial can represent a collection of one or more Studies.
  */
-CREATE TABLE brapi_Study (
+CREATE TABLE brapi_Studies (
   active BOOLEAN COMMENT 'A flag to indicate if a Study is currently active and ongoing',
   additionalInfo MAP<STRING,STRING> COMMENT 'A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.',
   commonCropName STRING COMMENT 'Common name for the crop associated with this study',
diff --git a/java/core/src/test/resources/SQLGenerator/ANSI/Study-using.sql b/java/core/src/test/resources/SQLGenerator/ANSI/Study-using.sql
@@ -2,7 +2,7 @@
 /* 
 A Study represents an experiment that has taken place at a single location. The Study contains metadata about the parameters and design of the experiment. It can also be used to group results and data sets generated from the experiment. A Trial can represent a collection of one or more Studies.
  */
-CREATE TABLE brapi_Study (
+CREATE TABLE brapi_Studies (
   active BOOLEAN COMMENT 'A flag to indicate if a Study is currently active and ongoing',
   additionalInfo MAP<STRING,STRING> COMMENT 'A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.',
   commonCropName STRING COMMENT 'Common name for the crop associated with this study',
diff --git a/java/core/src/test/resources/SQLGenerator/ANSI/Study.sql b/java/core/src/test/resources/SQLGenerator/ANSI/Study.sql
@@ -2,7 +2,7 @@
 /* 
 A Study represents an experiment that has taken place at a single location. The Study contains metadata about the parameters and design of the experiment. It can also be used to group results and data sets generated from the experiment. A Trial can represent a collection of one or more Studies.
  */
-CREATE TABLE brapi_Study (
+CREATE TABLE brapi_Studies (
   active BOOLEAN COMMENT 'A flag to indicate if a Study is currently active and ongoing',
   additionalInfo MAP<STRING,STRING> COMMENT 'A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.',
   commonCropName STRING COMMENT 'Common name for the crop associated with this study',
diff --git a/java/core/src/test/resources/SQLGenerator/ANSI/StudyPUI.sql b/java/core/src/test/resources/SQLGenerator/ANSI/StudyPUI.sql
@@ -2,7 +2,7 @@
 /* 
 A Study represents an experiment that has taken place at a single location. The Study contains metadata about the parameters and design of the experiment. It can also be used to group results and data sets generated from the experiment. A Trial can represent a collection of one or more Studies.
  */
-CREATE TABLE brapi_Study (
+CREATE TABLE brapi_Studies (
   active BOOLEAN COMMENT 'A flag to indicate if a Study is currently active and ongoing',
   additionalInfo MAP<STRING,STRING> COMMENT 'A free space containing any additional information related to a particular object. A data source may provide any JSON object, unrestricted by the BrAPI specification.',
   commonCropName STRING COMMENT 'Common name for the crop associated with this study',
diff --git a/java/gradle.properties b/java/gradle.properties
@@ -1,2 +1,2 @@
-version=0.55.0
+version=0.56.0
 org.gradle.configuration-cache=false
