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. FlagCloseable
  5. Storage
  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

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. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  11. lazy val converters: DbStorageConverters.type
    Definition Classes
    DbStorage
  12. val dbConfig: DbConfig
    Definition Classes
    DbStorageSingleDbStorage
  13. implicit val ec: ExecutionContext
    Definition Classes
    DbStorageSingleDbStorage
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  16. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  19. 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
  20. 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
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. 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
  23. 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
  24. 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
  25. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  26. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbStorageSingleNamedLogging
  27. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  28. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  29. val metrics: DbStorageMetrics
    Definition Classes
    DbStorageSingleDbStorage
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  32. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  33. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  34. def onClosed(): Unit
    Definition Classes
    DbStorageSingleFlagCloseable
  35. 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
  36. 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
  37. 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
  38. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  39. 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
  40. val profile: Profile
    Definition Classes
    DbStorageSingleDbStorage
  41. 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
  42. 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
  43. def querySingle[A](action: DBIOAction[Option[A], NoStream, Read with Transactional], operationName: String)(implicit traceContext: TraceContext, closeContext: CloseContext): OptionT[Future, A]
    Definition Classes
    DbStorage
  44. def run[A](operationName: String, maxRetries: Int)(body: => Future[A])(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
    Attributes
    protected
    Definition Classes
    DbStorage
  45. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task that will run onClose after all "performUnlessShutdown" tasks have finished

    Register a task that will run onClose after all "performUnlessShutdown" tasks have finished

    Definition Classes
    FlagCloseable
  46. def runRead[A](action: ReadTransactional[A], operationName: String, maxRetries: Int)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
    Attributes
    protected[canton]
    Definition Classes
    DbStorageSingleDbStorage
  47. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  48. def runWrite[A](action: All[A], operationName: String, maxRetries: Int)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
    Attributes
    protected[canton]
    Definition Classes
    DbStorageSingleDbStorage
  49. def sequentialQueryAndCombine[A](actions: Iterable[ReadOnly[Iterable[A]]], operationName: String)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[Iterable[A]]
    Definition Classes
    DbStorage
  50. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  51. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbStorageSingleDbStorageFlagCloseable
  52. def toString(): String
    Definition Classes
    AnyRef → Any
  53. 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
  54. 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
  55. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  57. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

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 FlagCloseable

Inherited from Storage

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped