API for interacting with metadata streams in EventStoreDB.
Methods for getting, setting and unsetting metadata for streams.
- Type Params
- F
the effect type in which MetaStreams operates.
- Companion
- object
Value members
Abstract methods
Gets the access control list for a stream.
Gets the access control list for a stream.
- Value Params
- 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.
Gets the cache control for a stream.
Gets the cache control for a stream.
- Value Params
- 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.
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 Params
- 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.
Gets the max age for a stream.
Gets the max age for a stream.
- Value Params
- 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.
Gets the max count for a stream.
Gets the max count for a stream.
- Value Params
- 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.
Gets the StreamPosition value that a stream is truncated before.
Gets the StreamPosition value that a stream is truncated before.
- Value Params
- 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.
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 Params
- 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.
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 Params
- 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.
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 Params
- 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.
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 Params
- 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.
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 Params
- 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.
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 Params
- 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.
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 Params
- expectedState
the state that the stream is expected to in. See StreamState for details.
- id
the id of the stream.
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 Params
- expectedState
the state that the stream is expected to in. See StreamState for details.
- id
the id of the stream.
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 Params
- expectedState
the state that the stream is expected to in. See StreamState for details.
- id
the id of the stream.
- Note
Removing custom JSON metadata does not affect other metadata values.
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 Params
- expectedState
the state that the stream is expected to in. See StreamState for details.
- id
the id of the stream.
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 Params
- expectedState
the state that the stream is expected to in. See StreamState for details.
- id
the id of the stream.
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 Params
- expectedState
the state that the stream is expected to in. See StreamState for details.
- id
the id of the stream.
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 Params
- creds
Custom user credentials to use.