Package de.kaiserpfalzedv.commons.liquibase

Interface ChangeLog

public interface ChangeLog

ChangeLog -- The liquibase changelog.

This is the interface description to the changelog table as described in the liquibase documentation.

Since:
3.0.0 2023-01-19
Author:
klenkes74 <rlichti@kaiserpfalz-edv.de>

  • Method Details

    • getId

      @NotNull @Size(max=255) @NotNull @Size(max=255) String getId()

    • getAuthor

      @Size(max=255) @Size(max=255) String getAuthor()
      Returns:
      Value from the changeset author attribute.

    • getFilename

      @Size(max=255) @NotNull @Size(max=255) @NotNull String getFilename()
      Path to the changelog. This may be an absolute path or a relative path depending on how the changelog was passed to Liquibase. For best results, it should be a relative path. The logicalFilePath attribute can be used on the changelog or on individual changesets.
      Returns:
      Path to the changelog.

    • getExecutionDate

      @NotNull @Size(max=255) @NotNull @Size(max=255) OffsetDateTime getExecutionDate()
      Returns:
      Date/time of when the changeset was executed. Used with getExecutionOrder() to determine rollback order.

    • getExecutionOrder

      int getExecutionOrder()

      Order that the changesets were executed. Used in addition to getExecutionDate() to ensure order is correct even when the databases datetime supports poor resolution.

      NOTE: The values are only guaranteed to be increasing within an individual update run. There are times where they will restart at zero.

      Returns:
      Order that the changesets were executed.

    • getExecutionType

      @NotNull @NotNull ChangeLog.ExecType getExecutionType()
      Description of how the changeset was executed.
      Returns:
      Description of how the changeset was executed.

    • getMd5Sum

      @NotNull @Size(max=35) @NotNull @Size(max=35) String getMd5Sum()
      Checksum of the changeset when it was executed. Used on each run to ensure there have been no unexpected changes to changesets in the changelog file.
      Returns:
      Checksum of the changeset when it was executed.

    • getDescription

      @NotNull @Size(max=255) @NotNull @Size(max=255) String getDescription()
      Returns:
      Short auto-generated human-readable description of changeset

    • getComments

      @Size(max=255) @Size(max=255) String getComments()
      Returns:
      Value from the changeset comment attribute.

    • getTag

      @Size(max=255) @Size(max=255) String getTag()
      Returns:
      Tracks which changeset correspond to tag operations.

    • getLiquibaseVersion

      @NotNull @Size(max=20) @NotNull @Size(max=20) String getLiquibaseVersion()
      Returns:
      Version of Liquibase used to execute the changeset.

    • getContexts

      @Size(max=255) @Size(max=255) String getContexts()
      Returns:
      Context(s) used to execute the changeset.

    • getLabels

      @Size(max=255) @Size(max=255) String getLabels()
      Returns:
      Label(s) used to execute the changeset.

    • getDeploymentId

      @NotNull @Size(max=10) @NotNull @Size(max=10) String getDeploymentId()
      Returns:
      changesets deployed together will have the same unique identifier.