Updates documentation for tsvector type.

Signed-off-by: Noufal Ibrahim <noufal@nibrahim.net.in>

1 files changed, 26 insertions, 1 deletions

diff --git a/lib/sqlalchemy/dialects/postgresql/base.py b/lib/sqlalchemy/dialects/postgresql/base.py
index 5ef16c412..ed8a8c90f 100644
--- a/lib/sqlalchemy/dialects/postgresql/base.py
+++ b/lib/sqlalchemy/dialects/postgresql/base.py
@@ -369,6 +369,31 @@ class UUID(sqltypes.TypeEngine):
 PGUuid = UUID
 
 class TSVECTOR(sqltypes.TypeEngine):
+    """The TSVECTOR type implements the Postgresql text search type
+    TSVECTOR.
+
+    It can be used to do full text queries on natural language
+    *documents*.
+
+    Search queries are performed using the ``@@`` operator in
+    postgresql. This is made available with the ``match`` method
+    available on the column.
+
+    This means that if you have a table ``Example`` with a column
+    ``text`` of type ``TSVECTOR``, you can create a search clause like
+    so
+
+    ::
+
+        Example.text.match("search string")
+
+    which will be compiled to
+
+    ::
+
+        text @@ to_tsquery('search string')
+
+    """
     __visit_name__ = 'TSVECTOR'
 
 
@@ -1169,7 +1194,7 @@ class PGDDLCompiler(compiler.DDLCompiler):
 class PGTypeCompiler(compiler.GenericTypeCompiler):
     def visit_TSVECTOR(self, type):
         return "TSVECTOR"
-    
+
     def visit_INET(self, type_):
         return "INET"