Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jupe/mongoose-query
mongoose query creator. Alternative for mongoose-api-query but without schema understanding.
https://github.com/jupe/mongoose-query
javascript mongoose mongoose-queries query-builder
Last synced: about 1 month ago
JSON representation
mongoose query creator. Alternative for mongoose-api-query but without schema understanding.
- Host: GitHub
- URL: https://github.com/jupe/mongoose-query
- Owner: jupe
- License: mit
- Created: 2013-07-31T11:40:28.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-03-23T19:56:22.000Z (10 months ago)
- Last Synced: 2024-04-25T02:02:41.979Z (9 months ago)
- Topics: javascript, mongoose, mongoose-queries, query-builder
- Language: JavaScript
- Size: 405 KB
- Stars: 60
- Watchers: 6
- Forks: 20
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mongoose-query
[](https://travis-ci.org/jupe/mongoose-query)
[](https://standardjs.com)
[](https://img.shields.io)
[](https://github.com/jupe/mongoose-query/releases/latest)
[](https://badge.fury.io/js/mongoose-query)
[](https://img.shields.io)
This library is usefull example with `expressjs` + `mongoose` applications to help construct mongoose query model directly from url parameters. Example:
```
http://localhost/model?q={"group":"users"}&f=name&sk=1&l=5&p=name
```
Converted to:
```
model.find({group: "users"}).select("name").skip(1).limit(5).populate('name')
```
### Tested with node.js versions
12.x, 14.x, 16.x,latest release
## Changes log
See [releases page](https://github.com/jupe/mongoose-query/releases).
## Installation
Use [npm](https://www.npmjs.org/package/mongoose-query):
```
npm install mongoose-query
```
## Test
```
npm test && npm run lint
```
## Usage Example
```
var QueryPlugin = require(mongoose-query);
var TestSchema = new mongoose.Schema({});
TestSchema.plugin(QueryPlugin);
var testmodel = mongoose.model('test', TestSchema);
//express route
module.exports = function query(req, res) {
testmodel.query(req.query, function(error, data){
res.json(error?{error: error}:data);
});
}
```
## doc
```
var QueryPlugin = require(mongoose-query);
schema.plugin( QueryPlugin(, ) )
```
optional `options`:
* `logger`: custom logger, e.g. winston logger, default: "dummy logger"
* `includeAllParams`: Parse also other values. e.g. `?name=me`. default: true
* `ignoreKeys` : keys to be ignored. Default: []
Model static methods:
`model.query( (, ) )`
`model.leanQuery((, ) )`: gives plain objects ([lean](http://mongoosejs.com/docs/api.html#query_Query-lean))
**Note:** without `` you get Promise.
**URL API:**
```
http://www.myserver.com/query?[q=][&t=][&f=][&s=][&sk=]
[&l=][&p=][&fl=][&map=][&reduce=]
q= restrict results by the specified JSON query
regex e.g. q='{"field":{"$regex":"/mygrep/", "$options":"i"}}'
t= find|findOne|count|estimateCount|aggregate|distinct|aggregate|mapReduce
f= specify the set of fields to include or exclude in each document
(1 - include; 0 - exclude)
s= specify the order in which to sort each specified field
(1- ascending; -1 - descending), JSON
sk= specify the number of results to skip in the result set;
useful for paging
l= specify the limit for the number of results (default is 1000)
p= specify the fields for populate, also more complex json object is supported.
x= allowed values: 'queryPlanner', 'executionStats', 'allPlansExecution'
to= timeout for query
d= allowDiskUse (for heavy queries)
map= mongodb map function as string
http://docs.mongodb.org/manual/reference/command/mapReduce/#mapreduce-map-cmd'
e.g. "function(){if (this.status == 'A') emit(this.cust_id, 1);)}"
reduce= mongodb reduce function as string
http://docs.mongodb.org/manual/reference/command/mapReduce/#mapreduce-reduce-cmd
e.g. "function(key, values) {return result;}"
fl= Flat results or not
Special values:
"oid:" string is converted to ObjectId
"/regex/(options)" converted to regex
{ $regex: //, regex match with optional regex options
($options: "") }
Alternative search conditions:
"key={i}a" case insensitive
"key={e}a" ends with a
"key={ei}a" ends with a, case insensitive
"key={b}a" begins with a
"key={bi}a" begins with a, case insensitive
"key={in}a,b" At least one of these is in array
"key={nin}a,b" Any of these values is not in array
"key={all}a,b" All of these contains in array
"key={empty}" Field is empty or not exists
"key={!empty}" Field exists and is not empty
"key={mod}a,b" Docs where key mod a is b
"key={gt}a" value is greater than a
"key={gte}a" value is greater or equal than a
"key={lt}a" value is lower than a
"key={lte}a" value is lower or equal
"key={ne}a" value is not equal
"key={size}a" value is array, and array size is a
"key={sort_by}" sort by asc
"key={sort_by}-1" sort by desc
**References to mongo:**
- [elemMatch](https://docs.mongodb.com/manual/reference/operator/query/elemMatch/)
- [size](https://docs.mongodb.com/manual/reference/operator/query/size/)
```
Results with `fl=false`:
```
[
{
nest: {
ed: {
data: 'value',
data2':'value'
}
}
}
]
```
Results with `fl=true`:
```
[
{'nest.ed.data': 'value',
'nest.ed.data2':'value'},
]
```
#### Date
Allowed date formats:
- `2010/10/1` (y/m/d)
- `31/2/2010` (d/m/y)
- `2011-10-10T14:48:00` (ISO 8601)
**Note:**
Only valid format is ISO when using date inside `q` -parameter.