summary refs log tree commit diff
path: root/synapse/storage/search.py
diff options
context:
space:
mode:
authorErik Johnston <erik@matrix.org>2015-10-16 11:28:12 +0100
committerErik Johnston <erik@matrix.org>2015-10-16 11:28:12 +0100
commit3cf9948b8d5956c05026ee734ccf65d203eb6d6b (patch)
treeaf214d49abe0a3f7caa9f4b238de0c1d1411a2a4 /synapse/storage/search.py
parentComment on the LIMIT 500 (diff)
downloadsynapse-3cf9948b8d5956c05026ee734ccf65d203eb6d6b.tar.xz
Add docstring
Diffstat (limited to 'synapse/storage/search.py')
-rw-r--r--synapse/storage/search.py11
1 files changed, 11 insertions, 0 deletions
diff --git a/synapse/storage/search.py b/synapse/storage/search.py
index 7d642e18ff..6c10f9631e 100644
--- a/synapse/storage/search.py
+++ b/synapse/storage/search.py
@@ -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 = []