Changes between Version 13 and Version 14 of DeveloperGuidelines/EdenMobile/Database

Timestamp:

03/15/17 12:04:12 (8 years ago)

Author:

Dominic König

Comment:

--

DeveloperGuidelines/EdenMobile/Database

@@ -109 +109 @@
 
 '''$emDB''' uses the {{{emSQL}}} service to construct common SQL statements. It can be found in www/services/sql.js.
+
+== Components ==
+
+Components are supported (currently only direct foreign-key relationships).
+
+Components must be declared in the master table schema (see Table Schema Format).
+
+== Table Schema Format ==
+
+The following format is used for both emDefaultSchema, and schema imports (as JSON).
+
+{{{#!js
+var tableSchema = {
+
+    // The table name
+    _name: 'person',
+
+    // Fields in the table
+    'first_name': {             // Field name (key)
+        type: 'string',         // Field type (required)
+        label: 'First Name',    // Label in form
+        placeholder: 'Jane',    // Placeholder (text fields only)
+        notnull: true           // NOT NULL constraint
+    },
+    'last_name': {
+        type: 'string',
+        label: 'Last Name',
+        placeholder: 'Doe'
+    },
+    'date_of_birth': {
+        type: 'date',
+        label: 'Date of Birth'
+    },
+    'missing': {
+        type: 'boolean',
+        label: 'Missing'
+    },
+    'gender': {
+        type: 'integer',
+        label: 'Gender',
+        options: {2: 'female',  // Fixed set of options
+                  3: 'male'     // value: label
+                  },
+        defaultValue: 2         // Default value
+    },
+
+    // Fields in the form (in order)
+    _form: [
+        'first_name',
+        'last_name',
+        'gender',
+        'missing',
+        'date_of_birth'
+    ],
+
+    // Data list card template
+    _card: {
+
+        // Fields to extract (analogous to "list_fields", required)
+        fields: ['first_name', 'last_name'],
+
+        // AngularJS expression for the card title
+        title: '{{record.first_name}} {{record.last_name}}'
+    },
+
+    // CRUD strings and icons
+    _strings: {
+
+        // name and namePlural will be used as page titles
+        name: 'Person',
+        namePlural: 'Persons',
+
+        // Icon for the form list
+        icon: 'ion-person-stalker'
+    },
+
+    // Component declaration
+    _components: {
+
+        'photo': {                      // Component name (alias)
+            title: 'Photos',            // Component title ("tab" title)
+            resource: 'person_photo',   // Component table name (required)
+            joinby: 'person_id',        // Name of the the joinby-key (required)
+            multiple: true              // Multiple-setting (default true)
+        }
+    }
+},
+
+{
+    // Component table
+    _name: 'person_photo',
+
+    'person_id': {
+
+        // Lookup-field (component key)
+        type: 'reference person',       
+        notnull: true,
+
+        // Representation of foreign keys:
+        // - list of field names, values will be concatenated
+        //   in order, separated by blanks
+        represent: ['first_name', 'last_name']
+
+    },
+    'photo': {
+
+        // Upload-fields automatically use photo widget
+        type: 'upload'                  
+    }
+}
+}}}