trait DbPrunableByTimeDomain extends DbPrunableByTime[IndexedDomain]
Specialized DbPrunableByTime that uses the com.digitalasset.canton.topology.DomainId as discriminator
- Self Type
- DbPrunableByTimeDomain with DbStore
- Alphabetic
- By Inheritance
- DbPrunableByTimeDomain
- DbPrunableByTime
- PrunableByTime
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- abstract def doPrune(limit: CantonTimestamp, lastPruning: Option[CantonTimestamp])(implicit traceContext: TraceContext): Future[Int]
Actual invocation of doPrune
Actual invocation of doPrune
- returns
the approximate number of pruned rows, used to adjust the pruning windows to reach optimal batch sizes
- Attributes
- protected[canton]
- Definition Classes
- PrunableByTime
- Annotations
- @VisibleForTesting()
- abstract def domainId: IndexedDomain
- Attributes
- protected[this]
- implicit abstract val ec: ExecutionContext
- Attributes
- protected[this]
- Definition Classes
- DbPrunableByTime → PrunableByTime
- abstract def kind: String
- Attributes
- protected
- Definition Classes
- PrunableByTime
- abstract val processingTime: TimedLoadGauge
- Attributes
- protected
- Definition Classes
- DbPrunableByTime
- abstract 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
phasestores the com.digitalasset.canton.pruning.PruningPhasetsstores the com.digitalasset.canton.data.CantonTimestamp -
- Attributes
- protected[this]
- Definition Classes
- DbPrunableByTime
Concrete Value Members
- 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): Future[Unit]
- Attributes
- protected[canton]
- Definition Classes
- DbPrunableByTime → PrunableByTime
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def batchingParameters: Option[PrunableByTimeParameters]
Parameters to control prune batching
Parameters to control prune batching
If defined, then the pruning window will be computed such that it targets the ideal target batch size in order to optimize the load on the database.
This is currently used with the journal stores. Normal pruning of other stores already does batching on its own.
- Attributes
- protected
- Definition Classes
- PrunableByTime
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val partitionColumn: String
- Attributes
- protected[this]
- Definition Classes
- DbPrunableByTimeDomain → DbPrunableByTime
- def partitionKey: IndexedDomain
- Attributes
- protected[this]
- Definition Classes
- DbPrunableByTimeDomain → DbPrunableByTime
- final def prune(limit: CantonTimestamp)(implicit errorLoggingContext: ErrorLoggingContext, closeContext: CloseContext): Future[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): Future[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
- implicit val setParameterDiscriminator: SetParameter[IndexedDomain]
- Attributes
- protected[this]
- Definition Classes
- DbPrunableByTimeDomain → DbPrunableByTime
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])