Package io.ebeaninternal.dbmigration.ddlgeneration.platform

Interface PlatformHistoryDdl

All Known Subinterfaces:
PlatformHistoryDdl.TableBased
All Known Implementing Classes:
Db2HistoryDdl, DbTableBasedHistoryDdl, DbTriggerBasedHistoryDdl, H2HistoryDdl, HanaHistoryDdl, MariaDbHistoryDdl, MySqlHistoryDdl, NoHistorySupportDdl, NuoDbHistoryDdl, PostgresHistoryDdl, SqlServerHistoryDdl, YugabyteHistoryDdl
public interface PlatformHistoryDdl
Defines the implementation for adding history support to a table.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    PlatformHistoryDdl.TableBased
    When history is table based, then alters on the live tables are applied also to the history tables.

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addHistoryTable(DdlWrite writer, AddHistoryTable addHistoryTable)
    Add history support to the given table.
    void
    configure(io.ebean.config.DatabaseConfig config, PlatformDdl platformDdl)
    Configure typically reading the necessary parameters from DatabaseConfig and Platform.
    void
    createWithHistory(DdlWrite writer, MTable table)
    Creates a new table and add history support to the table using platform specific mechanism.
    void
    dropHistoryTable(DdlWrite writer, DropHistoryTable dropHistoryTable)
    Drop history support for the given table.
    default void
    updateTriggers(DdlWrite writer, String tableName)
    Regenerate the history triggers/stored function due to column added/dropped/included or excluded.

  • Method Details

    • configure

      void configure(io.ebean.config.DatabaseConfig config, PlatformDdl platformDdl)
      Configure typically reading the necessary parameters from DatabaseConfig and Platform.

    • createWithHistory

      void createWithHistory(DdlWrite writer, MTable table)
      Creates a new table and add history support to the table using platform specific mechanism.

    • dropHistoryTable

      void dropHistoryTable(DdlWrite writer, DropHistoryTable dropHistoryTable)
      Drop history support for the given table.

    • addHistoryTable

      void addHistoryTable(DdlWrite writer, AddHistoryTable addHistoryTable)
      Add history support to the given table.

    • updateTriggers

      default void updateTriggers(DdlWrite writer, String tableName)
      Regenerate the history triggers/stored function due to column added/dropped/included or excluded. Note: This function may be called multiple times for the same table.