class DbStorageMulti extends DbStorage with NamedLogging with HasCloseContext
DB Storage implementation that allows multiple processes to access the underlying database and uses a pool of write connections which are guarded by an exclusive main lock to ensure a single writer instance.
Periodically checks the activeness of the write connection pool and if the activeness changes executes the
onActive
or onPassive
callbacks.
- Alphabetic
- By Inheritance
- DbStorageMulti
- HasCloseContext
- PromiseUnlessShutdownFactory
- NamedLogging
- DbStorage
- Storage
- AtomicHealthComponent
- AtomicHealthElement
- CloseableHealthComponent
- HealthComponent
- CloseableHealthQuasiComponent
- HealthQuasiComponent
- CloseableHealthElement
- HealthElement
- FlagCloseable
- PerformUnlessClosing
- OnShutdownRunner
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- type State = ComponentHealthState
The type of health states exposed by this component
The type of health states exposed by this component
- Definition Classes
- HealthComponent → HealthQuasiComponent → HealthElement
Value Members
- object DbStorageConverters
- Definition Classes
- DbStorage
- 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
- lazy val api: (profile)#DbStorageAPI.type
- Definition Classes
- DbStorage
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- final def associatedOnShutdownRunner: FlagCloseable
The com.digitalasset.canton.lifecycle.OnShutdownRunner associated with this object.
The com.digitalasset.canton.lifecycle.OnShutdownRunner associated with this object.
When this com.digitalasset.canton.lifecycle.OnShutdownRunner closes, the health state permanently becomes closingState and all listeners are notified about this.
- Attributes
- protected
- Definition Classes
- CloseableHealthElement → HealthElement
- def cancelShutdownTask(token: Long): Unit
Removes a shutdown task from the list using a token returned by runOnShutdown
Removes a shutdown task from the list using a token returned by runOnShutdown
- Definition Classes
- OnShutdownRunner
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
- final def close(): Unit
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
- Definition Classes
- FlagCloseable → OnShutdownRunner → AutoCloseable
- implicit val closeContext: CloseContext
- Definition Classes
- HasCloseContext
- def closingState: ComponentHealthState
The state set when the associatedOnShutdownRunner closes
The state set when the associatedOnShutdownRunner closes
- Definition Classes
- HealthComponent → HealthQuasiComponent → HealthElement
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable → PerformUnlessClosing
- def containsShutdownTask(token: Long): Boolean
- Definition Classes
- OnShutdownRunner
- lazy val converters: DbStorageConverters.type
- Definition Classes
- DbStorage
- val dbConfig: DbConfig
- Definition Classes
- DbStorageMulti → DbStorage
- def degradationOccurred(error: String)(implicit tc: TraceContext): Unit
Report that the component is now degraded.
Report that the component is now degraded. Note that this will override the component state, even if it is currently failed!
- Definition Classes
- AtomicHealthComponent
- def degradationOccurred(error: BaseError)(implicit tc: TraceContext): Unit
Report that the component is now degraded.
Report that the component is now degraded. Note that this will override the component state, even if it is currently failed!
- Definition Classes
- AtomicHealthComponent
- implicit val ec: ExecutionContext
- Attributes
- protected
- Definition Classes
- DbStorageMulti → DbStorage
- 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
- def failureOccurred(error: String)(implicit tc: TraceContext): Unit
Report that the component is now failed
Report that the component is now failed
- Definition Classes
- AtomicHealthComponent
- def failureOccurred(error: BaseError)(implicit tc: TraceContext): Unit
Report that the component is now failed
Report that the component is now failed
- Definition Classes
- AtomicHealthComponent
- def fatalOccurred(error: String)(implicit tc: TraceContext): Unit
Report that the component is now fatally failed and the system should be restarted.
Report that the component is now fatally failed and the system should be restarted.
- Definition Classes
- AtomicHealthComponent
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- final def getState: State
Returns the current state
Returns the current state
- Definition Classes
- HealthElement
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
- def initialHealthState: ComponentHealthState
The initial state upon creation
The initial state upon creation
- Definition Classes
- DbStorageMulti → DbStorage → HealthElement
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def isActive: Boolean
Indicates if the storage instance is active and ready to perform updates/writes.
Indicates if the storage instance is active and ready to perform updates/writes.
- Definition Classes
- DbStorageMulti → Storage
- def isClosing: Boolean
Check whether we're closing.
Check whether we're closing. Susceptible to race conditions; unless you're using this as a flag to the retry lib or you really know what you're doing, prefer
performUnlessClosing
and friends.- Definition Classes
- OnShutdownRunner
- def isDegrading: Boolean
- Definition Classes
- HealthQuasiComponent
- def isFailed: Boolean
- Definition Classes
- HealthQuasiComponent
- def isFatal: Boolean
- Definition Classes
- HealthQuasiComponent
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isOk: Boolean
- Definition Classes
- HealthQuasiComponent
- def keepTrackOfOpenFutures: Boolean
track running futures on shutdown
track running futures on shutdown
set to true to get detailed information about all futures that did not complete during shutdown. if set to false, we don't do anything.
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def limit(numberOfItems: Int, skipItems: Long = 0L): String
Returns database specific limit [offset] clause.
Returns database specific limit [offset] clause. Safe to use in a select slick query with #$... interpolation
- Definition Classes
- DbStorage
- def limitSql(numberOfItems: Int, skipItems: Long = 0L): SQLActionBuilder
Automatically performs #$ interpolation for a call to
limit
Automatically performs #$ interpolation for a call to
limit
- Definition Classes
- DbStorage
- val logOperations: Boolean
- Attributes
- protected
- Definition Classes
- DbStorageMulti → DbStorage
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- DbStorageMulti → NamedLogging
- def maxSleepMillis: Long
How often to poll to check that all tasks have completed.
How often to poll to check that all tasks have completed.
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- val metrics: DbStorageMetrics
- Definition Classes
- DbStorageMulti → DbStorage
- def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext, ec: ExecutionContext): PromiseUnlessShutdown[A]
Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.
Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.
Note: you should *not* invoke
success
on the returned promise but rather usetrySuccess
. The reason is that the call tosuccess
may fail in case of shutdown.- Definition Classes
- PromiseUnlessShutdownFactory
- val name: String
Name of the health element.
Name of the health element. Used for logging.
- Definition Classes
- DbStorage → HealthElement
- 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() @IntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
- def onCloseFailure(e: Throwable): Unit
- Attributes
- protected
- Definition Classes
- PerformUnlessClosing
- def onClosed(): Unit
- Definition Classes
- DbStorageMulti → PerformUnlessClosing
- final def onFirstClose(): Unit
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
Blocks until all earlier tasks have completed and then prevents further tasks from being run.
- Definition Classes
- PerformUnlessClosing → OnShutdownRunner
- Annotations
- @SuppressWarnings()
- def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
f
unless a shutdown has been initiated.Performs the task given by
f
unless a shutdown has been initiated. The shutdown will only begin afterf
completes, but other tasks may execute concurrently withf
, if started using this function, or one of the other variants (performUnlessClosingF and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.DO NOT CALL
this.close
as part off
, because it will result in a deadlock.- f
The task to perform
- returns
scala.None$ if a shutdown has been initiated. Otherwise the result of the task.
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingCheckedT[A, N, R](name: String, onClosing: => Checked[A, N, R])(etf: => CheckedT[Future, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[Future, A, N, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherT[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]
Performs the EitherT[Future] given by
etf
unless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etf
unless a shutdown has been initiated, in which case the provided error is returned instead. Bothetf
and the error are lazy;etf
is only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretf
completes, but other tasks may execute concurrently withetf
, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingF). The tasks are assumed to take less than closingTimeout to complete.DO NOT CALL
this.close
as part ofetf
, because it will result in a deadlock.- etf
The task to perform
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherTF[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
f
unless a shutdown has been initiated.Performs the Future given by
f
unless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterf
completes, but other tasks may execute concurrently withf
, if started using this function, or one of the other variants (performUnlessClosing and performUnlessClosingEitherT). The tasks are assumed to take less than closingTimeout to complete.DO NOT CALL
this.close
as part off
, because it will result in a deadlock.- f
The task to perform
- returns
The future completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if a shutdown has been initiated. Otherwise the result of the task wrapped in com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome.
- Definition Classes
- PerformUnlessClosing
- def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
- Definition Classes
- PerformUnlessClosing
- def prettyState: Pretty[State]
- Attributes
- protected
- Definition Classes
- HealthQuasiComponent → HealthElement
- val profile: Profile with DbLockSupport
- Definition Classes
- DbStorageMulti → DbStorage
- def query[A](action: ReadTransactional[A], operationName: String, retries: DbRetries = DbRetries())(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
Read-only query, possibly transactional
Read-only query, possibly transactional
- Definition Classes
- DbStorage
- def queryAndUpdate[A](action: DBIOAction[A, NoStream, All], operationName: String, retries: DbRetries = DbRetries())(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
Query and update in a single action.
Query and update in a single action.
Note that the action is not transactional by default, but can be made so via using
queryAndUpdate(action.transactionally..withTransactionIsolation(Serializable), "name")
The action must be idempotent because it may be retried multiple times. Only the result of the last retry will be reported. If the action reports the number of rows changed, this number may be lower than actual number of affected rows because updates from earlier retries are not accounted.
- Definition Classes
- DbStorage
- def querySingle[A](action: DBIOAction[Option[A], NoStream, Read with Transactional], operationName: String, retries: DbRetries = DbRetries())(implicit traceContext: TraceContext, closeContext: CloseContext): OptionT[Future, A]
- Definition Classes
- DbStorage
- def refreshState(newState: Eval[State])(implicit traceContext: TraceContext): Unit
Triggers a refresh of the component's state, using
newState
to determine the new state.Triggers a refresh of the component's state, using
newState
to determine the new state. May return before thenewState
has been evaluated and the listeners have been poked.Note that listeners need not be poked about every state change; it suffices that they are poked eventually after each state change. So if there are frequent updates to the state, possibly from concurrent calls, then the listeners may never see some intermediate states.
- Attributes
- protected
- Definition Classes
- HealthElement
- def registerOnHealthChange(listener: HealthListener): Boolean
Registers a listener that gets poked upon each change of this element's health state.
Registers a listener that gets poked upon each change of this element's health state.
- returns
Whether the listener was not registered before
- Definition Classes
- HealthElement
- def reportHealthState(state: State)(implicit tc: TraceContext): Unit
Sets the state of this component and notifies its listeners
Sets the state of this component and notifies its listeners
- Definition Classes
- AtomicHealthElement
- def resolveUnhealthy()(implicit traceContext: TraceContext): Unit
Set the health state to Ok and if the previous state was unhealthy, log a message to inform about the resolution of the ongoing issue.
Set the health state to Ok and if the previous state was unhealthy, log a message to inform about the resolution of the ongoing issue.
- Definition Classes
- AtomicHealthComponent
- def run[A](action: String, operationName: String, retries: DbRetries)(body: => Future[A])(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
- Attributes
- protected
- Definition Classes
- DbStorage
- def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long
Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask
Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask
- Definition Classes
- OnShutdownRunner
- def runOnShutdown_[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit
Register a task to run when shutdown is initiated.
Register a task to run when shutdown is initiated.
You can use this for example to register tasks that cancel long-running computations, whose termination you can then wait for in "closeAsync".
- Definition Classes
- OnShutdownRunner
- def runRead[A](action: ReadTransactional[A], operationName: String, retries: DbRetries)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
- Attributes
- protected[canton]
- Definition Classes
- DbStorageMulti → DbStorage
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- OnShutdownRunner
- Annotations
- @VisibleForTesting()
- def runWrite[A](action: All[A], operationName: String, retries: DbRetries)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
- Attributes
- protected[canton]
- Definition Classes
- DbStorageMulti → DbStorage
- def sequentialQueryAndCombine[A](actions: Iterable[ReadOnly[Iterable[A]]], operationName: String)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[Iterable[A]]
- Definition Classes
- DbStorage
- def setPassive()(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val threadsAvailableForWriting: PositiveInt
- Definition Classes
- DbStorageMulti → DbStorage
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- DbStorageMulti → DbStorage → FlagCloseable
- def toComponentStatus: ComponentStatus
- Definition Classes
- HealthQuasiComponent
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unregisterOnHealthChange(listener: HealthListener): Boolean
Unregisters a listener.
Unregisters a listener.
- returns
Whether the listener was registered before.
- Definition Classes
- HealthElement
- def update[A](action: DBIOAction[A, NoStream, Write with Transactional], operationName: String, retries: DbRetries = DbRetries())(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
Write-only action, possibly transactional
Write-only action, possibly transactional
The action must be idempotent because it may be retried multiple times. Only the result of the last retry will be reported. If the action reports the number of rows changed, this number may be lower than actual number of affected rows because updates from earlier retries are not accounted.
- Definition Classes
- DbStorage
- def update_(action: DBIOAction[_, NoStream, Write with Transactional], operationName: String, retries: DbRetries = DbRetries())(implicit traceContext: TraceContext, closeContext: CloseContext): Future[Unit]
Write-only action, possibly transactional The action must be idempotent because it may be retried multiple times.
Write-only action, possibly transactional The action must be idempotent because it may be retried multiple times.
- Definition Classes
- DbStorage
- 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()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- def withSyncCommitOnPostgres[A, E <: Effect](query: DBIOAction[A, NoStream, E]): DBIOAction[A, NoStream, Write with E with Transactional]
Runs the given
query
transactionally with synchronous commit replication if the database provides the ability to configure synchronous commits per transaction.Runs the given
query
transactionally with synchronous commit replication if the database provides the ability to configure synchronous commits per transaction.Currently only Postgres supports this.
- Definition Classes
- DbStorage