class DbContractStore extends ContractStore with DbStore

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

Instance Constructors

  1. new DbContractStore(storage: DbStorage, domainIdIndexed: IndexedDomain, protocolVersion: ProtocolVersion, maxContractIdSqlInListSize: PositiveNumeric[Int], maxDbConnections: Int, cacheConfig: CacheConfig, dbQueryBatcherConfig: BatchAggregatorConfig, insertBatchAggregatorConfig: BatchAggregatorConfig, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

Type Members

  1. case class ReaderState(count: Int, readers: MultiSet[String]) extends Product with Serializable
    Definition Classes
    FlagCloseable

Value Members

  1. object ReaderState extends Serializable
    Definition Classes
    FlagCloseable
  2. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  3. final def ##: Int
    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  7. 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()
  8. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  9. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseable
  10. def contractCount()(implicit traceContext: TraceContext): Future[Int]
    Definition Classes
    DbContractStoreContractStore
  11. def deleteContract(id: LfContractId)(implicit traceContext: TraceContext): EitherT[Future, UnknownContract, Unit]

    Removes the contract from the contract store.

    Removes the contract from the contract store.

    Definition Classes
    DbContractStoreContractStore
  12. def deleteDivulged(upTo: RequestCounter)(implicit traceContext: TraceContext): Future[Unit]

    Deletes all divulged contracts up to a given request counter.

    Deletes all divulged contracts up to a given request counter.

    Definition Classes
    DbContractStoreContractStore
  13. def deleteIgnoringUnknown(contractIds: Iterable[LfContractId])(implicit traceContext: TraceContext): Future[Unit]

    Deletes multiple contracts from the contract store.

    Deletes multiple contracts from the contract store.

    Ignores errors due to a contract not being present in the store, fails on other errors.

    Definition Classes
    DbContractStoreContractStore
  14. implicit val ec: ExecutionContext
    Attributes
    protected
    Definition Classes
    DbContractStoreContractLookup
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  18. def find(filterId: Option[String], filterPackage: Option[String], filterTemplate: Option[String], limit: Int)(implicit traceContext: TraceContext): Future[List[SerializableContract]]

    Debug find utility to search pcs

    Debug find utility to search pcs

    Definition Classes
    DbContractStoreContractStore
  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def hasActiveContracts(partyId: PartyId, contractIds: Vector[LfContractId], batchSize: Int = 10)(implicit traceContext: TraceContext): Future[Boolean]
    Definition Classes
    ContractStore
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    FlagCloseable
  23. 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
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. 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
  26. def logger: TracedLogger
    Attributes
    protected[store]
    Definition Classes
    DbContractStoreNamedLoggingFlagCloseableContractLookup
  27. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbContractStoreNamedLogging
  28. def lookup(id: LfContractId)(implicit traceContext: TraceContext): OptionT[Future, StoredContract]
    Definition Classes
    DbContractStoreContractLookup
  29. def lookupContract(id: LfContractId)(implicit traceContext: TraceContext): OptionT[Future, SerializableContract]
    Definition Classes
    ContractLookup
  30. def lookupContractE(id: LfContractId)(implicit traceContext: TraceContext): EitherT[Future, UnknownContract, SerializableContract]
    Definition Classes
    ContractLookup
  31. def lookupE(id: LfContractId)(implicit traceContext: TraceContext): EitherT[Future, UnknownContract, StoredContract]
    Definition Classes
    ContractLookup
  32. def lookupLfInstance(lfId: LfContractId)(implicit traceContext: TraceContext): OptionT[Future, LfContractInst]

    Yields None (embedded in a Future) if the contract instance has not been stored or the id cannot be parsed.

    Yields None (embedded in a Future) if the contract instance has not been stored or the id cannot be parsed.

    Discards the serialization.

    Definition Classes
    ContractLookup
  33. def lookupManyUncached(ids: Seq[LfContractId])(implicit traceContext: TraceContext): Future[List[Option[StoredContract]]]
    Definition Classes
    DbContractStoreContractLookup
  34. def lookupStakeholders(ids: Set[LfContractId])(implicit traceContext: TraceContext): EitherT[Future, UnknownContracts, Map[LfContractId, Set[LfPartyId]]]
    Definition Classes
    DbContractStoreContractLookup
  35. def maxSleepMillis: Long
    Attributes
    protected
    Definition Classes
    FlagCloseable
  36. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  37. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  38. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  39. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  41. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
  42. def performUnlessClosing[A](name: String)(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.

    DO NOT CALL this.close as part of f, because it will result in a deadlock.

    f

    The task to perform

    returns

    scala.None$ if a shutdown has been initiated. Otherwise the result of the task.

    Definition Classes
    FlagCloseable
  43. def performUnlessClosingCheckedT[A, N, R](name: String, onClosing: Checked[A, N, R])(etf: => CheckedT[Future, A, N, R])(implicit ec: ExecutionContext, traceContext: TraceContext): CheckedT[Future, A, N, R]
    Definition Classes
    FlagCloseable
  44. def performUnlessClosingEitherT[E, R](name: String, 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.

    DO NOT CALL this.close as part of etf, because it will result in a deadlock.

    etf

    The task to perform

    Definition Classes
    FlagCloseable
  45. def performUnlessClosingEitherTF[E, R](name: String, onClosing: => E)(etf: => EitherT[Future, E, Future[R]])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[Future, E, Future[R]]
    Definition Classes
    FlagCloseable
  46. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    FlagCloseable
  47. def performUnlessClosingF[A](name: String)(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.

    DO NOT CALL this.close as part of f, because it will result in a deadlock.

    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
  48. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    FlagCloseable
  49. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Unit

    Register a task to run when shutdown is initiated.

    Register a task to run when shutdown is initiated.

    You can use this for example to register tasks that cancel long-running computations, whose termination you can then wait for in "closeAsync".

    Definition Classes
    FlagCloseable
  50. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    FlagCloseable
    Annotations
    @VisibleForTesting()
  51. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbContractStoreDbStore
  52. def storeCreatedContract(requestCounter: RequestCounter, transactionId: TransactionId, contract: SerializableContract)(implicit traceContext: TraceContext): Future[Unit]
    Definition Classes
    ContractStore
  53. def storeCreatedContracts(requestCounter: RequestCounter, transactionId: TransactionId, creations: Seq[SerializableContract])(implicit traceContext: TraceContext): Future[Unit]

    Stores contracts created by a request.

    Stores contracts created by a request. If the same contract instance has been stored before, the request counter is set to the lower one.

    requestCounter

    The request counter of the transaction creating the contracts.

    creations

    The contracts to be created

    returns

    DuplicateContract for the contracts that have been or are being inserted with different values for com.digitalasset.canton.protocol.SerializableContract.contractInstance or com.digitalasset.canton.protocol.SerializableContract.ledgerCreateTime.

    Definition Classes
    DbContractStoreContractStore
  54. def storeDivulgedContract(requestCounter: RequestCounter, contract: SerializableContract)(implicit traceContext: TraceContext): Future[Unit]
    Definition Classes
    ContractStore
  55. def storeDivulgedContracts(requestCounter: RequestCounter, divulgences: Seq[SerializableContract])(implicit traceContext: TraceContext): Future[Unit]

    Store divulged contracts.

    Store divulged contracts.

    returns

    DuplicateContract for the contracts that have been or are being inserted with a different contract instance or a different ledger time.

    Definition Classes
    DbContractStoreContractStore
  56. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  57. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbContractStoreFlagCloseable
  58. def toString(): String
    Definition Classes
    AnyRef → Any
  59. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  60. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  61. 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 AutoCloseable

Inherited from ContractStore

Inherited from ContractLookup

Inherited from AnyRef

Inherited from Any

Ungrouped