]> git.ipfire.org Git - thirdparty/sqlalchemy/sqlalchemy.git/commitdiff
- add full docs for like()/ilike()
authorMike Bayer <mike_mp@zzzcomputing.com>
Mon, 28 Jan 2013 18:58:01 +0000 (13:58 -0500)
committerMike Bayer <mike_mp@zzzcomputing.com>
Mon, 28 Jan 2013 18:58:01 +0000 (13:58 -0500)
lib/sqlalchemy/sql/operators.py

index f233bf0fb787f538cb0368f41271fc319a09c13d..10d01acd626c2741a583cb6aa0234fdddd46932c 100644 (file)
@@ -356,6 +356,20 @@ class ColumnOperators(Operators):
 
         In a column context, produces the clause ``a LIKE other``.
 
+        E.g.::
+
+            select([sometable]).where(sometable.c.column.like("%foobar%"))
+
+        :param other: expression to be compared
+        :param escape: optional escape character, renders the ``ESCAPE``
+          keyword, e.g.::
+
+            somecolumn.like("foo/%bar", escape="/")
+
+        .. seealso::
+
+            :meth:`.ColumnOperators.ilike`
+
         """
         return self.operate(like_op, other, escape=escape)
 
@@ -364,6 +378,20 @@ class ColumnOperators(Operators):
 
         In a column context, produces the clause ``a ILIKE other``.
 
+        E.g.::
+
+            select([sometable]).where(sometable.c.column.ilike("%foobar%"))
+
+        :param other: expression to be compared
+        :param escape: optional escape character, renders the ``ESCAPE``
+          keyword, e.g.::
+
+            somecolumn.ilike("foo/%bar", escape="/")
+
+        .. seealso::
+
+            :meth:`.ColumnOperators.like`
+
         """
         return self.operate(ilike_op, other, escape=escape)