API/Queries/Query-Search-Options.md

@@ -61,17 +61,37 @@ WHERE ( me.name in (?) )
 WHERE ( me.name not in (?) )
 ```
 
+# -in_function
+
+This is an extension for IronAPI.
+
+Instead of defining an array of ids for the "in" statement, get an array of ids from a function. This will only work if the function used has explicitly been listed as permitted for this.
+
+```json
+{
+  "conds": {
+    "me.id": {
+      "-in_function":  "core.assignment_ids_for_unit_instance(12)"
+    }
+  }
+}
+```
+
+```sql
+  "me.id" IN (SELECT * FROM core.assignment_ids_for_unit_instance(12))
+```
+
 # Regex
 
 The regex operators (`~`, `!~`, `~*`, `!~*`) are supported:
 
-```JSON
+```json
 #/data/system/entity/query
 
 "conds" : {"me.name" : {"~*": "module.name"}}
 ```
 
-```SQL
+```sql
 WHERE ( me.name ~* ? )
 ```
 
@@ -82,7 +102,7 @@ If a column on a big table is not indexed correctly, this search option will not
 This is an extension for IronAPI.
 
 
-```JSON
+```json
 {"attrs" : {"order_by" : {"-similarity" : ["me.name","constant"]}, "columns" : "me.name"}}
 ```
 
@@ -96,7 +116,7 @@ This is an extension for IronAPI.
 
 The attrs are just for reference, they are not needed for the search query!
 
-```JSON
+```json
 #/data/system/entity/query
 {
   "conds" : {"-tsquery" : ["english","me.name","data"] },
@@ -106,7 +126,7 @@ The attrs are just for reference, they are not needed for the search query!
 
 will be translated to
 
-```SQL
+```sql
   WHERE ( to_tsvector(?,me.name) @@ to_tsquery(?, ? ) ): 'english', 'english', 'data'
 ```
 
@@ -116,7 +136,7 @@ If a column on a big table is not indexed correctly, this search option will not
 
 This is an extension for IronAPI. Does the left JSONB value contain the right JSONB path/value entries at the top level?
 
-```JSON
+```json
 #/data/core/customer/query
 {
   "conds" : {"me.phonenumbers" : {"@>" : {"mobile": "+4354359"} } }
@@ -129,7 +149,7 @@ This is an extension for IronAPI.
 
 For entities which represent a tree structure ("isTree": true in the universe), a search for a subtree of an element possible. The following will return all entries of the current entity which are "under" id 1, i.e. have either "1" or any of it's (children's) children as their parent:
  
-```JSON
+```json
 {
   "conds": {"me.id": {"-subtree": [1] }
 }
@@ -138,7 +158,7 @@ For entities which represent a tree structure ("isTree": true in the universe),
 The search may be limited to a certain depth, in this example it's "2", so only the main entry (with id "1") and it's direct children will be returned:
 
 
-```JSON
+```json
 {
   "conds": {"me.id": {"-subtree": [1, 2] }
 }
@@ -146,7 +166,7 @@ The search may be limited to a certain depth, in this example it's "2", so only
 
 It can be combined with other search options, like this for example with "or":
 
-```JSON
+```json
 {
   "conds": [
            {"me.id": {"-subtree": [1,2]}},
@@ -173,7 +193,7 @@ This is an extension for IronAPI.
 
 Similar to -subtree, this allows to select the parent entries of an instance with the last entry being the last parent the user has access to.
 
-```
+```json
 {
   "me.id" : {"-parents" : 5}
 }