Skip to content
Snippets Groups Projects
Commit 35b5c4ba authored by Mark Haines's avatar Mark Haines
Browse files

use google style doc strings

parent a2866e2e
Branches
Tags v1.126.0rc2
No related merge requests found
...@@ -49,17 +49,18 @@ class StreamIdGenerator(object): ...@@ -49,17 +49,18 @@ class StreamIdGenerator(object):
all ids less than or equal to it have completed. This handles the fact that all ids less than or equal to it have completed. This handles the fact that
persistence of events can complete out of order. persistence of events can complete out of order.
:param connection db_conn: A database connection to use to fetch the Args:
initial value of the generator from. db_conn(connection): A database connection to use to fetch the
:param str table: A database table to read the initial value of the id initial value of the generator from.
generator from. table(str): A database table to read the initial value of the id
:param str column: The column of the database table to read the initial generator from.
value from the id generator from. column(str): The column of the database table to read the initial
:param list extra_tables: List of pairs of database tables and columns to value from the id generator from.
use to source the initial value of the generator from. The value with extra_tables(list): List of pairs of database tables and columns to
the largest magnitude is used. use to source the initial value of the generator from. The value
:param int step: which direction the stream ids grow in. +1 to grow with the largest magnitude is used.
upwards, -1 to grow downwards. step(int): which direction the stream ids grow in. +1 to grow
upwards, -1 to grow downwards.
Usage: Usage:
with stream_id_gen.get_next() as stream_id: with stream_id_gen.get_next() as stream_id:
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment