Packages

object pruning

Annotations
@Summary(s = "Pruning of the sequencer", flag = console.this.Help.Summary.<init>$default$2)
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. pruning
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. def force_prune(dryRun: Boolean): String
    Annotations
    @Summary(s = "Force remove data from the Sequencer including data that may have not been read by offline clients", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Will force pruning up until the default retention period by potentially disabling clients
    |that have not yet read data we would like to remove.
    |Disabling these clients will prevent them from ever reconnecting to the Domain so should only be
    |used if the Domain operator is confident they can be permanently ignored.
    |Run with `dryRun = true` to review a description of which clients will be disabled first.
    |Run with `dryRun = false` to disable these clients and perform a forced pruning.
    |"""
    )
  9. def force_prune_at(timestamp: CantonTimestamp, dryRun: Boolean): String
    Annotations
    @Summary(s = "Force removing data from the Sequencer including data that may have not been read by offline clients up until the specified time", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "Similar to the above `force_prune` command but allows specifying the exact time at which to prune")
  10. def force_prune_with_retention_period(retentionPeriod: FiniteDuration, dryRun: Boolean): String
    Annotations
    @Summary(s = "Force removing data from the Sequencer including data that may have not been read by offline clients up until a custom retention period", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "Similar to the above `force_prune` command but allows specifying a custom retention period")
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. def prune(): String
    Annotations
    @Summary(s = "Remove unnecessary data from the Sequencer up until the default retention point", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Removes unnecessary data from the Sequencer that is earlier than the default retention period.
    |The default retention period is set in the configuration of the canton processing running this
    |command under `parameters.retention-period-defaults.sequencer`.
    |This pruning command requires that data is read and acknowledged by clients before
    |considering it safe to remove.
    |
    |If no data is being removed it could indicate that clients are not reading or acknowledging data
    |in a timely fashion (typically due to nodes going offline for long periods).
    |You have the option of disabling the members running on these nodes to allow removal of this data,
    |however this will mean that they will be unable to reconnect to the domain in the future.
    |To do this run `force_prune(dryRun = true)` to return a description of which members would be
    |disabled in order to prune the Sequencer.
    |If you are happy to disable the described clients then run `force_prune(dryRun = false)` to
    |permanently remove their unread data.
    |
    |Once offline clients have been disabled you can continue to run `prune` normally.
    |"""
    )
  18. def prune_at(timestamp: CantonTimestamp): String
    Annotations
    @Summary(s = "Remove data that has been read up until the specified time", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "Similar to the above `prune` command but allows specifying the exact time at which to prune")
  19. def prune_with_retention_period(retentionPeriod: FiniteDuration): String
    Annotations
    @Summary(s = "Remove data that has been read up until a custom retention period", flag = console.this.Help.Summary.<init>$default$2) @Description(s = "Similar to the above `prune` command but allows specifying a custom retention period")
  20. def status(): SequencerPruningStatus
    Annotations
    @Summary(s = "Status of the sequencer and its connected clients", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Provides a detailed breakdown of information required for pruning:
    | - the current time according to this sequencer instance
    | - domain members that the sequencer supports
    | - for each member when they were registered and whether they are enabled
    | - a list of clients for each member, their last acknowledgement, and whether they are enabled
    |"""
    )
  21. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  22. def toString(): String
    Definition Classes
    AnyRef → Any
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  25. 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 AnyRef

Inherited from Any

Ungrouped