all
Extensions
Inherited extensions
Sets cache control in FiniteDuration 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 cache control in FiniteDuration 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 FiniteDuration value for data in the stream. Valid values are FiniteDuration greater or equal to 1 second. An InvalidInput exception is raised for invalid input value.
- expectedState
the state that the stream is expected to in. See StreamState for details.
- id
the id of the stream.
- Inherited from
- MetaStreamsSyntax
Sets max age in FiniteDuration 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 max age in FiniteDuration 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 FiniteDuration value for data in the stream. Valid values are FiniteDuration greater or equal to 1 second. An InvalidInput exception is raised for invalid input value.
- expectedState
the state that the stream is expected to in. See StreamState for details.
- id
the id of the stream.
- Inherited from
- MetaStreamsSyntax
Sets max count in Int 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 max count in Int 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 Int value for data in the stream. Valid values are greater or equal to 1. An InvalidInput exception is raised for invalid input value.
- expectedState
the state that the stream is expected to in. See StreamState for details.
- id
the id of the stream.
- Inherited from
- MetaStreamsSyntax
Sets truncated before in Long 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 truncated before in Long 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.
- truncatedBefore
the truncated before Long value for data in the stream. Valid values are Long greater or equal to 0L. An InvalidInput exception is raised for invalid input value.
- Inherited from
- MetaStreamsSyntax
Read events backwards from the global stream, sec.StreamId.All.
Read events backwards from the global stream, sec.StreamId.All.
- Value Params
- from
log position to read from.
- maxCount
limits maximum events returned.
- resolveLinkTos
whether to resolve EventType.LinkTo events automatically.
- Returns
a Stream that emits AllEvent values.
- Inherited from
- StreamsSyntax
Read events forwards from the global stream, sec.StreamId.All.
Read events forwards from the global stream, sec.StreamId.All.
- Value Params
- from
log position to read from.
- maxCount
limits maximum events returned.
- resolveLinkTos
whether to resolve EventType.LinkTo events automatically.
- Returns
a Stream that emits AllEvent values.
- Inherited from
- StreamsSyntax
Read events backwards from an individual stream. A sec.api.exceptions.StreamNotFound is raised when the stream does not exist.
Read events backwards from an individual stream. A sec.api.exceptions.StreamNotFound is raised when the stream does not exist.
- Value Params
- from
stream position to read from.
- maxCount
limits maximum events returned.
- resolveLinkTos
whether to resolve EventType.LinkTo events automatically.
- streamId
the id of the stream to read from.
- Returns
a Stream that emits StreamEvent values.
- Inherited from
- StreamsSyntax
Read events forwards from an individual stream. A sec.api.exceptions.StreamNotFound is raised when the stream does not exist.
Read events forwards from an individual stream. A sec.api.exceptions.StreamNotFound is raised when the stream does not exist.
- Value Params
- from
stream position to read from.
- maxCount
limits maximum events returned.
- resolveLinkTos
whether to resolve EventType.LinkTo events automatically.
- streamId
the id of the stream to read from.
- Returns
a Stream that emits StreamEvent values.
- Inherited from
- StreamsSyntax
Subscribes to the global stream, StreamId.All using a subscription filter without resolving EventType.LinkTo events.
Subscribes to the global stream, StreamId.All using a subscription filter without resolving EventType.LinkTo events.
- Value Params
- exclusiveFrom
log position to start from. Use None to subscribe from the beginning.
- filterOptions
to use when subscribing - See sec.api.SubscriptionFilterOptions.
- Returns
a Stream that emits either Checkpoint or AllEvent values. How frequent Checkpoint is emitted depends on filterOptions.
- Inherited from
- StreamsSyntax
Subscribes to the global stream, StreamId.All without resolving EventType.LinkTo events.
Subscribes to the global stream, StreamId.All without resolving EventType.LinkTo events.
- Value Params
- exclusiveFrom
position to start from. Use None to subscribe from the beginning.
- Returns
a Stream that emits AllEvent values.
- Inherited from
- StreamsSyntax
Subscribes to an individual stream without resolving EventType.LinkTo events.
Subscribes to an individual stream without resolving EventType.LinkTo events.
- Value Params
- exclusiveFrom
stream position to start from. Use None to subscribe from the beginning.
- streamId
the id of the stream to subscribe to.
- Returns
a Stream that emits StreamEvent values.
- Inherited from
- StreamsSyntax