feat: Analytics database [DHIS2-16705]

dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/hisp/dhis/analytics/table/model/AnalyticsTable.java

@@ -29,6 +29,7 @@
 
 import java.util.Date;
 import java.util.List;
+import java.util.Objects;
 import lombok.Getter;
 import org.hisp.dhis.analytics.AnalyticsTableType;
 import org.hisp.dhis.commons.collection.UniqueArrayList;
@@ -38,7 +39,6 @@
 import org.hisp.dhis.db.model.TablePartition;
 import org.hisp.dhis.program.Program;
 import org.hisp.dhis.trackedentity.TrackedEntityType;
-import org.springframework.util.Assert;
 
 /**
  * Class representing an analytics database table. Note that the table name initially represents a
@@ -219,15 +219,15 @@ public List<AnalyticsTableColumn> getFactColumns() {
    */
   public AnalyticsTable addTablePartition(
       List<String> checks, Integer year, Date startDate, Date endDate) {
-    Assert.notNull(year, "Year must be specified");
+    Objects.requireNonNull(year);
 
     AnalyticsTablePartition partition =
         new AnalyticsTablePartition(this, checks, year, startDate, endDate);
 
-    this.tablePartitions.add(partition);
-
     super.addPartition(toTablePartition(partition));
 
+    this.tablePartitions.add(partition);
+
     return this;
   }
 

dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/hisp/dhis/db/sql/DorisSqlBuilder.java

@@ -0,0 +1,331 @@
+/*
+ * Copyright (c) 2004-2024, University of Oslo
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ * Redistributions of source code must retain the above copyright notice, this
+ * list of conditions and the following disclaimer.
+ *
+ * Redistributions in binary form must reproduce the above copyright notice,
+ * this list of conditions and the following disclaimer in the documentation
+ * and/or other materials provided with the distribution.
+ * Neither the name of the HISP project nor the names of its contributors may
+ * be used to endorse or promote products derived from this software without
+ * specific prior written permission.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package org.hisp.dhis.db.sql;
+
+import static org.hisp.dhis.commons.util.TextUtils.removeLastComma;
+
+import org.apache.commons.lang3.Validate;
+import org.hisp.dhis.db.model.Column;
+import org.hisp.dhis.db.model.Index;
+import org.hisp.dhis.db.model.Table;
+import org.hisp.dhis.db.model.TablePartition;
+import org.hisp.dhis.db.model.constraint.Nullable;
+
+public class DorisSqlBuilder extends AbstractSqlBuilder {
+
+  // Constants
+
+  private static final String QUOTE = "`";
+
+  // Data types
+
+  @Override
+  public String dataTypeSmallInt() {
+    return "smallint";
+  }
+
+  @Override
+  public String dataTypeInteger() {
+    return "int";
+  }
+
+  @Override
+  public String dataTypeBigInt() {
+    return "bigint";
+  }
+
+  @Override
+  public String dataTypeDecimal() {
+    return "decimal(18,6)";
+  }
+
+  @Override
+  public String dataTypeFloat() {
+    return "float";
+  }
+
+  @Override
+  public String dataTypeDouble() {
+    return "double";
+  }
+
+  @Override
+  public String dataTypeBoolean() {
+    return "boolean";
+  }
+
+  @Override
+  public String dataTypeCharacter(int length) {
+    return String.format("char(%d)", length);
+  }
+
+  @Override
+  public String dataTypeVarchar(int length) {
+    return String.format("varchar(%d)", length);
+  }
+
+  @Override
+  public String dataTypeText() {
+    return "string";
+  }
+
+  @Override
+  public String dataTypeDate() {
+    return "date";
+  }
+
+  @Override
+  public String dataTypeTimestamp() {
+    return "datetime";
+  }
+
+  @Override
+  public String dataTypeTimestampTz() {
+    return "datetime";
+  }
+
+  @Override
+  public String dataTypeGeometry() {
+    return "string";
+  }
+
+  @Override
+  public String dataTypeGeometryPoint() {
+    return "string";
+  }
+
+  @Override
+  public String dataTypeJson() {
+    return "json";
+  }
+
+  // Index types
+
+  @Override
+  public String indexTypeBtree() {
+    return notSupported();
+  }
+
+  @Override
+  public String indexTypeGist() {
+    return notSupported();
+  }
+
+  @Override
+  public String indexTypeGin() {
+    return notSupported();
+  }
+
+  // Index functions
+
+  @Override
+  public String indexFunctionUpper() {
+    return "upper";
+  }
+
+  @Override
+  public String indexFunctionLower() {
+    return "lower";
+  }
+
+  // Capabilities
+
+  @Override
+  public boolean supportsGeospatialData() {
+    return false;
+  }
+
+  @Override
+  public boolean supportsDeclarativePartitioning() {
+    return true;
+  }
+
+  @Override
+  public boolean supportsAnalyze() {
+    return false;
+  }
+
+  @Override
+  public boolean supportsVacuum() {
+    return false;
+  }
+
+  @Override
+  public boolean requiresIndexesForAnalytics() {
+    return false;
+  }
+
+  // Utilities
+
+  @Override
+  public String quote(String relation) {
+    String escapedRelation = relation.replace(QUOTE, (QUOTE + QUOTE));
+    return QUOTE + escapedRelation + QUOTE;
+  }
+
+  @Override
+  public String quote(String alias, String relation) {
+    return alias + DOT + quote(relation);
+  }
+
+  @Override
+  public String singleQuote(String value) {
+    return SINGLE_QUOTE + escape(value) + SINGLE_QUOTE;
+  }
+
+  @Override
+  public String escape(String value) {
+    return value
+        .replace(SINGLE_QUOTE, (SINGLE_QUOTE + SINGLE_QUOTE))
+        .replace(BACKSLASH, (BACKSLASH + BACKSLASH));
+  }
+
+  // Statements
+  @Override
+  public String createTable(Table table) {
+    Validate.isTrue(table.hasPrimaryKey());
+
+    StringBuilder sql =
+        new StringBuilder("create table ").append(quote(table.getName())).append(" ");
+
+    // Columns
+
+    if (table.hasColumns()) {
+      sql.append("(");
+
+      for (Column column : table.getColumns()) {
+        String dataType = getDataTypeName(column.getDataType());
+        String nullable = column.getNullable() == Nullable.NOT_NULL ? " not null" : " null";
+
+        sql.append(quote(column.getName()) + " ").append(dataType).append(nullable).append(", ");
+      }
+
+      removeLastComma(sql).append(") engine=olap ");
+    }
+
+    // Primary key
+
+    if (table.hasPrimaryKey()) {
+      sql.append("duplicate key (");
+
+      for (String columnName : table.getPrimaryKey()) {
+        sql.append(quote(columnName) + ", ");
+      }
+
+      removeLastComma(sql).append(") ");
+    }
+
+    // Partitions
+
+    if (table.hasPartitions()) {
+      sql.append("partition by range(year) (");
+
+      for (TablePartition partition : table.getPartitions()) {
+        sql.append("partition ")
+            .append(quote(partition.getName()))
+            .append(" values less than(\"")
+            .append(partition.getValue())
+            .append("\"),");
+      }
+
+      removeLastComma(sql).append(") ");
+    }
+
+    // Distribution
+
+    if (table.hasPrimaryKey()) {
+      sql.append("distributed by hash(")
+          .append(quote(table.getFirstPrimaryKey()))
+          .append(") ")
+          .append("buckets = 10 "); // Verify this
+    }
+
+    // Properties
+
+    sql.append("properties (\"replication_num\" = \"1\")");
+
+    return sql.append(";").toString();
+  }
+
+  @Override
+  public String analyzeTable(String name) {
+    return notSupported();
+  }
+
+  @Override
+  public String vacuumTable(Table table) {
+    return notSupported();
+  }
+
+  @Override
+  public String renameTable(Table table, String newName) {
+    return String.format("alter table %s rename to %s;", quote(table.getName()), quote(newName));
+  }
+
+  @Override
+  public String dropTableIfExists(String name) {
+    return String.format("drop table if exists %s;", quote(name));
+  }
+
+  @Override
+  public String dropTableIfExistsCascade(Table table) {
+    return dropTableIfExists(table);
+  }
+
+  @Override
+  public String dropTableIfExistsCascade(String name) {
+    return dropTableIfExists(name);
+  }
+
+  @Override
+  public String setParentTable(Table table, String parentName) {
+    return notSupported();
+  }
+
+  @Override
+  public String removeParentTable(Table table, String parentName) {
+    return notSupported();
+  }
+
+  @Override
+  public String tableExists(String name) {
+    return String.format(
+        "select t.table_name from information_schema.tables t "
+            + "where t.table_schema = 'public' and t.table_name = %s;",
+        singleQuote(name));
+  }
+
+  /**
+   * Doris supports indexes but relies on concurrency and compression for query performance instead
+   * of indexes on arbitrary columns. Read more at {@link https://t.ly/uNK5T}.
+   */
+  @Override
+  public String createIndex(Index index) {
+    return notSupported();
+  }
+}

dhis-2/dhis-services/dhis-service-analytics/src/main/java/org/hisp/dhis/db/sql/SqlBuilderProvider.java

@@ -61,6 +61,8 @@ private SqlBuilder getSqlBuilder(AnalyticsTableSettings config) {
     Database database = config.getAnalyticsDatabase();
     Objects.requireNonNull(database);
     switch (database) {
+      case DORIS:
+        return new DorisSqlBuilder();
       default:
         return new PostgreSqlBuilder();
     }