trait DbStorage extends Storage with FlagCloseable

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbStorage
  2. FlagCloseable
  3. Storage
  4. ComponentHealth
  5. HealthElement
  6. AutoCloseable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
    Definition Classes
    FlagCloseable
  2. type HealthListener = (DbStorage.this, (DbStorage.this)#State, TraceContext) => Unit
    Definition Classes
    HealthElement
  3. type State = ComponentState
    Definition Classes
    ComponentHealth → HealthElement

Abstract Value Members

  1. abstract val dbConfig: DbConfig
  2. implicit abstract def ec: ExecutionContext
    Attributes
    protected
  3. abstract 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
    Storage
  4. abstract def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    FlagCloseable
  5. abstract def metrics: DbStorageMetrics
  6. abstract val profile: Profile
  7. abstract def runRead[A](action: ReadTransactional[A], operationName: String, maxRetries: Int)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
    Attributes
    protected[canton]
  8. abstract def runWrite[A](action: All[A], operationName: String, maxRetries: Int)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
    Attributes
    protected[canton]
  9. abstract def timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbStorage → FlagCloseable

Concrete Value Members

  1. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable
  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: DbStorageAPI.type
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. 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 → AutoCloseable
    Annotations
    @SuppressWarnings()
  9. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  10. lazy val converters: (DbStorage.this)#DbStorageConverters.type
  11. 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
    ComponentHealth
  12. def degradationOccurred(error: CantonError)(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
    ComponentHealth
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  15. def failureOccurred(error: String)(implicit tc: TraceContext): Unit

    Report that the component is now failed

    Report that the component is now failed

    Definition Classes
    ComponentHealth
  16. def failureOccurred(error: CantonError)(implicit tc: TraceContext): Unit

    Report that the component is now failed

    Report that the component is now failed

    Definition Classes
    ComponentHealth
  17. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def getState: ComponentState

    Current state

    Current state

    Definition Classes
    ComponentHealth → HealthElement
  19. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. lazy val initialState: ComponentState

    Initial state of the component

    Initial state of the component

    Definition Classes
    DbStorage → ComponentHealth
  21. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  22. 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
    FlagCloseable
  23. def isFailed: Boolean

    Whether the component is in a failed state.

    Whether the component is in a failed state. Note: failed here means exactly _failed_, to know if the component is just unhealthy (i.e degraded or failed), use isUnhealthy.

    Definition Classes
    ComponentHealth
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def isNotFailed: Boolean

    Returns true when the component is not in a failed state (for components, degraded is still not failed)

    Returns true when the component is not in a failed state (for components, degraded is still not failed)

    Definition Classes
    ComponentHealth → HealthElement
  26. 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
    FlagCloseable
  27. 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

  28. def limitSql(numberOfItems: Int, skipItems: Long = 0L): SQLActionBuilder

    Automatically performs #$ interpolation for a call to limit

  29. val listeners: AtomicReference[List[(DbStorage.this)#HealthListener]]
    Attributes
    protected
    Definition Classes
    HealthElement
  30. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  31. val name: String

    Name of the health element.

    Name of the health element. Used for logging.

    Definition Classes
    DbStorage → HealthElement
  32. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  33. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  35. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
  36. 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
    FlagCloseable
  37. 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
    FlagCloseable
  38. 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
    FlagCloseable
  39. 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
    FlagCloseable
  40. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  41. 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
    FlagCloseable
  42. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  43. def query[A](action: ReadTransactional[A], operationName: String, maxRetries: Int = defaultMaxRetries)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]

    Read-only query, possibly transactional

  44. 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.

  45. def querySingle[A](action: DBIOAction[Option[A], NoStream, Read with Transactional], operationName: String)(implicit traceContext: TraceContext, closeContext: CloseContext): OptionT[Future, A]
  46. def registerOnHealthChange(listener: (DbStorage.this)#HealthListener): Unit
    Definition Classes
    HealthElement
  47. def reportHealthState(state: ComponentState)(implicit tc: TraceContext): Boolean
    Definition Classes
    ComponentHealth
  48. def reportHealthState_(state: ComponentState)(implicit tc: TraceContext): Unit
    Definition Classes
    ComponentHealth
  49. def resolveUnhealthy(implicit traceContext: TraceContext): Boolean

    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
    ComponentHealth
  50. def resolveUnhealthy_(implicit traceContext: TraceContext): Unit
    Definition Classes
    ComponentHealth
  51. def run[A](operationName: String, maxRetries: Int)(body: => Future[A])(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
    Attributes
    protected
  52. 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
    FlagCloseable
  53. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  54. def sequentialQueryAndCombine[A](actions: Iterable[ReadOnly[Iterable[A]]], operationName: String)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[Iterable[A]]
  55. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  56. def toString(): String
    Definition Classes
    AnyRef → Any
  57. 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.

  58. 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.

  59. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  61. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  62. 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.

  63. object DbStorageConverters

Deprecated Value Members

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

Inherited from FlagCloseable

Inherited from Storage

Inherited from ComponentHealth

Inherited from HealthElement

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped