https://github.com/kelp404/nyarudb-control
A management tool for NyaruDB which is a simple NoSQL database in Objective-C.
https://github.com/kelp404/nyarudb-control
Last synced: 2 months ago
JSON representation
A management tool for NyaruDB which is a simple NoSQL database in Objective-C.
- Host: GitHub
- URL: https://github.com/kelp404/nyarudb-control
- Owner: kelp404
- Created: 2013-03-28T02:47:05.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2014-02-25T09:06:34.000Z (over 11 years ago)
- Last Synced: 2025-04-02T20:57:00.076Z (2 months ago)
- Language: CoffeeScript
- Homepage: https://github.com/kelp404/NyaruDB
- Size: 504 KB
- Stars: 5
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
#NyaruDB Control
[MIT License](http://www.opensource.org/licenses/mit-license.php)
NyaruDB Control is a management tool for NyaruDB which is a simple NoSQL database in Objective-C.
You could use CoffeeScript to execute query.
(run coffee script: ⌘+R)
##Installation
```bash
$ git clone --recursive git://github.com/kelp404/NyaruDB-Control.git
```
##Example
####get/create a collection 'user'
>
```coffee
co = db.collection 'user'
```
####create an index 'name'
>
```coffee
co.createIndex 'name'
```
####put a document {name: 'kelp', email:'[email protected]', update:}
>
```coffee
co.put
name: 'kelp'
email: '[email protected]'
update: new Date()
```
####fetch all documents then print
>
```coffee
print co.all().fetch()
```
####search documents which name is 'kelp'
>
```coffee
print co.where('name', equal: 'kelp').fetch()
```
####print all documents count
>
```coffee
print co.all().count()
```
##Class
###NyaruDB
>
```coffee
collection: (name) ->
###
Get or create a collection.
:param name: collection name
:return: NyaruCollection
###
```
###NyaruCollection
>
```coffee
### Index ###
allIndexes: ->
###
[NATIVE]
call native code -> [NyaruCollection allIndexes]
:return: ['index name']
###
createIndex: (index_name) ->
###
[NATIVE]
call native code -> [NyaruCollection createIndex]
:param index_name: index name
###
removeIndex: (index_name) ->
###
[NATIVE]
call native code -> [NyaruCollection removeIndex]
:param index_name: index name
###
```
>
```coffee
### Document ###
put: (doc) ->
###
[NATIVE]
call native code -> [NyaruCollection put]
:param doc: a new document object
###
all: ->
###
Generate NyaruQuery
###
where: (index_name, arg={}) ->
###
Generate NyaruQuery
:param index_name: index name
:param arg: query operation
ex:
equal: '11'
greater: 12
###
removeAll: ->
###
[NATIVE]
call native code -> [NyaruCollection removeAll]
###
```
###NyaruQuery
>
```coffee
and: (index_name, arg={}) ->
###
Append NyaruQueryCell
:param arg:
equal
notEqual
less
lessEqual
greater
greaterEqual
like
ex: co.all().and('index_name', equal: 'value')
:return: NyaruQuery
###
union: (index_name, arg={}) ->
###
Append NyaruQueryCell
:param arg:
equal
notEqual
less
lessEqual
greater
greaterEqual
like
ex: co.all().union('index_name', equal: 'value')
:return: NyaruQuery
###
orderBy: (index_name) ->
###
Append NyaruQueryCell order by
:param index_name: index name
:return: NyaruQuery
###
orderByDESC: (index_name) ->
###
Append NyaruQueryCell order by DESC
:param index_name: index name
:return: NyaruQuery
###
fetch: (limit=0, skip=0) ->
###
[NATIVE]
call native code -> [NyaruQuery fetch]
:param limit: result documents limit
:param skip: result documents skip
:return: [{document}]
###
count: ->
###
[NATIVE]
call native code -> [NyaruQuery cunt]
:return: number
###
remove: ->
###
[NATIVE]
call native code -> [NyaruQuery remove]
remove documents that are match this query.
###
```