Yugabyte platform support - Automatic detection and DDL support

- Automatic detection similar to Cockroach - DDL very similar to Postgres but no CREATE TABLE LIKE support (for history DDL)
2026-10-22 02:46:59 +00:00 · 2022-01-28 17:04:19 +13:00
parent 425124d8f7
commit 64605b5090
12 changed files with 98 additions and 33 deletions
@@ -49,7 +49,7 @@
    <dependency>
      <groupId>io.ebean</groupId>
      <artifactId>ebean-annotation</artifactId>
-      <version>7.5</version>
+      <version>7.6</version>
    </dependency>

    <dependency>
@@ -0,0 +1,12 @@
+package io.ebean.config.dbplatform.yugabyte;
+
+import io.ebean.annotation.Platform;
+import io.ebean.config.dbplatform.postgres.PostgresPlatform;
+
+public class YugabytePlaform extends PostgresPlatform {
+
+  public YugabytePlaform() {
+    super();
+    this.platform = Platform.YUGABYTE;
+  }
+}
@@ -24,12 +24,14 @@ import io.ebean.config.dbplatform.sqlanywhere.SqlAnywherePlatform;
 import io.ebean.config.dbplatform.sqlite.SQLitePlatform;
 import io.ebean.config.dbplatform.sqlserver.SqlServer16Platform;
 import io.ebean.config.dbplatform.sqlserver.SqlServer17Platform;
+import io.ebean.config.dbplatform.yugabyte.YugabytePlaform;
 import io.ebeaninternal.api.CoreLog;
 import io.ebeaninternal.api.DbOffline;

 import javax.persistence.PersistenceException;
 import javax.sql.DataSource;
 import java.sql.*;
+import java.util.Locale;

 /**
 * Create a DatabasePlatform from the configuration.
@@ -164,7 +166,8 @@ public class DatabasePlatformFactory {
    } else if (dbProductName.contains("hsql database engine")) {
      return new HsqldbPlatform();
    } else if (dbProductName.contains("postgres")) {
-      return readPostgres(connection, majorVersion);
+      String productVersion = metaData.getDatabaseProductVersion().toLowerCase(Locale.ENGLISH);
+      return readPostgres(connection, majorVersion, productVersion);
    } else if (dbProductName.contains("mariadb")) {
      return new MariaDbPlatform();
    } else if (dbProductName.contains("mysql")) {
@@ -207,11 +210,14 @@ public class DatabasePlatformFactory {
  /**
   * Use a select version() query as it could be Postgres or CockroachDB.
   */
-  private static DatabasePlatform readPostgres(Connection connection, int majorVersion) {
+  private static DatabasePlatform readPostgres(Connection connection, int majorVersion, String productVersion) {
+    if (productVersion.contains("-yb-")) {
+      return new YugabytePlaform();
+    }
    try (PreparedStatement statement = connection.prepareStatement("select version() as \"version\"")) {
      try (ResultSet resultSet = statement.executeQuery()) {
        if (resultSet.next()) {
-          String productVersion = resultSet.getString("version").toLowerCase();
+          productVersion = resultSet.getString("version").toLowerCase();
          if (productVersion.contains("cockroach")) {
            return new CockroachPlatform();
          }
@@ -15,6 +15,8 @@ public final class DbExpressionHandlerFactory {
      case H2:
        return new H2DbExpression();
      case POSTGRES:
+      case YUGABYTE:
+      case COCKROACH:
        return new PostgresDbExpression();
      case MARIADB:
        return new MariaDbExpression();
@@ -1,21 +1,7 @@
 package io.ebeaninternal.dbmigration.ddlgeneration;

 import io.ebean.config.dbplatform.DatabasePlatform;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.ClickHouseDdl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.CockroachDdl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.DB2Ddl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.H2Ddl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.HanaColumnStoreDdl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.HsqldbDdl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.MariaDbDdl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.MySqlDdl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.NuoDbDdl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.OracleDdl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.PlatformDdl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.Postgres9Ddl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.PostgresDdl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.SQLiteDdl;
-import io.ebeaninternal.dbmigration.ddlgeneration.platform.SqlServerDdl;
+import io.ebeaninternal.dbmigration.ddlgeneration.platform.*;

 /**
 * Builds platform specific DDL handler.
@@ -53,6 +39,8 @@ public class PlatformDdlBuilder {
        return new Postgres9Ddl(platform);
      case POSTGRES:
        return new PostgresDdl(platform);
+      case YUGABYTE:
+        return new YugabyteDdl(platform);
      case COCKROACH:
        return new CockroachDdl(platform);
      case SQLSERVER16:
@@ -174,16 +174,21 @@ public abstract class DbTriggerBasedHistoryDdl implements PlatformHistoryDdl {
  }

  protected void createHistoryTable(DdlBuffer apply, MTable table) throws IOException {
+    createHistoryTableAs(apply, table);
+    createHistoryTableWithPeriod(apply);
+  }

+  protected void createHistoryTableAs(DdlBuffer apply, MTable table) throws IOException {
    apply.append(platformDdl.getCreateTableCommandPrefix()).append(" ").append(table.getName()).append(historySuffix).append("(").newLine();
-
-    Collection<MColumn> cols = table.allColumns();
-    for (MColumn column : cols) {
+    for (MColumn column : table.allColumns()) {
      if (!column.isDraftOnly()) {
        writeColumnDefinition(apply, column.getName(), column.getType());
        apply.append(",").newLine();
      }
    }
+  }
+
+  protected void createHistoryTableWithPeriod(DdlBuffer apply) throws IOException {
    writeColumnDefinition(apply, sysPeriodStart, sysPeriodType);
    apply.append(",").newLine();
    writeColumnDefinition(apply, sysPeriodEnd, sysPeriodType);
@@ -22,11 +22,8 @@ public class PostgresHistoryDdl extends DbTriggerBasedHistoryDdl {
   */
  @Override
  protected void createHistoryTable(DdlBuffer apply, MTable table) throws IOException {
-
-    String baseTable = table.getName();
-    apply
-      .append("create table ").append(baseTable).append(historySuffix)
-      .append("(like ").append(baseTable).append(")").endOfStatement();
+    apply.append("create table ").append(table.getName()).append(historySuffix)
+      .append("(like ").append(table.getName()).append(")").endOfStatement();
  }

  /**
@@ -57,7 +54,6 @@ public class PostgresHistoryDdl extends DbTriggerBasedHistoryDdl {

  @Override
  protected void createTriggers(DdlWrite writer, MTable table) throws IOException {
-
    String baseTableName = table.getName();
    String procedureName = procedureName(baseTableName);
    String triggerName = triggerName(baseTableName);
@@ -110,7 +106,6 @@ public class PostgresHistoryDdl extends DbTriggerBasedHistoryDdl {

  @Override
  protected void createStoredFunction(DdlWrite writer, MTable table) throws IOException {
-
    String procedureName = procedureName(table.getName());
    String historyTable = historyTableName(table.getName());

@@ -120,16 +115,13 @@ public class PostgresHistoryDdl extends DbTriggerBasedHistoryDdl {

  @Override
  protected void updateHistoryTriggers(DbTriggerUpdate update) throws IOException {
-
    String procedureName = procedureName(update.getBaseTable());
-
    recreateHistoryView(update);
    createOrReplaceFunction(update.historyTriggerBuffer(), procedureName, update.getHistoryTable(), update.getColumns());
  }

  @Override
  protected void appendInsertIntoHistory(DdlBuffer buffer, String historyTable, List<String> columns) throws IOException {
-
    buffer.append("    insert into ").append(historyTable).append(" (").append(sysPeriod).append(",");
    appendColumnNames(buffer, columns, "");
    buffer.append(") values (tstzrange(lowerTs,upperTs), ");
@@ -0,0 +1,11 @@
+package io.ebeaninternal.dbmigration.ddlgeneration.platform;
+
+import io.ebean.config.dbplatform.DatabasePlatform;
+
+public class YugabyteDdl extends PostgresDdl {
+
+  public YugabyteDdl(DatabasePlatform platform) {
+    super(platform);
+    this.historyDdl = new YugabyteHistoryDdl();
+  }
+}
@@ -0,0 +1,16 @@
+package io.ebeaninternal.dbmigration.ddlgeneration.platform;
+
+import io.ebeaninternal.dbmigration.ddlgeneration.DdlBuffer;
+import io.ebeaninternal.dbmigration.model.MTable;
+
+import java.io.IOException;
+
+public class YugabyteHistoryDdl extends PostgresHistoryDdl {
+
+  @Override
+  protected void createHistoryTable(DdlBuffer apply, MTable table) throws IOException {
+    createHistoryTableAs(apply, table);
+    writeColumnDefinition(apply, sysPeriod, "tstzrange");
+    apply.newLine().append(")").endOfStatement();
+  }
+}
@@ -56,7 +56,7 @@
    <dependency>
      <groupId>io.ebean</groupId>
      <artifactId>ebean-test-docker</artifactId>
-      <version>4.4</version>
+      <version>4.5</version>
    </dependency>

    <dependency>
@@ -0,0 +1,28 @@
+package main;
+
+import io.ebean.docker.commands.YugabyteConfig;
+import io.ebean.docker.commands.YugabyteContainer;
+
+public class StartYugabyte {
+
+  public static void main(String[] args) {
+
+    YugabyteConfig config = new YugabyteConfig("2.11.2.0-b89");
+    config.setDbName("unit");
+    config.setUser("unit");
+
+    YugabyteContainer container = new YugabyteContainer(config);
+    container.start();
+
+//    Run container ut_yugabyte with host:localhost port:6433 db:unit user:unit/test shutdown:None
+//    docker run -d --name ut_yugabyte -p 6433:5433 -p 7000:7000 -p 9000:9000 -p 9042:9042 yugabytedb/yugabyte:2.11.2.0-b89 bin/yugabyted start --daemon=false
+//    ...
+//    Commands - sqlRun: drop database if exists unit
+//    Commands - sqlRun: drop role if exists unit
+//    Commands - sqlRun: select 1 from pg_database where datname = 'unit'
+//    Commands - sqlRun: select rolname from pg_roles where rolname = 'unit'
+//    Commands - sqlRun: create role unit password 'test' login createrole
+//    Commands - sqlRun: create database unit with owner unit
+
+  }
+}
@@ -23,6 +23,7 @@ ebean.ddl.run=true
 ebean.ddl.header=-- Generated by ebean ${version} at ${timestamp}
 ebean.packages=org.tests,org.etest
 datasource.default=h2
+#datasource.default=yugabyte
 #datasource.h2.capturestacktrace=true

 #ebean.dumpMetricsOnShutdown=true
@@ -144,6 +145,10 @@ datasource.cockroach.password=
 datasource.cockroach.url=jdbc:postgresql://localhost:26257/unit?sslmode=disable
 datasource.cockroach.driver=org.postgresql.Driver

+datasource.yugabyte.username=unit
+datasource.yugabyte.password=test
+datasource.yugabyte.url=jdbc:postgresql://localhost:6433/unit?sslmode=disable
+
 datasource.oracle.username=test_ebean
 datasource.oracle.password=test
 datasource.oracle.url=jdbc:oracle:thin:@localhost:1521:XE