Python gRPC Client for EventStoreDB
Project description
Python gRPC Client for EventStoreDB
This package provides a Python gRPC client for EventStoreDB. It has been developed and tested to work with EventStoreDB LTS version 21.10, and with Python versions 3.7, 3.8, 3.9, 3.10, and 3.11.
Methods have typing annotations, the static typing is checked with mypy, and the test coverage is 100%.
Not all the features of the EventStoreDB API are presented by this client in its current form, however many of the most useful aspects are presented in an easy-to-use interface (see below). For an example of usage, see the eventsourcing-eventstoredb package.
Table of contents
Installation
Use pip to install this package from the Python Package Index.
$ pip install esdbclient
It is recommended to install Python packages into a Python virtual environment.
Getting started
Start EventStoreDB
Use Docker to run EventStoreDB from the official container image on DockerHub.
$ docker run -d --name my-eventstoredb -it -p 2113:2113 -p 1113:1113 eventstore/eventstore:21.10.2-buster-slim --insecure
Please note, this will start the server without SSL/TLS enabled, allowing only "insecure" connections. This version of this Python client does not support SSL/TLS connections. A future version of this library will support "secure" connections.
Stop EventStoreDB
Use Docker to stop and remove the EventStoreDB container.
$ docker stop my-eventstoredb
$ docker rm my-eventstoredb
Construct client
The class EsdbClient can be constructed with a uri that indicates the
hostname and port number of the EventStoreDB server.
from esdbclient import EsdbClient
client = EsdbClient(uri='localhost:2113')
Streams
Append events
The client has an append_events() method, which can be used to append
new events to a "stream". A stream is a sequence of recorded events that
is uniquely identified by a "stream name"
Three arguments are required, stream_name, expected_position
and events.
The stream_name argument is required, and is expected to be a Python
str object that uniquely identifies the stream in the database.
The expected_position argument is required, is expected to be: either
a positive integer equal to the position in the stream of the last recorded
event in the stream (known as the "stream position"); or None if new events
are being appended to a new stream.
The stream position sequences are zero-based, and so for example when a stream
has one recorded event, the stream position is 0, and the correct value of the
expected_position argument when appending the second new event should be 0.
The correct value of the expected_position argument when appending the first
event of a new stream (a stream with zero recorded events) is None. That is,
streams are created by appending events with expected_position=None, and there
is no way to create a stream without appending events.
If there is a mismatch between the given value of this argument and the
actual stream position when the new events are recorded by the database,
then an ExpectedPositionError exception will be raised. This accomplishes
optimistic concurrency control when appending new events.
If you wish to disable optimistic concurrency, set the
expected_position to a negative integer.
If you need to get the current stream position, then use the get_stream_position()
method (see below).
The events argument is required, and is expected to be a sequence of new
event objects to be appended to the named stream. The NewEvent class should
be used to construct new event objects (see below).
Please note, the append events operation is atomic, so that either all or none of the given new events will be recorded. By design, it is only possible with EventStoreDB to atomically record new events in one stream.
In the example below, a new event is appended to a new stream.
from uuid import uuid4
from esdbclient import NewEvent
# Construct new event object.
event1 = NewEvent(
type='OrderCreated',
data=b'data1',
metadata=b'{}'
)
# Define stream name.
stream_name1 = str(uuid4())
# Append list of events to new stream.
commit_position1 = client.append_events(
stream_name=stream_name1,
expected_position=None,
events=[event1],
)
In the example below, two subsequent events are appended to an existing stream.
event2 = NewEvent(
type='OrderUpdated',
data=b'data2',
metadata=b'{}',
)
event3 = NewEvent(
type='OrderDeleted',
data=b'data3',
metadata=b'{}',
)
commit_position2 = client.append_events(
stream_name=stream_name1,
expected_position=0,
events=[event2, event3],
)
If the append operation is successful, this method returns an integer representing the overall "commit position" as it was when the operation was completed. Otherwise, an exception will be raised.
A "commit position" is a monotonically increasing integer representing the position of the recorded event in a "total order" of all recorded events in the database across all streams. The sequence of commit positions is not gapless. It represents the position of the event record on disk, and there are usually large differences between successive commits.
The "commit position" returned in this way can be used to wait for a downstream component to have processed the newly appended events. For example, after a user interface command that results in the recording of new events, and before a query is issued that depends on an eventually consistent materialized view in a downstream component that would be stale if those newly appended events have not yet been processed, the user interface can poll the downstream component, to see if it has processed an event at that commit position, before executing a query for that materialized view.
Get current stream position
The client has a get_stream_position() method, which can be used to
get the current "stream position" of a stream (the position in the
stream of the last recorded event in that stream).
This method has a stream_name argument, which is required.
This method also takes an optional timeout argument, that
is expected to be a Python float, which sets a deadline
for the completion of the gRPC operation.
The sequence of positions in a stream is gapless. It is zero-based,
so that a stream with one recorded event has a current stream
position of 0. The current stream position is 1 when a stream has
two events, and it is 2 when there are events, and so on.
In the example below, the current stream position is obtained of the
stream to which events were appended in the examples above.
Because the sequence of stream positions is zero-based, and because
three events were appended, so the current stream position is 2.
stream_position = client.get_stream_position(
stream_name=stream_name1
)
assert stream_position == 2
If a stream does not exist, the returned stream position value is None,
which matches the required expected position when appending the first event
of a new stream (see above).
stream_position = client.get_stream_position(
stream_name=str(uuid4())
)
assert stream_position == None
This method takes an optional argument timeout which is a float that sets
a deadline for the completion of the gRPC operation.
Read stream events
The client has a read_stream_events() method, which can be used to read
the events of a stream.
This method returns nn iterable object that yields recorded event objects.
These recorded event objects are instances of the RecordedEvent class (see below)
This method has one required argument, stream_name, which is the name of
the stream to be read. By default, the recorded events in the stream
are returned in the order they were recorded.
The example below shows how to read the recorded events of a stream
forwards from the start of the stream to the end of the stream. The
name of a stream is given when calling the method. In this example,
the iterable response object is converted into a Python list, which
contains all the recorded event objects that were read from the stream.
response = client.read_stream_events(
stream_name=stream_name1
)
events = list(response)
Now that we have a list of event objects, we can check we got the three events that were appended to the stream, and that they are ordered exactly as they were appended.
assert len(events) == 3
assert events[0].stream_name == stream_name1
assert events[0].stream_position == 0
assert events[0].type == event1.type
assert events[0].data == event1.data
assert events[1].stream_name == stream_name1
assert events[1].stream_position == 1
assert events[1].type == event2.type
assert events[1].data == event2.data
assert events[2].stream_name == stream_name1
assert events[2].stream_position == 2
assert events[2].type == event3.type
assert events[2].data == event3.data
The method read_stream_events() also supports four optional arguments,
position, backwards, limit, and timeout.
The optional position argument is an optional integer that can be used to indicate
the position in the stream from which to start reading. This argument is None
by default, which means the stream will be read either from the start of the
stream (the default behaviour), or from the end of the stream if backwards is
True (see below). When reading a stream from a specific position in the stream, the
recorded event at that position WILL be included, both when reading forwards
from that position, and when reading backwards from that position.
The optional argument backwards is a boolean, by default False, which means the
stream will be read forwards by default, so that events are returned in the
order they were appended, If backwards is True, the stream will be read
backwards, so that events are returned in reverse order.
The optional argument limit is an integer which limits the number of events that will
be returned. The default value is sys.maxint.
The optional argument timeout is a float which sets a deadline for the completion of
the gRPC operation.
The example below shows how to read recorded events in a stream forwards from a specific stream position to the end of the stream.
events = list(
client.read_stream_events(
stream_name=stream_name1,
position=1,
)
)
assert len(events) == 2
assert events[0].stream_name == stream_name1
assert events[0].stream_position == 1
assert events[0].type == event2.type
assert events[0].data == event2.data
assert events[1].stream_name == stream_name1
assert events[1].stream_position == 2
assert events[1].type == event3.type
assert events[1].data == event3.data
The example below shows how to read the recorded events in a stream backwards from the end of the stream to the start of the stream.
events = list(
client.read_stream_events(
stream_name=stream_name1,
backwards=True,
)
)
assert len(events) == 3
assert events[0].stream_name == stream_name1
assert events[0].stream_position == 2
assert events[0].type == event3.type
assert events[0].data == event3.data
assert events[1].stream_name == stream_name1
assert events[1].stream_position == 1
assert events[1].type == event2.type
assert events[1].data == event2.data
The example below shows how to read a limited number (two) of the recorded events in a stream forwards from the start of the stream.
events = list(
client.read_stream_events(
stream_name=stream_name1,
limit=2,
)
)
assert len(events) == 2
assert events[0].stream_name == stream_name1
assert events[0].stream_position == 0
assert events[0].type == event1.type
assert events[0].data == event1.data
assert events[1].stream_name == stream_name1
assert events[1].stream_position == 1
assert events[1].type == event2.type
assert events[1].data == event2.data
The example below shows how to read a limited number (one) of the recorded events in a stream backwards from a given stream position.
events = list(
client.read_stream_events(
stream_name=stream_name1,
position=2,
backwards=True,
limit=1,
)
)
assert len(events) == 1
assert events[0].stream_name == stream_name1
assert events[0].stream_position == 2
assert events[0].type == event3.type
assert events[0].data == event3.data
Read all recorded events
The method read_all_events() can be used to read all recorded events
in the database in the order they were recorded. An iterable object of
recorded events is returned. This iterable object will stop when it has
yielded the last recorded event.
The method read_stream_events() supports six optional arguments,
commit_position, backwards, filter_exclude, filter_include, limit,
and timeout.
The optional argument position is an optional integer that can be used to specify
the commit position from which to start reading. This argument is None by
default, meaning that all the events will be read either from the start, or
from the end if backwards is True (see below). Please note, if specified,
the specified position must be an actually existing commit position, because
any other number will result in a server error (at least in EventStoreDB v21.10).
Please also note, when reading forwards from a specific commit position, the event at the specified position WILL be included. However, when reading backwards, the event at the specified position will NOT be included. (This non-inclusive behaviour of excluding the specified commit position when reading all streams differs from the behaviour when reading a named stream backwards from a specific stream position, I'm not sure why.)
The optional argument backwards is a boolean which is by default False meaning the
events will be read forwards by default, so that events are returned in the
order they were committed, If backwards is True, the events will be read
backwards, so that events are returned in reverse order.
The optional argument filter_exclude is a sequence of regular expressions that
match the type strings of recorded events that should not be included. By default,
this argument will match "system events", so that they will not be included.
This argument is ignored if filter_include is set to a non-empty sequence.
The optional argument filter_include is a sequence of regular expressions
that match the type strings of recorded events that should be included. By
default, this argument is an empty tuple. If this argument is set to a
non-empty sequence, the filter_exclude argument is ignored.
Please note, the filtering happens on the EventStoreDB server, and the
limit argument is applied on the server after filtering. See below for
more information about filter regular expressions.
The optional argument limit is an integer which limits the number of events that will
be returned. The default value is sys.maxint.
The optional argument timeout is a float which sets a deadline for the completion of
the gRPC operation.
The example below shows how to read all events in the database in the order they were recorded.
events = list(client.read_all_events())
assert len(events) >= 3
The example below shows how to read all recorded events from a particular commit position.
events = list(
client.read_all_events(
commit_position=commit_position1
)
)
assert len(events) == 3
assert events[0].stream_name == stream_name1
assert events[0].stream_position == 0
assert events[0].type == event1.type
assert events[0].data == event1.data
assert events[1].stream_name == stream_name1
assert events[1].stream_position == 1
assert events[1].type == event2.type
assert events[1].data == event2.data
assert events[2].stream_name == stream_name1
assert events[2].stream_position == 2
assert events[2].type == event3.type
assert events[2].data == event3.data
The example below shows how to read all recorded events in reverse order.
events = list(
client.read_all_events(
backwards=True
)
)
assert len(events) >= 3
assert events[0].stream_name == stream_name1
assert events[0].stream_position == 2
assert events[0].type == event3.type
assert events[0].data == event3.data
assert events[1].stream_name == stream_name1
assert events[1].stream_position == 1
assert events[1].type == event2.type
assert events[1].data == event2.data
assert events[2].stream_name == stream_name1
assert events[2].stream_position == 0
assert events[2].type == event1.type
assert events[2].data == event1.data
The example below shows how to read a limited number (one) of the recorded events in the database forwards from a specific commit position. Please note, when reading all events forwards from a specific commit position, the event at the specified position WILL be included.
events = list(
client.read_all_events(
commit_position=commit_position1,
limit=1,
)
)
assert len(events) == 1
assert events[0].stream_name == stream_name1
assert events[0].stream_position == 0
assert events[0].type == event1.type
assert events[0].data == event1.data
assert events[0].commit_position == commit_position1
The example below shows how to read a limited number (one) of the recorded events in the database backwards from the end. This gives the last recorded event.
events = list(
client.read_all_events(
backwards=True,
limit=1,
)
)
assert len(events) == 1
assert events[0].stream_name == stream_name1
assert events[0].stream_position == 2
assert events[0].type == event3.type
assert events[0].data == event3.data
The example below shows how to read a limited number (one) of the recorded events in the database backwards from a specific commit position. Please note, when reading all events backwards from a specific commit position, the event at the specified position WILL NOT be included.
events = list(
client.read_all_events(
commit_position=commit_position2,
backwards=True,
limit=1,
)
)
assert len(events) == 1
assert events[0].commit_position < commit_position2
Get current commit position
The method get_commit_position() can be used to get the current
commit position of the database.
commit_position = client.get_commit_position()
This method takes an optional argument timeout which is a float that sets
a deadline for the completion of the gRPC operation.
This method can be useful to measure progress of a downstream component that is processing all recorded events, by comparing the current commit position with the recorded commit position of the last successfully processed event in a downstream component.
The value of the commit_position argument when reading events either by using
the read_all_events() method or by using a catch-up subscription would usually
be determined by the recorded commit position of the last successfully processed
event in a downstream component.
Subscriptions
Catch-up subscriptions
The client has a subscribe_all_events() method, which can be used
to start a "catch-up" subscription.
Many catch-up subscriptions can be created, concurrently or successively, and all will receive all the events they are subscribed to receive.
This method returns an iterator object which yields recorded events, including events that are recorded after the subscription was created. This iterator object will therefore not stop, unless the connection to the database is lost. The connection will be closed when the iterator object is deleted from memory, which will happen when the iterator object goes out of scope is explicitly deleted (see below), and the connection may be closed by the server.
This method takes an optional commit_position argument, which can be
used to specify a commit position from which to subscribe for
recorded events. The default value is None, which means
the subscription will operate from the first recorded event
in the database. If a commit position is given, it must match
an actually existing commit position in the database. The events
that are obtained will not include the event recorded at that commit
position.
This method also takes three other optional arguments, filter_exclude,
filter_include, and timeout.
The argument filter_exclude is a sequence of regular expressions matching
the type strings of recorded events that should be excluded. By default,
this argument will match "system events", so that they will not be included.
This argument is ignored if filter_include is set to a non-empty sequence.
The argument filter_include is a sequence of regular expressions
matching the type strings of recorded events that should be included. By
default, this argument is an empty tuple. If this argument is set to a
non-empty sequence, the filter_exclude argument is ignored.
Please note, the filtering happens on the EventStoreDB server, and the
limit argument is applied on the server after filtering. See below for
more information about filter regular expressions.
The argument timeout is a float which sets a deadline for the completion of
the gRPC operation. This probably isn't very useful, but is included for
completeness and consistency with the other methods.
The example below shows how to subscribe to receive all recorded events from a specific commit position. Three already-recorded events are received, and then three new events are recorded, which are then received via the subscription.
# Get the commit position (usually from database of materialised views).
commit_position = client.get_commit_position()
# Append three events to another stream.
stream_name2 = str(uuid4())
event4 = NewEvent(
type='OrderCreated',
data=b'data4',
metadata=b'{}',
)
event5 = NewEvent(
type='OrderUpdated',
data=b'data5',
metadata=b'{}',
)
event6 = NewEvent(
type='OrderDeleted',
data=b'data6',
metadata=b'{}',
)
client.append_events(
stream_name=stream_name2,
expected_position=None,
events=[event4, event5, event6],
)
# Subscribe from the commit position.
subscription = client.subscribe_all_events(
commit_position=commit_position
)
# Catch up by receiving the three events from the subscription.
events = []
for event in subscription:
events.append(event)
if event.data == event6.data and event.stream_name:
break
assert events[0].data == event4.data
assert events[1].data == event5.data
assert events[2].data == event6.data
# Append three more events.
stream_name3 = str(uuid4())
event7 = NewEvent(
type='OrderCreated',
data=b'data7',
metadata=b'{}',
)
event8 = NewEvent(
type='OrderUpdated',
data=b'data8',
metadata=b'{}',
)
event9 = NewEvent(
type='OrderDeleted',
data=b'data9',
metadata=b'{}',
)
client.append_events(
stream_name=stream_name3,
expected_position=None,
events=[event7, event8, event9],
)
# Receive the three new events from the same subscription.
for event in subscription:
# Check the stream name.
events.append(event)
if event.stream_name == stream_name3:
if event.data == event9.data:
break
assert events[3].data == event7.data
assert events[4].data == event8.data
assert events[5].data == event9.data
Catch-up subscriptions are not registered in EventStoreDB (they are not "persistent" subscriptions). It is simply a streaming gRPC call which is kept open by the server, with newly recorded events sent to the client as the client iterates over the subscription. This kind of subscription is closed as soon as the subscription object goes out of memory.
# End the subscription.
del subscription
Please note, when processing events in a downstream component, the commit position of the last successfully processed event is usefully recorded by the downstream component so that the commit position can be determined by the downstream component from its own recorded when it is restarted. This commit position can be used to specify the commit position from which to subscribe. Since this commit position represents the position of the last successfully processed event in a downstream component, so it will be usual to want the next event after this position, because that is the next event that needs to be processed. When subscribing for events using a catchup-subscription in EventStoreDB, the event at the specified commit position will NOT be included in the sequence of recorded events.
To accomplish "exactly once" processing of the events, the commit position of a recorded event should be recorded atomically and uniquely along with the result of processing recorded events, for example in the same database as materialised views when implementing eventually-consistent CQRS, or in the same database as a downstream analytics or reporting or archiving application. This avoids "dual writing" in the processing of events.
Recorded events received from a catch-up subscription cannot be acknowledged back to the EventStoreDB server (there is no need to do this). Acknowledging events is an aspect of "persistent subscriptions" (see below).
The subscription object might be used directly when processing events. It might also be used within a thread dedicated to receiving events, with recorded events put on a queue for processing in a different thread. This package doesn't provide such thread or queue objects, you would need to do that yourself. Just make sure to reconstruct the subscription (and the queue) using your last recorded commit position when resuming the subscription after an error, to be sure all events are processed once.
Persistent subscriptions
The method create_subscription() can be used to create a
"persistent subscription" to EventStoreDB.
This method takes a required group_name argument, which is the
name of a "group" of consumers of the subscription.
This method takes an optional from_end argument, which can be
used to specify that the group of consumers of the subscription should
only receive events that were recorded after the subscription was created.
This method takes an optional commit_position argument, which can be
used to specify a commit position from which the group of consumers of
the subscription should receive events. Please note, the recorded event
at the specified commit position MAY be included in the recorded events
received by the group of consumers.
If neither from_end or position are specified, the group of consumers
of the subscription will receive all recorded events.
The method create_subscription() does not return a value, because
recorded events are obtained by the group of consumers of the subscription
using the read_subscription() method.
In the example below, a persistent subscription is created.
# Create a persistent subscription.
group_name = f"group-{uuid4()}"
client.create_subscription(group_name=group_name)
The method read_subscription() can be used by a group of consumers to receive
recorded events from a persistent subscription created using create_subscription.
This method takes a required group_name argument, which is
the name of a "group" of consumers of the subscription specified
when create_subscription() was called.
This method returns a 2-tuple: a "read request" object and a "read response" object.
read_req, read_resp = client.read_subscription(group_name=group_name)
The "read response" object is an iterator that yields recorded events from the specified commit position.
The "read request" object has an ack() method that can be used by a consumer
in a group to acknowledge to the server that it has received and successfully
processed a recorded event. This will prevent that recorded event being received
by another consumer in the same group. The ack() method takes an event_id
argument, which is the ID of the recorded event that has been received.
The example below iterates over the "read response" object, and calls ack()
on the "read response" object. The for loop breaks when we have received
the last event, so that we can continue with the examples below.
events = []
for event in read_resp:
events.append(event)
# Acknowledge the received event.
read_req.ack(event_id=event.id)
# Break when the last event has been received.
if event.stream_name == stream_name3:
if event.data == event9.data:
break
The received events are the events we appended above.
assert events[-9].data == event1.data
assert events[-8].data == event2.data
assert events[-7].data == event3.data
assert events[-6].data == event4.data
assert events[-5].data == event5.data
assert events[-4].data == event6.data
assert events[-3].data == event7.data
assert events[-2].data == event8.data
assert events[-1].data == event9.data
The "read request" object also has an nack() method that can be used by a consumer
in a group to acknowledge to the server that it has failed successfully to
process a recorded event. This will allow that recorded event to be received
by this or another consumer in the same group.
It might be more useful to encapsulate the request and response objects and to iterate
over the "read response" in a separate thread, to call back to a handler function when
a recorded event is received, and call ack() if the handler does not raise an
exception, and to call nack() if an exception is raised. The example below shows how
this might be done.
from threading import Thread
class SubscriptionReader:
def __init__(self, client, group_name, callback):
self.client = client
self.group_name = group_name
self.callback = callback
self.thread = Thread(target=self.read_subscription, daemon=True)
self.error = None
def start(self):
self.thread.start()
def join(self):
self.thread.join()
def read_subscription(self):
req, resp = self.client.read_subscription(group_name=self.group_name)
for event in resp:
try:
self.callback(event)
except Exception as e:
# req.nack(event.id) # not yet implemented....
self.error = e
break
else:
req.ack(event.id)
# Create another persistent subscription.
group_name = f"group-{uuid4()}"
client.create_subscription(group_name=group_name)
events = []
def handle_event(event):
events.append(event)
print("Event:", event.stream_name, event.data)
if event.stream_name == stream_name3:
if event.data == event9.data:
raise Exception()
reader = SubscriptionReader(
client=client,
group_name=group_name,
callback=handle_event
)
reader.start()
reader.join()
assert events[-1].data == event9.data
Please note, when processing events in a downstream component, the commit position of the last successfully processed event is usefully recorded by the downstream component so that the commit position can be determined by the downstream component from its own recorded when it is restarted. This commit position can be used to specify the commit position from which to subscribe. Since this commit position represents the position of the last successfully processed event in a downstream component, so it will be usual to want to read from the next event after this position, because that is the next event that needs to be processed. However, when subscribing for events using a persistent subscription in EventStoreDB, the event at the specified commit position MAY be returned as the first event in the received sequence of recorded events, and so it may be necessary to check the commit position of the received events and to discard any recorded event object that has a commit position equal to the commit position specified in the request.
Whilst there are some advantages of persistent subscriptions, by tracking in the upstream server the position in the commit sequence of events that have been processed, there is a danger of "dual writing" in the consumption of events. The danger is that if an event is successfully processed but then the acknowledgment fails, the event may be received more than once. On the other hand, if the acknowledgment is successful but then the processing fails, the event may effectively not be been processed. By either processing an events more than once, or failing to process an event, the resulting state of the processing of the recorded events might be inaccurate, or possibly inconsistent, and perhaps catastrophically so. Any relatively minor consequences may or may not matter in your situation. But sometimes inconsistencies may halt processing until the issue is resolved. You can avoid "dual writing" in the consumption of events by atomically recording the commit position of an event that has been processed along with the results of processing that event (that is, with both things being recorded in the same transaction), and making these records unique so that transactions will be rolled back preventing the results of reprocessing the event being committed.
Notes
Regular expression filters
The filter_exclude and filter_include arguments in read_all_events() and
subscribe_all_events() are applied to the type attribute of recorded events.
The default value of the filter_exclude arguments is designed to exclude
EventStoreDB "system events", which otherwise would be included. System
events, by convention in EventStoreDB, all have type strings that
start with the $ sign.
Please note, characters that have a special meaning in regular expressions will need to be escaped (with double-backslash) when matching these characters in type strings.
For example, to match EventStoreDB system events, use the sequence ['\\$.*'].
Please note, the constant ESDB_EVENTS_REGEX is set to '\\$.*'. You
can import this value (from esdbclient import ESDB_EVENTS_REGEX) and use
it when building longer sequences of regular expressions. For example,
to exclude system events and snapshots, you might use the sequence
[ESDB_EVENTS_REGEX, '.*Snapshot'] as the value of the filter_exclude
argument.
The NewEvent class
The NewEvent class can be used to define new events.
The attribute type is a unicode string, used to specify the type of the event
to be recorded.
The attribute data is a byte string, used to specify the data of the event
to be recorded. Please note, in this version of this Python client,
writing JSON event data to EventStoreDB isn't supported, but it might be in
a future version.
The attribute metadata is a byte string, used to specify metadata for the event
to be recorded.
new_event = NewEvent(
type='OrderCreated',
data=b'{}',
metadata=b'{}',
)
The RecordedEvent class
The RecordedEvent class is used when reading recorded events.
The attribute type is a unicode string, used to indicate the type of the event
that was recorded.
The attribute data is a byte string, used to indicate the data of the event
that was recorded.
The attribute metadata is a byte string, used to indicate metadata for the event
that was recorded.
The attribute stream_name is a unicode string, used to indicate the type of
the name of the stream in which the event was recorded.
The attribute stream_position is an integer, used to indicate
the position in the stream at which the event was recorded.
The attribute commit_position is an integer, used to indicate
the position in total order of all recorded events at which the
event was recorded.
from esdbclient.events import RecordedEvent
recorded_event = RecordedEvent(
id=uuid4(),
type='OrderCreated',
data=b'{}',
metadata=b'{}',
stream_name='stream1',
stream_position=0,
commit_position=512,
)
Contributors
Install Poetry
The first thing is to check you have Poetry installed.
$ poetry --version
If you don't, then please install Poetry.
$ curl -sSL https://install.python-poetry.org | python3 -
It will help to make sure Poetry's bin directory is in your PATH environment variable.
But in any case, make sure you know the path to the poetry executable. The Poetry
installer tells you where it has been installed, and how to configure your shell.
Please refer to the Poetry docs for guidance on using Poetry.
Setup for PyCharm users
You can easily obtain the project files using PyCharm (menu "Git > Clone..."). PyCharm will then usually prompt you to open the project.
Open the project in a new window. PyCharm will then usually prompt you to create a new virtual environment.
Create a new Poetry virtual environment for the project. If PyCharm doesn't already
know where your poetry executable is, then set the path to your poetry executable
in the "New Poetry Environment" form input field labelled "Poetry executable". In the
"New Poetry Environment" form, you will also have the opportunity to select which
Python executable will be used by the virtual environment.
PyCharm will then create a new Poetry virtual environment for your project, using
a particular version of Python, and also install into this virtual environment the
project's package dependencies according to the pyproject.toml file, or the
poetry.lock file if that exists in the project files.
You can add different Poetry environments for different Python versions, and switch between them using the "Python Interpreter" settings of PyCharm. If you want to use a version of Python that isn't installed, either use your favourite package manager, or install Python by downloading an installer for recent versions of Python directly from the Python website.
Once project dependencies have been installed, you should be able to run tests
from within PyCharm (right-click on the tests folder and select the 'Run' option).
Because of a conflict between pytest and PyCharm's debugger and the coverage tool,
you may need to add --no-cov as an option to the test runner template. Alternatively,
just use the Python Standard Library's unittest module.
You should also be able to open a terminal window in PyCharm, and run the project's Makefile commands from the command line (see below).
Setup from command line
Obtain the project files, using Git or suitable alternative.
In a terminal application, change your current working directory to the root folder of the project files. There should be a Makefile in this folder.
Use the Makefile to create a new Poetry virtual environment for the project and install the project's package dependencies into it, using the following command.
$ make install-packages
It's also possible to also install the project in 'editable mode'.
$ make install
Please note, if you create the virtual environment in this way, and then try to open the project in PyCharm and configure the project to use this virtual environment as an "Existing Poetry Environment", PyCharm sometimes has some issues (don't know why) which might be problematic. If you encounter such issues, you can resolve these issues by deleting the virtual environment and creating the Poetry virtual environment using PyCharm (see above).
Project Makefile commands
You can start EventStoreDB using the following command.
$ make start-eventstoredb
You can run tests using the following command (needs EventStoreDB to be running).
$ make test
You can stop EventStoreDB using the following command.
$ make stop-eventstoredb
You can check the formatting of the code using the following command.
$ make lint
You can reformat the code using the following command.
$ make fmt
Tests belong in ./tests. Code-under-test belongs in ./esdbclient.
Edit package dependencies in pyproject.toml. Update installed packages (and the
poetry.lock file) using the following command.
$ make update-packages
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
