class DbDamlPackageStore extends DamlPackageStore with FlagCloseable with NamedLogging
- Alphabetic
- By Inheritance
- DbDamlPackageStore
- NamedLogging
- FlagCloseable
- AutoCloseable
- DamlPackageStore
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Instance Constructors
- new DbDamlPackageStore(maxContractIdSqlInListSize: PositiveNumeric[Int], storage: DbStorage, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)
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 anyPackagePreventsDarRemoval(packages: List[PackageId], removeDar: DarDescriptor)(implicit tc: TraceContext): OptionT[Future, PackageId]
Find from
packagesa registered package that does not exist in any dar except perhapsremoveDar.Find from
packagesa registered package that does not exist in any dar except perhapsremoveDar. This checks whether a DAR containingpackagescan be safely removed -- if there's any package that would be left without a DAR then we won't remove the DAR.- Definition Classes
- DbDamlPackageStore → DamlPackageStore
- def append(pkgs: List[Archive], sourceDescription: String, dar: Option[Dar])(implicit traceContext: TraceContext): Future[Unit]
- dar
The DAR containing the package
- returns
Future which gets completed when the package is successfully stored.
- Definition Classes
- DbDamlPackageStore → DamlPackageStore
- 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()
- def closingTimeout: FiniteDuration
- Attributes
- protected
- Definition Classes
- FlagCloseable
- 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 getDar(hash: Hash)(implicit traceContext: TraceContext): Future[Option[Dar]]
Get DAR by hash
Get DAR by hash
- hash
The hash of the DAR file
- returns
Future that will contain an empty option if the DAR with the given hash could not be found or an option with the DAR if it could be found.
- Definition Classes
- DbDamlPackageStore → DamlPackageStore
- def getPackage(packageId: PackageId)(implicit traceContext: TraceContext): Future[Option[Archive]]
- packageId
The package id of the Daml package to be retrieved from the store.
- returns
Future that will contain an empty option if the package with the given id could not be found or an option with the archive (serialized version of the package) if it could be found.
- Definition Classes
- DbDamlPackageStore → DamlPackageStore
- def getPackageDescription(packageId: PackageId)(implicit traceContext: TraceContext): Future[Option[PackageDescription]]
- Definition Classes
- DbDamlPackageStore → DamlPackageStore
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def internalPerformUnlessClosingF[A](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 listDars(limit: Option[Int])(implicit traceContext: TraceContext): Future[Seq[DarDescriptor]]
- returns
Future with sequence of DAR descriptors (hash and name)
- Definition Classes
- DbDamlPackageStore → DamlPackageStore
- def listPackages(limit: Option[Int])(implicit traceContext: TraceContext): Future[Seq[PackageDescription]]
- returns
yields descriptions of all persisted Daml packages
- Definition Classes
- DbDamlPackageStore → DamlPackageStore
- def logger: TracedLogger
- Attributes
- protected
- Definition Classes
- NamedLogging
- val loggerFactory: NamedLoggerFactory
- Attributes
- protected
- Definition Classes
- DbDamlPackageStore → NamedLogging
- implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
- 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 performUnlessClosing[A](f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]
Performs the task given by
funless a shutdown has been initiated.Performs the task given by
funless a shutdown has been initiated. The shutdown will only begin afterfcompletes, 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.- 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](onClosing: => E)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, R]
Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead.Performs the EitherT[Future] given by
etfunless a shutdown has been initiated, in which case the provided error is returned instead. Bothetfand the error are lazy;etfis only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin afteretfcompletes, 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.- etf
The task to perform
- Definition Classes
- FlagCloseable
- def performUnlessClosingEitherTF[E, R](onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
- Definition Classes
- FlagCloseable
- def performUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
Performs the Future given by
funless a shutdown has been initiated.Performs the Future given by
funless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin afterfcompletes, 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.- 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 removeDar(hash: Hash)(implicit traceContext: TraceContext): Future[Unit]
Remove the DAR with hash
hashfrom the storeRemove the DAR with hash
hashfrom the store- Definition Classes
- DbDamlPackageStore → DamlPackageStore
- def removePackage(packageId: PackageId)(implicit traceContext: TraceContext): Future[Unit]
Remove the package from the package store.
Remove the package from the package store.
- Definition Classes
- DbDamlPackageStore → DamlPackageStore
- def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
Register a task that will run onClose after all "performUnlessShutdown" tasks have finished
- Definition Classes
- FlagCloseable
- def runStateChanged(waitingState: Boolean = false): Unit
- Attributes
- protected
- Definition Classes
- FlagCloseable
- Annotations
- @VisibleForTesting()
- def sleepMillis: Long
- Attributes
- protected
- Definition Classes
- FlagCloseable
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- val timeouts: ProcessingTimeout
- Attributes
- protected
- Definition Classes
- DbDamlPackageStore → FlagCloseable
- 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])