Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/thewei/react-native-store

A simple database base on react-native AsyncStorage.
https://github.com/thewei/react-native-store

asyncstorage database react-native react-native-store

Last synced: 2 months ago
JSON representation

A simple database base on react-native AsyncStorage.

Lists

README 

        
## react-native-store 

[![Build Status](https://travis-ci.org/thewei/react-native-store.svg?branch=master)](https://travis-ci.org/thewei/react-native-store) 

[![npm version](https://badge.fury.io/js/react-native-store.svg)](http://badge.fury.io/js/react-native-store)

[![NPM downloads](http://img.shields.io/npm/dm/react-native-store.svg?style=flat-square)](https://npmjs.org/package/react-native-store)



A simple database base on react-native AsyncStorage.



### Installation

```bash

$ npm install react-native-store --save

```



***Upgrading from previous version?*** Check for [breaking-changes](breaking-changes.md).



### Data anatomy

```

db_store

   |---model_name

         |---totalrows (variable)

         |---autoinc (variable)

         |---rows (array)

                |--- _id (number)

                |--- ....



```



### API

- **Model( modelName )** : returns a `Model` object

- **Model.add( data, filter )** : returns a `promise` object

- **Model.update( data, filter )** : returns a `promise` object

- **Model.updateById( data, id )** : returns a `promise` object

- **Model.remove( filter )** : returns a `promise` object

- **Model.removeById( id )** : returns a `promise` object

- **Model.find( filter )** : returns a `promise` object

- **Model.findById( id )** : returns a `promise` object

- **Model.get( filter )** : returns a `promise` object

- **Model.destroy()** : returns a `promise` object



### Simple example



```js

import Store from 'react-native-store';



const DB = {

    'foo': Store.model('foo'),

    'bar': Store.model('bar')

}



// somewhere inside react components



componentDidMount() {

    // Return all items

    DB.foo.find().then(resp => this.setState({items: resp}));

}



handleFilter(itemName) {

    DB.foo.find({

        where: {

            and: [{ foo: { neq: itemName } }, { age: { gte: 5 } }]

        },

        order: {

            age: 'ASC',

        }

    }).then(resp => this.setState({items: resp}));

}



handleOnPress() {

    DB.bar.add({

        foo: 'foo',

        bar: 'bar',

        age: 12

    });

}



```



### Advanced Filtering



Filtering adds more advanced logic to queries. This implementation is heavily

based off of [LoopBack's implementation](https://docs.strongloop.com/display/public/LB/Querying+data#Queryingdata-Filters).

However, there are some important things that are different/leftout:



- The [include filter](https://docs.strongloop.com/display/public/LB/Include+filter) is not implemented as it is not relevant.

- The [near and like/nlike](https://docs.strongloop.com/display/public/LB/Where+filter#Wherefilter-likeandnlike) operators are not implemented.

- The [skip filter](https://docs.strongloop.com/display/public/LB/Skip+filter) in LoopBack is the offset filter in this implementation to

  stay consistent with previous versions.



**Note**: Query operations on object nested within an entry are not perfect.

For example, trying to update an entry that looks something like this:



```javascript

{

  location: { name: 'place', distance: 'far' }

}

```



With this as the value of a where filter:



```javascript

{

  location: { name: 'place' }

}

```



Will overwrite the value of `location`, effectively removing the `distance`

property.

This occurs similarly with the order and fields filter, as you can only apply

the filters to values that are not nested within an object.



### Contributing

- Fork this Repo first

- Clone your Repo

- Install dependencies by `$ npm install`

- Checkout develop branch

- Feel free to add your features

- Make sure your features are fully tested

- Publish your local branch, Open a pull request

- Enjoy hacking <3