c

com.digitalasset.canton.console.commands

LocalParticipantPruningAdministrationGroup

class LocalParticipantPruningAdministrationGroup extends ParticipantPruningAdministrationGroup with NoTracing

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LocalParticipantPruningAdministrationGroup
  2. NoTracing
  3. ParticipantPruningAdministrationGroup
  4. Helpful
  5. FeatureFlagFilter
  6. NamedLogging
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new LocalParticipantPruningAdministrationGroup(runner: AdminCommandRunner with LedgerApiCommandRunner with BaseInspection[ParticipantNode], consoleEnvironment: ConsoleEnvironment, loggerFactory: NamedLoggerFactory)

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 cantonConfig: CantonConfig
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  6. def check[T](flag: FeatureFlag)(command: => T): T
    Attributes
    protected
    Definition Classes
    FeatureFlagFilter
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. val consoleEnvironment: ConsoleEnvironment
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. def find_safe_offset(beforeOrAt: Instant = Instant.now()): Option[LedgerOffset]
    Annotations
    @Summary(s = "Return the highest participant ledger offset whose record time is before or at the given one (if any) at which pruning is safely possible", flag = FeatureFlag.Preview)
  12. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. def get_offset_by_time(upToInclusive: Instant): Option[LedgerOffset]
    Definition Classes
    ParticipantPruningAdministrationGroup
    Annotations
    @Summary(s = "Identify the participant ledger offset to prune up to based on the specified timestamp.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Return the largest participant ledger offset that has been processed before or at the specified timestamp.
    |The time is measured on the participant's local clock at some point while the participant has processed the
    |the event. Returns ``None`` if no such offset exists.
    """
    )
  14. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  15. def help(methodName: String)(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
    Annotations
    @Summary(s = "Help for specific commands (use help() or help(\"method\") for more information)", flag = console.this.Help.Summary.<init>$default$2) @Topic(t = Seq("Top-level Commands"))
  16. def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
    Definition Classes
    Helpful
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def locate_offset(n: Long): LedgerOffset
    Definition Classes
    ParticipantPruningAdministrationGroup
    Annotations
    @Summary(s = "Identify the participant ledger offset to prune up to.", flag = FeatureFlag.Preview) @Description(s = """Return the participant ledger offset that corresponds to pruning "n" number of transactions
    |from the beginning of the ledger. Errors if the ledger holds less than "n" transactions. Specifying "n" of 1
    |returns the offset of the first transaction (if the ledger is non-empty).
    """
    )
  19. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  20. val loggerFactory: NamedLoggerFactory
  21. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  22. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  23. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  24. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def prune(pruneUpTo: LedgerOffset): Unit
    Definition Classes
    ParticipantPruningAdministrationGroup
    Annotations
    @Summary(s = "Prune the ledger up to the specified offset inclusively.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """Prunes the participant ledger up to the specified offset inclusively returning ``Unit`` if the ledger has been
    |successfully pruned.
    |Note that upon successful pruning, subsequent attempts to read transactions via ``ledger_api.transactions.flat`` or
    |``ledger_api.transactions.trees`` or command completions via ``ledger_api.completions.list`` by specifying a begin offset
    |lower than the returned pruning offset will result in a ``NOT_FOUND`` error.
    |In the Enterprise Edition, ``prune`` performs a "full prune" freeing up significantly more space and also
    |performs additional safety checks returning a ``NOT_FOUND`` error if ``pruneUpTo`` is higher than the
    |offset returned by ``find_safe_offset`` on any domain with events preceding the pruning offset."""
    )
  27. def prune_internally(pruneUpTo: LedgerOffset): Unit
    Definition Classes
    ParticipantPruningAdministrationGroup
    Annotations
    @Summary(s = "Prune only internal ledger state up to the specified offset inclusively.", flag = FeatureFlag.Preview) @Description(s = """Special-purpose variant of the ``prune`` command only available in the Enterprise Edition that prunes only partial,
    |internal participant ledger state freeing up space not needed for serving ``ledger_api.transactions``
    |and ``ledger_api.completions`` requests. In conjunction with ``prune``, ``prune_internally`` enables pruning
    |internal ledger state more aggressively than externally observable data via the ledger api. In most use cases
    |``prune`` should be used instead. Unlike ``prune``, ``prune_internally`` has no visible effect on the Ledger API.
    |The command returns ``Unit`` if the ledger has been successfully pruned or an error if the timestamp
    |performs additional safety checks returning a ``NOT_FOUND`` error if ``pruneUpTo`` is higher than the
    |offset returned by ``find_safe_offset`` on any domain with events preceding the pruning offset."""
    )
  28. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. implicit def traceContext: TraceContext
    Attributes
    protected
    Definition Classes
    NoTracing
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. 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 NoTracing

Inherited from Helpful

Inherited from FeatureFlagFilter

Inherited from NamedLogging

Inherited from AnyRef

Inherited from Any

Ungrouped