@ -1,15 +1,14 @@
var customUtils = require ( './customUtils' ) const customUtils = require ( './customUtils' )
, model = require ( './model' ) const model = require ( './model' )
, async = require ( 'async' ) const async = require ( 'async' )
, Executor = require ( './executor' ) const Executor = require ( './executor' )
, Index = require ( './indexes' ) const Index = require ( './indexes' )
, util = require ( 'util' ) const util = require ( 'util' )
, _ = require ( 'underscore' ) const _ = require ( 'underscore' )
, Persistence = require ( './persistence' ) const Persistence = require ( './persistence' )
, Cursor = require ( './cursor' ) const Cursor = require ( './cursor' )
;
class Datastore {
/ * * / * *
* Create a new collection * Create a new collection
* @ param { String } options . filename Optional , datastore will be in - memory only if not provided * @ param { String } options . filename Optional , datastore will be in - memory only if not provided
@ -26,88 +25,86 @@ var customUtils = require('./customUtils')
* Event Emitter - Events * Event Emitter - Events
* * compaction . done - Fired whenever a compaction operation was finished * * compaction . done - Fired whenever a compaction operation was finished
* / * /
function Datastore ( options ) { constructor ( options ) {
var filename ; let filename
// Retrocompatibility with v0.6 and before
// Retrocompatibility with v0.6 and before
if ( typeof options === 'string' ) { if ( typeof options === 'string' ) {
filename = options ; filename = options
this . inMemoryOnly = false ; // Default
this . inMemoryOnly = false // Default
} else { } else {
options = options || { } ; options = options || { }
filename = options . filename ; filename = options . filename
this . inMemoryOnly = options . inMemoryOnly || false ; this . inMemoryOnly = options . inMemoryOnly || false
this . autoload = options . autoload || false ; this . autoload = options . autoload || false
this . timestampData = options . timestampData || false ; this . timestampData = options . timestampData || false
} }
// Determine whether in memory or persistent
// Determine whether in memory or persistent
if ( ! filename || typeof filename !== 'string' || filename . length === 0 ) { if ( ! filename || typeof filename !== 'string' || filename . length === 0 ) {
this . filename = null ; this . filename = null
this . inMemoryOnly = true ; this . inMemoryOnly = true
} else { } else {
this . filename = filename ; this . filename = filename
} }
// String comparison function
// String comparison function
this . compareStrings = options . compareStrings ; this . compareStrings = options . compareStrings
// Persistence handling
// Persistence handling
this . persistence = new Persistence ( { db : this , nodeWebkitAppName : options . nodeWebkitAppName this . persistence = new Persistence ( {
, afterSerialization : options . afterSerialization db : this ,
, beforeDeserialization : options . beforeDeserialization nodeWebkitAppName : options . nodeWebkitAppName ,
, corruptAlertThreshold : options . corruptAlertThreshold afterSerialization : options . afterSerialization ,
} ) ; beforeDeserialization : options . beforeDeserialization ,
corruptAlertThreshold : options . corruptAlertThreshold
} )
// This new executor is ready if we don't use persistence
// This new executor is ready if we don't use persistence
// If we do, it will only be ready once loadDatabase is called
// If we do, it will only be ready once loadDatabase is called
this . executor = new Executor ( ) ; this . executor = new Executor ( )
if ( this . inMemoryOnly ) { this . executor . ready = true ; } if ( this . inMemoryOnly ) { this . executor . ready = true }
// Indexed by field name, dot notation can be used
// Indexed by field name, dot notation can be used
// _id is always indexed and since _ids are generated randomly the underlying
// _id is always indexed and since _ids are generated randomly the underlying
// binary is always well-balanced
// binary is always well-balanced
this . indexes = { } ; this . indexes = { }
this . indexes . _id = new Index ( { fieldName : '_id' , unique : true } ) ; this . indexes . _id = new Index ( { fieldName : '_id' , unique : true } )
this . ttlIndexes = { } ; this . ttlIndexes = { }
// Queue a load of the database right away and call the onload handler
// Queue a load of the database right away and call the onload handler
// By default (no onload handler), if there is an error there, no operation will be possible so warn the user by throwing an exception
// By default (no onload handler), if there is an error there, no operation will be possible so warn the user by throwing an exception
if ( this . autoload ) { this . loadDatabase ( options . onload || function ( err ) { if ( this . autoload ) {
if ( err ) { throw err ; } this . loadDatabase ( options . onload || function ( err ) {
} ) ; } if ( err ) { throw err }
} )
}
} }
util . inherits ( Datastore , require ( 'events' ) . EventEmitter ) ;
/ * * / * *
* Load the database from the datafile , and trigger the execution of buffered commands if any * Load the database from the datafile , and trigger the execution of buffered commands if any
* / * /
Datastore . prototype . loadDatabase = function ( ) { loadDatabase ( ) {
this . executor . push ( { this : this . persistence , fn : this . persistence . loadDatabase , arguments : arguments } , true ) ; this . executor . push ( { this : this . persistence , fn : this . persistence . loadDatabase , arguments : arguments } , true )
} ; }
/ * * / * *
* Get an array of all the data in the database * Get an array of all the data in the database
* / * /
Datastore . prototype . getAllData = function ( ) { getAllData ( ) {
return this . indexes . _id . getAll ( ) ; return this . indexes . _id . getAll ( )
} ; }
/ * * / * *
* Reset all currently defined indexes * Reset all currently defined indexes
* / * /
Datastore . prototype . resetIndexes = function ( newData ) { resetIndexes ( newData ) {
var self = this ; const self = this
Object . keys ( this . indexes ) . forEach ( function ( i ) { Object . keys ( this . indexes ) . forEach ( function ( i ) {
self . indexes [ i ] . reset ( newData ) ; self . indexes [ i ] . reset ( newData )
} ) ; } )
} ; }
/ * * / * *
* Ensure an index is kept for this field . Same parameters as lib / indexes * Ensure an index is kept for this field . Same parameters as lib / indexes
@ -119,125 +116,122 @@ Datastore.prototype.resetIndexes = function (newData) {
* @ param { Number } options . expireAfterSeconds - Optional , if set this index becomes a TTL index ( only works on Date fields , not arrays of Date ) * @ param { Number } options . expireAfterSeconds - Optional , if set this index becomes a TTL index ( only works on Date fields , not arrays of Date )
* @ param { Function } cb Optional callback , signature : err * @ param { Function } cb Optional callback , signature : err
* / * /
Datastore . prototype . ensureIndex = function ( options , cb ) { ensureIndex ( options , cb ) {
var err let err
, callback = cb || function ( ) { } ; const callback = cb || function ( ) { }
options = options || { } ; options = options || { }
if ( ! options . fieldName ) { if ( ! options . fieldName ) {
err = new Error ( "Cannot create an index without a fieldName" ) ; err = new Error ( 'Cannot create an index without a fieldName' )
err . missingFieldName = true ; err . missingFieldName = true
return callback ( err ) ; return callback ( err )
} }
if ( this . indexes [ options . fieldName ] ) { return callback ( null ) ; } if ( this . indexes [ options . fieldName ] ) { return callback ( null ) }
this . indexes [ options . fieldName ] = new Index ( options ) ; this . indexes [ options . fieldName ] = new Index ( options )
if ( options . expireAfterSeconds !== undefined ) { this . ttlIndexes [ options . fieldName ] = options . expireAfterSeconds ; } // With this implementation index creation is not necessary to ensure TTL but we stick with MongoDB's API here
if ( options . expireAfterSeconds !== undefined ) { this . ttlIndexes [ options . fieldName ] = options . expireAfterSeconds } // With this implementation index creation is not necessary to ensure TTL but we stick with MongoDB's API here
try { try {
this . indexes [ options . fieldName ] . insert ( this . getAllData ( ) ) ; this . indexes [ options . fieldName ] . insert ( this . getAllData ( ) )
} catch ( e ) { } catch ( e ) {
delete this . indexes [ options . fieldName ] ; delete this . indexes [ options . fieldName ]
return callback ( e ) ; return callback ( e )
} }
// We may want to force all options to be persisted including defaults, not just the ones passed the index creation function
// We may want to force all options to be persisted including defaults, not just the ones passed the index creation function
this . persistence . persistNewState ( [ { $$indexCreated : options } ] , function ( err ) { this . persistence . persistNewState ( [ { $$indexCreated : options } ] , function ( err ) {
if ( err ) { return callback ( err ) ; } if ( err ) { return callback ( err ) }
return callback ( null ) ; return callback ( null )
} ) ; } )
} ; }
/ * * / * *
* Remove an index * Remove an index
* @ param { String } fieldName * @ param { String } fieldName
* @ param { Function } cb Optional callback , signature : err * @ param { Function } cb Optional callback , signature : err
* / * /
Datastore . prototype . removeIndex = function ( fieldName , cb ) { removeIndex ( fieldName , cb ) {
var callback = cb || function ( ) { } ; const callback = cb || function ( ) { }
delete this . indexes [ fieldName ] ; delete this . indexes [ fieldName ]
this . persistence . persistNewState ( [ { $$indexRemoved : fieldName } ] , function ( err ) { this . persistence . persistNewState ( [ { $$indexRemoved : fieldName } ] , function ( err ) {
if ( err ) { return callback ( err ) ; } if ( err ) { return callback ( err ) }
return callback ( null ) ; return callback ( null )
} ) ; } )
} ; }
/ * * / * *
* Add one or several document ( s ) to all indexes * Add one or several document ( s ) to all indexes
* / * /
Datastore . prototype . addToIndexes = function ( doc ) { addToIndexes ( doc ) {
var i , failingIndex , error let i
, keys = Object . keys ( this . indexes ) let failingIndex
; let error
const keys = Object . keys ( this . indexes )
for ( i = 0 ; i < keys . length ; i += 1 ) { for ( i = 0 ; i < keys . length ; i += 1 ) {
try { try {
this . indexes [ keys [ i ] ] . insert ( doc ) ; this . indexes [ keys [ i ] ] . insert ( doc )
} catch ( e ) { } catch ( e ) {
failingIndex = i ; failingIndex = i
error = e ; error = e
break ; break
} }
} }
// If an error happened, we need to rollback the insert on all other indexes
// If an error happened, we need to rollback the insert on all other indexes
if ( error ) { if ( error ) {
for ( i = 0 ; i < failingIndex ; i += 1 ) { for ( i = 0 ; i < failingIndex ; i += 1 ) {
this . indexes [ keys [ i ] ] . remove ( doc ) ; this . indexes [ keys [ i ] ] . remove ( doc )
} }
throw error ; throw error
}
} }
} ;
/ * * / * *
* Remove one or several document ( s ) from all indexes * Remove one or several document ( s ) from all indexes
* / * /
Datastore . prototype . removeFromIndexes = function ( doc ) { removeFromIndexes ( doc ) {
var self = this ; const self = this
Object . keys ( this . indexes ) . forEach ( function ( i ) { Object . keys ( this . indexes ) . forEach ( function ( i ) {
self . indexes [ i ] . remove ( doc ) ; self . indexes [ i ] . remove ( doc )
} ) ; } )
} ; }
/ * * / * *
* Update one or several documents in all indexes * Update one or several documents in all indexes
* To update multiple documents , oldDoc must be an array of { oldDoc , newDoc } pairs * To update multiple documents , oldDoc must be an array of { oldDoc , newDoc } pairs
* If one update violates a constraint , all changes are rolled back * If one update violates a constraint , all changes are rolled back
* / * /
Datastore . prototype . updateIndexes = function ( oldDoc , newDoc ) { updateIndexes ( oldDoc , newDoc ) {
var i , failingIndex , error let i
, keys = Object . keys ( this . indexes ) let failingIndex
; let error
const keys = Object . keys ( this . indexes )
for ( i = 0 ; i < keys . length ; i += 1 ) { for ( i = 0 ; i < keys . length ; i += 1 ) {
try { try {
this . indexes [ keys [ i ] ] . update ( oldDoc , newDoc ) ; this . indexes [ keys [ i ] ] . update ( oldDoc , newDoc )
} catch ( e ) { } catch ( e ) {
failingIndex = i ; failingIndex = i
error = e ; error = e
break ; break
} }
} }
// If an error happened, we need to rollback the update on all other indexes
// If an error happened, we need to rollback the update on all other indexes
if ( error ) { if ( error ) {
for ( i = 0 ; i < failingIndex ; i += 1 ) { for ( i = 0 ; i < failingIndex ; i += 1 ) {
this . indexes [ keys [ i ] ] . revertUpdate ( oldDoc , newDoc ) ; this . indexes [ keys [ i ] ] . revertUpdate ( oldDoc , newDoc )
} }
throw error ; throw error
}
} }
} ;
/ * * / * *
* Return the list of candidates for a given query * Return the list of candidates for a given query
@ -252,86 +246,88 @@ Datastore.prototype.updateIndexes = function (oldDoc, newDoc) {
* @ param { Boolean } dontExpireStaleDocs Optional , defaults to false , if true don 't remove stale docs. Useful for the remove function which shouldn' t be impacted by expirations * @ param { Boolean } dontExpireStaleDocs Optional , defaults to false , if true don 't remove stale docs. Useful for the remove function which shouldn' t be impacted by expirations
* @ param { Function } callback Signature err , candidates * @ param { Function } callback Signature err , candidates
* / * /
Datastore . prototype . getCandidates = function ( query , dontExpireStaleDocs , callback ) { getCandidates ( query , dontExpireStaleDocs , callback ) {
var indexNames = Object . keys ( this . indexes ) const indexNames = Object . keys ( this . indexes )
, self = this const self = this
, usableQueryKeys ; let usableQueryKeys
if ( typeof dontExpireStaleDocs === 'function' ) { if ( typeof dontExpireStaleDocs === 'function' ) {
callback = dontExpireStaleDocs ; callback = dontExpireStaleDocs
dontExpireStaleDocs = false ; dontExpireStaleDocs = false
} }
async . waterfall ( [ async . waterfall ( [
// STEP 1: get candidates list by checking indexes from most to least frequent usecase
// STEP 1: get candidates list by checking indexes from most to least frequent usecase
function ( cb ) { function ( cb ) {
// For a basic match
// For a basic match
usableQueryKeys = [ ] ; usableQueryKeys = [ ]
Object . keys ( query ) . forEach ( function ( k ) { Object . keys ( query ) . forEach ( function ( k ) {
if ( typeof query [ k ] === 'string' || typeof query [ k ] === 'number' || typeof query [ k ] === 'boolean' || util . isDate ( query [ k ] ) || query [ k ] === null ) { if ( typeof query [ k ] === 'string' || typeof query [ k ] === 'number' || typeof query [ k ] === 'boolean' || util . types . isDate ( query [ k ] ) || query [ k ] === null ) {
usableQueryKeys . push ( k ) ; usableQueryKeys . push ( k )
} }
} ) ; } )
usableQueryKeys = _ . intersection ( usableQueryKeys , indexNames ) ; usableQueryKeys = _ . intersection ( usableQueryKeys , indexNames )
if ( usableQueryKeys . length > 0 ) { if ( usableQueryKeys . length > 0 ) {
return cb ( null , self . indexes [ usableQueryKeys [ 0 ] ] . getMatching ( query [ usableQueryKeys [ 0 ] ] ) ) ; return cb ( null , self . indexes [ usableQueryKeys [ 0 ] ] . getMatching ( query [ usableQueryKeys [ 0 ] ] ) )
} }
// For a $in match
// For a $in match
usableQueryKeys = [ ] ; usableQueryKeys = [ ]
Object . keys ( query ) . forEach ( function ( k ) { Object . keys ( query ) . forEach ( function ( k ) {
if ( query [ k ] && query [ k ] . hasOwnProperty ( '$in' ) ) { if ( query [ k ] && Object . prototype . hasOwnProperty . call ( query [ k ] , '$in' ) ) {
usableQueryKeys . push ( k ) ; usableQueryKeys . push ( k )
} }
} ) ; } )
usableQueryKeys = _ . intersection ( usableQueryKeys , indexNames ) ; usableQueryKeys = _ . intersection ( usableQueryKeys , indexNames )
if ( usableQueryKeys . length > 0 ) { if ( usableQueryKeys . length > 0 ) {
return cb ( null , self . indexes [ usableQueryKeys [ 0 ] ] . getMatching ( query [ usableQueryKeys [ 0 ] ] . $in ) ) ; return cb ( null , self . indexes [ usableQueryKeys [ 0 ] ] . getMatching ( query [ usableQueryKeys [ 0 ] ] . $in ) )
} }
// For a comparison match
// For a comparison match
usableQueryKeys = [ ] ; usableQueryKeys = [ ]
Object . keys ( query ) . forEach ( function ( k ) { Object . keys ( query ) . forEach ( function ( k ) {
if ( query [ k ] && ( query [ k ] . hasOwnProperty ( '$lt' ) || query [ k ] . hasOwnProperty ( '$lte' ) || query [ k ] . hasOwnProperty ( '$gt' ) || query [ k ] . hasOwnProperty ( '$gte' ) ) ) { if ( query [ k ] && ( Object . prototype . hasOwnProperty . call ( query [ k ] , '$lt' ) || Object . prototype . hasOwnProperty . call ( query [ k ] , '$lte' ) || Object . prototype . hasOwnProperty . call ( query [ k ] , '$gt' ) || Object . prototype . hasOwnProperty . call ( query [ k ] , '$gte' ) ) ) {
usableQueryKeys . push ( k ) ; usableQueryKeys . push ( k )
} }
} ) ; } )
usableQueryKeys = _ . intersection ( usableQueryKeys , indexNames ) ; usableQueryKeys = _ . intersection ( usableQueryKeys , indexNames )
if ( usableQueryKeys . length > 0 ) { if ( usableQueryKeys . length > 0 ) {
return cb ( null , self . indexes [ usableQueryKeys [ 0 ] ] . getBetweenBounds ( query [ usableQueryKeys [ 0 ] ] ) ) ; return cb ( null , self . indexes [ usableQueryKeys [ 0 ] ] . getBetweenBounds ( query [ usableQueryKeys [ 0 ] ] ) )
} }
// By default, return all the DB data
// By default, return all the DB data
return cb ( null , self . getAllData ( ) ) ; return cb ( null , self . getAllData ( ) )
} } ,
// STEP 2: remove all expired documents
// STEP 2: remove all expired documents
, function ( docs ) { function ( docs ) {
if ( dontExpireStaleDocs ) { return callback ( null , docs ) ; } if ( dontExpireStaleDocs ) { return callback ( null , docs ) }
var expiredDocsIds = [ ] , validDocs = [ ] , ttlIndexesFieldNames = Object . keys ( self . ttlIndexes ) ; const expiredDocsIds = [ ]
const validDocs = [ ]
const ttlIndexesFieldNames = Object . keys ( self . ttlIndexes )
docs . forEach ( function ( doc ) { docs . forEach ( function ( doc ) {
var valid = true ; let valid = true
ttlIndexesFieldNames . forEach ( function ( i ) { ttlIndexesFieldNames . forEach ( function ( i ) {
if ( doc [ i ] !== undefined && util . isDate ( doc [ i ] ) && Date . now ( ) > doc [ i ] . getTime ( ) + self . ttlIndexes [ i ] * 1000 ) { if ( doc [ i ] !== undefined && util . types . isDate ( doc [ i ] ) && Date . now ( ) > doc [ i ] . getTime ( ) + self . ttlIndexes [ i ] * 1000 ) {
valid = false ; valid = false
} }
} ) ; } )
if ( valid ) { validDocs . push ( doc ) ; } else { expiredDocsIds . push ( doc . _id ) ; } if ( valid ) { validDocs . push ( doc ) } else { expiredDocsIds . push ( doc . _id ) }
} ) ; } )
async . eachSeries ( expiredDocsIds , function ( _id , cb ) { async . eachSeries ( expiredDocsIds , function ( _id , cb ) {
self . _remove ( { _id : _id } , { } , function ( err ) { self . _remove ( { _id : _id } , { } , function ( err ) {
if ( err ) { return callback ( err ) ; } if ( err ) { return callback ( err ) }
return cb ( ) ; return cb ( )
} ) ; } )
// eslint-disable-next-line node/handle-callback-err
} , function ( err ) { } , function ( err ) {
return callback ( null , validDocs ) ; // TODO: handle error
} ) ; return callback ( null , validDocs )
} ] ) ; } )
} ; } ] )
}
/ * * / * *
* Insert a new document * Insert a new document
@ -339,120 +335,120 @@ Datastore.prototype.getCandidates = function (query, dontExpireStaleDocs, callba
* *
* @ api private Use Datastore . insert which has the same signature * @ api private Use Datastore . insert which has the same signature
* / * /
Datastore . prototype . _insert = function ( newDoc , cb ) { _insert ( newDoc , cb ) {
var callback = cb || function ( ) { } const callback = cb || function ( ) { }
, preparedDoc let preparedDoc
;
try { try {
preparedDoc = this . prepareDocumentForInsertion ( newDoc ) preparedDoc = this . prepareDocumentForInsertion ( newDoc )
this . _insertInCache ( preparedDoc ) ; this . _insertInCache ( preparedDoc )
} catch ( e ) { } catch ( e ) {
return callback ( e ) ; return callback ( e )
} }
this . persistence . persistNewState ( util . isArray ( preparedDoc ) ? preparedDoc : [ preparedDoc ] , function ( err ) { this . persistence . persistNewState ( Array . isArray ( preparedDoc ) ? preparedDoc : [ preparedDoc ] , function ( err ) {
if ( err ) { return callback ( err ) ; } if ( err ) { return callback ( err ) }
return callback ( null , model . deepCopy ( preparedDoc ) ) ; return callback ( null , model . deepCopy ( preparedDoc ) )
} ) ; } )
} ; }
/ * * / * *
* Create a new _id that ' s not already in use * Create a new _id that ' s not already in use
* / * /
Datastore . prototype . createNewId = function ( ) { createNewId ( ) {
var tentativeId = customUtils . uid ( 16 ) ; let tentativeId = customUtils . uid ( 16 )
// Try as many times as needed to get an unused _id. As explained in customUtils, the probability of this ever happening is extremely small, so this is O(1)
// Try as many times as needed to get an unused _id. As explained in customUtils, the probability of this ever happening is extremely small, so this is O(1)
if ( this . indexes . _id . getMatching ( tentativeId ) . length > 0 ) { if ( this . indexes . _id . getMatching ( tentativeId ) . length > 0 ) {
tentativeId = this . createNewId ( ) ; tentativeId = this . createNewId ( )
}
return tentativeId
} }
return tentativeId ;
} ;
/ * * / * *
* Prepare a document ( or array of documents ) to be inserted in a database * Prepare a document ( or array of documents ) to be inserted in a database
* Meaning adds _id and timestamps if necessary on a copy of newDoc to avoid any side effect on user input * Meaning adds _id and timestamps if necessary on a copy of newDoc to avoid any side effect on user input
* @ api private * @ api private
* / * /
Datastore . prototype . prepareDocumentForInsertion = function ( newDoc ) { prepareDocumentForInsertion ( newDoc ) {
var preparedDoc , self = this ; let preparedDoc
const self = this
if ( util . isArray ( newDoc ) ) { if ( Array . isArray ( newDoc ) ) {
preparedDoc = [ ] ; preparedDoc = [ ]
newDoc . forEach ( function ( doc ) { preparedDoc . push ( self . prepareDocumentForInsertion ( doc ) ) ; } ) ; newDoc . forEach ( function ( doc ) { preparedDoc . push ( self . prepareDocumentForInsertion ( doc ) ) } )
} else { } else {
preparedDoc = model . deepCopy ( newDoc ) ; preparedDoc = model . deepCopy ( newDoc )
if ( preparedDoc . _id === undefined ) { preparedDoc . _id = this . createNewId ( ) ; } if ( preparedDoc . _id === undefined ) { preparedDoc . _id = this . createNewId ( ) }
var now = new Date ( ) ; const now = new Date ( )
if ( this . timestampData && preparedDoc . createdAt === undefined ) { preparedDoc . createdAt = now ; } if ( this . timestampData && preparedDoc . createdAt === undefined ) { preparedDoc . createdAt = now }
if ( this . timestampData && preparedDoc . updatedAt === undefined ) { preparedDoc . updatedAt = now ; } if ( this . timestampData && preparedDoc . updatedAt === undefined ) { preparedDoc . updatedAt = now }
model . checkObject ( preparedDoc ) ; model . checkObject ( preparedDoc )
} }
return preparedDoc ; return preparedDoc
} ; }
/ * * / * *
* If newDoc is an array of documents , this will insert all documents in the cache * If newDoc is an array of documents , this will insert all documents in the cache
* @ api private * @ api private
* / * /
Datastore . prototype . _insertInCache = function ( preparedDoc ) { _insertInCache ( preparedDoc ) {
if ( util . isArray ( preparedDoc ) ) { if ( Array . isArray ( preparedDoc ) ) {
this . _insertMultipleDocsInCache ( preparedDoc ) ; this . _insertMultipleDocsInCache ( preparedDoc )
} else { } else {
this . addToIndexes ( preparedDoc ) ; this . addToIndexes ( preparedDoc )
}
} }
} ;
/ * * / * *
* If one insertion fails ( e . g . because of a unique constraint ) , roll back all previous * If one insertion fails ( e . g . because of a unique constraint ) , roll back all previous
* inserts and throws the error * inserts and throws the error
* @ api private * @ api private
* / * /
Datastore . prototype . _insertMultipleDocsInCache = function ( preparedDocs ) { _insertMultipleDocsInCache ( preparedDocs ) {
var i , failingI , error ; let i
let failingI
let error
for ( i = 0 ; i < preparedDocs . length ; i += 1 ) { for ( i = 0 ; i < preparedDocs . length ; i += 1 ) {
try { try {
this . addToIndexes ( preparedDocs [ i ] ) ; this . addToIndexes ( preparedDocs [ i ] )
} catch ( e ) { } catch ( e ) {
error = e ; error = e
failingI = i ; failingI = i
break ; break
} }
} }
if ( error ) { if ( error ) {
for ( i = 0 ; i < failingI ; i += 1 ) { for ( i = 0 ; i < failingI ; i += 1 ) {
this . removeFromIndexes ( preparedDocs [ i ] ) ; this . removeFromIndexes ( preparedDocs [ i ] )
} }
throw error ; throw error
}
} }
} ;
Datastore . prototype . insert = function ( ) {
this . executor . push ( { this : this , fn : this . _insert , arguments : arguments } ) ;
} ;
insert ( ) {
this . executor . push ( { this : this , fn : this . _insert , arguments : arguments } )
}
/ * * / * *
* Count all documents matching the query * Count all documents matching the query
* @ param { Object } query MongoDB - style query * @ param { Object } query MongoDB - style query
* / * /
Datastore . prototype . count = function ( query , callback ) { count ( query , callback ) {
var cursor = new Cursor ( this , query , function ( err , docs , callback ) { const cursor = new Cursor ( this , query , function ( err , docs , callback ) {
if ( err ) { return callback ( err ) ; } if ( err ) { return callback ( err ) }
return callback ( null , docs . length ) ; return callback ( null , docs . length )
} ) ; } )
if ( typeof callback === 'function' ) { if ( typeof callback === 'function' ) {
cursor . exec ( callback ) ; cursor . exec ( callback )
} else { } else {
return cursor ; return cursor
}
} }
} ;
/ * * / * *
* Find all documents matching the query * Find all documents matching the query
@ -460,76 +456,75 @@ Datastore.prototype.count = function(query, callback) {
* @ param { Object } query MongoDB - style query * @ param { Object } query MongoDB - style query
* @ param { Object } projection MongoDB - style projection * @ param { Object } projection MongoDB - style projection
* / * /
Datastore . prototype . find = function ( query , projection , callback ) { find ( query , projection , callback ) {
switch ( arguments . length ) { switch ( arguments . length ) {
case 1 : case 1 :
projection = { } ; projection = { }
// callback is undefined, will return a cursor
// callback is undefined, will return a cursor
break ; break
case 2 : case 2 :
if ( typeof projection === 'function' ) { if ( typeof projection === 'function' ) {
callback = projection ; callback = projection
projection = { } ; projection = { }
} // If not assume projection is an object and callback undefined
} // If not assume projection is an object and callback undefined
break ; break
} }
var cursor = new Cursor ( this , query , function ( err , docs , callback ) { const cursor = new Cursor ( this , query , function ( err , docs , callback ) {
var res = [ ] , i ; const res = [ ]
let i
if ( err ) { return callback ( err ) ; } if ( err ) { return callback ( err ) }
for ( i = 0 ; i < docs . length ; i += 1 ) { for ( i = 0 ; i < docs . length ; i += 1 ) {
res . push ( model . deepCopy ( docs [ i ] ) ) ; res . push ( model . deepCopy ( docs [ i ] ) )
} }
return callback ( null , res ) ; return callback ( null , res )
} ) ; } )
cursor . projection ( projection ) ; cursor . projection ( projection )
if ( typeof callback === 'function' ) { if ( typeof callback === 'function' ) {
cursor . exec ( callback ) ; cursor . exec ( callback )
} else { } else {
return cursor ; return cursor
}
} }
} ;
/ * * / * *
* Find one document matching the query * Find one document matching the query
* @ param { Object } query MongoDB - style query * @ param { Object } query MongoDB - style query
* @ param { Object } projection MongoDB - style projection * @ param { Object } projection MongoDB - style projection
* / * /
Datastore . prototype . findOne = function ( query , projection , callback ) { findOne ( query , projection , callback ) {
switch ( arguments . length ) { switch ( arguments . length ) {
case 1 : case 1 :
projection = { } ; projection = { }
// callback is undefined, will return a cursor
// callback is undefined, will return a cursor
break ; break
case 2 : case 2 :
if ( typeof projection === 'function' ) { if ( typeof projection === 'function' ) {
callback = projection ; callback = projection
projection = { } ; projection = { }
} // If not assume projection is an object and callback undefined
} // If not assume projection is an object and callback undefined
break ; break
} }
var cursor = new Cursor ( this , query , function ( err , docs , callback ) { const cursor = new Cursor ( this , query , function ( err , docs , callback ) {
if ( err ) { return callback ( err ) ; } if ( err ) { return callback ( err ) }
if ( docs . length === 1 ) { if ( docs . length === 1 ) {
return callback ( null , model . deepCopy ( docs [ 0 ] ) ) ; return callback ( null , model . deepCopy ( docs [ 0 ] ) )
} else { } else {
return callback ( null , null ) ; return callback ( null , null )
} }
} ) ; } )
cursor . projection ( projection ) . limit ( 1 ) ; cursor . projection ( projection ) . limit ( 1 )
if ( typeof callback === 'function' ) { if ( typeof callback === 'function' ) {
cursor . exec ( callback ) ; cursor . exec ( callback )
} else { } else {
return cursor ; return cursor
}
} }
} ;
/ * * / * *
* Update all docs matching query * Update all docs matching query
@ -556,106 +551,107 @@ Datastore.prototype.findOne = function (query, projection, callback) {
* *
* @ api private Use Datastore . update which has the same signature * @ api private Use Datastore . update which has the same signature
* / * /
Datastore . prototype . _update = function ( query , updateQuery , options , cb ) { _update ( query , updateQuery , options , cb ) {
var callback const self = this
, self = this let numReplaced = 0
, numReplaced = 0 let i
, multi , upsert
, i if ( typeof options === 'function' ) {
; cb = options
options = { }
if ( typeof options === 'function' ) { cb = options ; options = { } ; } }
callback = cb || function ( ) { } ; const callback = cb || function ( ) { }
multi = options . multi !== undefined ? options . multi : false ; const multi = options . multi !== undefined ? options . multi : false
upsert = options . upsert !== undefined ? options . upsert : false ; const upsert = options . upsert !== undefined ? options . upsert : false
async . waterfall ( [ async . waterfall ( [
function ( cb ) { // If upsert option is set, check whether we need to insert the doc
function ( cb ) { // If upsert option is set, check whether we need to insert the doc
if ( ! upsert ) { return cb ( ) ; } if ( ! upsert ) { return cb ( ) }
// Need to use an internal function not tied to the executor to avoid deadlock
// Need to use an internal function not tied to the executor to avoid deadlock
var cursor = new Cursor ( self , query ) ; const cursor = new Cursor ( self , query )
cursor . limit ( 1 ) . _exec ( function ( err , docs ) { cursor . limit ( 1 ) . _exec ( function ( err , docs ) {
if ( err ) { return callback ( err ) ; } if ( err ) { return callback ( err ) }
if ( docs . length === 1 ) { if ( docs . length === 1 ) {
return cb ( ) ; return cb ( )
} else { } else {
var toBeInserted ; let toBeInserted
try { try {
model . checkObject ( updateQuery ) ; model . checkObject ( updateQuery )
// updateQuery is a simple object with no modifier, use it as the document to insert
// updateQuery is a simple object with no modifier, use it as the document to insert
toBeInserted = updateQuery ; toBeInserted = updateQuery
} catch ( e ) { } catch ( e ) {
// updateQuery contains modifiers, use the find query as the base,
// updateQuery contains modifiers, use the find query as the base,
// strip it from all operators and update it according to updateQuery
// strip it from all operators and update it according to updateQuery
try { try {
toBeInserted = model . modify ( model . deepCopy ( query , true ) , updateQuery ) ; toBeInserted = model . modify ( model . deepCopy ( query , true ) , updateQuery )
} catch ( err ) { } catch ( err ) {
return callback ( err ) ; return callback ( err )
} }
} }
return self . _insert ( toBeInserted , function ( err , newDoc ) { return self . _insert ( toBeInserted , function ( err , newDoc ) {
if ( err ) { return callback ( err ) ; } if ( err ) { return callback ( err ) }
return callback ( null , 1 , newDoc , true ) ; return callback ( null , 1 , newDoc , true )
} ) ; } )
} }
} ) ; } )
} } ,
, function ( ) { // Perform the update
function ( ) { // Perform the update
var modifiedDoc , modifications = [ ] , createdAt ; let modifiedDoc
const modifications = [ ]
let createdAt
self . getCandidates ( query , function ( err , candidates ) { self . getCandidates ( query , function ( err , candidates ) {
if ( err ) { return callback ( err ) ; } if ( err ) { return callback ( err ) }
// Preparing update (if an error is thrown here neither the datafile nor
// Preparing update (if an error is thrown here neither the datafile nor
// the in-memory indexes are affected)
// the in-memory indexes are affected)
try { try {
for ( i = 0 ; i < candidates . length ; i += 1 ) { for ( i = 0 ; i < candidates . length ; i += 1 ) {
if ( model . match ( candidates [ i ] , query ) && ( multi || numReplaced === 0 ) ) { if ( model . match ( candidates [ i ] , query ) && ( multi || numReplaced === 0 ) ) {
numReplaced += 1 ; numReplaced += 1
if ( self . timestampData ) { createdAt = candidates [ i ] . createdAt ; } if ( self . timestampData ) { createdAt = candidates [ i ] . createdAt }
modifiedDoc = model . modify ( candidates [ i ] , updateQuery ) ; modifiedDoc = model . modify ( candidates [ i ] , updateQuery )
if ( self . timestampData ) { if ( self . timestampData ) {
modifiedDoc . createdAt = createdAt ; modifiedDoc . createdAt = createdAt
modifiedDoc . updatedAt = new Date ( ) ; modifiedDoc . updatedAt = new Date ( )
} }
modifications . push ( { oldDoc : candidates [ i ] , newDoc : modifiedDoc } ) ; modifications . push ( { oldDoc : candidates [ i ] , newDoc : modifiedDoc } )
} }
} }
} catch ( err ) { } catch ( err ) {
return callback ( err ) ; return callback ( err )
} }
// Change the docs in memory
// Change the docs in memory
try { try {
self . updateIndexes ( modifications ) ; self . updateIndexes ( modifications )
} catch ( err ) { } catch ( err ) {
return callback ( err ) ; return callback ( err )
} }
// Update the datafile
// Update the datafile
var updatedDocs = _ . pluck ( modifications , 'newDoc' ) ; const updatedDocs = _ . pluck ( modifications , 'newDoc' )
self . persistence . persistNewState ( updatedDocs , function ( err ) { self . persistence . persistNewState ( updatedDocs , function ( err ) {
if ( err ) { return callback ( err ) ; } if ( err ) { return callback ( err ) }
if ( ! options . returnUpdatedDocs ) { if ( ! options . returnUpdatedDocs ) {
return callback ( null , numReplaced ) ; return callback ( null , numReplaced )
} else { } else {
var updatedDocsDC = [ ] ; let updatedDocsDC = [ ]
updatedDocs . forEach ( function ( doc ) { updatedDocsDC . push ( model . deepCopy ( doc ) ) ; } ) ; updatedDocs . forEach ( function ( doc ) { updatedDocsDC . push ( model . deepCopy ( doc ) ) } )
if ( ! multi ) { updatedDocsDC = updatedDocsDC [ 0 ] ; } if ( ! multi ) { updatedDocsDC = updatedDocsDC [ 0 ] }
return callback ( null , numReplaced , updatedDocsDC ) ; return callback ( null , numReplaced , updatedDocsDC )
}
} )
} )
} ] )
} }
} ) ;
} ) ;
} ] ) ;
} ;
Datastore . prototype . update = function ( ) {
this . executor . push ( { this : this , fn : this . _update , arguments : arguments } ) ;
} ;
update ( ) {
this . executor . push ( { this : this , fn : this . _update , arguments : arguments } )
}
/ * * / * *
* Remove all docs matching the query * Remove all docs matching the query
@ -667,39 +663,43 @@ Datastore.prototype.update = function () {
* *
* @ api private Use Datastore . remove which has the same signature * @ api private Use Datastore . remove which has the same signature
* / * /
Datastore . prototype . _remove = function ( query , options , cb ) { _remove ( query , options , cb ) {
var callback const self = this
, self = this , numRemoved = 0 , removedDocs = [ ] , multi let numRemoved = 0
; const removedDocs = [ ]
if ( typeof options === 'function' ) { cb = options ; options = { } ; } if ( typeof options === 'function' ) {
callback = cb || function ( ) { } ; cb = options
multi = options . multi !== undefined ? options . multi : false ; options = { }
}
const callback = cb || function ( ) { }
const multi = options . multi !== undefined ? options . multi : false
this . getCandidates ( query , true , function ( err , candidates ) { this . getCandidates ( query , true , function ( err , candidates ) {
if ( err ) { return callback ( err ) ; } if ( err ) { return callback ( err ) }
try { try {
candidates . forEach ( function ( d ) { candidates . forEach ( function ( d ) {
if ( model . match ( d , query ) && ( multi || numRemoved === 0 ) ) { if ( model . match ( d , query ) && ( multi || numRemoved === 0 ) ) {
numRemoved += 1 ; numRemoved += 1
removedDocs . push ( { $$deleted : true , _id : d . _id } ) ; removedDocs . push ( { $$deleted : true , _id : d . _id } )
self . removeFromIndexes ( d ) ; self . removeFromIndexes ( d )
} }
} ) ; } )
} catch ( err ) { return callback ( err ) ; } } catch ( err ) { return callback ( err ) }
self . persistence . persistNewState ( removedDocs , function ( err ) { self . persistence . persistNewState ( removedDocs , function ( err ) {
if ( err ) { return callback ( err ) ; } if ( err ) { return callback ( err ) }
return callback ( null , numRemoved ) ; return callback ( null , numRemoved )
} ) ; } )
} ) ; } )
} ; }
Datastore . prototype . remove = function ( ) {
this . executor . push ( { this : this , fn : this . _remove , arguments : arguments } ) ;
} ;
remove ( ) {
this . executor . push ( { this : this , fn : this . _remove , arguments : arguments } )
}
}
util . inherits ( Datastore , require ( 'events' ) . EventEmitter )
module . exports = Datastore ; module . exports = Datastore
Timothée Rebours
4 years ago