mirror of
https://github.com/element-hq/synapse
synced 2024-08-18 22:40:51 +00:00
Add docstring
This commit is contained in:
parent
73260ad01f
commit
3cf9948b8d
1 changed files with 11 additions and 0 deletions
|
@ -22,6 +22,17 @@ from synapse.storage.engines import PostgresEngine
|
|||
class SearchStore(SQLBaseStore):
|
||||
@defer.inlineCallbacks
|
||||
def search_msgs(self, room_ids, search_term, keys):
|
||||
"""Performs a full text search over events with give keys.
|
||||
|
||||
Args:
|
||||
room_ids (list): List of room ids to search in
|
||||
search_term (str): Search term to search for
|
||||
keys (list): List of keys to search in, currently supports
|
||||
"content.body", "content.name", "content.body"
|
||||
|
||||
Returns:
|
||||
2-tuple of (dict event_id -> rank, dict event_id -> event)
|
||||
"""
|
||||
clauses = []
|
||||
args = []
|
||||
|
||||
|
|
Loading…
Reference in a new issue