class DbStorageSingle extends DbStorage with FlagCloseable with NamedLogging
DB Storage implementation that assumes a single process accessing the underlying database.
- Alphabetic
- By Inheritance
- DbStorageSingle
- NamedLogging
- DbStorage
- FlagCloseable
- Storage
- ComponentHealth
- HealthElement
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
- Definition Classes
- FlagCloseable
- type HealthListener = (DbStorageSingle.this.type, State, TraceContext) => Unit
- Definition Classes
- HealthElement
- type State = ComponentState
- Definition Classes
- ComponentHealth → HealthElement
Value Members
- object ReaderState extends Serializable
- Definition Classes
- FlagCloseable
- 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: DbStorageAPI.type
- Definition Classes
- DbStorage
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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()
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- lazy val converters: DbStorageConverters.type
- Definition Classes
- DbStorage
- val dbConfig: DbConfig
- Definition Classes
- DbStorageSingle → 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
- ComponentHealth
- 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
- implicit val ec: ExecutionContext
- Definition Classes
- DbStorageSingle → 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
- ComponentHealth
- 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
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def getState: ComponentState
Current state
Current state
- Definition Classes
- ComponentHealth → HealthElement
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- lazy val initialState: ComponentState
Initial state of the component
Initial state of the component
- Definition Classes
- DbStorageSingle → DbStorage → ComponentHealth
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- FlagCloseable
- 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
- DbStorageSingle → Storage
- 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
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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
- 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
- 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
limitAutomatically performs #$ interpolation for a call to
limit- Definition Classes
- DbStorage
- val listeners: AtomicReference[List[HealthListener]]
- Attributes
- protected
- Definition Classes
- HealthElement
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- DbStorageSingle → NamedLogging
- def maxSleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- val metrics: DbStorageMetrics
- Definition Classes
- DbStorageSingle → DbStorage
- 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() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def onClosed(): Unit
- Definition Classes
- DbStorageSingle → FlagCloseable
- def performUnlessClosing[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
funless a shutdown has been initiated.Performs the task given by
funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, 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.closeas 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
- FlagCloseable
- 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
- 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
etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, 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.closeas part ofetf, because it will result in a deadlock.- etf
The task to perform
- Definition Classes
- FlagCloseable
- 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
- def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
- Definition Classes
- FlagCloseable
- def performUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
funless a shutdown has been initiated.Performs the Future given by
funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, 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.closeas 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
- FlagCloseable
- def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
- Definition Classes
- FlagCloseable
- val profile: Profile
- Definition Classes
- DbStorageSingle → DbStorage
- 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
- 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
- def querySingle[A](action: DBIOAction[Option[A], NoStream, Read with Transactional], operationName: String)(implicit traceContext: TraceContext, closeContext: CloseContext): OptionT[Future, A]
- Definition Classes
- DbStorage
- def registerOnHealthChange(listener: HealthListener): Unit
- Definition Classes
- HealthElement
- def reportHealthState(state: ComponentState)(implicit tc: TraceContext): Boolean
- Definition Classes
- ComponentHealth
- def reportHealthState_(state: ComponentState)(implicit tc: TraceContext): Unit
- Definition Classes
- ComponentHealth
- 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
- def resolveUnhealthy_(implicit traceContext: TraceContext): Unit
- Definition Classes
- ComponentHealth
- def run[A](operationName: String, maxRetries: Int)(body: => Future[A])(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
- Attributes
- protected
- Definition Classes
- DbStorage
- 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
- def runRead[A](action: ReadTransactional[A], operationName: String, maxRetries: Int)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
- Attributes
- protected[canton]
- Definition Classes
- DbStorageSingle → DbStorage
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- def runWrite[A](action: All[A], operationName: String, maxRetries: Int)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[A]
- Attributes
- protected[canton]
- Definition Classes
- DbStorageSingle → DbStorage
- def sequentialQueryAndCombine[A](actions: Iterable[ReadOnly[Iterable[A]]], operationName: String)(implicit traceContext: TraceContext, closeContext: CloseContext): Future[Iterable[A]]
- Definition Classes
- DbStorage
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- DbStorageSingle → DbStorage → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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
- 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
- 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
querytransactionally with synchronous commit replication if the database provides the ability to configure synchronous commits per transaction.Runs the given
querytransactionally with synchronous commit replication if the database provides the ability to configure synchronous commits per transaction.Currently only Postgres supports this.
- Definition Classes
- DbStorage