# littlefork-plugin-mongodb

This is a plugin for [littlefork](https://github.com/tacticaltech/littlefork).

Persists profile, history and unit data in mongodb.

## Installation

```
npm install --save littlefork-plugin-mongodb
```

## Usage

## Configuration

- `mongodb.uri` (defaults to `mongodb://localhost/littlefork`)

  All plugins accept `mongodb.uri` to specify the MongoDB database.

### `mongodb_store`

```
$(npm bin)/littlefork -q queries.json -c config.json -p twitter_feed,mongodb_store
```

Store all data units in a mongodb database. It differentiates new units,
revisions and relations.

### `mongodb_query_units`

Fetch all units based on a MongoDB query string. The query string is defined
as a Littlefork query, e.g.:

```
[{
  "type": "mongodb_query_units",
  "term": {}
}, {
  "type": "mongodb_query_units",
  "term": {"_lf_source": "twitter_feed"}
}, {
  "type": "mongodb_query_units",
  "term": {"_lf_markers": {"$elemMatch": {"$in": ["BJUwmvnsg", "S14uPDnog"]}}}
}]
```

### `mongodb_fetch_units`

Fetch units by `_lf_id_hash` from the database. Supply the query type
`mongodb_unit` that specifies the id hash of the unit.

```
littlefork -d -Q mongodb_unit:06b11b54d8c7c62af2c058d8c1f814cac5415bf149b790d447f0b34280f625d6 -p mongodb_fetch_units,tap_printf
```

### `mongodb_fetch_relations`

Fetch relations by `_lf_id_hash` from the database. Supply the query type
`mongodb_relation` that specifes the id hash.

### `mongodb_fetch_revisions`

Fetch revisions of units by `_lf_id_hash` from the database. Supply the query
type `mongodb_unit` that specifies the id hash of the unit.

### `mongodb_complement`

Complement data in the pipeline, with data that is already stored in the
database. This allows to enhance data, with already stored data. Data stored
in the database takes precedence.

### `mongodb_supplement`

Like `mongodb_complement`, but data in the pipeline takes precedence over data
stored in the database.