OpenCloud
/
MatrixSynapse
mirror of https://github.com/matrix-org/synapse
1
0
Fork 0
Code Issues Releases Wiki Activity

Update docstring

pull/5191/head
Erik Johnston 2019-05-16 16:41:05 +01:00
parent 7155162844
commit 895179a4dc
1 changed files with 12 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
synapse/storage/stream.py
View File

@ -77,6 +77,15 @@ def generate_pagination_where_clause(
would be generated for dir=b, from_token=(6, 7) and to_token=(5, 3). would be generated for dir=b, from_token=(6, 7) and to_token=(5, 3).
Note that tokens are considered to be after the row they are in, e.g. if
a row A has a token T, then we consider A to be before T. This covention
is important when figuring out inequalities for the generated SQL, and
produces the following result:
- If paginatiting forwards then we exclude any rows matching the from
token, but include those that match the to token.
- If paginatiting backwards then we include any rows matching the from
token, but include those that match the to token.
Args: Args:
direction (str): Whether we're paginating backwards("b") or direction (str): Whether we're paginating backwards("b") or
forwards ("f"). forwards ("f").
@ -131,7 +140,9 @@ def _make_generic_sql_bound(bound, column_names, values, engine):
names (tuple[str, str]): The column names. Must *not* be user defined names (tuple[str, str]): The column names. Must *not* be user defined
as these get inserted directly into the SQL statement without as these get inserted directly into the SQL statement without
escapes. escapes.
values (tuple[int, int]): The values to bound the columns by. values (tuple[int|None, int]): The values to bound the columns by. If
the first value is None then only creates a bound on the second
column.
engine: The database engine to generate the SQL for engine: The database engine to generate the SQL for
Returns: Returns: