Changes between Version 56 and Version 57 of S3/S3REST/s3_rest_controller

Timestamp:

02/15/11 11:30:01 (15 years ago)

Author:

Dominic König

Comment:

--

S3/S3REST/s3_rest_controller

@@ -310 +310 @@
 == Advanced Options ==
 
+=== Filtering Lists ===
+
+You can filter lists by setting {{{response.s3.filter}}} to a filter query:
+
+{{{
+    # This filters for females:
+    response.s3.filter = (db.pr_person.gender == 2)
+
+    return s3_rest_controller("pr", "person")
+}}}
+
+Note that {{{response.s3.filter}}} affects both, the primary resource and components!
+
+In {{{prep}}}, you can also add filter queries using the {{{add_filter}}} method:
+
+{{{
+    def prep(r):
+        resource = r.resource
+        query = (db.pr_address.type==1) # Home addresses only
+        resource.add_filter(query)
+        return True
+    response.s3.prep = prep
+
+    return s3_rest_controller("pr", "person")
+}}}
+
+However, {{{add_filter}}} again affects both, primary and component records - so this example would:
+
+- only retrieve {{{person}}} records which have a type 1 {{{address}}} record
+- only retrieve the {{{address}}} records with type 1.
+
+This can be an unwanted side-effect.
+
+To have the primary resource unfiltered, and filter only records in a particular component, you can use {{{add_component_filter}}}:
+
+{{{
+    def prep(r):
+        resource = r.resource
+        query = (db.pr_address.type==1) # Home addresses only
+        resource.add_component_filter("address", query)
+        return True
+    response.s3.prep = prep
+
+    return s3_rest_controller("pr", "person")
+}}}
+
+In this case, all {{{person}}} records would be selected - while only {{{address}}} records of type 1 would be retrieved.
+
+
 === Pre-populating Create-Forms ===