trait DbMigrations extends AnyRef

Self Type
DbMigrations with NamedLogging
Linear Supertypes
AnyRef, Any
Known Subclasses
CommunityDbMigrations, EnterpriseDbMigrations
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbMigrations
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. implicit abstract def closeContext: CloseContext
    Attributes
    protected
  2. abstract def dbConfig: DbConfig
    Attributes
    protected
  3. abstract def devVersionSupport: Boolean

    Whether we want to add the schema files found in the dev folder to the migration

    Whether we want to add the schema files found in the dev folder to the migration

    A user that does that, won't be able to upgrade to new Canton versions, as we reserve our right to just modify the dev version files in any way we like.

    Attributes
    protected
  4. abstract def withDb[A](retryConfig: RetryConfig = DbStorage.RetryConfig.failFast)(fn: (slick.jdbc.JdbcBackend.Database) => EitherT[UnlessShutdown, Error, A])(implicit traceContext: TraceContext): EitherT[UnlessShutdown, Error, A]

    Obtain access to the database to run the migration operation.

    Obtain access to the database to run the migration operation.

    Attributes
    protected

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def checkAndMigrate(params: CantonNodeParameters, retryConfig: RetryConfig)(implicit tc: TraceContext): EitherT[UnlessShutdown, Error, Unit]
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. def createFlyway(dataSource: DataSource): Flyway

    Database is migrated using Flyway, which looks at the migration files at src/main/resources/db/migration/canton as explained at https://flywaydb.org/documentation/getstarted/firststeps/api

    Database is migrated using Flyway, which looks at the migration files at src/main/resources/db/migration/canton as explained at https://flywaydb.org/documentation/getstarted/firststeps/api

    Attributes
    protected
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  10. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  13. def migrateDatabase(): EitherT[UnlessShutdown, Error, Unit]

    Migrate the database with all pending migrations.

  14. def migrateDatabaseInternal(flyway: Flyway)(implicit traceContext: TraceContext): EitherT[UnlessShutdown, Error, Unit]
    Attributes
    protected
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def repairFlywayMigration(): EitherT[UnlessShutdown, Error, Unit]

    Repair the database in case the migrations files changed (e.g.

    Repair the database in case the migrations files changed (e.g. due to comment changes). To quote the Flyway documentation:

    Repair is your tool to fix issues with the schema history table. It has a few main uses:

- Remove failed migration entries (only for databases that do NOT support DDL transactions)
- Realign the checksums, descriptions, and types of the applied migrations with the ones of the available migrations
- Mark all missing migrations as deleted
  19. def repairFlywayMigrationInternal(flyway: Flyway)(implicit traceContext: TraceContext): EitherT[UnlessShutdown, Error, Unit]
    Attributes
    protected
  20. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  23. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  24. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  25. def withCreatedDb[A](retryConfig: RetryConfig)(fn: (slick.jdbc.JdbcBackend.Database) => EitherT[UnlessShutdown, Error, A]): EitherT[UnlessShutdown, Error, A]
    Attributes
    protected
  26. def withFlyway[A](fn: (Flyway) => EitherT[UnlessShutdown, Error, A])(implicit traceContext: TraceContext): EitherT[UnlessShutdown, Error, A]
    Attributes
    protected

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated @Deprecated
    Deprecated

Inherited from AnyRef

Inherited from Any

Ungrouped