Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bramski/angular-indexedDB
An angularjs serviceprovider to utilize indexedDB with angular
https://github.com/bramski/angular-indexedDB
Last synced: 3 months ago
JSON representation
An angularjs serviceprovider to utilize indexedDB with angular
- Host: GitHub
- URL: https://github.com/bramski/angular-indexedDB
- Owner: bramski
- Fork: true (webcss/angular-indexedDB)
- Created: 2014-09-04T21:45:00.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2022-05-12T17:26:24.000Z (over 2 years ago)
- Last Synced: 2024-07-18T13:23:19.106Z (4 months ago)
- Language: CoffeeScript
- Homepage:
- Size: 179 KB
- Stars: 165
- Watchers: 16
- Forks: 49
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
angular-indexed-db
=================
An AngularJS service provider to utilize indexedDB with angular
##Release Notes
### 1.1.1
Bugfix release. Addresses a problem with opening multiple stores and a problem with
using this library in non-native indexedDB environments.
### 1.1.0
Lots of changes. The way of interacting with stores has changed so that you can operate
more transaction-aware. Many things did not work in the prior version correctly.
The service is now well tested and the base build is written in coffeescript.
## Installation
For installation the use of Bower is recommended.
### Bower
Call the following command on your command line:
```sh
bower install --save angular-indexed-db
```
And add the following line to your html file, for example `index.html`:
```html
```
### Manual
- Download file.
- Add the following line to your html file:
```html
```
## Usage
Normally, and as a recommendation, you have only one indexedDB per app.
Thus in your `app.js` where you define your module, you do:
```javascript
angular.module('myModuleName', ['indexedDB'])
.config(function ($indexedDBProvider) {
$indexedDBProvider
.connection('myIndexedDB')
.upgradeDatabase(1, function(event, db, tx){
var objStore = db.createObjectStore('people', {keyPath: 'ssn'});
objStore.createIndex('name_idx', 'name', {unique: false});
objStore.createIndex('age_idx', 'age', {unique: false});
});
});
```
The connection method takes the databasename as parameter,
the upgradeCallback has 3 parameters:
function callback(event, database, transaction). AngularJS-indexedDB supports incremental
upgrades. Simply define what to do for each version incrementally:
```javascript
angular.module('myModuleName', ['indexedDB'])
.config(function ($indexedDBProvider) {
$indexedDBProvider
.connection('myIndexedDB')
.upgradeDatabase(1, function(event, db, tx){
var objStore = db.createObjectStore('people', {keyPath: 'ssn'});
objStore.createIndex('name_idx', 'name', {unique: false});
objStore.createIndex('age_idx', 'age', {unique: false});
});
.upgradeDatabase(2, function(event, db, tx){
db.createObjectStore('peoplePhones', {keyPath: 'person_ssn'});
});
});
```
When upgrade is required only the migrations which have not been run yet will be run.
For upgrading your db structure, see
https://developer.mozilla.org/en-US/docs/IndexedDB/Using_IndexedDB.
You can also define your own error handlers, overwriting the default ones, which log to console.
Inside your controller you use `$indexedDB` like this:
```javascript
angular.module('myModuleName')
.controller('myControllerName', function($scope, $indexedDB) {
$scope.objects = [];
$indexedDB.openStore('people', function(store){
store.insert({"ssn": "444-444-222-111","name": "John Doe", "age": 57}).then(function(e){...});
store.getAll().then(function(people) {
// Update scope
$scope.objects = people;
});
});
});
```
## openStore
When you open a store a transaction is created for all of your actions against that store
you receive a promise for each operation within your transaction and also for the transaction
as a whole as the result of "openStore". The transaction resolves successfully after state
has been fully persisted.
## store operations
The following operations are allowed on a store..
* getAllKeys - Returns all the primary keys on the store
```javascript
$indexedDB.openStore('people', function(store){
store.getAllKeys().then(function(e){
$scope.primaryKeys = e;
});
});
```
* clear - Deletes all items from the store
```javascript
$indexedDB.openStore('people', function(store){
store.clear().then(function(){
// do something
});
});
```
* delete - Deletes a single item from the store
```javascript
$indexedDB.openStore('people', function(store){
store.delete($scope.personID).then(function(){
// do something
});
});
```
* upsert - Upserts an item or list of items in the store
```javascript
// build photo array to upsert
var addToPhotos = [];
for(var j=0; j < file.length; j++){
var photo = {"topicID": $scope.topicID, "filetype": file[j].filetype, "content": file[j].base64}
addToPhotos.push(photo);
}
$indexedDB.openStore('people', function(store){
// multiple items
store.upsert(addToPhotos).then(function(e){
// do something
});
// single item
store.upsert({"id": $scope.topicID, "name": $scope.topicName}).then(function (e) {
// do something
});
});
```
* insert - Inserts an item or list of items in the store
```javascript
// build photo array to upsert
var addToPhotos = [];
for(var j=0; j < file.length; j++){
var photo = {"topicID": $scope.topicID, "filetype": file[j].filetype, "content": file[j].base64}
addToPhotos.push(photo);
}
$indexedDB.openStore('people', function(store){
// multiple items
store.insert(addToPhotos).then(function(e){
// do something
});
// single item
store.insert({"id": $scope.topicID, "name": $scope.topicName}).then(function (e) {
// do something
});
});
```
* getAll - Returns all items in the store
```javascript
$indexedDB.openStore('people', function(store){
store.getAll().then(function(topics) {
// Update scope
$scope.topics = topics;
});
});
```
* each - iterates over all items in the store
* eachBy - iterates over all items in the store using a named index.
* eachWhere - uses the query() to execute a find against the store
```javascript
$indexedDB.openStore('photos', function(photos){
// build query
var find = photos.query();
find = find.$eq($scope.topicID);
find = find.$index("topicID_idx");
// update scope
photos.eachWhere(find).then(function(e){
$scope.photos = e;
});
});
```
* findWhere - an alias for eachWhere
* count - returns a count of all the items
```javascript
$indexedDB.openStore('people', function(store){
store.count().then(function(e){
$scope.count = e;
});
});
```
* find - returns a single item from the store
```javascript
$indexedDB.openStore('photos', function(photos){
photos.find($scope.key).then(function(e){
$scope.photo = e;
});
});
```
* findBy - searches a particular index for an item
```javascript
$indexedDB.openStore('photos', function(photos){
photos.findBy($scope.indexName, $scope.key).then(function(e){
$scope.photo = e;
});
});
```
* query - builds a new query obect for use against eachWhere
```javascript
var find = photos.query();
find = find.$eq($scope.topicID);
find = find.$index("topicID_idx");
// available query functions
$lt(value) - less than
$gt(value) - greater than
$lte(value) - less than or equal
$gte(value) - greater than or equal
$eq(value) - equal
$between(lower, upper, doNotIncludeLowerBound? true/false, doNotIncludeUpperBound true/false) - between two bounds
$desc(unique) - descending order
$asc(unique) - ascending order
$index(value) - name of index
```