Changes between Version 2 and Version 3 of DeveloperGuidelines/EdenMobile/Database

Timestamp:

09/27/16 09:27:06 (9 years ago)

Author:

Dominic König

Comment:

--

DeveloperGuidelines/EdenMobile/Database

@@ -19 +19 @@
 
 {{{$emdb}}} automatically bootstraps the database when it is first initialized.
+
+== API ==
+
+=== table ===
+
+The '''table''' API provides fundamental methods to access data in database tables, examples:
+
+{{{#!js
+// Instantiate the API with the table name
+table = $emdb.table("mytable");
+
+// Insert records into the table
+table.insert({
+    // The data to insert
+    'name': 'Example',
+    'number': 4
+}, function(recordID) {
+    // Callback function after successful insert
+});
+
+// Select records from the table - general pattern
+var fields = ['id', 'name'],
+    query = 'number > 3';
+table.select(fields, query, function(result) {
+    var rows = result.rows,
+    for (var i=0, len=rows.length; i<len; i++) {
+        record = rows.item(i);
+        // do something with the record
+    }
+});
+
+// Other variants of select:
+// Extract all records, but only certain fields
+table.select(fields, function(result) {
+    // process the result
+});
+
+// Extract all fields, but only certain records
+table.select(query, function(result) {
+    // process the result
+});
+
+// Extract all fields from all records
+table.select(function(result) {
+    // process the result
+});
+
+}}}
+
+Remember that '''all database transactions are asynchronous''', so callback functions may need to perform a {{{$scope.$apply}}} to trigger a digest cycle explicitly.
 
 == Default Schema ==