Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hemerajs/hemera-arango-store
Use Arangodb with Hemera
https://github.com/hemerajs/hemera-arango-store
arangodb hemera store
Last synced: 3 months ago
JSON representation
Use Arangodb with Hemera
- Host: GitHub
- URL: https://github.com/hemerajs/hemera-arango-store
- Owner: hemerajs
- License: mit
- Created: 2017-12-20T16:02:25.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2018-04-11T10:56:43.000Z (over 6 years ago)
- Last Synced: 2024-04-24T00:40:03.597Z (7 months ago)
- Topics: arangodb, hemera, store
- Language: JavaScript
- Size: 31.3 KB
- Stars: 5
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-arangodb - hemera-arango-store
README
# :avocado: Hemera-arango-store package
[](https://travis-ci.org/hemerajs/hemera-arango-store)
[](https://www.npmjs.com/package/hemera-arango-store)
[](#badge)
This is a plugin to use [Arangodb](https://github.com/arangodb) with Hemera.
Execute any AQL query from anywhere. For more details [ArangoDB Query Language](https://www.arangodb.com/why-arangodb/sql-aql-comparison/)
## Start Arangodb with Docker
```js
docker run -e ARANGO_NO_AUTH=1 -d --name arangodb-instance -d arangodb -p 8529:8529
```
### Running the tests
Install and start Arangodb before running the tests.
**arangod.conf**
```
endpoint = tcp://127.0.0.1:8529
authentication = false
```
```
npm run test
```
## Install
```
npm i hemera-arango-store --save
```
## Usage
```js
const hemera = new Hemera(nats)
hemera.use(require('hemera-joi'))
hemera.use(require('hemera-arango-store'), {
database: {
url: 'http://127.0.0.1:8529',
name: 'test' // default database
}
})
```
## Plugin decorators
* hemera.arango
* hemera.aql
## API
See [Store](https://github.com/hemerajs/hemera/tree/master/packages/hemera-store) Interface.
## Database specific interface
* [Arango API](#arango-api)
* [Collection API](#collection-api)
* [createCollection](#createcollection)
* [Query API](#query-api)
* [executeAqlQuery](#executeaqlquery)
* [Transaction API](#transaction-api)
* [executeTransaction](#executetransaction)
* [Database API](#database-api)
* [createDatabase](#createdatabase)
---
### createCollection
The pattern is:
* `topic`: is the store name to publish to `arango-store`
* `cmd`: is the command to execute `createCollection`
* `name`: the name of the collection `string`
* `database`: the database to use against the query. `string` _(optional)_
* `type`: the type of collection to create `edge` or `""` _(optional)_
Example:
```js
hemera.act(
{
topic: 'arango-store',
cmd: 'createCollection',
name: 'products'
},
function(err, resp) {}
)
```
---
### executeAqlQuery
The pattern is:
* `topic`: is the store name to publish to `arango-store`
* `cmd`: is the command to execute `executeAqlQuery`
* `database`: the database to use against the query. `string` _(optional)_
* `query`: the AQL query `string`
* `type`: return one or multiple results `one` or `all`
Example:
```js
hemera.act(
{
topic: 'arango-store',
cmd: 'executeAqlQuery',
type: 'one',
database: 'test',
query: aql`INSERT ${user} INTO testColl return NEW`
},
function(err, resp) {}
)
```
---
### executeTransaction
The pattern is:
* `topic`: is the store name to publish to `arango-store`
* `cmd`: is the command to execute `executeTransaction`
* `database`: the database to use against the query. `string` _(optional)_
* `action`: a string evaluating to a JavaScript function to be executed on the server. `string`
* `params`: available as variable `params` when the _action_ function is being executed on server. Check the example below. `object`
* `collection`: If _collections_ is an array or string, it will be treated as _collections.write_. `object` _(optional)_
* `read`: an array of names (or a single name) of collections that will be read from during the transaction. `Array` _(optional)_
* `write`: an array of names (or a single name) of collections that will be written from during the transaction. `Array` _(optional)_
* `lockTimeout`: determines how long the database will wait while attemping to gain locks on collections used by the transaction before timing out.
`integer`
Example:
```js
var action = String(function() {
return true
})
hemera.act(
{
topic: 'arango-store',
cmd: 'executeTransaction',
database: 'test',
action,
params: {
age: 12
},
collections: {
read: 'users'
}
},
function(err, resp) {}
)
```
---
### createDatabase
The pattern is:
* `topic`: is the store name to publish to `arango-store`
* `cmd`: is the command to execute `executeAqlQuery`
* `name`: the name of the database. `string`
Example:
```js
hemera.act(
{
topic: 'arango-store',
cmd: 'createDatabase',
name: 'test'
},
function(err, resp) {}
)
```