synapse-product/synapse/storage/relations.py

113 lines
3.4 KiB
Python
Raw Normal View History

# Copyright 2019 New Vector Ltd
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
import logging
from typing import Any, Dict, List, Optional, Tuple
2019-05-14 11:59:21 -04:00
import attr
2019-05-14 11:59:21 -04:00
from synapse.api.errors import SynapseError
from synapse.types import JsonDict
logger = logging.getLogger(__name__)
@attr.s(slots=True, auto_attribs=True)
2020-09-04 06:54:56 -04:00
class PaginationChunk:
2019-05-14 11:59:21 -04:00
"""Returned by relation pagination APIs.
Attributes:
chunk: The rows returned by pagination
next_batch: Token to fetch next set of results with, if
2019-05-14 11:59:21 -04:00
None then there are no more results.
prev_batch: Token to fetch previous set of results with, if
2019-05-14 11:59:21 -04:00
None then there are no previous results.
2019-05-14 11:59:21 -04:00
"""
chunk: List[JsonDict]
next_batch: Optional[Any] = None
prev_batch: Optional[Any] = None
2019-05-14 11:59:21 -04:00
def to_dict(self) -> Dict[str, Any]:
2019-05-14 11:59:21 -04:00
d = {"chunk": self.chunk}
2019-05-14 11:59:21 -04:00
if self.next_batch:
d["next_batch"] = self.next_batch.to_string()
if self.prev_batch:
d["prev_batch"] = self.prev_batch.to_string()
2019-05-14 11:59:21 -04:00
return d
@attr.s(frozen=True, slots=True, auto_attribs=True)
2020-09-04 06:54:56 -04:00
class RelationPaginationToken:
2019-05-14 11:59:21 -04:00
"""Pagination token for relation pagination API.
As the results are in topological order, we can use the
2019-05-14 11:59:21 -04:00
`topological_ordering` and `stream_ordering` fields of the events at the
boundaries of the chunk as pagination tokens.
Attributes:
topological: The topological ordering of the boundary event
stream: The stream ordering of the boundary event.
2019-05-14 11:59:21 -04:00
"""
topological: int
stream: int
2019-05-14 11:59:21 -04:00
@staticmethod
def from_string(string: str) -> "RelationPaginationToken":
2019-05-14 11:59:21 -04:00
try:
t, s = string.split("-")
return RelationPaginationToken(int(t), int(s))
except ValueError:
raise SynapseError(400, "Invalid relation pagination token")
2019-05-14 11:59:21 -04:00
def to_string(self) -> str:
2019-05-14 11:59:21 -04:00
return "%d-%d" % (self.topological, self.stream)
def as_tuple(self) -> Tuple[Any, ...]:
2019-05-16 09:21:39 -04:00
return attr.astuple(self)
2019-05-14 11:59:21 -04:00
@attr.s(frozen=True, slots=True, auto_attribs=True)
2020-09-04 06:54:56 -04:00
class AggregationPaginationToken:
2019-05-14 11:59:21 -04:00
"""Pagination token for relation aggregation pagination API.
As the results are order by count and then MAX(stream_ordering) of the
aggregation groups, we can just use them as our pagination token.
Attributes:
count: The count of relations in the boundary group.
stream: The MAX stream ordering in the boundary group.
2019-05-14 11:59:21 -04:00
"""
count: int
stream: int
2019-05-14 11:59:21 -04:00
@staticmethod
def from_string(string: str) -> "AggregationPaginationToken":
2019-05-14 11:59:21 -04:00
try:
c, s = string.split("-")
return AggregationPaginationToken(int(c), int(s))
except ValueError:
raise SynapseError(400, "Invalid aggregation pagination token")
2019-05-14 11:59:21 -04:00
def to_string(self) -> str:
2019-05-14 11:59:21 -04:00
return "%d-%d" % (self.count, self.stream)
def as_tuple(self) -> Tuple[Any, ...]:
2019-05-16 09:21:39 -04:00
return attr.astuple(self)