as well as sorting and clipping.
- fields should be a dictionary of field names and types
- Only filters on non-sequence type fields are supported.
+ fields should be a dictionary of field names and types.
+ As of PLCAPI-4.3-26, we provide support for filtering on
+ sequence types as well, with the special '&' and '|' modifiers.
example : fields = {'node_id': Parameter(int, "Node identifier"),
'hostname': Parameter(int, "Fully qualified hostname", max = 255),
...}
Special features:
+ * a field starting with '&' or '|' should refer to a sequence type
+ the semantic is then that the object value (expected to be a list)
+ should contain all (&) or any (|) value specified in the corresponding
+ filter value. See other examples below.
+ example : filter = { '|role_ids' : [ 20, 40 ] }
+ example : filter = { '|roles' : ['tech', 'pi'] }
+ example : filter = { '&roles' : ['admin', 'tech'] }
+ example : filter = { '&roles' : 'tech' }
+
* a field starting with the ~ character means negation.
example : filter = { '~peer_id' : None }
SQL wildcard character.
example : filter = { 'hostname' : '*.jp' }
- * fields starting with - are special and relate to row selection, i.e. sorting and clipping
+ * the filter's keys starting with '-' are special and relate to sorting and clipping
* '-SORT' : a field name, or an ordered list of field names that are used for sorting
these fields may start with + (default) or - for denoting increasing or decreasing order
example : filter = { '-SORT' : [ '+node_id', '-hostname' ] }
* '-LIMIT' : the amount of rows to be returned
example : filter = { '-OFFSET' : 100, '-LIMIT':25}
- A realistic example would read
+ Here are a few realistic examples
+
GetNodes ( { 'node_type' : 'regular' , 'hostname' : '*.edu' , '-SORT' : 'hostname' , '-OFFSET' : 30 , '-LIMIT' : 25 } )
- and that would return regular (usual) nodes matching '*.edu' in alphabetical order from 31th to 55th
+ would return regular (usual) nodes matching '*.edu' in alphabetical order from 31th to 55th
+
+ GetPersons ( { '|role_ids' : [ 20 , 40] } )
+ would return all persons that have either pi (20) or tech (40) roles
+
+ GetPersons ( { '&role_ids' : 10 } )
+ GetPersons ( { '&role_ids' : 10 } )
+ GetPersons ( { '|role_ids' : [ 10 ] } )
+ GetPersons ( { '|role_ids' : [ 10 ] } )
+ all 4 forms are equivalent and would return all admin users in the system
"""
def __init__(self, fields = {}, filter = {}, doc = "Attribute filter"):
# either a value or a list of values for each of the specified
# fields.
self.fields = dict ( [ ( field, Mixed (expected, [expected]))
- for (field,expected) in fields.iteritems()
- if python_type(expected) not in (list, tuple, set) ] )
+ for (field,expected) in fields.iteritems() ] )
# Null filter means no filter
Parameter.__init__(self, self.fields, doc = doc, nullok = True)
'<' : False, '>' : False,
'[' : False, ']' : False,
'-' : False,
+ '&' : False, '|' : False,
}
-
- for char in modifiers.keys():
- if field[0] == char:
- modifiers[char]=True;
- field = field[1:]
- break
+ def check_modifiers(field):
+ if field[0] in modifiers.keys():
+ modifiers[field[0]] = True
+ field = field[1:]
+ return check_modifiers(field)
+ return field
+ field = check_modifiers(field)
# filter on fields
if not modifiers['-']:
if field not in self.fields:
raise PLCInvalidArgument, "Invalid filter field '%s'" % field
- if isinstance(value, (list, tuple, set)):
- # handling filters like '~slice_id':[]
- # this should return true, as it's the opposite of 'slice_id':[] which is false
- # prior to this fix, 'slice_id':[] would have returned ``slice_id IN (NULL) '' which is unknown
- # so it worked by coincidence, but the negation '~slice_ids':[] would return false too
- if not value:
- field=""
- operator=""
- value = "FALSE"
- else:
- operator = "IN"
- value = map(str, map(api.db.quote, value))
- value = "(%s)" % ", ".join(value)
- else:
+ # handling array fileds always as compound values
+ if modifiers['&'] or modifiers['|']:
+ if not isinstance(value, (list, tuple, set)):
+ value = [value,]
+
+ def get_op_and_val(value):
if value is None:
operator = "IS"
value = "NULL"
operator='<='
if modifiers[']']:
operator='>='
+
+ value = str(api.db.quote(value))
+ return (operator, value)
+
+ if isinstance(value, (list, tuple, set)):
+ # handling filters like '~slice_id':[]
+ # this should return true, as it's the opposite of 'slice_id':[] which is false
+ # prior to this fix, 'slice_id':[] would have returned ``slice_id IN (NULL) '' which is unknown
+ # so it worked by coincidence, but the negation '~slice_ids':[] would return false too
+ if not value:
+ if modifiers['&'] or modifiers['|']:
+ operator = "="
+ value = "'{}'"
+ else:
+ field=""
+ operator=""
+ value = "FALSE"
+ else:
+ do_join = True
+ vals = {}
+ for val in value:
+ base_op, val = get_op_and_val(val)
+ if base_op != '=':
+ do_join = False
+ if base_op in vals:
+ vals[base_op].append(val)
+ else:
+ vals[base_op] = [val]
+ if do_join:
+ if modifiers['&']:
+ operator = "@>"
+ value = "ARRAY[%s]" % ", ".join(value)
+ elif modifiers['|']:
+ operator = "&&"
+ value = "ARRAY[%s]" % ", ".join(value)
+ else:
+ operator = "IN"
+ value = "(%s)" % ", ".join(value)
+ clause = "%s %s %s" % (field, operator, value)
else:
- value = str(api.db.quote(value))
-
- clause = "%s %s %s" % (field, operator, value)
+ # We need something more complex
+ subclauses = []
+ for operator in vals.keys():
+ if operator == '=':
+ subclauses.append("(%s IN (%s))" % (field, ",".join(vals[operator])))
+ elif operator == 'IS':
+ subclauses.append("(%s IS NULL)" % field)
+ else:
+ for value in vals[operator]:
+ subclauses.append("(%s %s %s)" % (field, operator, value))
+ clause = "(" + " OR ".join(subclauses) + ")"
+ else:
+ operator, value = get_op_and_val(value)
+
+ clause = "%s %s %s" % (field, operator, value)
if modifiers['~']:
clause = " ( NOT %s ) " % (clause)
git://git.onelab.eu / plcapi.git / blobdiff