https://github.com/dadi/api-filestore
A JSON datastore adapter for DADI API
https://github.com/dadi/api-filestore
api dadi dadi-api database json
Last synced: about 1 month ago
JSON representation
A JSON datastore adapter for DADI API
- Host: GitHub
- URL: https://github.com/dadi/api-filestore
- Owner: dadi
- Created: 2017-02-15T08:41:19.000Z (over 8 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-10T22:19:35.000Z (over 2 years ago)
- Last Synced: 2024-04-14T04:32:32.871Z (about 1 year ago)
- Topics: api, dadi, dadi-api, database, json
- Language: JavaScript
- Size: 1.02 MB
- Stars: 2
- Watchers: 6
- Forks: 3
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API FileStore Adapter
[](https://www.npmjs.com/package/@dadi/api-filestore)
[](https://coveralls.io/github/dadi/api-filestore?branch=master)
[](https://travis-ci.org/dadi/api-filestore)
[](http://standardjs.com/)
## Requirements
* [DADI API](https://www.npmjs.com/package/@dadi/api) Version 3.0.0 or greater
## Install
To use this adapter with your DADI API installation, you'll need to add it to your API's dependencies:
```bash
$ npm install @dadi/api-filestore --save
```
## Configure
### Configuration Files
Configuration settings are defined in JSON files within a `/config` directory at the root of your API application. DADI API has provision for multiple configuration files, one for each environment that your API is expected to run under, for example `development` and `production`.
A post-install script ran when you installed the package from NPM, creating a development configuration file for you at `config/filestore.development.json`.
The naming convention for `@dadi/api-filestore` configuration files follows the format `filestore..json`
For example:
```
filestore.development.json
filestore.production.json
```
### Application Anatomy
```sh
my-api/
config/ # contains environment-specific configuration properties
config.development.json
config.production.json
filestore.development.json
filestore.production.json
main.js # the entry point of the app
package.json
workspace/
collections/ # collection schema files
endpoints/ # custom Javascript endpoints
```
### Configuration
The contents of the configuration file should be similar to the following:
```json
{
"database": {
"path": "path/to/your/database",
"autosaveInterval": 10000,
"serializationMethod": "pretty"
}
}
```
Property | Description | Default
:--------|:------------|:-------
path | The relative or absolute path to where your database files will be stored | none
autosaveInterval | The interval, in milliseconds, between database writes to disk | 5000 (5 seconds)
serializationMethod | The format of the database file on disk. `normal` is a condensed version of the JSON, `pretty` is more readable | `normal`
### Querying Collections
#### $eq
```js
// explicit
{'Name': { '$eq' : 'Odin' }}
// implicit (assumes equality operator)
{'Name': 'Odin'}
```
#### $ne
not equal test
```js
{'legs': { '$ne' : 8 }}
```
#### $regex
```js
// pass in raw regex
var results = coll.find({'Name': { '$regex' : /din/ }});
// or pass in string pattern only
results = coll.find({'Name': { '$regex': 'din' }});
// or pass in [pattern, options] string array
results = coll.find({'Name': { '$regex': ['din', 'i'] }});
```
If using regex operator within a named transform or dynamic view filter, it is best to use the latter two examples since raw regex does not seem to serialize/deserialize well.
#### $in
```js
var users = db.addCollection("users");
users.insert({ name : 'odin' });
users.insert({ name : 'thor' });
users.insert({ name : 'svafrlami' });
// match users with name in array set ['odin' or 'thor']
{ 'name' : { '$in' : ['odin', 'thor'] } }
```
#### $between
```js
// match users with count value between 50 and 75
{ count : { '$between': [50, 75] } }
```
#### $contains / $containsAny / $containsNone
```js
var users = db.addCollection("users");
users.insert({ name : 'odin', weapons : ['gungnir', 'draupnir']});
users.insert({ name : 'thor', weapons : ['mjolnir']});
users.insert({ name : 'svafrlami', weapons : ['tyrfing']});
users.insert({ name : 'arngrim', weapons : ['tyrfing']});
// returns 'svafrlami' and 'arngrim' documents
{ 'weapons' : { '$contains' : 'tyrfing' } }
// returns 'svafrlami', 'arngrim', and 'thor' documents
{ 'weapons' : { '$containsAny' : ['tyrfing', 'mjolnir'] } }
// returns 'svafrlami' and 'arngrim'
{ 'weapons' : { '$containsNone' : ['gungnir', 'mjolnir'] } }
```
### Composing Nested Queries
#### $and
fetch documents matching both sub-expressions
```js
{
'$and': [{
'Age' : {
'$gt': 30
}
},{
'Name' : 'Thor'
}]
}
```
#### $or
fetch documents matching any of the sub-expressions
```js
{
'$or': [{
'Age' : {
'$gte': '40'
}
},{
'Name' : 'Thor'
}]
}
```