https://github.com/nswbmw/path-to-mongodb
Express style path to mongodb query.
https://github.com/nswbmw/path-to-mongodb
Last synced: 3 months ago
JSON representation
Express style path to mongodb query.
- Host: GitHub
- URL: https://github.com/nswbmw/path-to-mongodb
- Owner: nswbmw
- Created: 2015-03-10T11:09:29.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2016-04-15T03:23:09.000Z (over 9 years ago)
- Last Synced: 2025-04-19T21:29:50.392Z (6 months ago)
- Language: JavaScript
- Size: 7.81 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
## path-to-mongodb
Parse URL to MongoDB query.
### Install
npm i path-to-mongodb --save
### Usage
```
pathToMongodb(path, realPath, options);
```
- path: {String} Express style path like: `/users/:uid`.
- realPath: {String} Actual path like: `/users/123?vip=true`.
- options: {Object}
- queryOptions: {Object|Array} Options to preserve, see test.
- alias: {Object} alias for `query` or `options`, eg: `p=2` -> `skip=20&limit=10`.
- others see [path-to-regexp](https://www.npmjs.com/package/path-to-regexp).
### Example
```
pathToMongodb(
'/posts/:year',
'/posts/2015?__skip=20&__limit=10&(comments[$size]=10||praise>=5)',
{queryOptions: {__skip: 'skip', __limit: 'limit'}}
);
// output
{
"query": {
"$or": [
{"comments": {"$size": 10}},
{"praise": {"$gte": 5}}
],
"year": 2015
},
"options": {
"skip": 20,
"limit": 10
}
}
```
```
function aliasLimitAndSkip(p) {
return 'limit=10&skip=' + (p * 10);
}
pathToMongodb(
'/posts/:year',
'/posts/2015?((user=nswbmw||user=zk)&&(star=true||comments[$size]>=100))&p=2',
{
depth: Infinity,
alias: {
p: aliasLimitAndSkip
}
}
);
//output
{
"query": {
"$and": [{
"$or": [{
"user": "nswbmw"
},
{
"user": "zk"
}]
},
{
"$or": [{
"star": true
},
{
"comments": {
"$size": {
"$gte": 100
}
}
}]
}],
"year": 2015
},
"options": {
"limit": 10,
"skip": 20
}
}
```
Next, you may write like this:
```
mongoclient
.db('test')
.collection('users')
.find(obj.query, obj.options)
```
see [test](https://github.com/nswbmw/path-to-mongodb/blob/master/test/test.js) for more details.
### Test
npm test
### Benchmark
node benchmark
### License
MIT