class DbDamlPackageStore extends DamlPackageStore with DbStore

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbDamlPackageStore
  2. DbStore
  3. HasCloseContext
  4. NamedLogging
  5. FlagCloseable
  6. DamlPackageStore
  7. AutoCloseable
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DbDamlPackageStore(maxContractIdSqlInListSize: PositiveNumeric[Int], storage: DbStorage, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

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. def anyPackagePreventsDarRemoval(packages: List[PackageId], removeDar: DarDescriptor)(implicit tc: TraceContext): OptionT[Future, PackageId]

    Find from packages a registered package that does not exist in any dar except perhaps removeDar.

    Find from packages a registered package that does not exist in any dar except perhaps removeDar. This checks whether a DAR containing packages can be safely removed -- if there's any package that would be left without a DAR then we won't remove the DAR.

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  5. def append(pkgs: List[Archive], sourceDescription: String256M, 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
    DbDamlPackageStoreDamlPackageStore
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  8. 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()
  9. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  10. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. 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
    DbDamlPackageStoreDamlPackageStore
  15. 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
    DbDamlPackageStoreDamlPackageStore
  16. def getPackageDescription(packageId: PackageId)(implicit traceContext: TraceContext): Future[Option[PackageDescription]]
    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  17. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  18. def internalPerformUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  19. 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
  20. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  21. 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
  22. def listDars(limit: Option[Int])(implicit traceContext: TraceContext): Future[Seq[DarDescriptor]]

    returns

    Future with sequence of DAR descriptors (hash and name)

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  23. def listPackages(limit: Option[Int])(implicit traceContext: TraceContext): Future[Seq[PackageDescription]]

    returns

    yields descriptions of all persisted Daml packages

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  24. def logger: TracedLogger
    Attributes
    protected
    Definition Classes
    NamedLogging
  25. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbDamlPackageStoreNamedLogging
  26. implicit def loggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  27. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  28. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  29. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  30. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  31. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
  32. def performUnlessClosing[A](f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Performs the task given by f unless a shutdown has been initiated.

    Performs the task given by f unless a shutdown has been initiated. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, 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
  33. 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 etf unless a shutdown has been initiated, in which case the provided error is returned instead.

    Performs the EitherT[Future] given by etf unless a shutdown has been initiated, in which case the provided error is returned instead. Both etf and the error are lazy; etf is only evaluated if there is no shutdown, the error only if we're shutting down. The shutdown will only begin after etf completes, but other tasks may execute concurrently with etf, 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
  34. 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
  35. def performUnlessClosingF[A](f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Performs the Future given by f unless a shutdown has been initiated.

    Performs the Future given by f unless a shutdown has been initiated. The future is lazy and not evaluated during shutdown. The shutdown will only begin after f completes, but other tasks may execute concurrently with f, 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
  36. def removeDar(hash: Hash)(implicit traceContext: TraceContext): Future[Unit]

    Remove the DAR with hash hash from the store

    Remove the DAR with hash hash from the store

    Definition Classes
    DbDamlPackageStoreDamlPackageStore
  37. 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
    DbDamlPackageStoreDamlPackageStore
  38. 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
  39. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  40. def sleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  41. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbDamlPackageStoreDbStore
  42. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  43. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbDamlPackageStoreFlagCloseable
  44. def toString(): String
    Definition Classes
    AnyRef → Any
  45. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  46. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  47. 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 DbStore

Inherited from HasCloseContext

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from DamlPackageStore

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped