class DbSequencedEventStore extends SequencedEventStore with DbStore with DbPrunableByTime[SequencerClientDiscriminator, Nothing]
- Alphabetic
- By Inheritance
- DbSequencedEventStore
- DbPrunableByTime
- DbStore
- HasCloseContext
- FlagCloseable
- SequencedEventStore
- AutoCloseable
- NamedLogging
- PrunableByTime
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DbSequencedEventStore(storage: DbStorage, client: SequencerClientDiscriminator, protocolVersion: ProtocolVersion, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)
Type Members
- case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
- Definition Classes
- FlagCloseable
Value Members
- object ReaderState extends Serializable
- Definition Classes
- FlagCloseable
- 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
- def advancePruningTimestamp(phase: PruningPhase, timestamp: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, Nothing, Unit]
- Attributes
- protected[canton]
- Definition Classes
- DbPrunableByTime → PrunableByTime
- 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()
- implicit val closeContext: CloseContext
- Definition Classes
- HasCloseContext
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def doPrune(beforeAndIncluding: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, Nothing, Unit]
- Attributes
- protected[canton]
- Definition Classes
- DbSequencedEventStore → PrunableByTime
- implicit val ec: ExecutionContext
- Definition Classes
- DbSequencedEventStore → DbPrunableByTime → SequencedEventStore → PrunableByTime
- 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 find(criterion: SearchCriterion)(implicit traceContext: TraceContext): EitherT[Future, SequencedEventNotFoundError, PossiblyIgnoredSerializedEvent]
Looks up an event by the given criterion.
Looks up an event by the given criterion.
- returns
SequencedEventNotFoundError if no stored event meets the criterion.
- Definition Classes
- DbSequencedEventStore → SequencedEventStore
- def findRange(criterion: RangeCriterion, limit: Option[Int])(implicit traceContext: TraceContext): EitherT[Future, SequencedEventRangeOverlapsWithPruning, Seq[PossiblyIgnoredSerializedEvent]]
Looks up a set of sequenced events within the given range.
Looks up a set of sequenced events within the given range.
- limit
The maximum number of elements in the returned iterable, if set.
- Definition Classes
- DbSequencedEventStore → SequencedEventStore
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- implicit val getResultPossiblyIgnoredSequencedEvent: GetResult[PossiblyIgnoredSerializedEvent]
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def ignoreEvents(from: SequencerCounter, to: SequencerCounter)(implicit traceContext: TraceContext): EitherT[Future, ChangeWouldResultInGap, Unit]
Marks events between
from
andto
as ignored.Marks events between
from
andto
as ignored. Fills any gap betweenfrom
andto
by empty ignored events, i.e. ignored events without any underlying real event.- returns
ChangeWouldResultInGap if there would be a gap between the highest sequencer counter in the store and
from
.
- Definition Classes
- DbSequencedEventStore → SequencedEventStore
- def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
- Attributes
- protected
- Definition Classes
- FlagCloseable
- 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
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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 logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- DbSequencedEventStore → NamedLogging
- def maxSleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- 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
- Attributes
- protected
- Definition Classes
- FlagCloseable
- def partitionColumn: String
- Attributes
- protected[this]
- Definition Classes
- DbSequencedEventStore → DbPrunableByTime
- val partitionKey: SequencerClientDiscriminator
- Attributes
- protected[this]
- Definition Classes
- DbSequencedEventStore → DbPrunableByTime
- 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 afterf
completes, 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.close
as 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 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. Bothetf
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 afteretf
completes, 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.close
as 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
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 afterf
completes, 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.close
as 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 processingTime: TimedLoadGauge
- Attributes
- protected
- Definition Classes
- DbSequencedEventStore → DbPrunableByTime
- final def prune(limit: CantonTimestamp)(implicit traceContext: TraceContext): EitherT[Future, Nothing, Unit]
Prune all unnecessary data relating to events before the given timestamp.
Prune all unnecessary data relating to events before the given timestamp.
The meaning of "unnecessary", and whether the limit is inclusive or exclusive both depend on the particular store. The store must implement the actual pruning logic in the doPrune method.
- Definition Classes
- PrunableByTime
- def pruningStatus(implicit traceContext: TraceContext): EitherT[Future, Nothing, Option[PruningStatus]]
Returns the latest timestamp at which pruning was started or completed.
Returns the latest timestamp at which pruning was started or completed. For com.digitalasset.canton.pruning.PruningPhase.Started, it is guaranteed that no pruning has been run on the store after the returned timestamp. For com.digitalasset.canton.pruning.PruningPhase.Completed, it is guaranteed that the store is pruned at least up to the returned timestamp (inclusive). That is, another pruning with the returned timestamp (or earlier) has no effect on the store. Returns scala.None$ if no pruning has ever been started on the store.
- Definition Classes
- DbPrunableByTime → PrunableByTime
- def pruning_status_table: String
The table name to store the pruning timestamp in.
The table name to store the pruning timestamp in. The table must define the following fields:
- partitionColumn primary key
phase
stores the com.digitalasset.canton.pruning.PruningPhasets
stores the com.digitalasset.canton.data.CantonTimestamp -
- Attributes
- protected[this]
- Definition Classes
- DbSequencedEventStore → DbPrunableByTime
- 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 runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- def sequencedEvents(limit: Option[Int] = None)(implicit traceContext: TraceContext): Future[Seq[PossiblyIgnoredSerializedEvent]]
- Definition Classes
- DbSequencedEventStore → SequencedEventStore
- implicit def setParameterDiscriminator: SetParameter[SequencerClientDiscriminator]
- Attributes
- protected[this]
- Definition Classes
- DbSequencedEventStore → DbPrunableByTime
- val storage: DbStorage
- Attributes
- protected
- Definition Classes
- DbSequencedEventStore → DbStore
- def store(events: Seq[OrdinarySerializedEvent])(implicit traceContext: TraceContext): Future[Unit]
Stores the given com.digitalasset.canton.sequencing.protocol.SequencedEvents.
Stores the given com.digitalasset.canton.sequencing.protocol.SequencedEvents. If an event with the same timestamp already exist, the event may remain unchanged or overwritten.
- Definition Classes
- DbSequencedEventStore → SequencedEventStore
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- DbSequencedEventStore → FlagCloseable
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unignoreEvents(from: SequencerCounter, to: SequencerCounter)(implicit traceContext: TraceContext): EitherT[Future, ChangeWouldResultInGap, Unit]
Removes the ignored status from all events between
from
andto
.Removes the ignored status from all events between
from
andto
.- returns
ChangeWouldResultInGap if deleting empty ignored events between
from
andto
would result in a gap in sequencer counters.
- Definition Classes
- DbSequencedEventStore → SequencedEventStore
- 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])