class DbContractStore extends ContractStore with DbStore

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

Instance Constructors

  1. new DbContractStore(storage: DbStorage, domainIdIndexed: IndexedDomain, protocolVersion: ProtocolVersion, maxContractIdSqlInListSize: PositiveInt, cacheConfig: CacheConfig, dbQueryBatcherConfig: BatchAggregatorConfig, insertBatchAggregatorConfig: BatchAggregatorConfig, 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def cancelShutdownTask(token: Long): Unit

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Removes a shutdown task from the list using a token returned by runOnShutdown

    Definition Classes
    OnShutdownRunner
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  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
    FlagCloseableOnShutdownRunner → AutoCloseable
  8. implicit val closeContext: CloseContext
    Definition Classes
    HasCloseContext
  9. def closingTimeout: FiniteDuration
    Attributes
    protected
    Definition Classes
    FlagCloseablePerformUnlessClosing
  10. def containsShutdownTask(token: Long): Boolean
    Definition Classes
    OnShutdownRunner
  11. def contractCount()(implicit traceContext: TraceContext): Future[Int]
    Definition Classes
    DbContractStoreContractStore
  12. 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
  13. 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
  14. 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
  15. implicit val ec: ExecutionContext
    Attributes
    protected
    Definition Classes
    DbContractStoreContractLookup
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. implicit def errorLoggingContext(implicit traceContext: TraceContext): ErrorLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  19. 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
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  21. def hasActiveContracts(partyId: PartyId, contractIds: Iterator[LfContractId], batchSize: Int = 10)(implicit traceContext: TraceContext): Future[Boolean]
    Definition Classes
    ContractStore
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  23. def internalPerformUnlessClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): UnlessShutdown[Future[A]]
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  24. def isClosing: Boolean

    Check whether we're closing.

    Check whether we're closing. Susceptible to race conditions; unless you're using this as a flag to the retry lib or you really know what you're doing, prefer performUnlessClosing and friends.

    Definition Classes
    OnShutdownRunner
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. 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
    PerformUnlessClosing
  27. def logger: TracedLogger
    Attributes
    protected[store]
    Definition Classes
    DbContractStorePromiseUnlessShutdownFactoryNamedLoggingOnShutdownRunner
  28. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbContractStoreNamedLogging
  29. def lookup(id: LfContractId)(implicit traceContext: TraceContext): OptionT[Future, StoredContract]
    Definition Classes
    DbContractStoreContractLookup
  30. def lookupContract(id: LfContractId)(implicit traceContext: TraceContext): OptionT[Future, SerializableContract]
    Definition Classes
    ContractLookup
  31. def lookupContractE(id: LfContractId)(implicit traceContext: TraceContext): EitherT[Future, UnknownContract, SerializableContract]
    Definition Classes
    ContractLookup
  32. def lookupE(id: LfContractId)(implicit traceContext: TraceContext): EitherT[Future, UnknownContract, StoredContract]
    Definition Classes
    ContractLookup
  33. 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
  34. def lookupManyUncached(ids: Seq[LfContractId])(implicit traceContext: TraceContext): EitherT[Future, LfContractId, List[StoredContract]]
    Definition Classes
    DbContractStoreContractLookup
  35. def lookupStakeholders(ids: Set[LfContractId])(implicit traceContext: TraceContext): EitherT[Future, UnknownContracts, Map[LfContractId, Set[LfPartyId]]]
    Definition Classes
    DbContractStoreContractLookup
  36. def maxSleepMillis: Long

    How often to poll to check that all tasks have completed.

    How often to poll to check that all tasks have completed.

    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  37. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext, ec: ExecutionContext): PromiseUnlessShutdown[A]

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed.

    Use this method to create a PromiseUnlessShutdown that will automatically be cancelled when the close context is closed. This allows proper clean up of stray promises when the node is transitioning to a passive state.

    Note: you should *not* invoke success on the returned promise but rather use trySuccess. The reason is that the call to success may fail in case of shutdown.

    Definition Classes
    PromiseUnlessShutdownFactory
  38. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  41. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  42. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  43. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  44. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  45. final def onFirstClose(): 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
    PerformUnlessClosingOnShutdownRunner
    Annotations
    @SuppressWarnings()
  46. 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
    PerformUnlessClosing
  47. 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
    PerformUnlessClosing
  48. 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
    PerformUnlessClosing
  49. 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
    PerformUnlessClosing
  50. def performUnlessClosingEitherU[E, R](name: String)(etf: => EitherT[Future, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  51. def performUnlessClosingEitherUSF[E, R](name: String)(etf: => EitherT[FutureUnlessShutdown, E, R])(implicit ec: ExecutionContext, traceContext: TraceContext): EitherT[FutureUnlessShutdown, E, R]
    Definition Classes
    PerformUnlessClosing
  52. 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
    PerformUnlessClosing
  53. def performUnlessClosingUSF[A](name: String)(f: => FutureUnlessShutdown[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]
    Definition Classes
    PerformUnlessClosing
  54. def runOnShutdown[T](task: RunOnShutdown)(implicit traceContext: TraceContext): Long

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Same as runOnShutdown_ but returns a token that allows you to remove the task explicitly from being run using cancelShutdownTask

    Definition Classes
    OnShutdownRunner
  55. 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
    OnShutdownRunner
  56. def runStateChanged(waitingState: Boolean = false): Unit
    Attributes
    protected
    Definition Classes
    OnShutdownRunner
    Annotations
    @VisibleForTesting()
  57. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbContractStoreDbStore
  58. def storeCreatedContract(requestCounter: RequestCounter, transactionId: TransactionId, contract: SerializableContract)(implicit traceContext: TraceContext): Future[Unit]
    Definition Classes
    ContractStore
  59. def storeCreatedContracts(requestCounter: RequestCounter, creations: Seq[WithTransactionId[SerializableContract]])(implicit traceContext: TraceContext): Future[Unit]

    Stores contracts created by a request.

    Stores contracts created by a request. Assumes the contract data has been authenticated against the contract id using com.digitalasset.canton.participant.protocol.SerializableContractAuthenticator. If the same contract instance has been stored before, the fields not covered by the contract id authentication will be updated.

    requestCounter

    The request counter of the transaction creating the contracts.

    creations

    The contracts to be created together with the transaction id

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

    Store divulged contracts.

    Store divulged contracts. Assumes the contract data has been authenticated against the contract id using com.digitalasset.canton.participant.protocol.SerializableContractAuthenticator.

    If the same contract instance has been stored before, the fields not covered by the contract id authentication will be updated. The method will however not override a contract that has previously been stored as created contract.

    Definition Classes
    DbContractStoreContractStore
  62. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  63. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbContractStoreFlagCloseable
  64. def toString(): String
    Definition Classes
    AnyRef → Any
  65. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  66. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  67. 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
    Deprecated

Inherited from DbStore

Inherited from HasCloseContext

Inherited from NamedLogging

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from AutoCloseable

Inherited from ContractStore

Inherited from ContractLookup

Inherited from AnyRef

Inherited from Any

Ungrouped