trait DamlPackageStore extends AutoCloseable
For storing and retrieving Daml packages and DARs.
- Self Type
- DamlPackageStore with NamedLogging
- Alphabetic
- By Inheritance
- DamlPackageStore
- AutoCloseable
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Abstract Value Members
- 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 perhapsremoveDar
.Find from
packages
a registered package that does not exist in any dar except perhapsremoveDar
. This checks whether a DAR containingpackages
can be safely removed -- if there's any package that would be left without a DAR then we won't remove the DAR. - 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.
- abstract def close(): Unit
- Definition Classes
- AutoCloseable
- Annotations
- @throws(classOf[java.lang.Exception])
- 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.
- 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.
- abstract def getPackageDescription(packageId: PackageId)(implicit traceContext: TraceContext): Future[Option[PackageDescription]]
- abstract def listDars(limit: Option[Int] = None)(implicit traceContext: TraceContext): Future[Seq[DarDescriptor]]
- returns
Future with sequence of DAR descriptors (hash and name)
- abstract def listPackages(limit: Option[Int] = None)(implicit traceContext: TraceContext): Future[Seq[PackageDescription]]
- returns
yields descriptions of all persisted Daml packages
- abstract def removeDar(hash: Hash)(implicit traceContext: TraceContext): Future[Unit]
Remove the DAR with hash
hash
from the store - abstract def removePackage(packageId: PackageId)(implicit traceContext: TraceContext): Future[Unit]
Remove the package from the package store.
Concrete 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 clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- 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 hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- 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])