forked from techfort/LokiJS
-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathtutorial-Loki Angular.html
114 lines (99 loc) · 7.6 KB
/
tutorial-Loki Angular.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Tutorial: Loki Angular</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Tutorial: Loki Angular</h1>
<section>
<header>
<h2>Loki Angular</h2>
</header>
<article>
<h1>Lokiwork, the LokiJS Angular Service</h1><h2>Overview</h2><p>This service of Lokijs for Angular simplifies things to the most basic level because i found Loki difficult to work with in a mobile environment. all you do is setup json files that specify the layout of your data then add, and update entries to the databases.</p>
<p>###Install:
<code>bower install lokijs</code></p>
<p>###Html:</p>
<pre class="prettyprint source"><code><script src="bower_components/lokijs/src/lokijs.js"></script>
<script src="bower_components/lokijs/src/loki-angular.js"></script></code></pre><p>###App:
<code>angular.module('app',['lokijs']);</code></p>
<p>###Configure database template:
I might call this file -> <code>json_locations.js</code> Note: each one has to be called, json1, json2, json3, etc as shown in the following: </p>
<pre class="prettyprint source"><code>app.constant(
'json1',
{
"db":"settings",
"collection": "globals" ,
"documents" :
[
{
"name": "user settings",
"brands" : true,
"random" : "some value"
}
]
}
);</code></pre><p>###Controller:</p>
<pre class="prettyprint source"><code>app.controller('myCtrl', function($scope, Lokiwork){...});</code></pre><p>###Usage:</p>
<p>Lokiwork.setCurrentDoc(dbname, collection, document_identifier);</p>
<pre class="prettyprint source"><code>Lokiwork.setCurrentDoc('settings', 'globals', {'name': "user settings"});</code></pre><p>Lokiwork.getCurrentDoc();</p>
<pre class="prettyprint source"><code>Lokiwork.getCurrentDoc();</code></pre><p>Lokiwork.updateCurrentDoc(name, value);</p>
<pre class="prettyprint source"><code>Lokiwork.updateCurrentDoc("power", true);</code></pre><p>Lokiwork.deleteCurrentDoc();</p>
<pre class="prettyprint source"><code>Lokiwork.deleteCurrentDoc();</code></pre><p>Lokiwork.getDoc(dbName, collName, docName);</p>
<pre class="prettyprint source"><code>Lokiwork.getDoc("settings", "globals", {name:"user settings"});</code></pre><p>Lokiwork.addDocument(dbName, collName, newDoc);</p>
<pre class="prettyprint source"><code>Lokiwork.addDocument("settings", "globals", doc_obj); //example below</code></pre><p>Lokiwork.updateDoc(dbname, collName, document_identifier, name, value);</p>
<pre class="prettyprint source"><code>Lokiwork.updateDoc("settings", "globals", {name:"user settings"}, "brands", false});</code></pre><p>Lokiwork.deleteDocument(dbName, collName, document_identifier);</p>
<pre class="prettyprint source"><code>Lokiwork.deleteDocument('settings','globals', {name:'user settings'});</code></pre><p>Lokiwork.getCollection(dbName, collName);</p>
<pre class="prettyprint source"><code>Lokiwork.getCollection('settings', 'globals');</code></pre><p>Lokwork.addCollection(json_obj);</p>
<pre class="prettyprint source"><code>Lokiwork.addCollection(item); // example below</code></pre><p>Lokiwork.deleteCollection(dbName, collName);</p>
<pre class="prettyprint source"><code>Lokiwork.deleteCollection('settings', globals');</code></pre><p>Lokiwork.deleteDatabase(dbName);</p>
<pre class="prettyprint source"><code>Lokiwork.deleteDatabase("settings");</code></pre><p>####Further examples:</p>
<pre class="prettyprint source"><code>var collection = {
"db":"settings",
"collection": "globals" ,
"documents" :
[
{
"name": "user settings",
"brands" : true,
"face" : "You now it"
}
]
};
Lokiwork.addCollection(collection);</code></pre><p>With addDocument, you can pass a json document in if it's small enough, otherwise assign it to a variable first.</p>
<pre class="prettyprint source"><code>Lokiwork.addDocument("settings", "globals", {name:"user settings2", gay: true, brands:false})</code></pre><p>You can also use promises and/or chain them:</p>
<pre class="prettyprint source"><code>Lokiwork.setCurrentDoc('settings', 'globals', {'name': "user settings"})
.then(function(data){
Lokiwork.updateCurrentDoc("address", "1801 Waters Ridge Drive");
});</code></pre><p>###Remember!
A lot of the above commands may not be necessary if you are implementing a static change, just edit the underlying json javascript file, delete the local storage file, and restart the app.</p>
<p>###Notes:</p>
<ul>
<li>If you delete a database it's recreated the next time the app is restarted and on the first query because it will see the angular json file and recreate it (it won't overwrite existing though). If you want to permanantly remove a database, then you have to also remove the angular json file. This is perfect, because on a mobile device the user may have local storage wiped, no problem, because the next time they boot up the databases will all be recreated.</li>
<li>Since Lokijs is generating all of the database content it should be 100% compatible with native Lokijs commands not listed here but found on the office website shown below.</li>
</ul>
<p>###The official Lokijs page
<a href="https://github.com/techfort/LokiJS">LokiJS</a></p>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Collection.html">Collection</a></li><li><a href="DynamicView.html">DynamicView</a></li><li><a href="Loki.html">Loki</a></li><li><a href="LokiEventEmitter.html">LokiEventEmitter</a></li><li><a href="LokiFsAdapter.html">LokiFsAdapter</a></li><li><a href="LokiFsStructuredAdapter.html">LokiFsStructuredAdapter</a></li><li><a href="LokiIndexedAdapter.html">LokiIndexedAdapter</a></li><li><a href="LokiLocalStorageAdapter.html">LokiLocalStorageAdapter</a></li><li><a href="LokiMemoryAdapter.html">LokiMemoryAdapter</a></li><li><a href="LokiPartitioningAdapter.html">LokiPartitioningAdapter</a></li><li><a href="Resultset.html">Resultset</a></li></ul><h3>Tutorials</h3><ul><li><a href="tutorial-Autoupdating Collections.html">Autoupdating Collections</a></li><li><a href="tutorial-Changes API.html">Changes API</a></li><li><a href="tutorial-Collection Transforms.html">Collection Transforms</a></li><li><a href="tutorial-Indexing and Query performance.html">Indexing and Query performance</a></li><li><a href="tutorial-Loki Angular.html">Loki Angular</a></li><li><a href="tutorial-Persistence Adapters.html">Persistence Adapters</a></li><li><a href="tutorial-Query Examples.html">Query Examples</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu May 10 2018 03:42:33 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>