API for interacting with metadata streams in EventStoreDB.
Methods for getting, setting and unsetting metadata for streams.
Type parameters
- F
-
the effect type in which MetaStreams operates.
Attributes
- Companion
- object
- Source
- metastreams.scala
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
Members list
Value members
Abstract methods
Gets the access control list for a stream.
Gets the access control list for a stream.
Value parameters
- id
-
the id of the stream.
Attributes
- Returns
-
an optional result for the metadata stream containing current StreamPosition for the metadata stream and the StreamAcl value.
- Source
- metastreams.scala
Gets the cache control for a stream.
Gets the cache control for a stream.
Value parameters
- id
-
the id of the stream.
Attributes
- Returns
-
an optional result for the metadata stream containing current StreamPosition for the metadata stream and the CacheControl value.
- Source
- metastreams.scala
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.
Value parameters
- id
-
the id of the stream.
Attributes
- 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.
- Source
- metastreams.scala
Gets the max age for a stream.
Gets the max age for a stream.
Value parameters
- id
-
the id of the stream.
Attributes
- Returns
-
an optional result for the metadata stream containing current StreamPosition for the metadata stream and the MaxAge value.
- Source
- metastreams.scala
Gets the max count for a stream.
Gets the max count for a stream.
Value parameters
- id
-
the id of the stream.
Attributes
- Returns
-
an optional result for the metadata stream containing current StreamPosition for the metadata stream and the MaxCount value.
- Source
- metastreams.scala
Gets the StreamPosition value that a stream is truncated before.
Gets the StreamPosition value that a stream is truncated before.
Value parameters
- id
-
the id of the stream.
Attributes
- Returns
-
an optional result for the metadata stream containing current StreamPosition for the metadata stream and the StreamPosition truncate before value.
- Source
- metastreams.scala
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.
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.
Value parameters
- acl
-
the access control list for the stream.
- expectedState
-
the state that the stream is expected to in. See StreamState for details.
- id
-
the id of the stream.
Attributes
- Source
- metastreams.scala
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.
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.
Value parameters
- cacheControl
-
the cache control for the stream.
- expectedState
-
the state that the stream is expected to in. See StreamState for details.
- id
-
the id of the stream.
Attributes
- Source
- metastreams.scala
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.
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.
Value parameters
- custom
-
the custom JSON value using the provided io.circe.Encoder.AsObject encoder.
- expectedState
-
the state that the stream is expected to in. See StreamState for details.
- id
-
the id of the stream.
Attributes
- Source
- metastreams.scala
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.
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.
Value parameters
- age
-
the max age for data in the stream.
- expectedState
-
the state that the stream is expected to in. See StreamState for details.
- id
-
the id of the stream.
Attributes
- Source
- metastreams.scala
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.
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.
Value parameters
- count
-
the max count of data in the stream.
- expectedState
-
the state that the stream is expected to in. See StreamState for details.
- id
-
the id of the stream.
Attributes
- Source
- metastreams.scala
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.
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.
Value parameters
- expectedState
-
the state that the stream is expected to in. See StreamState for details.
- id
-
the id of the stream.
- 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.
Attributes
- Source
- metastreams.scala
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.
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.
Value parameters
- expectedState
-
the state that the stream is expected to in. See StreamState for details.
- id
-
the id of the stream.
Attributes
- Source
- metastreams.scala
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.
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.
Value parameters
- expectedState
-
the state that the stream is expected to in. See StreamState for details.
- id
-
the id of the stream.
Attributes
- Source
- metastreams.scala
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.
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.
Value parameters
- expectedState
-
the state that the stream is expected to in. See StreamState for details.
- id
-
the id of the stream.
Attributes
- Note
-
Removing custom JSON metadata does not affect other metadata values.
- Source
- metastreams.scala
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.
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.
Value parameters
- expectedState
-
the state that the stream is expected to in. See StreamState for details.
- id
-
the id of the stream.
Attributes
- Source
- metastreams.scala
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.
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.
Value parameters
- expectedState
-
the state that the stream is expected to in. See StreamState for details.
- id
-
the id of the stream.
Attributes
- Source
- metastreams.scala
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.
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.
Value parameters
- expectedState
-
the state that the stream is expected to in. See StreamState for details.
- id
-
the id of the stream.
Attributes
- Source
- metastreams.scala
Returns an instance that uses provided UserCredentials. This is useful when an operation requires different credentials from what is provided through configuration.
Returns an instance that uses provided UserCredentials. This is useful when an operation requires different credentials from what is provided through configuration.
Value parameters
- creds
-
Custom user credentials to use.
Attributes
- Source
- metastreams.scala