class DbMigrations extends NamedLogging
Performs DB migrations using Flyway.
- Alphabetic
- By Inheritance
- DbMigrations
- NamedLogging
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DbMigrations(dbConfig: DbConfig, alphaVersionSupport: Boolean, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext, closeContext: CloseContext)
- alphaVersionSupport
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.
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##: Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def checkAndMigrate(params: CantonNodeParameters, retryConfig: RetryConfig)(implicit tc: TraceContext): EitherT[UnlessShutdown, Error, Unit]
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- 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
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- DbMigrations → NamedLogging
- def migrateDatabase(): EitherT[UnlessShutdown, Error, Unit]
Migrate the database with all pending migrations.
- def migrateDatabaseInternal(flyway: Flyway)(implicit traceContext: TraceContext): EitherT[UnlessShutdown, Error, Unit]
- Attributes
- protected
- implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def noTracingLogger: Logger
- Attributes
- protected
- Definition Classes
- NamedLogging
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
- 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
- def repairFlywayMigrationInternal(flyway: Flyway)(implicit traceContext: TraceContext): EitherT[UnlessShutdown, Error, Unit]
- Attributes
- protected
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- def withCreatedDb[A](retryConfig: RetryConfig)(fn: (slick.jdbc.JdbcBackend.Database) => EitherT[UnlessShutdown, Error, A]): EitherT[UnlessShutdown, Error, A]
- Attributes
- protected
- def withDb[A](retryConfig: RetryConfig = RetryConfig.failFast)(fn: (slick.jdbc.JdbcBackend.Database) => EitherT[UnlessShutdown, Error, A])(implicit traceContext: TraceContext): EitherT[UnlessShutdown, Error, A]
With replication possibly multiple nodes sharing the same database, therefore we use a DB-lock based coordination for performing the DB migration.
With replication possibly multiple nodes sharing the same database, therefore we use a DB-lock based coordination for performing the DB migration. Only the node that acquired the lock performs the migration operation at a time.
- def withFlyway[A](fn: (Flyway) => EitherT[UnlessShutdown, Error, A])(implicit traceContext: TraceContext): EitherT[UnlessShutdown, Error, A]
- Attributes
- protected