class DbContractStore extends ContractStore with DbStore

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. DbContractStore
  2. DbStore
  3. HasCloseContext
  4. PromiseUnlessShutdownFactory
  5. NamedLogging
  6. ContractStore
  7. FlagCloseable
  8. PerformUnlessClosing
  9. HasSynchronizeWithReaders
  10. HasSynchronizeWithClosing
  11. OnShutdownRunner
  12. HasRunOnClosing
  13. HasUnlessClosing
  14. AutoCloseable
  15. Purgeable
  16. ContractLookup
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new DbContractStore(storage: DbStorage, cacheConfig: CacheConfig, dbQueryBatcherConfig: BatchAggregatorConfig, insertBatchAggregatorConfig: BatchAggregatorConfig, timeouts: ProcessingTimeout, loggerFactory: NamedLoggerFactory)(implicit ec: ExecutionContext)

Type Members

  1. type ContractsCreatedAtTime = CreatedAt
    Definition Classes
    ContractStoreContractLookup

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 addReader(reader: String)(implicit traceContext: TraceContext): UnlessShutdown[ReaderHandle]

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  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]) @IntrinsicCandidate() @native()
  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 contractCount()(implicit traceContext: TraceContext): FutureUnlessShutdown[Int]
    Definition Classes
    DbContractStoreContractStore
  11. implicit def contractGetResult(implicit getResultByteArray: GetResult[Array[Byte]]): GetResult[ContractInstance]
    Annotations
    @SuppressWarnings()
  12. implicit def contractSetParameter: SetParameter[ContractInstance]
  13. def deleteIgnoringUnknown(contractIds: Iterable[LfContractId])(implicit traceContext: TraceContext): FutureUnlessShutdown[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(exactId: Option[String], filterPackage: Option[String], filterTemplate: Option[String], limit: Int)(implicit traceContext: TraceContext): FutureUnlessShutdown[List[ContractInstance]]

    Debug find utility to search pcs

    Debug find utility to search pcs

    Definition Classes
    DbContractStoreContractStore
  19. def findWithPayload(contractIds: NonEmpty[Seq[LfContractId]])(implicit traceContext: TraceContext): FutureUnlessShutdown[Map[LfContractId, ContractInstance]]

    Debug find utility to search pcs.

    Debug find utility to search pcs. Omits contracts that are not found.

    Definition Classes
    DbContractStoreContractStore
  20. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  21. def hasActiveContracts(partyId: PartyId, contractIds: Iterator[LfContractId], batchSize: Int = 10)(implicit traceContext: TraceContext): FutureUnlessShutdown[Boolean]
    Definition Classes
    ContractStore
  22. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  23. 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
    OnShutdownRunnerHasUnlessClosing
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def isSignatoryOnActiveContracts(partyId: PartyId, contractIds: Iterator[LfContractId], batchSize: Int = 10)(implicit traceContext: TraceContext): FutureUnlessShutdown[Boolean]
    Definition Classes
    ContractStore
  26. def keepTrackOfReaderCallStack: Boolean

    Set this to true to get detailed information about all futures that did not complete during shutdown.

    Set this to true to get detailed information about all futures that did not complete during shutdown.

    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  27. def logger: TracedLogger
  28. val loggerFactory: NamedLoggerFactory
    Attributes
    protected
    Definition Classes
    DbContractStoreNamedLogging
  29. def lookup(id: LfContractId)(implicit traceContext: TraceContext): OptionT[FutureUnlessShutdown, ContractInstance]
    Definition Classes
    DbContractStoreContractLookup
  30. def lookupE(id: LfContractId)(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, UnknownContract, GenContractInstance { type InstCreatedAtTime <: DbContractStore.this.ContractsCreatedAtTime }]
    Definition Classes
    ContractLookup
  31. def lookupFatContract(id: LfContractId)(implicit traceContext: TraceContext): OptionT[FutureUnlessShutdown, FatContractInstance { type CreatedAtTime <: DbContractStore.this.ContractsCreatedAtTime }]
    Definition Classes
    ContractLookup
  32. def lookupManyExistingUncached(ids: Seq[LfContractId])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, LfContractId, List[ContractInstance]]
    Definition Classes
    DbContractStoreContractLookup
  33. def lookupManyUncached(ids: Seq[LfContractId])(implicit traceContext: TraceContext): FutureUnlessShutdown[List[Option[GenContractInstance { type InstCreatedAtTime <: DbContractStore.this.ContractsCreatedAtTime }]]]
    Definition Classes
    ContractLookup
  34. def lookupMetadata(ids: Set[LfContractId])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, UnknownContracts, Map[LfContractId, ContractMetadata]]
  35. def lookupSignatories(ids: Set[LfContractId])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, UnknownContracts, Map[LfContractId, Set[LfPartyId]]]
    Definition Classes
    DbContractStoreContractLookup
  36. def lookupStakeholders(ids: Set[LfContractId])(implicit traceContext: TraceContext): EitherT[FutureUnlessShutdown, UnknownContracts, Map[LfContractId, Set[LfPartyId]]]
    Definition Classes
    DbContractStoreContractLookup
  37. def mkPromise[A](description: String, futureSupervisor: FutureSupervisor, logAfter: Duration = 10.seconds, logLevel: Level = Level.DEBUG)(implicit elc: ErrorLoggingContext): 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. def nameInternal: String
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  39. implicit def namedLoggingContext(implicit traceContext: TraceContext): NamedLoggingContext
    Attributes
    protected
    Definition Classes
    NamedLogging
  40. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  41. def noTracingLogger: Logger
    Attributes
    protected
    Definition Classes
    NamedLogging
  42. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  43. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  44. def onCloseFailure(e: Throwable): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  45. def onClosed(): Unit
    Attributes
    protected
    Definition Classes
    PerformUnlessClosing
  46. 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
  47. def purge()(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]

    Purges all data from the store.

    Purges all data from the store. This MUST ONLY be invoked when none of the data is needed anymore for example on synchronizer migration once all the data has been reassigned to the new synchronizer.

    Definition Classes
    DbContractStorePurgeable
  48. def remainingReaders(): Seq[String]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  49. def removeReader(handle: ReaderHandle): Unit

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    TODO(#16601) Make this method private once PerformUnlessClosing doesn't need it any more

    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  50. def runOnClose(task: RunOnClosing): UnlessShutdown[LifeCycleRegistrationHandle]

    Schedules the given task to be run upon closing.

    Schedules the given task to be run upon closing.

    returns

    An com.digitalasset.canton.lifecycle.UnlessShutdown.Outcome indicates that the task will have been run when the LifeCycleManager's closeAsync method completes or when AutoCloseable's close method returns, unless the returned LifeCycleRegistrationHandle was used to cancel the task or the task has been done beforehand. com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if the task is not run due to closing. This always happens if isClosing returns true.

    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  51. def runOnOrAfterClose(task: RunOnClosing)(implicit traceContext: TraceContext): LifeCycleRegistrationHandle

    Register a task to run when closing is initiated, or run it immediately if closing is already ongoing.

    Register a task to run when closing is initiated, or run it immediately if closing is already ongoing. Unlike runOnClose, this method does not guarantee that this task will have run by the time the LifeCycleManager's closeAsync method completes or AutoCloseable's close returns. This is because the task is run immediately if the component has already been closed.

    Definition Classes
    HasRunOnClosing
  52. final def runOnOrAfterClose_(task: RunOnClosing)(implicit traceContext: TraceContext): Unit

    Variant of runOnOrAfterClose that does not return a com.digitalasset.canton.lifecycle.LifeCycleRegistrationHandle.

  53. def runTaskUnlessDone(task: RunOnClosing)(implicit traceContext: TraceContext): Unit
    Attributes
    protected[this]
    Definition Classes
    OnShutdownRunnerHasRunOnClosing
  54. val storage: DbStorage
    Attributes
    protected
    Definition Classes
    DbContractStoreDbStore
  55. def storeContract(contract: ContractInstance)(implicit traceContext: TraceContext): FutureUnlessShutdown[Unit]
    Definition Classes
    ContractStore
  56. def storeContracts(contracts: Seq[ContractInstance])(implicit traceContext: TraceContext): FutureUnlessShutdown[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.ContractAuthenticator.

    contracts

    The created contracts to be stored

    Definition Classes
    DbContractStoreContractStore
  57. def synchronizeWithClosing[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F], A: CanAbortDueToShutdown[F]): F[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    The computation completes with com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise it is the result of running f.

    Definition Classes
    HasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  58. def synchronizeWithClosingF[A](name: String)(f: => Future[A])(implicit ec: ExecutionContext, traceContext: TraceContext): FutureUnlessShutdown[A]

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns.

    Convenience method for synchronizing on Futures instead of FutureUnlessShutdowns. Equivalent to

    synchronizeWithClosing(name)(FutureUnlessShutdown.outcomeF(f))
    Definition Classes
    PerformUnlessClosing
  59. def synchronizeWithClosingPatience: FiniteDuration
    Attributes
    protected[this]
    Definition Classes
    PerformUnlessClosingHasSynchronizeWithReaders
  60. def synchronizeWithClosingSync[A](name: String)(f: => A)(implicit traceContext: TraceContext): UnlessShutdown[A]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has finished or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run.

    Definition Classes
    HasSynchronizeWithClosing
    Annotations
    @SuppressWarnings()
    See also

    HasRunOnClosing.isClosing

  61. def synchronizeWithClosingUS[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]

    Runs the computation f only if the component is not yet closing.

    Runs the computation f only if the component is not yet closing. If so, the component will delay releasing its resources until f has completed (as defined by the com.digitalasset.canton.util.Thereafter instance) or the synchronizeWithClosingPatience has elapsed.

    DO NOT CALL this.close as part of f, because it will result in a deadlock. DO NOT PUT retries, especially indefinite ones, inside f.

    returns

    com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if f has not run. Otherwise the result of running f.

    Definition Classes
    PerformUnlessClosingHasSynchronizeWithClosing
    See also

    HasRunOnClosing.isClosing

  62. def synchronizeWithReaders()(implicit traceContext: TraceContext): Boolean
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders
  63. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  64. val timeouts: ProcessingTimeout
    Attributes
    protected
    Definition Classes
    DbContractStoreFlagCloseable
  65. def toString(): String
    Definition Classes
    AnyRef → Any
  66. final def unlessClosing[F[_], A](fa: => F[A])(implicit F: CanAbortDueToShutdown[F]): F[A]

    Runs the computation fa unless isClosing returns true.

    Runs the computation fa unless isClosing returns true.

    This method does not delay the closing while fa is running, unlike the methods in HasSynchronizeWithClosing. Accordingly, this method is useful for intermittent checks whether the result of the computation is still relevant.

    returns

    The result of fa or com.digitalasset.canton.lifecycle.UnlessShutdown.AbortedDueToShutdown if isClosing is true

    Definition Classes
    HasUnlessClosing
    Annotations
    @inline()
  67. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  68. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  69. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  70. def withReader[F[_], A](name: String)(f: => F[A])(implicit traceContext: TraceContext, F: Thereafter[F]): UnlessShutdown[F[A]]
    Attributes
    protected[this]
    Definition Classes
    HasSynchronizeWithReaders

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from DbStore

Inherited from HasCloseContext

Inherited from NamedLogging

Inherited from ContractStore

Inherited from FlagCloseable

Inherited from PerformUnlessClosing

Inherited from OnShutdownRunner

Inherited from HasRunOnClosing

Inherited from HasUnlessClosing

Inherited from AutoCloseable

Inherited from Purgeable

Inherited from ContractLookup

Inherited from AnyRef

Inherited from Any

Ungrouped