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.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbStorageMulti
  2. HasCloseContext
  3. PromiseUnlessShutdownFactory
  4. NamedLogging
  5. DbStorage
  6. Storage
  7. AtomicHealthComponent
  8. AtomicHealthElement
  9. CloseableHealthComponent
  10. HealthComponent
  11. CloseableHealthQuasiComponent
  12. HealthQuasiComponent
  13. CloseableHealthElement
  14. HealthElement
  15. FlagCloseable
  16. PerformUnlessClosing
  17. OnShutdownRunner
  18. AutoCloseable
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type State = ComponentHealthState

    The type of health states exposed by this component

    The type of health states exposed by this component

    Definition Classes
    HealthComponentHealthQuasiComponentHealthElement

Value Members

  1. object DbStorageConverters
    Definition Classes
    DbStorage
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. lazy val api: (profile)#DbStorageAPI.type
    Definition Classes
    DbStorage
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. 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
    CloseableHealthElementHealthElement
  8. 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
  9. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  10. 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
    FlagCloseableOnShutdownRunner → AutoCloseable
  11. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  12. def closingState: ComponentHealthState

    The state set when the associatedOnShutdownRunner closes

    The state set when the associatedOnShutdownRunner closes

    Definition Classes
    HealthComponentHealthQuasiComponentHealthElement
  13. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  14. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  15. lazy val converters: DbStorageConverters.type
    Definition Classes
    DbStorage
  16. val dbConfig: DbConfig
    Definition Classes
    DbStorageMultiDbStorage
  17. 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
  18. 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
  19. implicit val ec: ExecutionContext
    Attributes
    protected
    Definition Classes
    DbStorageMultiDbStorage
  20. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  22. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  23. 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
  24. 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
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. final def getState: State

    Returns the current state

    Returns the current state

    Definition Classes
    HealthElement
  27. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  28. def initialHealthState: ComponentHealthState

    The initial state upon creation

    The initial state upon creation

    Definition Classes
    DbStorageMultiDbStorageHealthElement
  29. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  30. 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
    DbStorageMultiStorage
  31. def isClosing: Boolean

    Check whether we're closing.

    Check whether we're closing. Susceptible to race conditions; unless you're using using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

    Definition Classes
    OnShutdownRunner
  32. def isFailed: Boolean
    Definition Classes
    HealthQuasiComponent
  33. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  34. 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
  35. 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
  36. 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
  37. val logOperations: Boolean
    Attributes
    protected
    Definition Classes
    DbStorageMultiDbStorage
  38. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  39. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbStorageMultiNamedLogging
  40. 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
  41. val metrics: DbStorageMetrics
    Definition Classes
    DbStorageMultiDbStorage
  42. 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 use trySuccess. The reason is that the call to success may fail in case of shutdown.

    Definition Classes
    PromiseUnlessShutdownFactory
  43. val name: String

    Name of the health element.

    Name of the health element. Used for logging.

    Definition Classes
    DbStorageHealthElement
  44. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  45. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  46. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  47. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  48. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  49. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  50. def onClosed(): Unit
    Definition Classes
    DbStorageMultiPerformUnlessClosing
  51. 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
    PerformUnlessClosingOnShutdownRunner
    Annotations
    @SuppressWarnings()
  52. 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 after f completes, but other tasks may execute concurrently with f, 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 of f, 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
  53. 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
  54. 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. Both etf 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 after etf completes, but other tasks may execute concurrently with etf, 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 of etf, because it will result in a deadlock.

    etf

    The task to perform

    Definition Classes
    PerformUnlessClosing
  55. 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
  56. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  57. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  58. 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 after f completes, but other tasks may execute concurrently with f, 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 of f, 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
  59. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  60. def prettyState: Pretty[State]
    Attributes
    protected
    Definition Classes
    HealthQuasiComponentHealthElement
  61. val profile: Profile with DbLockSupport
    Definition Classes
    DbStorageMultiDbStorage
  62. def query[A](action: ReadTransactional[A], operationName: String, maxRetries: Int = defaultMaxRetries)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]

    Read-only query, possibly transactional

    Read-only query, possibly transactional

    Definition Classes
    DbStorage
  63. def queryAndUpdate[A](action: DBIOAction[A, NoStream, All], operationName: String, maxRetries: Int = defaultMaxRetries)(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
  64. def querySingle[A](action: DBIOAction[Option[A], NoStream, Read with Transactional], operationName: String)(implicit traceContext: TraceContext, closeContext: CloseContext): OptionT[Future, A]
    Definition Classes
    DbStorage
  65. 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 the newState 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
  66. 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
  67. 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
  68. 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
  69. def run[A](action: String, operationName: String, maxRetries: Int)(body: => Future[A])(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
    Attributes
    protected
    Definition Classes
    DbStorage
  70. 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
  71. 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
  72. def runRead[A](action: ReadTransactional[A], operationName: String, maxRetries: Int)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
    Attributes
    protected[canton]
    Definition Classes
    DbStorageMultiDbStorage
  73. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  74. def runWrite[A](action: All[A], operationName: String, maxRetries: Int)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
    Attributes
    protected[canton]
    Definition Classes
    DbStorageMultiDbStorage
  75. def sequentialQueryAndCombine[A](actions: Iterable[ReadOnly[Iterable[A]]], operationName: String)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[Iterable[A]]
    Definition Classes
    DbStorage
  76. def setPassive()(implicit traceContext: TraceContext): EitherT[Future, String, Unit]
  77. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  78. val threadsAvailableForWriting: PositiveInt
    Definition Classes
    DbStorageMultiDbStorage
  79. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbStorageMultiDbStorageFlagCloseable
  80. def toComponentStatus: ComponentStatus
    Definition Classes
    HealthQuasiComponent
  81. def toString(): String
    Definition Classes
    AnyRef → Any
  82. def unregisterOnHealthChange(listener: HealthListener): Boolean

    Unregisters a listener.

    Unregisters a listener.

    returns

    Whether the listener was registered before.

    Definition Classes
    HealthElement
  83. def update[A](action: DBIOAction[A, NoStream, Write with Transactional], operationName: String, maxRetries: Int = defaultMaxRetries)(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
  84. def update_(action: DBIOAction[_, NoStream, Write with Transactional], operationName: String, maxRetries: Int = defaultMaxRetries)(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
  85. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  86. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  87. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  88. 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

Deprecated Value Members

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

Inherited from HasCloseContext

Inherited from NamedLogging

Inherited from DbStorage

Inherited from Storage

Inherited from AtomicHealthComponent

Inherited from AtomicHealthElement

Inherited from HealthComponent

Inherited from HealthQuasiComponent

Inherited from CloseableHealthElement

Inherited from HealthElement

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped