https://github.com/baslr/fastango
supercharged arangodb poc client | fast client for arangodb
https://github.com/baslr/fastango
Last synced: over 1 year ago
JSON representation
supercharged arangodb poc client | fast client for arangodb
- Host: GitHub
- URL: https://github.com/baslr/fastango
- Owner: baslr
- Created: 2015-02-28T12:06:02.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2015-03-13T00:18:04.000Z (over 11 years ago)
- Last Synced: 2025-02-24T19:52:20.853Z (over 1 year ago)
- Language: CoffeeScript
- Homepage:
- Size: 160 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
fastango
========
supercharged arangodb poc client.
Fastango is up to 3x (save docs) and 4x (get docs) as fast as the official ArangoDB JavaScript client when it runs with TCP connection reusage and up to 6x (save docs) and 8x (get docs) as fast as the untouched version (3.3.0).
## [Collection functions](#collections)
## [Document functions](#documents)
## [Misc functions](#misc)
# impelentation status
## drawbacks
- not the full http api is implemented
- all request go into the same queue. on socket error this queue will resubmited to the db -> split queue to pipelined an non pipelined requests
- no cursor iteration (possbile when async functions land in in ES7)
## initialize client
```coffeescript
parser = new (require 'fastango/parser') 'IP', PORT
require('fastango/fastango') parser, '_system', (status, fastango) ->
if status >= 400
'some error'
return
'now you can use fastango'
```
## database
## _use
```coffeescript
fastango._use 'myDb', (status, fastango) ->
if status >= 400
'some error'
```
Change the database. Note: the old fastango object points to the old db. You have to use the newly returned fastango object.
## collections
### truncate
```coffeescript
fastango.testCollection.truncate (status, heads, body) ->
if status >= 400
'some error'
```
### drop
```coffeescript
fastango.testCollection.drop (status, heads, body) ->
if status >= 400
'some error'
```
### _createDocumentCollection
```coffeescript
fastango._createDocumentCollection 'NAME', {options}, (status, heads, body) ->
if status >= 400
'some error'
```
for options see
## documents
### save
```coffeescript
fastango.testCollection.save JSON.strinigfy({key:'value'}), (status, heads, body) ->
if status >= 400
'some error'
```
### update
```coffeescript
fastango.testCollection.update '_key', JSON.strinigfy({key:'value'}), {options}, (status, heads, body) ->
if status >= 400
'some error'
```
for options (optional) see (Patch document)
### document
```coffeescript
fastango.testCollection.document '_key', (status, heads, body) ->
if status >= 400
'some error'
```
### count
```coffeescript
fastango.testCollection.count (status, heads, body) ->
if status >= 400
'some error'
```
## misc
### _query
```coffeescript
fastango._query 'FOR doc IN docs RETURN doc._key', {bindVars}, {options}, (status, cursor) ->
if status >= 400
'some error'
return
cursor.all (status, results) ->
if status >= 400
'some error'
```
for options see
example:
```coffeescript
fastango._query 'FOR doc IN docs RETURN doc._key', {}, {fullCount:true, maxPlans:1}, (status, cursor) ->
```
for the moment only `cursor.all` is supported.
### _transaction
```coffeescript
fastango._transaction {
params:
a: 4
collections: ['col1', 'col2'] | # optional
read: ['col1', 'col2']
write: ['col1', 'col2']
waitForSync: true|false # optional
lockTimeout: UNUMBER # optional
}, (params) -> # the action function
return params.a
, (status, headers, body) ->
if status >= 400
'some error'
```