Add docstring

This commit is contained in:
Erik Johnston 2015-10-16 11:28:12 +01:00
parent 73260ad01f
commit 3cf9948b8d

View File

@ -22,6 +22,17 @@ from synapse.storage.engines import PostgresEngine
class SearchStore(SQLBaseStore): class SearchStore(SQLBaseStore):
@defer.inlineCallbacks @defer.inlineCallbacks
def search_msgs(self, room_ids, search_term, keys): 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 = [] clauses = []
args = [] args = []