Packages

trait DamlPackageStore extends AutoCloseable

For storing and retrieving Daml packages and DARs.

Self Type
DamlPackageStore with NamedLogging
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DamlPackageStore
  2. AutoCloseable
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract 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.

  2. abstract 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.

  3. abstract def close(): Unit
    Definition Classes
    AutoCloseable
    Annotations
    @throws(classOf[java.lang.Exception])
  4. abstract 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.

  5. abstract 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.

  6. abstract def getPackageDescription(packageId: PackageId)(implicit traceContext: TraceContext): Future[Option[PackageDescription]]
  7. abstract def listDars(limit: Option[Int] = None)(implicit traceContext: TraceContext): Future[Seq[DarDescriptor]]

    returns

    Future with sequence of DAR descriptors (hash and name)

  8. abstract def listPackages(limit: Option[Int] = None)(implicit traceContext: TraceContext): Future[Seq[PackageDescription]]

    returns

    yields descriptions of all persisted Daml packages

  9. abstract def removeDar(hash: Hash)(implicit traceContext: TraceContext): Future[Unit]

    Remove the DAR with hash hash from the store

  10. abstract def removePackage(packageId: PackageId)(implicit traceContext: TraceContext): Future[Unit]

    Remove the package from the package store.

Concrete 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. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. 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 AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped