class DbStorageSingle extends DbStorage with FlagCloseable with NamedLogging

DB Storage implementation that assumes a single process accessing the underlying database.

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbStorageSingle
  2. NamedLogging
  3. DbStorage
  4. Storage
  5. HealthComponent
  6. BaseHealthComponent
  7. HealthElement
  8. FlagCloseable
  9. AutoCloseable
  10. AnyRef
  11. 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 = (DbStorageSingle.this.type, State, TraceContext) => Unit
    Definition Classes
    HealthElement
  3. type State = ComponentHealthState

Value Members

  1. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable
  2. object DbStorageConverters
    Definition Classes
    DbStorage
  3. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def ##: Int
    Definition Classes
    AnyRef → Any
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. lazy val api: DbStorageAPI.type
    Definition Classes
    DbStorage
  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. 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()
  10. val closingState: ComponentHealthState
    Definition Classes
    HealthComponentBaseHealthComponent
  11. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  12. lazy val converters: DbStorageConverters.type
    Definition Classes
    DbStorage
  13. val dbConfig: DbConfig
    Definition Classes
    DbStorageSingleDbStorage
  14. 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
    HealthComponent
  15. 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
    HealthComponent
  16. implicit val ec: ExecutionContext
    Definition Classes
    DbStorageSingleDbStorage
  17. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  19. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  20. def failureOccurred(error: String)(implicit tc: TraceContext): Unit

    Report that the component is now failed

    Report that the component is now failed

    Definition Classes
    HealthComponent
  21. def failureOccurred(error: CantonError)(implicit tc: TraceContext): Unit

    Report that the component is now failed

    Report that the component is now failed

    Definition Classes
    HealthComponent
  22. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def getState: State

    Current state

    Current state

    Definition Classes
    BaseHealthComponentHealthElement
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. lazy val initialHealthState: ComponentHealthState
  26. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  27. 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
    DbStorageSingleStorage
  28. 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
  29. def isFailed: Boolean
    Definition Classes
    BaseHealthComponent
  30. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  31. 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
  32. 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
  33. 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
  34. val listeners: AtomicReference[List[HealthListener]]
    Attributes
    protected
    Definition Classes
    HealthElement
  35. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  36. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbStorageSingleNamedLogging
  37. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  38. val metrics: DbStorageMetrics
    Definition Classes
    DbStorageSingleDbStorage
  39. val name: String

    Name of the health element.

    Name of the health element. Used for logging.

    Definition Classes
    DbStorageHealthElement
  40. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  41. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  42. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  43. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  44. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  45. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
  46. def onClosed(): Unit
    Definition Classes
    DbStorageSingleFlagCloseable
  47. 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
  48. 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
  49. 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
  50. 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
  51. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  52. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  53. 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
  54. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  55. val profile: Profile
    Definition Classes
    DbStorageSingleDbStorage
  56. 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
  57. 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
  58. def querySingle[A](action: DBIOAction[Option[A], NoStream, Read with Transactional], operationName: String)(implicit traceContext: TraceContext, closeContext: CloseContext): OptionT[Future, A]
    Definition Classes
    DbStorage
  59. def registerOnHealthChange(listener: HealthListener): Unit
    Definition Classes
    BaseHealthComponentHealthElement
  60. def reportHealthState(state: State)(implicit tc: TraceContext): Boolean
    Definition Classes
    BaseHealthComponent
  61. def reportHealthState_(state: State)(implicit tc: TraceContext): Unit
    Definition Classes
    BaseHealthComponent
  62. 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
    HealthComponent
  63. def resolveUnhealthy_(implicit traceContext: TraceContext): Unit
    Definition Classes
    HealthComponent
  64. def run[A](operationName: String, maxRetries: Int)(body: => Future[A])(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
    Attributes
    protected
    Definition Classes
    DbStorage
  65. 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
  66. def runRead[A](action: ReadTransactional[A], operationName: String, maxRetries: Int)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
    Attributes
    protected[canton]
    Definition Classes
    DbStorageSingleDbStorage
  67. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  68. def runWrite[A](action: All[A], operationName: String, maxRetries: Int)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
    Attributes
    protected[canton]
    Definition Classes
    DbStorageSingleDbStorage
  69. def sequentialQueryAndCombine[A](actions: Iterable[ReadOnly[Iterable[A]]], operationName: String)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[Iterable[A]]
    Definition Classes
    DbStorage
  70. lazy val stateRef: AtomicReference[State]
    Attributes
    protected
    Definition Classes
    BaseHealthComponent
  71. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  72. val threadsAvailableForWriting: PositiveInt
    Definition Classes
    DbStorageSingleDbStorage
  73. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbStorageSingleDbStorageFlagCloseable
  74. def toComponentStatus: ComponentStatus
    Definition Classes
    BaseHealthComponent
  75. def toString(): String
    Definition Classes
    AnyRef → Any
  76. 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
  77. 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
  78. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  79. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  80. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  81. 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

Inherited from NamedLogging

Inherited from DbStorage

Inherited from Storage

Inherited from HealthComponent

Inherited from BaseHealthComponent

Inherited from HealthElement

Inherited from FlagCloseable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped