Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

use google style doc strings

This commit is contained in:
Mark Haines 2016-04-01 15:07:01 +01:00
parent a2866e2e6a
commit 35b5c4ba1b
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
synapse/storage/util/id_generators.py
View File

@ -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: