Changes between Version 7 and Version 8 of S3/DynamicTables

Timestamp:

02/21/17 10:40:43 (8 years ago)

Author:

Dominic König

Comment:

--

S3/DynamicTables

@@ -148 +148 @@
 == Dynamic Components ==
 
-   ''tbw''
+=== Component key definition ===
+
+Dynamic tables can be components of static tables.
+
+To achieve this, the dynamic model must have a foreign key field that links to the static table, e.g.:
+
+{{{#!python
+
+s3db = current.s3db
+
+ttable = s3db.s3_table
+ftable = s3db.s3_field
+
+# Create dynamic table
+table_id = ttable.insert(name = "s3dt_example,
+                         )
+
+# The dynamic data model
+model = (
+    # Component key
+    {"name": "organisation_id",
+     "field_type": "reference org_organisation",
+
+     # Indicate that this field is the foreign key that links to the master table (including component alias):
+     "component_key": True,
+     "component_alias": "rating",
+
+     },
+    # Other field
+    {"name": "value",
+     "field_type": "integer",
+     "options": {1: "very good",
+                 2: "good",
+                 3: "average",
+                 4: "acceptable",
+                 5: "poor",
+                 },
+     },
+    )
+
+for field_def in model:
+
+    # Add field definition
+    record = Storage(field_def)
+    record["table_id"] = table_id
+    record_id = ftable.insert(**record)
+
+    # Run onaccept (required!)
+    record["id"] = record_id
+    s3db.onaccept(ftable, record)
+
+}}}
+
+Further, dynamic components must be enabled for the master table (they are disabled by default for performance reasons):
+{{{#!python
+s3db.configure("org_organisation", dynamic_components=True)
+}}}
+
+With the settings, the dynamic component can be accessed from the master table like this:
+{{{
+# Access the dynamic table as component
+GET http://localhost:8000/eden/org/organisation/8/rating
+}}}