Packages

trait MetaStreams[F[_]] extends AnyRef

API for interacting with metadata streams in EventStoreDB.

Methods for getting, setting and unsetting metadata for streams.

F

the effect type in which MetaStreams operates.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MetaStreams
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Abstract Value Members

  1. abstract def getAcl(id: Id): F[Option[ReadResult[StreamAcl]]]

    Gets the access control list for a stream.

    Gets the access control list for a stream.

    id

    the id of the stream.

    returns

    an optional result for the metadata stream containing current StreamPosition for the metadata stream and the StreamAcl value.

  2. abstract def getCacheControl(id: Id): F[Option[ReadResult[CacheControl]]]

    Gets the cache control for a stream.

    Gets the cache control for a stream.

    id

    the id of the stream.

    returns

    an optional result for the metadata stream containing current StreamPosition for the metadata stream and the CacheControl value.

  3. abstract def getCustom[T](id: Id)(implicit arg0: Decoder[T]): F[Option[ReadResult[T]]]

    Gets a custom JSON encoded metadata value for a stream using a provided decoder.

    Gets a custom JSON encoded metadata value for a stream using a provided decoder.

    id

    the id of the stream.

    returns

    an optional result for the metadata stream containing current StreamPosition for the metadata stream and a JSON value using the provided io.circe.Decoder decoder.

  4. abstract def getMaxAge(id: Id): F[Option[ReadResult[MaxAge]]]

    Gets the max age for a stream.

    Gets the max age for a stream.

    id

    the id of the stream.

    returns

    an optional result for the metadata stream containing current StreamPosition for the metadata stream and the MaxAge value.

  5. abstract def getMaxCount(id: Id): F[Option[ReadResult[MaxCount]]]

    Gets the max count for a stream.

    Gets the max count for a stream.

    id

    the id of the stream.

    returns

    an optional result for the metadata stream containing current StreamPosition for the metadata stream and the MaxCount value.

  6. abstract def getTruncateBefore(id: Id): F[Option[ReadResult[Exact]]]

    Gets the StreamPosition value that a stream is truncated before.

    Gets the StreamPosition value that a stream is truncated before.

    id

    the id of the stream.

    returns

    an optional result for the metadata stream containing current StreamPosition for the metadata stream and the StreamPosition truncate before value.

  7. abstract def setAcl(id: Id, expectedState: StreamState, acl: StreamAcl): F[WriteResult]

    Sets StreamAcl for a stream and returns WriteResult with current positions of the stream after a successful operation.

    Sets StreamAcl for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

    id

    the id of the stream.

    expectedState

    the state that the stream is expected to in. See StreamState for details.

    acl

    the access control list for the stream.

  8. abstract def setCacheControl(id: Id, expectedState: StreamState, cacheControl: CacheControl): F[WriteResult]

    Sets CacheControl for a stream and returns WriteResult with current positions of the stream after a successful operation.

    Sets CacheControl for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

    id

    the id of the stream.

    expectedState

    the state that the stream is expected to in. See StreamState for details.

    cacheControl

    the cache control for the stream.

  9. abstract def setCustom[T](id: Id, expectedState: StreamState, custom: T)(implicit arg0: AsObject[T]): F[WriteResult]

    Sets a custom JSON metadata value for a stream and returns WriteResult with current positions of the stream after a successful operation.

    Sets a custom JSON metadata value for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

    id

    the id of the stream.

    expectedState

    the state that the stream is expected to in. See StreamState for details.

    custom

    the custom JSON value using the provided io.circe.Encoder.AsObject encoder.

  10. abstract def setMaxAge(id: Id, expectedState: StreamState, age: MaxAge): F[WriteResult]

    Sets MaxAge for a stream and returns WriteResult with current positions of the stream after a successful operation.

    Sets MaxAge for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

    id

    the id of the stream.

    expectedState

    the state that the stream is expected to in. See StreamState for details.

    age

    the max age for data in the stream.

  11. abstract def setMaxCount(id: Id, expectedState: StreamState, count: MaxCount): F[WriteResult]

    Sets MaxCount for a stream and returns WriteResult with current positions of the stream after a successful operation.

    Sets MaxCount for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

    id

    the id of the stream.

    expectedState

    the state that the stream is expected to in. See StreamState for details.

    count

    the max count of data in the stream.

  12. abstract def setTruncateBefore(id: Id, expectedState: StreamState, truncateBefore: Exact): F[WriteResult]

    Sets StreamPosition truncated value for a stream and returns WriteResult with current positions of the stream after a successful operation.

    Sets StreamPosition truncated value for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

    id

    the id of the stream.

    expectedState

    the state that the stream is expected to in. See StreamState for details.

    truncateBefore

    the truncated before stream position for the stream, the value used entails that events with a stream position less than the truncated before value should be removed.

  13. abstract def unsetAcl(id: Id, expectedState: StreamState): F[WriteResult]

    Removes StreamAcl for a stream and returns WriteResult with current positions of the stream after a successful operation.

    Removes StreamAcl for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

    id

    the id of the stream.

    expectedState

    the state that the stream is expected to in. See StreamState for details.

  14. abstract def unsetCacheControl(id: Id, expectedState: StreamState): F[WriteResult]

    Removes CacheControl for a stream and returns WriteResult with current positions of the stream after a successful operation.

    Removes CacheControl for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

    id

    the id of the stream.

    expectedState

    the state that the stream is expected to in. See StreamState for details.

  15. abstract def unsetCustom(id: Id, expectedState: StreamState): F[WriteResult]

    Removes custom JSON metadata value for a stream and returns WriteResult with current positions of the stream after a successful operation.

    Removes custom JSON metadata value for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

    id

    the id of the stream.

    expectedState

    the state that the stream is expected to in. See StreamState for details.

    Note

    Removing custom JSON metadata does not affect other metadata values.

  16. abstract def unsetMaxAge(id: Id, expectedState: StreamState): F[WriteResult]

    Removes MaxAge for a stream and returns WriteResult with current positions of the stream after a successful operation.

    Removes MaxAge for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

    id

    the id of the stream.

    expectedState

    the state that the stream is expected to in. See StreamState for details.

  17. abstract def unsetMaxCount(id: Id, expectedState: StreamState): F[WriteResult]

    Removes MaxCount for a stream and returns WriteResult with current positions of the stream after a successful operation.

    Removes MaxCount for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

    id

    the id of the stream.

    expectedState

    the state that the stream is expected to in. See StreamState for details.

  18. abstract def unsetTruncateBefore(id: Id, expectedState: StreamState): F[WriteResult]

    Removes StreamPosition truncated value for a stream and returns WriteResult with current positions of the stream after a successful operation.

    Removes StreamPosition truncated value for a stream and returns WriteResult with current positions of the stream after a successful operation. Failure to fulfill the expected state is manifested by raising sec.api.exceptions.WrongExpectedState.

    id

    the id of the stream.

    expectedState

    the state that the stream is expected to in. See StreamState for details.

  19. abstract def withCredentials(creds: UserCredentials): MetaStreams[F]

    Returns an instance that uses provided UserCredentials.

    Returns an instance that uses provided UserCredentials. This is useful when an operation requires different credentials from what is provided through configuration.

    creds

    Custom user credentials to use.

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 AnyRef

Inherited from Any

Ungrouped