1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253 |
- 'use strict';
- /**
- * Dependencies
- */
- var slice = require('sliced');
- var assert = require('assert');
- var util = require('util');
- var utils = require('./utils');
- var debug = require('debug')('mquery');
- /* global Map */
- /**
- * Query constructor used for building queries.
- *
- * ####Example:
- *
- * var query = new Query({ name: 'mquery' });
- * query.setOptions({ collection: moduleCollection })
- * query.where('age').gte(21).exec(callback);
- *
- * @param {Object} [criteria]
- * @param {Object} [options]
- * @api public
- */
- function Query(criteria, options) {
- if (!(this instanceof Query))
- return new Query(criteria, options);
- var proto = this.constructor.prototype;
- this.op = proto.op || undefined;
- this.options = {};
- this.setOptions(proto.options);
- this._conditions = proto._conditions
- ? utils.clone(proto._conditions)
- : {};
- this._fields = proto._fields
- ? utils.clone(proto._fields)
- : undefined;
- this._update = proto._update
- ? utils.clone(proto._update)
- : undefined;
- this._path = proto._path || undefined;
- this._distinct = proto._distinct || undefined;
- this._collection = proto._collection || undefined;
- this._traceFunction = proto._traceFunction || undefined;
- if (options) {
- this.setOptions(options);
- }
- if (criteria) {
- if (criteria.find && criteria.remove && criteria.update) {
- // quack quack!
- this.collection(criteria);
- } else {
- this.find(criteria);
- }
- }
- }
- /**
- * This is a parameter that the user can set which determines if mquery
- * uses $within or $geoWithin for queries. It defaults to true which
- * means $geoWithin will be used. If using MongoDB < 2.4 you should
- * set this to false.
- *
- * @api public
- * @property use$geoWithin
- */
- var $withinCmd = '$geoWithin';
- Object.defineProperty(Query, 'use$geoWithin', {
- get: function( ) { return $withinCmd == '$geoWithin'; },
- set: function(v) {
- if (true === v) {
- // mongodb >= 2.4
- $withinCmd = '$geoWithin';
- } else {
- $withinCmd = '$within';
- }
- }
- });
- /**
- * Converts this query to a constructor function with all arguments and options retained.
- *
- * ####Example
- *
- * // Create a query that will read documents with a "video" category from
- * // `aCollection` on the primary node in the replica-set unless it is down,
- * // in which case we'll read from a secondary node.
- * var query = mquery({ category: 'video' })
- * query.setOptions({ collection: aCollection, read: 'primaryPreferred' });
- *
- * // create a constructor based off these settings
- * var Video = query.toConstructor();
- *
- * // Video is now a subclass of mquery() and works the same way but with the
- * // default query parameters and options set.
- *
- * // run a query with the previous settings but filter for movies with names
- * // that start with "Life".
- * Video().where({ name: /^Life/ }).exec(cb);
- *
- * @return {Query} new Query
- * @api public
- */
- Query.prototype.toConstructor = function toConstructor() {
- function CustomQuery(criteria, options) {
- if (!(this instanceof CustomQuery))
- return new CustomQuery(criteria, options);
- Query.call(this, criteria, options);
- }
- utils.inherits(CustomQuery, Query);
- // set inherited defaults
- var p = CustomQuery.prototype;
- p.options = {};
- p.setOptions(this.options);
- p.op = this.op;
- p._conditions = utils.clone(this._conditions);
- p._fields = utils.clone(this._fields);
- p._update = utils.clone(this._update);
- p._path = this._path;
- p._distinct = this._distinct;
- p._collection = this._collection;
- p._traceFunction = this._traceFunction;
- return CustomQuery;
- };
- /**
- * Sets query options.
- *
- * ####Options:
- *
- * - [tailable](http://www.mongodb.org/display/DOCS/Tailable+Cursors) *
- * - [sort](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bsort(\)%7D%7D) *
- * - [limit](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Blimit%28%29%7D%7D) *
- * - [skip](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bskip%28%29%7D%7D) *
- * - [maxScan](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24maxScan) *
- * - [maxTime](http://docs.mongodb.org/manual/reference/operator/meta/maxTimeMS/#op._S_maxTimeMS) *
- * - [batchSize](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7BbatchSize%28%29%7D%7D) *
- * - [comment](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24comment) *
- * - [snapshot](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bsnapshot%28%29%7D%7D) *
- * - [hint](http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24hint) *
- * - [slaveOk](http://docs.mongodb.org/manual/applications/replication/#read-preference) *
- * - [safe](http://www.mongodb.org/display/DOCS/getLastError+Command)
- * - collection the collection to query against
- *
- * _* denotes a query helper method is also available_
- *
- * @param {Object} options
- * @api public
- */
- Query.prototype.setOptions = function(options) {
- if (!(options && utils.isObject(options)))
- return this;
- // set arbitrary options
- var methods = utils.keys(options),
- method;
- for (var i = 0; i < methods.length; ++i) {
- method = methods[i];
- // use methods if exist (safer option manipulation)
- if ('function' == typeof this[method]) {
- var args = utils.isArray(options[method])
- ? options[method]
- : [options[method]];
- this[method].apply(this, args);
- } else {
- this.options[method] = options[method];
- }
- }
- return this;
- };
- /**
- * Sets this Querys collection.
- *
- * @param {Collection} coll
- * @return {Query} this
- */
- Query.prototype.collection = function collection(coll) {
- this._collection = new Query.Collection(coll);
- return this;
- };
- /**
- * Adds a collation to this op (MongoDB 3.4 and up)
- *
- * ####Example
- *
- * query.find().collation({ locale: "en_US", strength: 1 })
- *
- * @param {Object} value
- * @return {Query} this
- * @see MongoDB docs https://docs.mongodb.com/manual/reference/method/cursor.collation/#cursor.collation
- * @api public
- */
- Query.prototype.collation = function(value) {
- this.options.collation = value;
- return this;
- };
- /**
- * Specifies a `$where` condition
- *
- * Use `$where` when you need to select documents using a JavaScript expression.
- *
- * ####Example
- *
- * query.$where('this.comments.length > 10 || this.name.length > 5')
- *
- * query.$where(function () {
- * return this.comments.length > 10 || this.name.length > 5;
- * })
- *
- * @param {String|Function} js javascript string or function
- * @return {Query} this
- * @memberOf Query
- * @method $where
- * @api public
- */
- Query.prototype.$where = function(js) {
- this._conditions.$where = js;
- return this;
- };
- /**
- * Specifies a `path` for use with chaining.
- *
- * ####Example
- *
- * // instead of writing:
- * User.find({age: {$gte: 21, $lte: 65}}, callback);
- *
- * // we can instead write:
- * User.where('age').gte(21).lte(65);
- *
- * // passing query conditions is permitted
- * User.find().where({ name: 'vonderful' })
- *
- * // chaining
- * User
- * .where('age').gte(21).lte(65)
- * .where('name', /^vonderful/i)
- * .where('friends').slice(10)
- * .exec(callback)
- *
- * @param {String} [path]
- * @param {Object} [val]
- * @return {Query} this
- * @api public
- */
- Query.prototype.where = function() {
- if (!arguments.length) return this;
- if (!this.op) this.op = 'find';
- var type = typeof arguments[0];
- if ('string' == type) {
- this._path = arguments[0];
- if (2 === arguments.length) {
- this._conditions[this._path] = arguments[1];
- }
- return this;
- }
- if ('object' == type && !Array.isArray(arguments[0])) {
- return this.merge(arguments[0]);
- }
- throw new TypeError('path must be a string or object');
- };
- /**
- * Specifies the complementary comparison value for paths specified with `where()`
- *
- * ####Example
- *
- * User.where('age').equals(49);
- *
- * // is the same as
- *
- * User.where('age', 49);
- *
- * @param {Object} val
- * @return {Query} this
- * @api public
- */
- Query.prototype.equals = function equals(val) {
- this._ensurePath('equals');
- var path = this._path;
- this._conditions[path] = val;
- return this;
- };
- /**
- * Specifies the complementary comparison value for paths specified with `where()`
- * This is alias of `equals`
- *
- * ####Example
- *
- * User.where('age').eq(49);
- *
- * // is the same as
- *
- * User.shere('age').equals(49);
- *
- * // is the same as
- *
- * User.where('age', 49);
- *
- * @param {Object} val
- * @return {Query} this
- * @api public
- */
- Query.prototype.eq = function eq(val) {
- this._ensurePath('eq');
- var path = this._path;
- this._conditions[path] = val;
- return this;
- };
- /**
- * Specifies arguments for an `$or` condition.
- *
- * ####Example
- *
- * query.or([{ color: 'red' }, { status: 'emergency' }])
- *
- * @param {Array} array array of conditions
- * @return {Query} this
- * @api public
- */
- Query.prototype.or = function or(array) {
- var or = this._conditions.$or || (this._conditions.$or = []);
- if (!utils.isArray(array)) array = [array];
- or.push.apply(or, array);
- return this;
- };
- /**
- * Specifies arguments for a `$nor` condition.
- *
- * ####Example
- *
- * query.nor([{ color: 'green' }, { status: 'ok' }])
- *
- * @param {Array} array array of conditions
- * @return {Query} this
- * @api public
- */
- Query.prototype.nor = function nor(array) {
- var nor = this._conditions.$nor || (this._conditions.$nor = []);
- if (!utils.isArray(array)) array = [array];
- nor.push.apply(nor, array);
- return this;
- };
- /**
- * Specifies arguments for a `$and` condition.
- *
- * ####Example
- *
- * query.and([{ color: 'green' }, { status: 'ok' }])
- *
- * @see $and http://docs.mongodb.org/manual/reference/operator/and/
- * @param {Array} array array of conditions
- * @return {Query} this
- * @api public
- */
- Query.prototype.and = function and(array) {
- var and = this._conditions.$and || (this._conditions.$and = []);
- if (!Array.isArray(array)) array = [array];
- and.push.apply(and, array);
- return this;
- };
- /**
- * Specifies a $gt query condition.
- *
- * When called with one argument, the most recent path passed to `where()` is used.
- *
- * ####Example
- *
- * Thing.find().where('age').gt(21)
- *
- * // or
- * Thing.find().gt('age', 21)
- *
- * @method gt
- * @memberOf Query
- * @param {String} [path]
- * @param {Number} val
- * @api public
- */
- /**
- * Specifies a $gte query condition.
- *
- * When called with one argument, the most recent path passed to `where()` is used.
- *
- * @method gte
- * @memberOf Query
- * @param {String} [path]
- * @param {Number} val
- * @api public
- */
- /**
- * Specifies a $lt query condition.
- *
- * When called with one argument, the most recent path passed to `where()` is used.
- *
- * @method lt
- * @memberOf Query
- * @param {String} [path]
- * @param {Number} val
- * @api public
- */
- /**
- * Specifies a $lte query condition.
- *
- * When called with one argument, the most recent path passed to `where()` is used.
- *
- * @method lte
- * @memberOf Query
- * @param {String} [path]
- * @param {Number} val
- * @api public
- */
- /**
- * Specifies a $ne query condition.
- *
- * When called with one argument, the most recent path passed to `where()` is used.
- *
- * @method ne
- * @memberOf Query
- * @param {String} [path]
- * @param {Number} val
- * @api public
- */
- /**
- * Specifies an $in query condition.
- *
- * When called with one argument, the most recent path passed to `where()` is used.
- *
- * @method in
- * @memberOf Query
- * @param {String} [path]
- * @param {Number} val
- * @api public
- */
- /**
- * Specifies an $nin query condition.
- *
- * When called with one argument, the most recent path passed to `where()` is used.
- *
- * @method nin
- * @memberOf Query
- * @param {String} [path]
- * @param {Number} val
- * @api public
- */
- /**
- * Specifies an $all query condition.
- *
- * When called with one argument, the most recent path passed to `where()` is used.
- *
- * @method all
- * @memberOf Query
- * @param {String} [path]
- * @param {Number} val
- * @api public
- */
- /**
- * Specifies a $size query condition.
- *
- * When called with one argument, the most recent path passed to `where()` is used.
- *
- * @method size
- * @memberOf Query
- * @param {String} [path]
- * @param {Number} val
- * @api public
- */
- /**
- * Specifies a $regex query condition.
- *
- * When called with one argument, the most recent path passed to `where()` is used.
- *
- * @method regex
- * @memberOf Query
- * @param {String} [path]
- * @param {String|RegExp} val
- * @api public
- */
- /**
- * Specifies a $maxDistance query condition.
- *
- * When called with one argument, the most recent path passed to `where()` is used.
- *
- * @method maxDistance
- * @memberOf Query
- * @param {String} [path]
- * @param {Number} val
- * @api public
- */
- /*!
- * gt, gte, lt, lte, ne, in, nin, all, regex, size, maxDistance
- *
- * Thing.where('type').nin(array)
- */
- 'gt gte lt lte ne in nin all regex size maxDistance minDistance'.split(' ').forEach(function($conditional) {
- Query.prototype[$conditional] = function() {
- var path, val;
- if (1 === arguments.length) {
- this._ensurePath($conditional);
- val = arguments[0];
- path = this._path;
- } else {
- val = arguments[1];
- path = arguments[0];
- }
- var conds = this._conditions[path] === null || typeof this._conditions[path] === 'object' ?
- this._conditions[path] :
- (this._conditions[path] = {});
- conds['$' + $conditional] = val;
- return this;
- };
- });
- /**
- * Specifies a `$mod` condition
- *
- * @param {String} [path]
- * @param {Number} val
- * @return {Query} this
- * @api public
- */
- Query.prototype.mod = function() {
- var val, path;
- if (1 === arguments.length) {
- this._ensurePath('mod');
- val = arguments[0];
- path = this._path;
- } else if (2 === arguments.length && !utils.isArray(arguments[1])) {
- this._ensurePath('mod');
- val = slice(arguments);
- path = this._path;
- } else if (3 === arguments.length) {
- val = slice(arguments, 1);
- path = arguments[0];
- } else {
- val = arguments[1];
- path = arguments[0];
- }
- var conds = this._conditions[path] || (this._conditions[path] = {});
- conds.$mod = val;
- return this;
- };
- /**
- * Specifies an `$exists` condition
- *
- * ####Example
- *
- * // { name: { $exists: true }}
- * Thing.where('name').exists()
- * Thing.where('name').exists(true)
- * Thing.find().exists('name')
- *
- * // { name: { $exists: false }}
- * Thing.where('name').exists(false);
- * Thing.find().exists('name', false);
- *
- * @param {String} [path]
- * @param {Number} val
- * @return {Query} this
- * @api public
- */
- Query.prototype.exists = function() {
- var path, val;
- if (0 === arguments.length) {
- this._ensurePath('exists');
- path = this._path;
- val = true;
- } else if (1 === arguments.length) {
- if ('boolean' === typeof arguments[0]) {
- this._ensurePath('exists');
- path = this._path;
- val = arguments[0];
- } else {
- path = arguments[0];
- val = true;
- }
- } else if (2 === arguments.length) {
- path = arguments[0];
- val = arguments[1];
- }
- var conds = this._conditions[path] || (this._conditions[path] = {});
- conds.$exists = val;
- return this;
- };
- /**
- * Specifies an `$elemMatch` condition
- *
- * ####Example
- *
- * query.elemMatch('comment', { author: 'autobot', votes: {$gte: 5}})
- *
- * query.where('comment').elemMatch({ author: 'autobot', votes: {$gte: 5}})
- *
- * query.elemMatch('comment', function (elem) {
- * elem.where('author').equals('autobot');
- * elem.where('votes').gte(5);
- * })
- *
- * query.where('comment').elemMatch(function (elem) {
- * elem.where({ author: 'autobot' });
- * elem.where('votes').gte(5);
- * })
- *
- * @param {String|Object|Function} path
- * @param {Object|Function} criteria
- * @return {Query} this
- * @api public
- */
- Query.prototype.elemMatch = function() {
- if (null == arguments[0])
- throw new TypeError('Invalid argument');
- var fn, path, criteria;
- if ('function' === typeof arguments[0]) {
- this._ensurePath('elemMatch');
- path = this._path;
- fn = arguments[0];
- } else if (utils.isObject(arguments[0])) {
- this._ensurePath('elemMatch');
- path = this._path;
- criteria = arguments[0];
- } else if ('function' === typeof arguments[1]) {
- path = arguments[0];
- fn = arguments[1];
- } else if (arguments[1] && utils.isObject(arguments[1])) {
- path = arguments[0];
- criteria = arguments[1];
- } else {
- throw new TypeError('Invalid argument');
- }
- if (fn) {
- criteria = new Query;
- fn(criteria);
- criteria = criteria._conditions;
- }
- var conds = this._conditions[path] || (this._conditions[path] = {});
- conds.$elemMatch = criteria;
- return this;
- };
- // Spatial queries
- /**
- * Sugar for geo-spatial queries.
- *
- * ####Example
- *
- * query.within().box()
- * query.within().circle()
- * query.within().geometry()
- *
- * query.where('loc').within({ center: [50,50], radius: 10, unique: true, spherical: true });
- * query.where('loc').within({ box: [[40.73, -73.9], [40.7, -73.988]] });
- * query.where('loc').within({ polygon: [[],[],[],[]] });
- *
- * query.where('loc').within([], [], []) // polygon
- * query.where('loc').within([], []) // box
- * query.where('loc').within({ type: 'LineString', coordinates: [...] }); // geometry
- *
- * ####NOTE:
- *
- * Must be used after `where()`.
- *
- * @memberOf Query
- * @return {Query} this
- * @api public
- */
- Query.prototype.within = function within() {
- // opinionated, must be used after where
- this._ensurePath('within');
- this._geoComparison = $withinCmd;
- if (0 === arguments.length) {
- return this;
- }
- if (2 === arguments.length) {
- return this.box.apply(this, arguments);
- } else if (2 < arguments.length) {
- return this.polygon.apply(this, arguments);
- }
- var area = arguments[0];
- if (!area)
- throw new TypeError('Invalid argument');
- if (area.center)
- return this.circle(area);
- if (area.box)
- return this.box.apply(this, area.box);
- if (area.polygon)
- return this.polygon.apply(this, area.polygon);
- if (area.type && area.coordinates)
- return this.geometry(area);
- throw new TypeError('Invalid argument');
- };
- /**
- * Specifies a $box condition
- *
- * ####Example
- *
- * var lowerLeft = [40.73083, -73.99756]
- * var upperRight= [40.741404, -73.988135]
- *
- * query.where('loc').within().box(lowerLeft, upperRight)
- * query.box('loc', lowerLeft, upperRight )
- *
- * @see http://www.mongodb.org/display/DOCS/Geospatial+Indexing
- * @see Query#within #query_Query-within
- * @param {String} path
- * @param {Object} val
- * @return {Query} this
- * @api public
- */
- Query.prototype.box = function() {
- var path, box;
- if (3 === arguments.length) {
- // box('loc', [], [])
- path = arguments[0];
- box = [arguments[1], arguments[2]];
- } else if (2 === arguments.length) {
- // box([], [])
- this._ensurePath('box');
- path = this._path;
- box = [arguments[0], arguments[1]];
- } else {
- throw new TypeError('Invalid argument');
- }
- var conds = this._conditions[path] || (this._conditions[path] = {});
- conds[this._geoComparison || $withinCmd] = { '$box': box };
- return this;
- };
- /**
- * Specifies a $polygon condition
- *
- * ####Example
- *
- * query.where('loc').within().polygon([10,20], [13, 25], [7,15])
- * query.polygon('loc', [10,20], [13, 25], [7,15])
- *
- * @param {String|Array} [path]
- * @param {Array|Object} [val]
- * @return {Query} this
- * @see http://www.mongodb.org/display/DOCS/Geospatial+Indexing
- * @api public
- */
- Query.prototype.polygon = function() {
- var val, path;
- if ('string' == typeof arguments[0]) {
- // polygon('loc', [],[],[])
- path = arguments[0];
- val = slice(arguments, 1);
- } else {
- // polygon([],[],[])
- this._ensurePath('polygon');
- path = this._path;
- val = slice(arguments);
- }
- var conds = this._conditions[path] || (this._conditions[path] = {});
- conds[this._geoComparison || $withinCmd] = { '$polygon': val };
- return this;
- };
- /**
- * Specifies a $center or $centerSphere condition.
- *
- * ####Example
- *
- * var area = { center: [50, 50], radius: 10, unique: true }
- * query.where('loc').within().circle(area)
- * query.center('loc', area);
- *
- * // for spherical calculations
- * var area = { center: [50, 50], radius: 10, unique: true, spherical: true }
- * query.where('loc').within().circle(area)
- * query.center('loc', area);
- *
- * @param {String} [path]
- * @param {Object} area
- * @return {Query} this
- * @see http://www.mongodb.org/display/DOCS/Geospatial+Indexing
- * @api public
- */
- Query.prototype.circle = function() {
- var path, val;
- if (1 === arguments.length) {
- this._ensurePath('circle');
- path = this._path;
- val = arguments[0];
- } else if (2 === arguments.length) {
- path = arguments[0];
- val = arguments[1];
- } else {
- throw new TypeError('Invalid argument');
- }
- if (!('radius' in val && val.center))
- throw new Error('center and radius are required');
- var conds = this._conditions[path] || (this._conditions[path] = {});
- var type = val.spherical
- ? '$centerSphere'
- : '$center';
- var wKey = this._geoComparison || $withinCmd;
- conds[wKey] = {};
- conds[wKey][type] = [val.center, val.radius];
- if ('unique' in val)
- conds[wKey].$uniqueDocs = !!val.unique;
- return this;
- };
- /**
- * Specifies a `$near` or `$nearSphere` condition
- *
- * These operators return documents sorted by distance.
- *
- * ####Example
- *
- * query.where('loc').near({ center: [10, 10] });
- * query.where('loc').near({ center: [10, 10], maxDistance: 5 });
- * query.where('loc').near({ center: [10, 10], maxDistance: 5, spherical: true });
- * query.near('loc', { center: [10, 10], maxDistance: 5 });
- * query.near({ center: { type: 'Point', coordinates: [..] }})
- * query.near().geometry({ type: 'Point', coordinates: [..] })
- *
- * @param {String} [path]
- * @param {Object} val
- * @return {Query} this
- * @see http://www.mongodb.org/display/DOCS/Geospatial+Indexing
- * @api public
- */
- Query.prototype.near = function near() {
- var path, val;
- this._geoComparison = '$near';
- if (0 === arguments.length) {
- return this;
- } else if (1 === arguments.length) {
- this._ensurePath('near');
- path = this._path;
- val = arguments[0];
- } else if (2 === arguments.length) {
- path = arguments[0];
- val = arguments[1];
- } else {
- throw new TypeError('Invalid argument');
- }
- if (!val.center) {
- throw new Error('center is required');
- }
- var conds = this._conditions[path] || (this._conditions[path] = {});
- var type = val.spherical
- ? '$nearSphere'
- : '$near';
- // center could be a GeoJSON object or an Array
- if (Array.isArray(val.center)) {
- conds[type] = val.center;
- var radius = 'maxDistance' in val
- ? val.maxDistance
- : null;
- if (null != radius) {
- conds.$maxDistance = radius;
- }
- if (null != val.minDistance) {
- conds.$minDistance = val.minDistance;
- }
- } else {
- // GeoJSON?
- if (val.center.type != 'Point' || !Array.isArray(val.center.coordinates)) {
- throw new Error(util.format('Invalid GeoJSON specified for %s', type));
- }
- conds[type] = { $geometry : val.center };
- // MongoDB 2.6 insists on maxDistance being in $near / $nearSphere
- if ('maxDistance' in val) {
- conds[type]['$maxDistance'] = val.maxDistance;
- }
- if ('minDistance' in val) {
- conds[type]['$minDistance'] = val.minDistance;
- }
- }
- return this;
- };
- /**
- * Declares an intersects query for `geometry()`.
- *
- * ####Example
- *
- * query.where('path').intersects().geometry({
- * type: 'LineString'
- * , coordinates: [[180.0, 11.0], [180, 9.0]]
- * })
- *
- * query.where('path').intersects({
- * type: 'LineString'
- * , coordinates: [[180.0, 11.0], [180, 9.0]]
- * })
- *
- * @param {Object} [arg]
- * @return {Query} this
- * @api public
- */
- Query.prototype.intersects = function intersects() {
- // opinionated, must be used after where
- this._ensurePath('intersects');
- this._geoComparison = '$geoIntersects';
- if (0 === arguments.length) {
- return this;
- }
- var area = arguments[0];
- if (null != area && area.type && area.coordinates)
- return this.geometry(area);
- throw new TypeError('Invalid argument');
- };
- /**
- * Specifies a `$geometry` condition
- *
- * ####Example
- *
- * var polyA = [[[ 10, 20 ], [ 10, 40 ], [ 30, 40 ], [ 30, 20 ]]]
- * query.where('loc').within().geometry({ type: 'Polygon', coordinates: polyA })
- *
- * // or
- * var polyB = [[ 0, 0 ], [ 1, 1 ]]
- * query.where('loc').within().geometry({ type: 'LineString', coordinates: polyB })
- *
- * // or
- * var polyC = [ 0, 0 ]
- * query.where('loc').within().geometry({ type: 'Point', coordinates: polyC })
- *
- * // or
- * query.where('loc').intersects().geometry({ type: 'Point', coordinates: polyC })
- *
- * ####NOTE:
- *
- * `geometry()` **must** come after either `intersects()` or `within()`.
- *
- * The `object` argument must contain `type` and `coordinates` properties.
- * - type {String}
- * - coordinates {Array}
- *
- * The most recent path passed to `where()` is used.
- *
- * @param {Object} object Must contain a `type` property which is a String and a `coordinates` property which is an Array. See the examples.
- * @return {Query} this
- * @see http://docs.mongodb.org/manual/release-notes/2.4/#new-geospatial-indexes-with-geojson-and-improved-spherical-geometry
- * @see http://www.mongodb.org/display/DOCS/Geospatial+Indexing
- * @see $geometry http://docs.mongodb.org/manual/reference/operator/geometry/
- * @api public
- */
- Query.prototype.geometry = function geometry() {
- if (!('$within' == this._geoComparison ||
- '$geoWithin' == this._geoComparison ||
- '$near' == this._geoComparison ||
- '$geoIntersects' == this._geoComparison)) {
- throw new Error('geometry() must come after `within()`, `intersects()`, or `near()');
- }
- var val, path;
- if (1 === arguments.length) {
- this._ensurePath('geometry');
- path = this._path;
- val = arguments[0];
- } else {
- throw new TypeError('Invalid argument');
- }
- if (!(val.type && Array.isArray(val.coordinates))) {
- throw new TypeError('Invalid argument');
- }
- var conds = this._conditions[path] || (this._conditions[path] = {});
- conds[this._geoComparison] = { $geometry: val };
- return this;
- };
- // end spatial
- /**
- * Specifies which document fields to include or exclude
- *
- * ####String syntax
- *
- * When passing a string, prefixing a path with `-` will flag that path as excluded. When a path does not have the `-` prefix, it is included.
- *
- * ####Example
- *
- * // include a and b, exclude c
- * query.select('a b -c');
- *
- * // or you may use object notation, useful when
- * // you have keys already prefixed with a "-"
- * query.select({a: 1, b: 1, c: 0});
- *
- * ####Note
- *
- * Cannot be used with `distinct()`
- *
- * @param {Object|String} arg
- * @return {Query} this
- * @see SchemaType
- * @api public
- */
- Query.prototype.select = function select() {
- var arg = arguments[0];
- if (!arg) return this;
- if (arguments.length !== 1) {
- throw new Error('Invalid select: select only takes 1 argument');
- }
- this._validate('select');
- var fields = this._fields || (this._fields = {});
- var type = typeof arg;
- var i, len;
- if (('string' == type || utils.isArgumentsObject(arg)) &&
- 'number' == typeof arg.length || Array.isArray(arg)) {
- if ('string' == type)
- arg = arg.split(/\s+/);
- for (i = 0, len = arg.length; i < len; ++i) {
- var field = arg[i];
- if (!field) continue;
- var include = '-' == field[0] ? 0 : 1;
- if (include === 0) field = field.substring(1);
- fields[field] = include;
- }
- return this;
- }
- if (utils.isObject(arg)) {
- var keys = utils.keys(arg);
- for (i = 0; i < keys.length; ++i) {
- fields[keys[i]] = arg[keys[i]];
- }
- return this;
- }
- throw new TypeError('Invalid select() argument. Must be string or object.');
- };
- /**
- * Specifies a $slice condition for a `path`
- *
- * ####Example
- *
- * query.slice('comments', 5)
- * query.slice('comments', -5)
- * query.slice('comments', [10, 5])
- * query.where('comments').slice(5)
- * query.where('comments').slice([-10, 5])
- *
- * @param {String} [path]
- * @param {Number} val number/range of elements to slice
- * @return {Query} this
- * @see mongodb http://www.mongodb.org/display/DOCS/Retrieving+a+Subset+of+Fields#RetrievingaSubsetofFields-RetrievingaSubrangeofArrayElements
- * @api public
- */
- Query.prototype.slice = function() {
- if (0 === arguments.length)
- return this;
- this._validate('slice');
- var path, val;
- if (1 === arguments.length) {
- var arg = arguments[0];
- if (typeof arg === 'object' && !Array.isArray(arg)) {
- var keys = Object.keys(arg);
- var numKeys = keys.length;
- for (var i = 0; i < numKeys; ++i) {
- this.slice(keys[i], arg[keys[i]]);
- }
- return this;
- }
- this._ensurePath('slice');
- path = this._path;
- val = arguments[0];
- } else if (2 === arguments.length) {
- if ('number' === typeof arguments[0]) {
- this._ensurePath('slice');
- path = this._path;
- val = slice(arguments);
- } else {
- path = arguments[0];
- val = arguments[1];
- }
- } else if (3 === arguments.length) {
- path = arguments[0];
- val = slice(arguments, 1);
- }
- var myFields = this._fields || (this._fields = {});
- myFields[path] = { '$slice': val };
- return this;
- };
- /**
- * Sets the sort order
- *
- * If an object is passed, values allowed are 'asc', 'desc', 'ascending', 'descending', 1, and -1.
- *
- * If a string is passed, it must be a space delimited list of path names. The sort order of each path is ascending unless the path name is prefixed with `-` which will be treated as descending.
- *
- * ####Example
- *
- * // these are equivalent
- * query.sort({ field: 'asc', test: -1 });
- * query.sort('field -test');
- * query.sort([['field', 1], ['test', -1]]);
- *
- * ####Note
- *
- * - The array syntax `.sort([['field', 1], ['test', -1]])` can only be used with [mongodb driver >= 2.0.46](https://github.com/mongodb/node-mongodb-native/blob/2.1/HISTORY.md#2046-2015-10-15).
- * - Cannot be used with `distinct()`
- *
- * @param {Object|String|Array} arg
- * @return {Query} this
- * @api public
- */
- Query.prototype.sort = function(arg) {
- if (!arg) return this;
- var i, len, field;
- this._validate('sort');
- var type = typeof arg;
- // .sort([['field', 1], ['test', -1]])
- if (Array.isArray(arg)) {
- len = arg.length;
- for (i = 0; i < arg.length; ++i) {
- if (!Array.isArray(arg[i])) {
- throw new Error('Invalid sort() argument, must be array of arrays');
- }
- _pushArr(this.options, arg[i][0], arg[i][1]);
- }
- return this;
- }
- // .sort('field -test')
- if (1 === arguments.length && 'string' == type) {
- arg = arg.split(/\s+/);
- len = arg.length;
- for (i = 0; i < len; ++i) {
- field = arg[i];
- if (!field) continue;
- var ascend = '-' == field[0] ? -1 : 1;
- if (ascend === -1) field = field.substring(1);
- push(this.options, field, ascend);
- }
- return this;
- }
- // .sort({ field: 1, test: -1 })
- if (utils.isObject(arg)) {
- var keys = utils.keys(arg);
- for (i = 0; i < keys.length; ++i) {
- field = keys[i];
- push(this.options, field, arg[field]);
- }
- return this;
- }
- if (typeof Map !== 'undefined' && arg instanceof Map) {
- _pushMap(this.options, arg);
- return this;
- }
- throw new TypeError('Invalid sort() argument. Must be a string, object, or array.');
- };
- /*!
- * @ignore
- */
- var _validSortValue = {
- '1': 1,
- '-1': -1,
- 'asc': 1,
- 'ascending': 1,
- 'desc': -1,
- 'descending': -1
- };
- function push(opts, field, value) {
- if (Array.isArray(opts.sort)) {
- throw new TypeError('Can\'t mix sort syntaxes. Use either array or object:' +
- '\n- `.sort([[\'field\', 1], [\'test\', -1]])`' +
- '\n- `.sort({ field: 1, test: -1 })`');
- }
- var s;
- if (value && value.$meta) {
- s = opts.sort || (opts.sort = {});
- s[field] = { $meta : value.$meta };
- return;
- }
- s = opts.sort || (opts.sort = {});
- var val = String(value || 1).toLowerCase();
- val = _validSortValue[val];
- if (!val) throw new TypeError('Invalid sort value: { ' + field + ': ' + value + ' }');
- s[field] = val;
- }
- function _pushArr(opts, field, value) {
- opts.sort = opts.sort || [];
- if (!Array.isArray(opts.sort)) {
- throw new TypeError('Can\'t mix sort syntaxes. Use either array or object:' +
- '\n- `.sort([[\'field\', 1], [\'test\', -1]])`' +
- '\n- `.sort({ field: 1, test: -1 })`');
- }
- var val = String(value || 1).toLowerCase();
- val = _validSortValue[val];
- if (!val) throw new TypeError('Invalid sort value: [ ' + field + ', ' + value + ' ]');
- opts.sort.push([field, val]);
- }
- function _pushMap(opts, map) {
- opts.sort = opts.sort || new Map();
- if (!(opts.sort instanceof Map)) {
- throw new TypeError('Can\'t mix sort syntaxes. Use either array or ' +
- 'object or map consistently');
- }
- map.forEach(function(value, key) {
- var val = String(value || 1).toLowerCase();
- val = _validSortValue[val];
- if (!val) throw new TypeError('Invalid sort value: < ' + key + ': ' + value + ' >');
- opts.sort.set(key, val);
- });
- }
- /**
- * Specifies the limit option.
- *
- * ####Example
- *
- * query.limit(20)
- *
- * ####Note
- *
- * Cannot be used with `distinct()`
- *
- * @method limit
- * @memberOf Query
- * @param {Number} val
- * @see mongodb http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Blimit%28%29%7D%7D
- * @api public
- */
- /**
- * Specifies the skip option.
- *
- * ####Example
- *
- * query.skip(100).limit(20)
- *
- * ####Note
- *
- * Cannot be used with `distinct()`
- *
- * @method skip
- * @memberOf Query
- * @param {Number} val
- * @see mongodb http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bskip%28%29%7D%7D
- * @api public
- */
- /**
- * Specifies the maxScan option.
- *
- * ####Example
- *
- * query.maxScan(100)
- *
- * ####Note
- *
- * Cannot be used with `distinct()`
- *
- * @method maxScan
- * @memberOf Query
- * @param {Number} val
- * @see mongodb http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24maxScan
- * @api public
- */
- /**
- * Specifies the batchSize option.
- *
- * ####Example
- *
- * query.batchSize(100)
- *
- * ####Note
- *
- * Cannot be used with `distinct()`
- *
- * @method batchSize
- * @memberOf Query
- * @param {Number} val
- * @see mongodb http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7BbatchSize%28%29%7D%7D
- * @api public
- */
- /**
- * Specifies the `comment` option.
- *
- * ####Example
- *
- * query.comment('login query')
- *
- * ####Note
- *
- * Cannot be used with `distinct()`
- *
- * @method comment
- * @memberOf Query
- * @param {Number} val
- * @see mongodb http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24comment
- * @api public
- */
- /*!
- * limit, skip, maxScan, batchSize, comment
- *
- * Sets these associated options.
- *
- * query.comment('feed query');
- */
- ['limit', 'skip', 'maxScan', 'batchSize', 'comment'].forEach(function(method) {
- Query.prototype[method] = function(v) {
- this._validate(method);
- this.options[method] = v;
- return this;
- };
- });
- /**
- * Specifies the maxTimeMS option.
- *
- * ####Example
- *
- * query.maxTime(100)
- * query.maxTimeMS(100)
- *
- * @method maxTime
- * @memberOf Query
- * @param {Number} ms
- * @see mongodb http://docs.mongodb.org/manual/reference/operator/meta/maxTimeMS/#op._S_maxTimeMS
- * @api public
- */
- Query.prototype.maxTime = Query.prototype.maxTimeMS = function(ms) {
- this._validate('maxTime');
- this.options.maxTimeMS = ms;
- return this;
- };
- /**
- * Specifies this query as a `snapshot` query.
- *
- * ####Example
- *
- * mquery().snapshot() // true
- * mquery().snapshot(true)
- * mquery().snapshot(false)
- *
- * ####Note
- *
- * Cannot be used with `distinct()`
- *
- * @see mongodb http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%7B%7Bsnapshot%28%29%7D%7D
- * @return {Query} this
- * @api public
- */
- Query.prototype.snapshot = function() {
- this._validate('snapshot');
- this.options.snapshot = arguments.length
- ? !!arguments[0]
- : true;
- return this;
- };
- /**
- * Sets query hints.
- *
- * ####Example
- *
- * query.hint({ indexA: 1, indexB: -1});
- * query.hint('indexA_1_indexB_1');
- *
- * ####Note
- *
- * Cannot be used with `distinct()`
- *
- * @param {Object|string} val a hint object or the index name
- * @return {Query} this
- * @see mongodb http://www.mongodb.org/display/DOCS/Advanced+Queries#AdvancedQueries-%24hint
- * @api public
- */
- Query.prototype.hint = function() {
- if (0 === arguments.length) return this;
- this._validate('hint');
- var arg = arguments[0];
- if (utils.isObject(arg)) {
- var hint = this.options.hint || (this.options.hint = {});
- // must keep object keys in order so don't use Object.keys()
- for (var k in arg) {
- hint[k] = arg[k];
- }
- return this;
- }
- if (typeof arg === 'string') {
- this.options.hint = arg;
- return this;
- }
- throw new TypeError('Invalid hint. ' + arg);
- };
- /**
- * Requests acknowledgement that this operation has been persisted to MongoDB's
- * on-disk journal.
- * This option is only valid for operations that write to the database:
- *
- * - `deleteOne()`
- * - `deleteMany()`
- * - `findOneAndDelete()`
- * - `findOneAndUpdate()`
- * - `remove()`
- * - `update()`
- * - `updateOne()`
- * - `updateMany()`
- *
- * Defaults to the `j` value if it is specified in writeConcern options
- *
- * ####Example:
- *
- * mquery().w(2).j(true).wtimeout(2000);
- *
- * @method j
- * @memberOf Query
- * @instance
- * @param {boolean} val
- * @see mongodb https://docs.mongodb.com/manual/reference/write-concern/#j-option
- * @return {Query} this
- * @api public
- */
- Query.prototype.j = function j(val) {
- this.options.j = val;
- return this;
- };
- /**
- * Sets the slaveOk option. _Deprecated_ in MongoDB 2.2 in favor of read preferences.
- *
- * ####Example:
- *
- * query.slaveOk() // true
- * query.slaveOk(true)
- * query.slaveOk(false)
- *
- * @deprecated use read() preferences instead if on mongodb >= 2.2
- * @param {Boolean} v defaults to true
- * @see mongodb http://docs.mongodb.org/manual/applications/replication/#read-preference
- * @see read()
- * @return {Query} this
- * @api public
- */
- Query.prototype.slaveOk = function(v) {
- this.options.slaveOk = arguments.length ? !!v : true;
- return this;
- };
- /**
- * Sets the readPreference option for the query.
- *
- * ####Example:
- *
- * new Query().read('primary')
- * new Query().read('p') // same as primary
- *
- * new Query().read('primaryPreferred')
- * new Query().read('pp') // same as primaryPreferred
- *
- * new Query().read('secondary')
- * new Query().read('s') // same as secondary
- *
- * new Query().read('secondaryPreferred')
- * new Query().read('sp') // same as secondaryPreferred
- *
- * new Query().read('nearest')
- * new Query().read('n') // same as nearest
- *
- * // you can also use mongodb.ReadPreference class to also specify tags
- * new Query().read(mongodb.ReadPreference('secondary', [{ dc:'sf', s: 1 },{ dc:'ma', s: 2 }]))
- *
- * new Query().setReadPreference('primary') // alias of .read()
- *
- * ####Preferences:
- *
- * primary - (default) Read from primary only. Operations will produce an error if primary is unavailable. Cannot be combined with tags.
- * secondary Read from secondary if available, otherwise error.
- * primaryPreferred Read from primary if available, otherwise a secondary.
- * secondaryPreferred Read from a secondary if available, otherwise read from the primary.
- * nearest All operations read from among the nearest candidates, but unlike other modes, this option will include both the primary and all secondaries in the random selection.
- *
- * Aliases
- *
- * p primary
- * pp primaryPreferred
- * s secondary
- * sp secondaryPreferred
- * n nearest
- *
- * Read more about how to use read preferences [here](http://docs.mongodb.org/manual/applications/replication/#read-preference) and [here](http://mongodb.github.com/node-mongodb-native/driver-articles/anintroductionto1_1and2_2.html#read-preferences).
- *
- * @param {String|ReadPreference} pref one of the listed preference options or their aliases
- * @see mongodb http://docs.mongodb.org/manual/applications/replication/#read-preference
- * @see driver http://mongodb.github.com/node-mongodb-native/driver-articles/anintroductionto1_1and2_2.html#read-preferences
- * @return {Query} this
- * @api public
- */
- Query.prototype.read = Query.prototype.setReadPreference = function(pref) {
- if (arguments.length > 1 && !Query.prototype.read.deprecationWarningIssued) {
- console.error('Deprecation warning: \'tags\' argument is not supported anymore in Query.read() method. Please use mongodb.ReadPreference object instead.');
- Query.prototype.read.deprecationWarningIssued = true;
- }
- this.options.readPreference = utils.readPref(pref);
- return this;
- };
- /**
- * Sets the readConcern option for the query.
- *
- * ####Example:
- *
- * new Query().readConcern('local')
- * new Query().readConcern('l') // same as local
- *
- * new Query().readConcern('available')
- * new Query().readConcern('a') // same as available
- *
- * new Query().readConcern('majority')
- * new Query().readConcern('m') // same as majority
- *
- * new Query().readConcern('linearizable')
- * new Query().readConcern('lz') // same as linearizable
- *
- * new Query().readConcern('snapshot')
- * new Query().readConcern('s') // same as snapshot
- *
- * new Query().r('s') // r is alias of readConcern
- *
- *
- * ####Read Concern Level:
- *
- * local MongoDB 3.2+ The query returns from the instance with no guarantee guarantee that the data has been written to a majority of the replica set members (i.e. may be rolled back).
- * available MongoDB 3.6+ The query returns from the instance with no guarantee guarantee that the data has been written to a majority of the replica set members (i.e. may be rolled back).
- * majority MongoDB 3.2+ The query returns the data that has been acknowledged by a majority of the replica set members. The documents returned by the read operation are durable, even in the event of failure.
- * linearizable MongoDB 3.4+ The query returns data that reflects all successful majority-acknowledged writes that completed prior to the start of the read operation. The query may wait for concurrently executing writes to propagate to a majority of replica set members before returning results.
- * snapshot MongoDB 4.0+ Only available for operations within multi-document transactions. Upon transaction commit with write concern "majority", the transaction operations are guaranteed to have read from a snapshot of majority-committed data.
- *
- *
- * Aliases
- *
- * l local
- * a available
- * m majority
- * lz linearizable
- * s snapshot
- *
- * Read more about how to use read concern [here](https://docs.mongodb.com/manual/reference/read-concern/).
- *
- * @param {String} level one of the listed read concern level or their aliases
- * @see mongodb https://docs.mongodb.com/manual/reference/read-concern/
- * @return {Query} this
- * @api public
- */
- Query.prototype.readConcern = Query.prototype.r = function(level) {
- this.options.readConcern = utils.readConcern(level);
- return this;
- };
- /**
- * Sets tailable option.
- *
- * ####Example
- *
- * query.tailable() <== true
- * query.tailable(true)
- * query.tailable(false)
- *
- * ####Note
- *
- * Cannot be used with `distinct()`
- *
- * @param {Boolean} v defaults to true
- * @see mongodb http://www.mongodb.org/display/DOCS/Tailable+Cursors
- * @api public
- */
- Query.prototype.tailable = function() {
- this._validate('tailable');
- this.options.tailable = arguments.length
- ? !!arguments[0]
- : true;
- return this;
- };
- /**
- * Sets the specified number of `mongod` servers, or tag set of `mongod` servers,
- * that must acknowledge this write before this write is considered successful.
- * This option is only valid for operations that write to the database:
- *
- * - `deleteOne()`
- * - `deleteMany()`
- * - `findOneAndDelete()`
- * - `findOneAndUpdate()`
- * - `remove()`
- * - `update()`
- * - `updateOne()`
- * - `updateMany()`
- *
- * Defaults to the `w` value if it is specified in writeConcern options
- *
- * ####Example:
- *
- * mquery().writeConcern(0)
- * mquery().writeConcern(1)
- * mquery().writeConcern({ w: 1, j: true, wtimeout: 2000 })
- * mquery().writeConcern('majority')
- * mquery().writeConcern('m') // same as majority
- * mquery().writeConcern('tagSetName') // if the tag set is 'm', use .writeConcern({ w: 'm' }) instead
- * mquery().w(1) // w is alias of writeConcern
- *
- * @method writeConcern
- * @memberOf Query
- * @instance
- * @param {String|number|object} concern 0 for fire-and-forget, 1 for acknowledged by one server, 'majority' for majority of the replica set, or [any of the more advanced options](https://docs.mongodb.com/manual/reference/write-concern/#w-option).
- * @see mongodb https://docs.mongodb.com/manual/reference/write-concern/#w-option
- * @return {Query} this
- * @api public
- */
- Query.prototype.writeConcern = Query.prototype.w = function writeConcern(concern) {
- if ('object' === typeof concern) {
- if ('undefined' !== typeof concern.j) this.options.j = concern.j;
- if ('undefined' !== typeof concern.w) this.options.w = concern.w;
- if ('undefined' !== typeof concern.wtimeout) this.options.wtimeout = concern.wtimeout;
- } else {
- this.options.w = 'm' === concern ? 'majority' : concern;
- }
- return this;
- };
- /**
- * Specifies a time limit, in milliseconds, for the write concern.
- * If `ms > 1`, it is maximum amount of time to wait for this write
- * to propagate through the replica set before this operation fails.
- * The default is `0`, which means no timeout.
- *
- * This option is only valid for operations that write to the database:
- *
- * - `deleteOne()`
- * - `deleteMany()`
- * - `findOneAndDelete()`
- * - `findOneAndUpdate()`
- * - `remove()`
- * - `update()`
- * - `updateOne()`
- * - `updateMany()`
- *
- * Defaults to `wtimeout` value if it is specified in writeConcern
- *
- * ####Example:
- *
- * mquery().w(2).j(true).wtimeout(2000)
- *
- * @method wtimeout
- * @memberOf Query
- * @instance
- * @param {number} ms number of milliseconds to wait
- * @see mongodb https://docs.mongodb.com/manual/reference/write-concern/#wtimeout
- * @return {Query} this
- * @api public
- */
- Query.prototype.wtimeout = Query.prototype.wTimeout = function wtimeout(ms) {
- this.options.wtimeout = ms;
- return this;
- };
- /**
- * Merges another Query or conditions object into this one.
- *
- * When a Query is passed, conditions, field selection and options are merged.
- *
- * @param {Query|Object} source
- * @return {Query} this
- */
- Query.prototype.merge = function(source) {
- if (!source)
- return this;
- if (!Query.canMerge(source))
- throw new TypeError('Invalid argument. Expected instanceof mquery or plain object');
- if (source instanceof Query) {
- // if source has a feature, apply it to ourselves
- if (source._conditions) {
- utils.merge(this._conditions, source._conditions);
- }
- if (source._fields) {
- this._fields || (this._fields = {});
- utils.merge(this._fields, source._fields);
- }
- if (source.options) {
- this.options || (this.options = {});
- utils.merge(this.options, source.options);
- }
- if (source._update) {
- this._update || (this._update = {});
- utils.mergeClone(this._update, source._update);
- }
- if (source._distinct) {
- this._distinct = source._distinct;
- }
- return this;
- }
- // plain object
- utils.merge(this._conditions, source);
- return this;
- };
- /**
- * Finds documents.
- *
- * Passing a `callback` executes the query.
- *
- * ####Example
- *
- * query.find()
- * query.find(callback)
- * query.find({ name: 'Burning Lights' }, callback)
- *
- * @param {Object} [criteria] mongodb selector
- * @param {Function} [callback]
- * @return {Query} this
- * @api public
- */
- Query.prototype.find = function(criteria, callback) {
- this.op = 'find';
- if ('function' === typeof criteria) {
- callback = criteria;
- criteria = undefined;
- } else if (Query.canMerge(criteria)) {
- this.merge(criteria);
- }
- if (!callback) return this;
- var conds = this._conditions;
- var options = this._optionsForExec();
- if (this.$useProjection) {
- options.projection = this._fieldsForExec();
- } else {
- options.fields = this._fieldsForExec();
- }
- debug('find', this._collection.collectionName, conds, options);
- callback = this._wrapCallback('find', callback, {
- conditions: conds,
- options: options
- });
- this._collection.find(conds, options, utils.tick(callback));
- return this;
- };
- /**
- * Returns the query cursor
- *
- * ####Examples
- *
- * query.find().cursor();
- * query.cursor({ name: 'Burning Lights' });
- *
- * @param {Object} [criteria] mongodb selector
- * @return {Object} cursor
- * @api public
- */
- Query.prototype.cursor = function cursor(criteria) {
- if (this.op) {
- if (this.op !== 'find') {
- throw new TypeError('.cursor only support .find method');
- }
- } else {
- this.find(criteria);
- }
- var conds = this._conditions;
- var options = this._optionsForExec();
- if (this.$useProjection) {
- options.projection = this._fieldsForExec();
- } else {
- options.fields = this._fieldsForExec();
- }
- debug('findCursor', this._collection.collectionName, conds, options);
- return this._collection.findCursor(conds, options);
- };
- /**
- * Executes the query as a findOne() operation.
- *
- * Passing a `callback` executes the query.
- *
- * ####Example
- *
- * query.findOne().where('name', /^Burning/);
- *
- * query.findOne({ name: /^Burning/ })
- *
- * query.findOne({ name: /^Burning/ }, callback); // executes
- *
- * query.findOne(function (err, doc) {
- * if (err) return handleError(err);
- * if (doc) {
- * // doc may be null if no document matched
- *
- * }
- * });
- *
- * @param {Object|Query} [criteria] mongodb selector
- * @param {Function} [callback]
- * @return {Query} this
- * @api public
- */
- Query.prototype.findOne = function(criteria, callback) {
- this.op = 'findOne';
- if ('function' === typeof criteria) {
- callback = criteria;
- criteria = undefined;
- } else if (Query.canMerge(criteria)) {
- this.merge(criteria);
- }
- if (!callback) return this;
- var conds = this._conditions;
- var options = this._optionsForExec();
- if (this.$useProjection) {
- options.projection = this._fieldsForExec();
- } else {
- options.fields = this._fieldsForExec();
- }
- debug('findOne', this._collection.collectionName, conds, options);
- callback = this._wrapCallback('findOne', callback, {
- conditions: conds,
- options: options
- });
- this._collection.findOne(conds, options, utils.tick(callback));
- return this;
- };
- /**
- * Exectues the query as a count() operation.
- *
- * Passing a `callback` executes the query.
- *
- * ####Example
- *
- * query.count().where('color', 'black').exec(callback);
- *
- * query.count({ color: 'black' }).count(callback)
- *
- * query.count({ color: 'black' }, callback)
- *
- * query.where('color', 'black').count(function (err, count) {
- * if (err) return handleError(err);
- * console.log('there are %d kittens', count);
- * })
- *
- * @param {Object} [criteria] mongodb selector
- * @param {Function} [callback]
- * @return {Query} this
- * @see mongodb http://www.mongodb.org/display/DOCS/Aggregation#Aggregation-Count
- * @api public
- */
- Query.prototype.count = function(criteria, callback) {
- this.op = 'count';
- this._validate();
- if ('function' === typeof criteria) {
- callback = criteria;
- criteria = undefined;
- } else if (Query.canMerge(criteria)) {
- this.merge(criteria);
- }
- if (!callback) return this;
- var conds = this._conditions,
- options = this._optionsForExec();
- debug('count', this._collection.collectionName, conds, options);
- callback = this._wrapCallback('count', callback, {
- conditions: conds,
- options: options
- });
- this._collection.count(conds, options, utils.tick(callback));
- return this;
- };
- /**
- * Declares or executes a distinct() operation.
- *
- * Passing a `callback` executes the query.
- *
- * ####Example
- *
- * distinct(criteria, field, fn)
- * distinct(criteria, field)
- * distinct(field, fn)
- * distinct(field)
- * distinct(fn)
- * distinct()
- *
- * @param {Object|Query} [criteria]
- * @param {String} [field]
- * @param {Function} [callback]
- * @return {Query} this
- * @see mongodb http://www.mongodb.org/display/DOCS/Aggregation#Aggregation-Distinct
- * @api public
- */
- Query.prototype.distinct = function(criteria, field, callback) {
- this.op = 'distinct';
- this._validate();
- if (!callback) {
- switch (typeof field) {
- case 'function':
- callback = field;
- if ('string' == typeof criteria) {
- field = criteria;
- criteria = undefined;
- }
- break;
- case 'undefined':
- case 'string':
- break;
- default:
- throw new TypeError('Invalid `field` argument. Must be string or function');
- }
- switch (typeof criteria) {
- case 'function':
- callback = criteria;
- criteria = field = undefined;
- break;
- case 'string':
- field = criteria;
- criteria = undefined;
- break;
- }
- }
- if ('string' == typeof field) {
- this._distinct = field;
- }
- if (Query.canMerge(criteria)) {
- this.merge(criteria);
- }
- if (!callback) {
- return this;
- }
- if (!this._distinct) {
- throw new Error('No value for `distinct` has been declared');
- }
- var conds = this._conditions,
- options = this._optionsForExec();
- debug('distinct', this._collection.collectionName, conds, options);
- callback = this._wrapCallback('distinct', callback, {
- conditions: conds,
- options: options
- });
- this._collection.distinct(this._distinct, conds, options, utils.tick(callback));
- return this;
- };
- /**
- * Declare and/or execute this query as an update() operation. By default,
- * `update()` only modifies the _first_ document that matches `criteria`.
- *
- * _All paths passed that are not $atomic operations will become $set ops._
- *
- * ####Example
- *
- * mquery({ _id: id }).update({ title: 'words' }, ...)
- *
- * becomes
- *
- * collection.update({ _id: id }, { $set: { title: 'words' }}, ...)
- *
- * ####Note
- *
- * Passing an empty object `{}` as the doc will result in a no-op unless the `overwrite` option is passed. Without the `overwrite` option set, the update operation will be ignored and the callback executed without sending the command to MongoDB so as to prevent accidently overwritting documents in the collection.
- *
- * ####Note
- *
- * The operation is only executed when a callback is passed. To force execution without a callback (which would be an unsafe write), we must first call update() and then execute it by using the `exec()` method.
- *
- * var q = mquery(collection).where({ _id: id });
- * q.update({ $set: { name: 'bob' }}).update(); // not executed
- *
- * var q = mquery(collection).where({ _id: id });
- * q.update({ $set: { name: 'bob' }}).exec(); // executed as unsafe
- *
- * // keys that are not $atomic ops become $set.
- * // this executes the same command as the previous example.
- * q.update({ name: 'bob' }).where({ _id: id }).exec();
- *
- * var q = mquery(collection).update(); // not executed
- *
- * // overwriting with empty docs
- * var q.where({ _id: id }).setOptions({ overwrite: true })
- * q.update({ }, callback); // executes
- *
- * // multi update with overwrite to empty doc
- * var q = mquery(collection).where({ _id: id });
- * q.setOptions({ multi: true, overwrite: true })
- * q.update({ });
- * q.update(callback); // executed
- *
- * // multi updates
- * mquery()
- * .collection(coll)
- * .update({ name: /^match/ }, { $set: { arr: [] }}, { multi: true }, callback)
- * // more multi updates
- * mquery({ })
- * .collection(coll)
- * .setOptions({ multi: true })
- * .update({ $set: { arr: [] }}, callback)
- *
- * // single update by default
- * mquery({ email: 'address@example.com' })
- * .collection(coll)
- * .update({ $inc: { counter: 1 }}, callback)
- *
- * // summary
- * update(criteria, doc, opts, cb) // executes
- * update(criteria, doc, opts)
- * update(criteria, doc, cb) // executes
- * update(criteria, doc)
- * update(doc, cb) // executes
- * update(doc)
- * update(cb) // executes
- * update(true) // executes (unsafe write)
- * update()
- *
- * @param {Object} [criteria]
- * @param {Object} [doc] the update command
- * @param {Object} [options]
- * @param {Function} [callback]
- * @return {Query} this
- * @api public
- */
- Query.prototype.update = function update(criteria, doc, options, callback) {
- var force;
- switch (arguments.length) {
- case 3:
- if ('function' == typeof options) {
- callback = options;
- options = undefined;
- }
- break;
- case 2:
- if ('function' == typeof doc) {
- callback = doc;
- doc = criteria;
- criteria = undefined;
- }
- break;
- case 1:
- switch (typeof criteria) {
- case 'function':
- callback = criteria;
- criteria = options = doc = undefined;
- break;
- case 'boolean':
- // execution with no callback (unsafe write)
- force = criteria;
- criteria = undefined;
- break;
- default:
- doc = criteria;
- criteria = options = undefined;
- break;
- }
- }
- return _update(this, 'update', criteria, doc, options, force, callback);
- };
- /**
- * Declare and/or execute this query as an `updateMany()` operation. Identical
- * to `update()` except `updateMany()` will update _all_ documents that match
- * `criteria`, rather than just the first one.
- *
- * _All paths passed that are not $atomic operations will become $set ops._
- *
- * ####Example
- *
- * // Update every document whose `title` contains 'test'
- * mquery().updateMany({ title: /test/ }, { year: 2017 })
- *
- * @param {Object} [criteria]
- * @param {Object} [doc] the update command
- * @param {Object} [options]
- * @param {Function} [callback]
- * @return {Query} this
- * @api public
- */
- Query.prototype.updateMany = function updateMany(criteria, doc, options, callback) {
- var force;
- switch (arguments.length) {
- case 3:
- if ('function' == typeof options) {
- callback = options;
- options = undefined;
- }
- break;
- case 2:
- if ('function' == typeof doc) {
- callback = doc;
- doc = criteria;
- criteria = undefined;
- }
- break;
- case 1:
- switch (typeof criteria) {
- case 'function':
- callback = criteria;
- criteria = options = doc = undefined;
- break;
- case 'boolean':
- // execution with no callback (unsafe write)
- force = criteria;
- criteria = undefined;
- break;
- default:
- doc = criteria;
- criteria = options = undefined;
- break;
- }
- }
- return _update(this, 'updateMany', criteria, doc, options, force, callback);
- };
- /**
- * Declare and/or execute this query as an `updateOne()` operation. Identical
- * to `update()` except `updateOne()` will _always_ update just one document,
- * regardless of the `multi` option.
- *
- * _All paths passed that are not $atomic operations will become $set ops._
- *
- * ####Example
- *
- * // Update the first document whose `title` contains 'test'
- * mquery().updateMany({ title: /test/ }, { year: 2017 })
- *
- * @param {Object} [criteria]
- * @param {Object} [doc] the update command
- * @param {Object} [options]
- * @param {Function} [callback]
- * @return {Query} this
- * @api public
- */
- Query.prototype.updateOne = function updateOne(criteria, doc, options, callback) {
- var force;
- switch (arguments.length) {
- case 3:
- if ('function' == typeof options) {
- callback = options;
- options = undefined;
- }
- break;
- case 2:
- if ('function' == typeof doc) {
- callback = doc;
- doc = criteria;
- criteria = undefined;
- }
- break;
- case 1:
- switch (typeof criteria) {
- case 'function':
- callback = criteria;
- criteria = options = doc = undefined;
- break;
- case 'boolean':
- // execution with no callback (unsafe write)
- force = criteria;
- criteria = undefined;
- break;
- default:
- doc = criteria;
- criteria = options = undefined;
- break;
- }
- }
- return _update(this, 'updateOne', criteria, doc, options, force, callback);
- };
- /**
- * Declare and/or execute this query as an `replaceOne()` operation. Similar
- * to `updateOne()`, except `replaceOne()` is not allowed to use atomic
- * modifiers (`$set`, `$push`, etc.). Calling `replaceOne()` will always
- * replace the existing doc.
- *
- * ####Example
- *
- * // Replace the document with `_id` 1 with `{ _id: 1, year: 2017 }`
- * mquery().replaceOne({ _id: 1 }, { year: 2017 })
- *
- * @param {Object} [criteria]
- * @param {Object} [doc] the update command
- * @param {Object} [options]
- * @param {Function} [callback]
- * @return {Query} this
- * @api public
- */
- Query.prototype.replaceOne = function replaceOne(criteria, doc, options, callback) {
- var force;
- switch (arguments.length) {
- case 3:
- if ('function' == typeof options) {
- callback = options;
- options = undefined;
- }
- break;
- case 2:
- if ('function' == typeof doc) {
- callback = doc;
- doc = criteria;
- criteria = undefined;
- }
- break;
- case 1:
- switch (typeof criteria) {
- case 'function':
- callback = criteria;
- criteria = options = doc = undefined;
- break;
- case 'boolean':
- // execution with no callback (unsafe write)
- force = criteria;
- criteria = undefined;
- break;
- default:
- doc = criteria;
- criteria = options = undefined;
- break;
- }
- }
- this.setOptions({ overwrite: true });
- return _update(this, 'replaceOne', criteria, doc, options, force, callback);
- };
- /*!
- * Internal helper for update, updateMany, updateOne
- */
- function _update(query, op, criteria, doc, options, force, callback) {
- query.op = op;
- if (Query.canMerge(criteria)) {
- query.merge(criteria);
- }
- if (doc) {
- query._mergeUpdate(doc);
- }
- if (utils.isObject(options)) {
- // { overwrite: true }
- query.setOptions(options);
- }
- // we are done if we don't have callback and they are
- // not forcing an unsafe write.
- if (!(force || callback)) {
- return query;
- }
- if (!query._update ||
- !query.options.overwrite && 0 === utils.keys(query._update).length) {
- callback && utils.soon(callback.bind(null, null, 0));
- return query;
- }
- options = query._optionsForExec();
- if (!callback) options.safe = false;
- criteria = query._conditions;
- doc = query._updateForExec();
- debug('update', query._collection.collectionName, criteria, doc, options);
- callback = query._wrapCallback(op, callback, {
- conditions: criteria,
- doc: doc,
- options: options
- });
- query._collection[op](criteria, doc, options, utils.tick(callback));
- return query;
- }
- /**
- * Declare and/or execute this query as a remove() operation.
- *
- * ####Example
- *
- * mquery(collection).remove({ artist: 'Anne Murray' }, callback)
- *
- * ####Note
- *
- * The operation is only executed when a callback is passed. To force execution without a callback (which would be an unsafe write), we must first call remove() and then execute it by using the `exec()` method.
- *
- * // not executed
- * var query = mquery(collection).remove({ name: 'Anne Murray' })
- *
- * // executed
- * mquery(collection).remove({ name: 'Anne Murray' }, callback)
- * mquery(collection).remove({ name: 'Anne Murray' }).remove(callback)
- *
- * // executed without a callback (unsafe write)
- * query.exec()
- *
- * // summary
- * query.remove(conds, fn); // executes
- * query.remove(conds)
- * query.remove(fn) // executes
- * query.remove()
- *
- * @param {Object|Query} [criteria] mongodb selector
- * @param {Function} [callback]
- * @return {Query} this
- * @api public
- */
- Query.prototype.remove = function(criteria, callback) {
- this.op = 'remove';
- var force;
- if ('function' === typeof criteria) {
- callback = criteria;
- criteria = undefined;
- } else if (Query.canMerge(criteria)) {
- this.merge(criteria);
- } else if (true === criteria) {
- force = criteria;
- criteria = undefined;
- }
- if (!(force || callback))
- return this;
- var options = this._optionsForExec();
- if (!callback) options.safe = false;
- var conds = this._conditions;
- debug('remove', this._collection.collectionName, conds, options);
- callback = this._wrapCallback('remove', callback, {
- conditions: conds,
- options: options
- });
- this._collection.remove(conds, options, utils.tick(callback));
- return this;
- };
- /**
- * Declare and/or execute this query as a `deleteOne()` operation. Behaves like
- * `remove()`, except for ignores the `justOne` option and always deletes at
- * most one document.
- *
- * ####Example
- *
- * mquery(collection).deleteOne({ artist: 'Anne Murray' }, callback)
- *
- * @param {Object|Query} [criteria] mongodb selector
- * @param {Function} [callback]
- * @return {Query} this
- * @api public
- */
- Query.prototype.deleteOne = function(criteria, callback) {
- this.op = 'deleteOne';
- var force;
- if ('function' === typeof criteria) {
- callback = criteria;
- criteria = undefined;
- } else if (Query.canMerge(criteria)) {
- this.merge(criteria);
- } else if (true === criteria) {
- force = criteria;
- criteria = undefined;
- }
- if (!(force || callback))
- return this;
- var options = this._optionsForExec();
- if (!callback) options.safe = false;
- delete options.justOne;
- var conds = this._conditions;
- debug('deleteOne', this._collection.collectionName, conds, options);
- callback = this._wrapCallback('deleteOne', callback, {
- conditions: conds,
- options: options
- });
- this._collection.deleteOne(conds, options, utils.tick(callback));
- return this;
- };
- /**
- * Declare and/or execute this query as a `deleteMany()` operation. Behaves like
- * `remove()`, except for ignores the `justOne` option and always deletes
- * _every_ document that matches `criteria`.
- *
- * ####Example
- *
- * mquery(collection).deleteMany({ artist: 'Anne Murray' }, callback)
- *
- * @param {Object|Query} [criteria] mongodb selector
- * @param {Function} [callback]
- * @return {Query} this
- * @api public
- */
- Query.prototype.deleteMany = function(criteria, callback) {
- this.op = 'deleteMany';
- var force;
- if ('function' === typeof criteria) {
- callback = criteria;
- criteria = undefined;
- } else if (Query.canMerge(criteria)) {
- this.merge(criteria);
- } else if (true === criteria) {
- force = criteria;
- criteria = undefined;
- }
- if (!(force || callback))
- return this;
- var options = this._optionsForExec();
- if (!callback) options.safe = false;
- delete options.justOne;
- var conds = this._conditions;
- debug('deleteOne', this._collection.collectionName, conds, options);
- callback = this._wrapCallback('deleteOne', callback, {
- conditions: conds,
- options: options
- });
- this._collection.deleteMany(conds, options, utils.tick(callback));
- return this;
- };
- /**
- * Issues a mongodb [findAndModify](http://www.mongodb.org/display/DOCS/findAndModify+Command) update command.
- *
- * Finds a matching document, updates it according to the `update` arg, passing any `options`, and returns the found document (if any) to the callback. The query executes immediately if `callback` is passed.
- *
- * ####Available options
- *
- * - `new`: bool - true to return the modified document rather than the original. defaults to true
- * - `upsert`: bool - creates the object if it doesn't exist. defaults to false.
- * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
- *
- * ####Examples
- *
- * query.findOneAndUpdate(conditions, update, options, callback) // executes
- * query.findOneAndUpdate(conditions, update, options) // returns Query
- * query.findOneAndUpdate(conditions, update, callback) // executes
- * query.findOneAndUpdate(conditions, update) // returns Query
- * query.findOneAndUpdate(update, callback) // returns Query
- * query.findOneAndUpdate(update) // returns Query
- * query.findOneAndUpdate(callback) // executes
- * query.findOneAndUpdate() // returns Query
- *
- * @param {Object|Query} [query]
- * @param {Object} [doc]
- * @param {Object} [options]
- * @param {Function} [callback]
- * @see mongodb http://www.mongodb.org/display/DOCS/findAndModify+Command
- * @return {Query} this
- * @api public
- */
- Query.prototype.findOneAndUpdate = function(criteria, doc, options, callback) {
- this.op = 'findOneAndUpdate';
- this._validate();
- switch (arguments.length) {
- case 3:
- if ('function' == typeof options) {
- callback = options;
- options = {};
- }
- break;
- case 2:
- if ('function' == typeof doc) {
- callback = doc;
- doc = criteria;
- criteria = undefined;
- }
- options = undefined;
- break;
- case 1:
- if ('function' == typeof criteria) {
- callback = criteria;
- criteria = options = doc = undefined;
- } else {
- doc = criteria;
- criteria = options = undefined;
- }
- }
- if (Query.canMerge(criteria)) {
- this.merge(criteria);
- }
- // apply doc
- if (doc) {
- this._mergeUpdate(doc);
- }
- options && this.setOptions(options);
- if (!callback) return this;
- return this._findAndModify('update', callback);
- };
- /**
- * Issues a mongodb [findAndModify](http://www.mongodb.org/display/DOCS/findAndModify+Command) remove command.
- *
- * Finds a matching document, removes it, passing the found document (if any) to the callback. Executes immediately if `callback` is passed.
- *
- * ####Available options
- *
- * - `sort`: if multiple docs are found by the conditions, sets the sort order to choose which doc to update
- *
- * ####Examples
- *
- * A.where().findOneAndRemove(conditions, options, callback) // executes
- * A.where().findOneAndRemove(conditions, options) // return Query
- * A.where().findOneAndRemove(conditions, callback) // executes
- * A.where().findOneAndRemove(conditions) // returns Query
- * A.where().findOneAndRemove(callback) // executes
- * A.where().findOneAndRemove() // returns Query
- * A.where().findOneAndDelete() // alias of .findOneAndRemove()
- *
- * @param {Object} [conditions]
- * @param {Object} [options]
- * @param {Function} [callback]
- * @return {Query} this
- * @see mongodb http://www.mongodb.org/display/DOCS/findAndModify+Command
- * @api public
- */
- Query.prototype.findOneAndRemove = Query.prototype.findOneAndDelete = function(conditions, options, callback) {
- this.op = 'findOneAndRemove';
- this._validate();
- if ('function' == typeof options) {
- callback = options;
- options = undefined;
- } else if ('function' == typeof conditions) {
- callback = conditions;
- conditions = undefined;
- }
- // apply conditions
- if (Query.canMerge(conditions)) {
- this.merge(conditions);
- }
- // apply options
- options && this.setOptions(options);
- if (!callback) return this;
- return this._findAndModify('remove', callback);
- };
- /**
- * _findAndModify
- *
- * @param {String} type - either "remove" or "update"
- * @param {Function} callback
- * @api private
- */
- Query.prototype._findAndModify = function(type, callback) {
- assert.equal('function', typeof callback);
- var options = this._optionsForExec();
- var fields;
- var doc;
- if ('remove' == type) {
- options.remove = true;
- } else {
- if (!('new' in options)) options.new = true;
- if (!('upsert' in options)) options.upsert = false;
- doc = this._updateForExec();
- if (!doc) {
- if (options.upsert) {
- // still need to do the upsert to empty doc
- doc = { $set: {} };
- } else {
- return this.findOne(callback);
- }
- }
- }
- fields = this._fieldsForExec();
- if (fields != null) {
- if (this.$useProjection) {
- options.projection = this._fieldsForExec();
- } else {
- options.fields = this._fieldsForExec();
- }
- }
- var conds = this._conditions;
- debug('findAndModify', this._collection.collectionName, conds, doc, options);
- callback = this._wrapCallback('findAndModify', callback, {
- conditions: conds,
- doc: doc,
- options: options
- });
- this._collection.findAndModify(conds, doc, options, utils.tick(callback));
- return this;
- };
- /**
- * Wrap callback to add tracing
- *
- * @param {Function} callback
- * @param {Object} [queryInfo]
- * @api private
- */
- Query.prototype._wrapCallback = function(method, callback, queryInfo) {
- var traceFunction = this._traceFunction || Query.traceFunction;
- if (traceFunction) {
- queryInfo.collectionName = this._collection.collectionName;
- var traceCallback = traceFunction &&
- traceFunction.call(null, method, queryInfo, this);
- var startTime = new Date().getTime();
- return function wrapperCallback(err, result) {
- if (traceCallback) {
- var millis = new Date().getTime() - startTime;
- traceCallback.call(null, err, result, millis);
- }
- if (callback) {
- callback.apply(null, arguments);
- }
- };
- }
- return callback;
- };
- /**
- * Add trace function that gets called when the query is executed.
- * The function will be called with (method, queryInfo, query) and
- * should return a callback function which will be called
- * with (err, result, millis) when the query is complete.
- *
- * queryInfo is an object containing: {
- * collectionName: <name of the collection>,
- * conditions: <query criteria>,
- * options: <comment, fields, readPreference, etc>,
- * doc: [document to update, if applicable]
- * }
- *
- * NOTE: Does not trace stream queries.
- *
- * @param {Function} traceFunction
- * @return {Query} this
- * @api public
- */
- Query.prototype.setTraceFunction = function(traceFunction) {
- this._traceFunction = traceFunction;
- return this;
- };
- /**
- * Executes the query
- *
- * ####Examples
- *
- * query.exec();
- * query.exec(callback);
- * query.exec('update');
- * query.exec('find', callback);
- *
- * @param {String|Function} [operation]
- * @param {Function} [callback]
- * @api public
- */
- Query.prototype.exec = function exec(op, callback) {
- switch (typeof op) {
- case 'function':
- callback = op;
- op = null;
- break;
- case 'string':
- this.op = op;
- break;
- }
- assert.ok(this.op, 'Missing query type: (find, update, etc)');
- if ('update' == this.op || 'remove' == this.op) {
- callback || (callback = true);
- }
- var _this = this;
- if ('function' == typeof callback) {
- this[this.op](callback);
- } else {
- return new Query.Promise(function(success, error) {
- _this[_this.op](function(err, val) {
- if (err) error(err);
- else success(val);
- success = error = null;
- });
- });
- }
- };
- /**
- * Returns a thunk which when called runs this.exec()
- *
- * The thunk receives a callback function which will be
- * passed to `this.exec()`
- *
- * @return {Function}
- * @api public
- */
- Query.prototype.thunk = function() {
- var _this = this;
- return function(cb) {
- _this.exec(cb);
- };
- };
- /**
- * Executes the query returning a `Promise` which will be
- * resolved with either the doc(s) or rejected with the error.
- *
- * @param {Function} [resolve]
- * @param {Function} [reject]
- * @return {Promise}
- * @api public
- */
- Query.prototype.then = function(resolve, reject) {
- var _this = this;
- var promise = new Query.Promise(function(success, error) {
- _this.exec(function(err, val) {
- if (err) error(err);
- else success(val);
- success = error = null;
- });
- });
- return promise.then(resolve, reject);
- };
- /**
- * Returns a stream for the given find query.
- *
- * @throws Error if operation is not a find
- * @returns {Stream} Node 0.8 style
- */
- Query.prototype.stream = function(streamOptions) {
- if ('find' != this.op)
- throw new Error('stream() is only available for find');
- var conds = this._conditions;
- var options = this._optionsForExec();
- if (this.$useProjection) {
- options.projection = this._fieldsForExec();
- } else {
- options.fields = this._fieldsForExec();
- }
- debug('stream', this._collection.collectionName, conds, options, streamOptions);
- return this._collection.findStream(conds, options, streamOptions);
- };
- /**
- * Determines if field selection has been made.
- *
- * @return {Boolean}
- * @api public
- */
- Query.prototype.selected = function selected() {
- return !!(this._fields && Object.keys(this._fields).length > 0);
- };
- /**
- * Determines if inclusive field selection has been made.
- *
- * query.selectedInclusively() // false
- * query.select('name')
- * query.selectedInclusively() // true
- * query.selectedExlusively() // false
- *
- * @returns {Boolean}
- */
- Query.prototype.selectedInclusively = function selectedInclusively() {
- if (!this._fields) return false;
- var keys = Object.keys(this._fields);
- if (0 === keys.length) return false;
- for (var i = 0; i < keys.length; ++i) {
- var key = keys[i];
- if (0 === this._fields[key]) return false;
- if (this._fields[key] &&
- typeof this._fields[key] === 'object' &&
- this._fields[key].$meta) {
- return false;
- }
- }
- return true;
- };
- /**
- * Determines if exclusive field selection has been made.
- *
- * query.selectedExlusively() // false
- * query.select('-name')
- * query.selectedExlusively() // true
- * query.selectedInclusively() // false
- *
- * @returns {Boolean}
- */
- Query.prototype.selectedExclusively = function selectedExclusively() {
- if (!this._fields) return false;
- var keys = Object.keys(this._fields);
- if (0 === keys.length) return false;
- for (var i = 0; i < keys.length; ++i) {
- var key = keys[i];
- if (0 === this._fields[key]) return true;
- }
- return false;
- };
- /**
- * Merges `doc` with the current update object.
- *
- * @param {Object} doc
- */
- Query.prototype._mergeUpdate = function(doc) {
- if (!this._update) this._update = {};
- if (doc instanceof Query) {
- if (doc._update) {
- utils.mergeClone(this._update, doc._update);
- }
- } else {
- utils.mergeClone(this._update, doc);
- }
- };
- /**
- * Returns default options.
- *
- * @return {Object}
- * @api private
- */
- Query.prototype._optionsForExec = function() {
- var options = utils.clone(this.options);
- return options;
- };
- /**
- * Returns fields selection for this query.
- *
- * @return {Object}
- * @api private
- */
- Query.prototype._fieldsForExec = function() {
- return utils.clone(this._fields);
- };
- /**
- * Return an update document with corrected $set operations.
- *
- * @api private
- */
- Query.prototype._updateForExec = function() {
- var update = utils.clone(this._update),
- ops = utils.keys(update),
- i = ops.length,
- ret = {};
- while (i--) {
- var op = ops[i];
- if (this.options.overwrite) {
- ret[op] = update[op];
- continue;
- }
- if ('$' !== op[0]) {
- // fix up $set sugar
- if (!ret.$set) {
- if (update.$set) {
- ret.$set = update.$set;
- } else {
- ret.$set = {};
- }
- }
- ret.$set[op] = update[op];
- ops.splice(i, 1);
- if (!~ops.indexOf('$set')) ops.push('$set');
- } else if ('$set' === op) {
- if (!ret.$set) {
- ret[op] = update[op];
- }
- } else {
- ret[op] = update[op];
- }
- }
- this._compiledUpdate = ret;
- return ret;
- };
- /**
- * Make sure _path is set.
- *
- * @parmam {String} method
- */
- Query.prototype._ensurePath = function(method) {
- if (!this._path) {
- var msg = method + '() must be used after where() '
- + 'when called with these arguments';
- throw new Error(msg);
- }
- };
- /*!
- * Permissions
- */
- Query.permissions = require('./permissions');
- Query._isPermitted = function(a, b) {
- var denied = Query.permissions[b];
- if (!denied) return true;
- return true !== denied[a];
- };
- Query.prototype._validate = function(action) {
- var fail;
- var validator;
- if (undefined === action) {
- validator = Query.permissions[this.op];
- if ('function' != typeof validator) return true;
- fail = validator(this);
- } else if (!Query._isPermitted(action, this.op)) {
- fail = action;
- }
- if (fail) {
- throw new Error(fail + ' cannot be used with ' + this.op);
- }
- };
- /**
- * Determines if `conds` can be merged using `mquery().merge()`
- *
- * @param {Object} conds
- * @return {Boolean}
- */
- Query.canMerge = function(conds) {
- return conds instanceof Query || utils.isObject(conds);
- };
- /**
- * Set a trace function that will get called whenever a
- * query is executed.
- *
- * See `setTraceFunction()` for details.
- *
- * @param {Object} conds
- * @return {Boolean}
- */
- Query.setGlobalTraceFunction = function(traceFunction) {
- Query.traceFunction = traceFunction;
- };
- /*!
- * Exports.
- */
- Query.utils = utils;
- Query.env = require('./env');
- Query.Collection = require('./collection');
- Query.BaseCollection = require('./collection/collection');
- Query.Promise = require('bluebird');
- module.exports = exports = Query;
- // TODO
- // test utils
|