class LocalParticipantPruningAdministrationGroup extends ParticipantPruningAdministrationGroup with NoTracing
Linear Supertypes
Ordering
- Alphabetic
- By Inheritance
Inherited
- LocalParticipantPruningAdministrationGroup
- NoTracing
- ParticipantPruningAdministrationGroup
- FeatureFlagFilter
- NamedLogging
- PruningSchedulerAdministration
- Helpful
- AnyRef
- Any
- Hide All
- Show All
Visibility
- Public
- Protected
Instance Constructors
- new LocalParticipantPruningAdministrationGroup(runner: AdminCommandRunner with LedgerApiCommandRunner with BaseInspection[ParticipantNode], consoleEnvironment: ConsoleEnvironment, loggerFactory: NamedLoggerFactory)
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
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def cantonConfig: CantonConfig
- Attributes
- protected
- Definition Classes
- FeatureFlagFilter
- def check[T](flag: FeatureFlag)(command: => T): T
- Attributes
- protected
- Definition Classes
- FeatureFlagFilter
- def clear_schedule(): Unit
- Definition Classes
- PruningSchedulerAdministration
- Annotations
- @Summary(s = "Deactivate automatic pruning.", flag = console.this.Help.Summary.<init>$default$2)
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- val consoleEnvironment: ConsoleEnvironment
- Attributes
- protected
- Definition Classes
- PruningSchedulerAdministration
- 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_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)
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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.
""")
- def get_schedule(): Option[PruningSchedule]
- Definition Classes
- PruningSchedulerAdministration
- Annotations
- @Summary(s = "Inspect the automatic pruning schedule.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """The schedule consists of a "cron" expression and "max_duration" and "retention" durations. The cron string
|indicates the points in time at which pruning should begin in the GMT time zone, and the maximum duration
|indicates how long from the start time pruning is allowed to run as long as pruning has not finished pruning
|up to the specified retention period.
|Returns `None` if no schedule has been configured via `set_schedule` or if `clear_schedule` has been invoked.
""")
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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"))
- def help()(implicit consoleEnvironment: ConsoleEnvironment): Unit
- Definition Classes
- Helpful
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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).
""")
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- PruningSchedulerAdministration
- 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 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.""")
- 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.""")
- def set_cron(cron: String): Unit
- Definition Classes
- PruningSchedulerAdministration
- Annotations
- @Summary(s = "Modify the cron used by automatic pruning.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """The schedule is specified in cron format and refers to pruning start times in the GMT time zone.
|This call returns an error if no schedule has been configured via `set_schedule` or if automatic
|pruning has been disabled via `clear_schedule`. Additionally if at the time of this modification, pruning is
|actively running, a best effort is made to pause pruning and restart according to the new schedule. This
|allows for the case that the new schedule no longer allows pruning at the current time.
""")
- def set_max_duration(maxDuration: PositiveDurationSeconds): Unit
- Definition Classes
- PruningSchedulerAdministration
- Annotations
- @Summary(s = "Modify the maximum duration used by automatic pruning.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """The `maxDuration` is specified as a positive duration and has at most per-second granularity.
|This call returns an error if no schedule has been configured via `set_schedule` or if automatic
|pruning has been disabled via `clear_schedule`. Additionally if at the time of this modification, pruning is
|actively running, a best effort is made to pause pruning and restart according to the new schedule. This
|allows for the case that the new schedule no longer allows pruning at the current time.
""")
- def set_retention(retention: PositiveDurationSeconds): Unit
- Definition Classes
- PruningSchedulerAdministration
- Annotations
- @Summary(s = "Update the pruning retention used by automatic pruning.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """The `retention` is specified as a positive duration and has at most per-second granularity.
|This call returns an error if no schedule has been configured via `set_schedule` or if automatic
|pruning has been disabled via `clear_schedule`. Additionally if at the time of this update, pruning is
|actively running, a best effort is made to pause pruning and restart with the newly specified retention.
|This allows for the case that the new retention mandates retaining more data than previously.
""")
- def set_schedule(cron: String, maxDuration: PositiveDurationSeconds, retention: PositiveDurationSeconds): Unit
- Definition Classes
- PruningSchedulerAdministration
- Annotations
- @Summary(s = "Activate automatic pruning according to the specified schedule.", flag = console.this.Help.Summary.<init>$default$2) @Description(s = """The schedule is specified in cron format and "max_duration" and "retention" durations. The cron string indicates
|the points in time at which pruning should begin in the GMT time zone, and the maximum duration indicates how
|long from the start time pruning is allowed to run as long as pruning has not finished pruning up to the
|specified retention period.
""")
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- implicit def traceContext: TraceContext
- Attributes
- protected
- Definition Classes
- NoTracing
- 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])