`eventstoredb.options`#

Module Contents#

Classes#

`AppendExpectedRevision`	Create a collection of name/value pairs.
`AppendToStreamOptions`
`CreatePersistentSubscriptionToAllOptions`
`ConsumerStrategy`	Create a collection of name/value pairs.
`CreatePersistentSubscriptionToStreamOptions`
`PersistentSubscriptionSettings`
`DeletePersistentSubscriptionToAllOptions`
`DeletePersistentSubscriptionToStreamOptions`
`ReadAllOptions`
`ReadStreamOptions`
`SubscribeToAllOptions`
`SubscribeToPersistentSubscriptionToAllOptions`
`NackAction`	Create a collection of name/value pairs.
`SubscribeToPersistentSubscriptionToStreamOptions`
`SubscribeToStreamOptions`
`ClientOptions`
`UpdatePersistentSubscriptionToAllOptions`
`UpdatePersistentSubscriptionToStreamOptions`
`AllPosition`
`ReadDirection`	Create a collection of name/value pairs.
`StreamPosition`	Create a collection of name/value pairs.

class eventstoredb.options.AppendExpectedRevision(*args, **kwds)[source]#

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

NO_STREAM#

ANY#

STREAM_EXISTS#

class eventstoredb.options.AppendToStreamOptions[source]#

expected_revision: AppendExpectedRevision | eventstoredb.types.StreamRevision#

class eventstoredb.options.CreatePersistentSubscriptionToAllOptions[source]#

settings: eventstoredb.client.create_persistent_subscription_to_stream.types.PersistentSubscriptionSettings#

from_position: eventstoredb.types.AllPosition | eventstoredb.types.StreamPosition#

filter: eventstoredb.filters.ExcludeSystemEventsFilter | eventstoredb.filters.EventTypeFilter | eventstoredb.filters.StreamNameFilter | None#

max_search_window: int | None#

checkpoint_interval: int = 1#

class eventstoredb.options.ConsumerStrategy(*args, **kwds)[source]#

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

DISPATCH_TO_SINGLE#

ROUND_ROBIN#

PINNED#

class eventstoredb.options.CreatePersistentSubscriptionToStreamOptions[source]#

settings: PersistentSubscriptionSettings#

from_revision: eventstoredb.types.StreamRevision | eventstoredb.types.StreamPosition#

class eventstoredb.options.PersistentSubscriptionSettings[source]#

resolve_links: bool = False#

extra_statistics: bool = False#

message_timeout: int = 30000#

max_retry_count: int = 10#

checkpoint_after: int = 2000#

min_checkpoint_count: int = 10#

max_checkpoint_count: int = 1000#

max_subscriber_count: int = 0#

live_buffer_size: int = 500#

read_batch_size: int = 20#

history_buffer_size: int = 500#

consumer_strategy: ConsumerStrategy#

class eventstoredb.options.DeletePersistentSubscriptionToAllOptions[source]#

class eventstoredb.options.DeletePersistentSubscriptionToStreamOptions[source]#

class eventstoredb.options.ReadAllOptions[source]#

from_position: eventstoredb.types.AllPosition | eventstoredb.types.StreamPosition#

max_count: int#

direction: eventstoredb.types.ReadDirection#

resolve_links: bool = False#

filter: eventstoredb.filters.ExcludeSystemEventsFilter | eventstoredb.filters.EventTypeFilter | eventstoredb.filters.StreamNameFilter | None#

class eventstoredb.options.ReadStreamOptions[source]#

from_revision: eventstoredb.types.StreamRevision | eventstoredb.types.StreamPosition#

max_count: int#

direction: eventstoredb.types.ReadDirection#

resolve_links: bool = False#

class eventstoredb.options.SubscribeToAllOptions[source]#

from_position: eventstoredb.types.AllPosition | eventstoredb.types.StreamPosition#

resolve_links: bool = False#

filter: eventstoredb.filters.ExcludeSystemEventsFilter | eventstoredb.filters.EventTypeFilter | eventstoredb.filters.StreamNameFilter | None#

max_search_window: int | None#

checkpoint_interval: int = 1#

class eventstoredb.options.SubscribeToPersistentSubscriptionToAllOptions[source]#: Bases: eventstoredb.client.subscribe_to_persistent_subscription_to_stream.types.SubscribeToPersistentSubscriptionToStreamOptions

class eventstoredb.options.NackAction(*args, **kwds)[source]#

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

UNKNOWN#

PARK#

RETRY#

SKIP#

STOP#

class eventstoredb.options.SubscribeToPersistentSubscriptionToStreamOptions[source]#

buffer_size: int = 10#

class eventstoredb.options.SubscribeToStreamOptions[source]#

from_revision: eventstoredb.types.StreamRevision | eventstoredb.types.StreamPosition#

resolve_links: bool = False#

class eventstoredb.options.ClientOptions[source]#

host: str#

port: int = 2113#

username: str | None#

password: str | None#

tls: bool = True#

dns_discovery: bool = False#

keep_alive_timeout: int = 10000#

keep_alive_interval: int = 10000#

classmethod from_connection_string(connection_string)[source]#

Parameters:: connection_string (str) –
Return type:: ClientOptions

class eventstoredb.options.UpdatePersistentSubscriptionToAllOptions[source]#: Bases: eventstoredb.client.create_persistent_subscription_to_all.types.CreatePersistentSubscriptionToAllOptions

class eventstoredb.options.UpdatePersistentSubscriptionToStreamOptions[source]#: Bases: eventstoredb.client.create_persistent_subscription_to_stream.types.CreatePersistentSubscriptionToStreamOptions

class eventstoredb.options.AllPosition[source]#

commit_position: int#

prepare_position: int#

class eventstoredb.options.ReadDirection(*args, **kwds)[source]#

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

FORWARDS#

BACKWARDS#

class eventstoredb.options.StreamPosition(*args, **kwds)[source]#

Bases: enum.Enum

Create a collection of name/value pairs.

Example enumeration:

>>> class Color(Enum):
...     RED = 1
...     BLUE = 2
...     GREEN = 3

Access them by:

attribute access:
```
>>> Color.RED
<Color.RED: 1>
```
value lookup:
```
>>> Color(1)
<Color.RED: 1>
```
name lookup:
```
>>> Color['RED']
<Color.RED: 1>
```

Enumerations can be iterated over, and know how many members they have:

>>> len(Color)
3

>>> list(Color)
[<Color.RED: 1>, <Color.BLUE: 2>, <Color.GREEN: 3>]

Methods can be added to enumerations, and members can have their own attributes – see the documentation for details.

START#

END#

eventstoredb.options#

Module Contents#

Classes#

`eventstoredb.options`#