[#234] Implement case-insensitive queries

Author: stsnel

README.rst

@@ -746,6 +746,16 @@ In this case since we are expecting only one row we can directly call ``query.ex
 | rods         | 14        | 62262     |
 +--------------+-----------+-----------+
 
+For a case-insensitive query, add a `case_sensitive=False` parameter to the query:
+
+>>> with iRODSSession(irods_env_file=env_file) as session:
+...     query = session.query(DataObject.name, case_sensitive=False).filter(Like(DataObject.name, "%oBjEcT"))
+...     print(query.all())
++---------------------+
+| DATA_NAME           |
++---------------------+
+| caseSENSITIVEobject |
++---------------------+
 
 Specific Queries
 ----------------

irods/column.py

@@ -33,22 +33,23 @@ class Criterion(object):
     def __init__(self, op, query_key, value):
         self.op = op
         self.query_key = query_key
-        self._value = value
+        self.value = value
 
     @property
-    def value(self):
-        return self.query_key.column_type.to_irods(self._value)
+    def irods_value(self):
+        return self.query_key.column_type.to_irods(self.value)
+
 
 class In(Criterion):
 
     def __init__(self, query_key, value):
         super(In, self).__init__('in', query_key, value)
 
     @property
-    def value(self):
+    def irods_value(self):
         v = "("
         comma = ""
-        for element in self._value:
+        for element in self.value:
             v += "{}'{}'".format(comma,element)
             comma = ","
         v += ")"
@@ -72,8 +73,8 @@ def __init__(self, query_key, value):
         super(Between, self).__init__('between', query_key, value)
 
     @property
-    def value(self):
-        lower_bound, upper_bound = self._value
+    def irods_value(self):
+        lower_bound, upper_bound = self.value
         return "{} {}".format(self.query_key.column_type.to_irods(lower_bound),
                               self.query_key.column_type.to_irods(upper_bound))
 

irods/query.py

@@ -33,6 +33,7 @@ def __init__(self, sess, *args, **kwargs):
         self.sess = sess
         self.columns = OrderedDict()
         self.criteria = []
+        self.case_sensitive = kwargs.pop('case_sensitive', True)
         self._limit = -1
         self._offset = 0
         self._continue_index = 0
@@ -52,6 +53,7 @@ def _clone(self):
         new_q = Query(self.sess)
         new_q.columns = self.columns
         new_q.criteria = self.criteria
+        new_q.case_sensitive = self.case_sensitive
         new_q._limit = self._limit
         new_q._offset = self._offset
         new_q._continue_index = self._continue_index
@@ -65,7 +67,28 @@ def add_keyword(self, keyword, value = ''):
 
     def filter(self, *criteria):
         new_q = self._clone()
-        new_q.criteria += list(criteria)
+
+        if self.case_sensitive:
+            new_q.criteria += list(criteria)
+        else:
+            # In case-insensitive mode, all criterion values are converted
+            # to uppercase here, and the UPPER_CASE_WHERE option is enabled
+            # when creating a new GenQueryRequest in the _message function.
+            # Converting both keys and values to uppercase results in
+            # case-insensitive queries.
+            for criterion in criteria:
+                if type(criterion.value) == str:
+                    criterion.value = str.upper(
+                        criterion.value)
+                elif type(criterion.value) == list:
+                    criterion.value = [str.upper(c) if type(c) == str
+                                           else c for c in criterion.value]
+                elif type(criterion.value) == tuple:
+                    criterion.value = tuple(
+                        [str.upper(c) if type(c) == str else c for c in
+                         list(criterion.value)])
+                new_q.criteria.append(criterion)
+
         return new_q
 
     def order_by(self, column, order='asc'):
@@ -132,7 +155,7 @@ def _select_message(self):
     # lists
     def _conds_message(self):
         dct = _OrderedMultiMapping([
-            (criterion.query_key.icat_id, criterion.op + ' ' + criterion.value)
+            (criterion.query_key.icat_id, criterion.op + ' ' + criterion.irods_value)
             for criterion in self.criteria
             if isinstance(criterion.query_key, Column)
         ])
@@ -141,7 +164,7 @@ def _conds_message(self):
     def _kw_message(self):
         dct = dict([
             (criterion.query_key.icat_key,
-             criterion.op + ' ' + criterion.value)
+             criterion.op + ' ' + criterion.irods_value)
             for criterion in self.criteria
             if isinstance(criterion.query_key, Keyword)
         ])
@@ -155,7 +178,7 @@ def _message(self):
             'maxRows': max_rows,
             'continueInx': self._continue_index,
             'partialStartIndex': self._offset,
-            'options': 0,
+            'options': 0 if self.case_sensitive else query_number['UPPER_CASE_WHERE'],
             'KeyValPair_PI': self._kw_message(),
             'InxIvalPair_PI': self._select_message(),
             'InxValPair_PI': self._conds_message()

irods/session.py

@@ -238,8 +238,8 @@ def configure(self, **kwargs):
         self.pool.connection_timeout = conn_timeout
         return account
 
-    def query(self, *args):
-        return Query(self, *args)
+    def query(self, *args, **kwargs):
+        return Query(self, *args, **kwargs)
 
     @property
     def username(self):