@rough/rx-gremlin
Version:
The simplest RxJS wrapper around gremlin lib
55 lines (42 loc) • 1.74 kB
Markdown
# The simplest RxJS wrapper around gremlin lib
[](https://travis-ci.com/ihoro/rough-rx-gremlin)
[](https://badge.fury.io/js/%40rough%2Frx-gremlin)
Rough implementation of [rxified](https://npmjs.com/rxjs) wrapper of [gremlin](https://npmjs.com/gremlin) lib.
## Usage examples
```js
const { tap } = require('rxjs/operators');
const RxGremlin = require('@rough/rx-gremlin');
const gremlin = new RxGremlin('ws://gremlin-server:8182/gremlin');
gremlin.traverse(g => g.V().hasLabel('Person').valueMap(true).next())
.pipe(
tap(({ value }) => console.log(value))
)
// .subscribe ...
```
Also, each `g` instance has handy shortcuts as follows:
```js
g.T = gremlin.process.t;
g.G = gremlin.process.statics;
g.P = gremlin.process.P;
g.TextP = gremlin.process.TextP;
g.C = gremlin.process.cardinality;
g.O = gremlin.process.order;
```
What can be used right away without additional imports:
```js
// ...
g => g.V()
.has(g.T.label, g.P.within('Entity', 'Person'))
.has('description', g.P.not(g.TextP.containing(['word1', 'word2'])))
.where(g.G.not(g.G.outE('parent')))
.order().by('updated_at', g.O.desc)
.valueMap(true)
.toList()
// ...
```
## Configuration
For connection options see official [DriverRemoteConnection class](https://tinkerpop.apache.org/jsdocs/3.6.0/DriverRemoteConnection.html).
You may pass such options as the second parameter of the constructor, e.g. in order to switch from default GraphSON to GraphBinary protocol you would do the following:
```js
new RxGremlin('ws://gremlin-server:8182/gremlin', { mimeType: 'application/vnd.graphbinary-v1.0' });
```