api documentation for tingodb (v0.5.1)

Embedded Node.js database upward compatible with MongoDB

table of contents

  1. module tingodb
    1. function tingodb (opts)
    2. function tingodb.ObjectId (val)
    3. function tingodb.db ()
    4. function tingodb.tcache (tdb, size)
    5. function tingodb.tcoll (tdb)
    6. function tingodb.tcursor (tcoll, query, fields, opts)
    7. function tingodb.tdb (path_, opts, gopts)
    8. function tingodb.tindex (key, tcoll, options, name)
    9. function tingodb.tstream (cursor, options)
    10. function tingodb.wqueue (limit, first)
    11. object tingodb.ObjectId.prototype
    12. object tingodb.db.prototype
    13. object tingodb.tbinary
    14. object tingodb.tcache.prototype
    15. object tingodb.tcode
    16. object tingodb.tcoll.prototype
    17. object tingodb.tcursor.prototype
    18. object tingodb.tdb.prototype
    19. object tingodb.tindex.prototype
    20. object tingodb.tstream.prototype
    21. object tingodb.utils
    22. object tingodb.wqueue.prototype
  2. module tingodb.ObjectId
    1. function tingodb.ObjectId (val)
    2. function tingodb.ObjectId.createFromHexString (str)
    3. function tingodb.ObjectId.createFromString (str)
  3. module tingodb.ObjectId.prototype
    1. function tingodb.ObjectId.prototype._init (val)
    2. function tingodb.ObjectId.prototype._persist (v)
    3. function tingodb.ObjectId.prototype.equals (val)
    4. function tingodb.ObjectId.prototype.inspect ()
    5. function tingodb.ObjectId.prototype.toHexString ()
    6. function tingodb.ObjectId.prototype.toJSON ()
    7. function tingodb.ObjectId.prototype.toString ()
    8. function tingodb.ObjectId.prototype.valueOf ()
  4. module tingodb.db
    1. function tingodb.db ()
  5. module tingodb.db.prototype
    1. function tingodb.db.prototype.init (path, options, cb)
  6. module tingodb.tbinary
    1. function tingodb.tbinary.Binary (buffer, subType)
  7. module tingodb.tcache
    1. function tingodb.tcache (tdb, size)
  8. module tingodb.tcache.prototype
    1. function tingodb.tcache.prototype.clear ()
    2. function tingodb.tcache.prototype.get (k, unsafe)
    3. function tingodb.tcache.prototype.set (k, v)
    4. function tingodb.tcache.prototype.unset (k)
  9. module tingodb.tcode
    1. function tingodb.tcode.Code (code, scope)
  10. module tingodb.tcoll
    1. function tingodb.tcoll (tdb)
  11. module tingodb.tcoll.prototype
    1. function tingodb.tcoll.prototype.__find (query, fields, skip, limit, sort, hint, arFields, cb)
    2. function tingodb.tcoll.prototype._bestSortIndex (sort)
    3. function tingodb.tcoll.prototype._compact (cb)
    4. function tingodb.tcoll.prototype._ensureIds (obj)
    5. function tingodb.tcoll.prototype._find (query, fields, skip, limit, sort_, hint, arFields, cb)
    6. function tingodb.tcoll.prototype._getFS (pos, unsafe, cb)
    7. function tingodb.tcoll.prototype._getM (pos, unsafe, cb)
    8. function tingodb.tcoll.prototype._putFS (item, remove, cb)
    9. function tingodb.tcoll.prototype._putM (item_, remove, cb)
    10. function tingodb.tcoll.prototype._refreshIndexes (cb)
    11. function tingodb.tcoll.prototype._stop (cb)
    12. function tingodb.tcoll.prototype._unwrapTypes (obj)
    13. function tingodb.tcoll.prototype._wrapTypes (obj)
    14. function tingodb.tcoll.prototype.compactCollection (cb)
    15. function tingodb.tcoll.prototype.count (query, options, cb)
    16. function tingodb.tcoll.prototype.createIndex (obj, options, cb)
    17. function tingodb.tcoll.prototype.drop (cb)
    18. function tingodb.tcoll.prototype.ensureIndex (obj, options, cb)
    19. function tingodb.tcoll.prototype.find ()
    20. function tingodb.tcoll.prototype.findAndModify (query, sort, doc, opts, cb)
    21. function tingodb.tcoll.prototype.findAndRemove (query, sort, opts, cb)
    22. function tingodb.tcoll.prototype.findOne ()
    23. function tingodb.tcoll.prototype.group ()
    24. function tingodb.tcoll.prototype.indexExists (idx, cb)
    25. function tingodb.tcoll.prototype.indexes (cb)
    26. function tingodb.tcoll.prototype.initFS (tdb, name, options, create, cb)
    27. function tingodb.tcoll.prototype.initM (tdb, name, options, create, cb)
    28. function tingodb.tcoll.prototype.insert (docs, opts, cb )
    29. function tingodb.tcoll.prototype.mapReduce (map, reduce, opts, cb)
    30. function tingodb.tcoll.prototype.remove (query, opts, cb)
    31. function tingodb.tcoll.prototype.rename (nname, opts, cb)
    32. function tingodb.tcoll.prototype.save (doc, opts, cb)
    33. function tingodb.tcoll.prototype.stats (cb)
    34. function tingodb.tcoll.prototype.update (query, doc, opts, cb)
  12. module tingodb.tcursor
    1. function tingodb.tcursor (tcoll, query, fields, opts)
  13. module tingodb.tcursor.prototype
    1. function tingodb.tcursor.prototype._ensure (cb)
    2. function tingodb.tcursor.prototype._get (pos, cb)
    3. function tingodb.tcursor.prototype._projectFields (obj)
    4. function tingodb.tcursor.prototype.batchSize (v, cb)
    5. function tingodb.tcursor.prototype.close (cb)
    6. function tingodb.tcursor.prototype.count (applySkipLimit, cb)
    7. function tingodb.tcursor.prototype.each (cb)
    8. function tingodb.tcursor.prototype.isClosed ()
    9. function tingodb.tcursor.prototype.limit (v, cb)
    10. function tingodb.tcursor.prototype.nextObject (cb)
    11. function tingodb.tcursor.prototype.rewind ()
    12. function tingodb.tcursor.prototype.setReadPreference (the, cb)
    13. function tingodb.tcursor.prototype.skip (v, cb)
    14. function tingodb.tcursor.prototype.sort (v, d, cb)
    15. function tingodb.tcursor.prototype.stream (options)
    16. function tingodb.tcursor.prototype.toArray (cb)
  14. module tingodb.tdb
    1. function tingodb.tdb (path_, opts, gopts)
  15. module tingodb.tdb.prototype
    1. function tingodb.tdb.prototype._cloneDeep (obj)
    2. function tingodb.tdb.prototype._collection (cname, opts, create, cb)
    3. function tingodb.tdb.prototype._nameCheck (cname)
    4. function tingodb.tdb.prototype.close (forceClose, cb)
    5. function tingodb.tdb.prototype.collection (cname, opts, cb)
    6. function tingodb.tdb.prototype.collectionNames (opts, cb)
    7. function tingodb.tdb.prototype.collections (cb)
    8. function tingodb.tdb.prototype.compactDatabase (cb)
    9. function tingodb.tdb.prototype.createCollection (cname, opts, cb)
    10. function tingodb.tdb.prototype.createIndex ()
    11. function tingodb.tdb.prototype.dropCollection (cname, cb)
    12. function tingodb.tdb.prototype.dropDatabase (cb)
    13. function tingodb.tdb.prototype.open (options, cb)
    14. function tingodb.tdb.prototype.renameCollection (on, nn, opts, cb)
  16. module tingodb.tindex
    1. function tingodb.tindex (key, tcoll, options, name)
  17. module tingodb.tindex.prototype
    1. function tingodb.tindex.prototype._del (k, v, o)
    2. function tingodb.tindex.prototype._set (k, v, o)
    3. function tingodb.tindex.prototype.all (order, shallow)
    4. function tingodb.tindex.prototype.clear ()
    5. function tingodb.tindex.prototype.count ()
    6. function tingodb.tindex.prototype.del (k_, v)
    7. function tingodb.tindex.prototype.depth ()
    8. function tingodb.tindex.prototype.fields ()
    9. function tingodb.tindex.prototype.inspect (depth)
    10. function tingodb.tindex.prototype.match (k)
    11. function tingodb.tindex.prototype.nuls ()
    12. function tingodb.tindex.prototype.range (s, e, si, ei)
    13. function tingodb.tindex.prototype.set (k_, v, check)
    14. function tingodb.tindex.prototype.values ()
  18. module tingodb.tstream
    1. function tingodb.tstream (cursor, options)
  19. module tingodb.tstream.prototype
    1. function tingodb.tstream.prototype._init ()
    2. function tingodb.tstream.prototype._next ()
    3. function tingodb.tstream.prototype._onNextObject (err, doc)
    4. function tingodb.tstream.prototype.destroy (err)
    5. function tingodb.tstream.prototype.pause ()
    6. function tingodb.tstream.prototype.resume ()
  20. module tingodb.utils
    1. function tingodb.utils.intersectIndexes (indexes, base)
  21. module tingodb.wqueue
    1. function tingodb.wqueue (limit, first)
  22. module tingodb.wqueue.prototype
    1. function tingodb.wqueue.prototype._exec (task, block, cb)
    2. function tingodb.wqueue.prototype._ping ()
    3. function tingodb.wqueue.prototype.add (task, block, cb)

module tingodb

function tingodb (opts)

function tingodb.ObjectId (val)

function tingodb.db ()

function tingodb.tcache (tdb, size)

function tingodb.tcoll (tdb)

function tingodb.tcursor (tcoll, query, fields, opts)

function tingodb.tdb (path_, opts, gopts)

function tingodb.tindex (key, tcoll, options, name)

function tingodb.tstream (cursor, options)

function tingodb.wqueue (limit, first)

module tingodb.ObjectId

function tingodb.ObjectId (val)

function tingodb.ObjectId.createFromHexString (str)

function tingodb.ObjectId.createFromString (str)

module tingodb.ObjectId.prototype

function tingodb.ObjectId.prototype._init (val)

function tingodb.ObjectId.prototype._persist (v)

function tingodb.ObjectId.prototype.equals (val)

function tingodb.ObjectId.prototype.inspect ()

function tingodb.ObjectId.prototype.toHexString ()

function tingodb.ObjectId.prototype.toJSON ()

function tingodb.ObjectId.prototype.toString ()

function tingodb.ObjectId.prototype.valueOf ()

module tingodb.db

function tingodb.db ()

module tingodb.db.prototype

function tingodb.db.prototype.init (path, options, cb)

module tingodb.tbinary

function tingodb.tbinary.Binary (buffer, subType)

module tingodb.tcache

function tingodb.tcache (tdb, size)

module tingodb.tcache.prototype

function tingodb.tcache.prototype.clear ()

function tingodb.tcache.prototype.get (k, unsafe)

function tingodb.tcache.prototype.set (k, v)

function tingodb.tcache.prototype.unset (k)

module tingodb.tcode

function tingodb.tcode.Code (code, scope)

module tingodb.tcoll

function tingodb.tcoll (tdb)

module tingodb.tcoll.prototype

function tingodb.tcoll.prototype.__find (query, fields, skip, limit, sort, hint, arFields, cb)

function tingodb.tcoll.prototype._bestSortIndex (sort)

function tingodb.tcoll.prototype._compact (cb)

function tingodb.tcoll.prototype._ensureIds (obj)

function tingodb.tcoll.prototype._find (query, fields, skip, limit, sort_, hint, arFields, cb)

function tingodb.tcoll.prototype._getFS (pos, unsafe, cb)

function tingodb.tcoll.prototype._getM (pos, unsafe, cb)

function tingodb.tcoll.prototype._putFS (item, remove, cb)

function tingodb.tcoll.prototype._putM (item_, remove, cb)

function tingodb.tcoll.prototype._refreshIndexes (cb)

function tingodb.tcoll.prototype._stop (cb)

function tingodb.tcoll.prototype._unwrapTypes (obj)

function tingodb.tcoll.prototype._wrapTypes (obj)

function tingodb.tcoll.prototype.compactCollection (cb)

function tingodb.tcoll.prototype.count (query, options, cb)

function tingodb.tcoll.prototype.createIndex (obj, options, cb)

function tingodb.tcoll.prototype.drop (cb)

function tingodb.tcoll.prototype.ensureIndex (obj, options, cb)

function tingodb.tcoll.prototype.find ()

function tingodb.tcoll.prototype.findAndModify (query, sort, doc, opts, cb)

function tingodb.tcoll.prototype.findAndRemove (query, sort, opts, cb)

function tingodb.tcoll.prototype.findOne ()

function tingodb.tcoll.prototype.group ()

function tingodb.tcoll.prototype.indexExists (idx, cb)

function tingodb.tcoll.prototype.indexes (cb)

function tingodb.tcoll.prototype.initFS (tdb, name, options, create, cb)

function tingodb.tcoll.prototype.initM (tdb, name, options, create, cb)

function tingodb.tcoll.prototype.insert (docs, opts, cb )

function tingodb.tcoll.prototype.mapReduce (map, reduce, opts, cb)

function tingodb.tcoll.prototype.remove (query, opts, cb)

function tingodb.tcoll.prototype.rename (nname, opts, cb)

function tingodb.tcoll.prototype.save (doc, opts, cb)

function tingodb.tcoll.prototype.stats (cb)

function tingodb.tcoll.prototype.update (query, doc, opts, cb)

module tingodb.tcursor

function tingodb.tcursor (tcoll, query, fields, opts)

module tingodb.tcursor.prototype

function tingodb.tcursor.prototype._ensure (cb)

function tingodb.tcursor.prototype._get (pos, cb)

function tingodb.tcursor.prototype._projectFields (obj)

function tingodb.tcursor.prototype.batchSize (v, cb)

function tingodb.tcursor.prototype.close (cb)

function tingodb.tcursor.prototype.count (applySkipLimit, cb)

function tingodb.tcursor.prototype.each (cb)

function tingodb.tcursor.prototype.isClosed ()

function tingodb.tcursor.prototype.limit (v, cb)

function tingodb.tcursor.prototype.nextObject (cb)

function tingodb.tcursor.prototype.rewind ()

function tingodb.tcursor.prototype.setReadPreference (the, cb)

function tingodb.tcursor.prototype.skip (v, cb)

function tingodb.tcursor.prototype.sort (v, d, cb)

function tingodb.tcursor.prototype.stream (options)

function tingodb.tcursor.prototype.toArray (cb)

module tingodb.tdb

function tingodb.tdb (path_, opts, gopts)

module tingodb.tdb.prototype

function tingodb.tdb.prototype._cloneDeep (obj)

function tingodb.tdb.prototype._collection (cname, opts, create, cb)

function tingodb.tdb.prototype._nameCheck (cname)

function tingodb.tdb.prototype.close (forceClose, cb)

function tingodb.tdb.prototype.collection (cname, opts, cb)

function tingodb.tdb.prototype.collectionNames (opts, cb)

function tingodb.tdb.prototype.collections (cb)

function tingodb.tdb.prototype.compactDatabase (cb)

function tingodb.tdb.prototype.createCollection (cname, opts, cb)

function tingodb.tdb.prototype.createIndex ()

function tingodb.tdb.prototype.dropCollection (cname, cb)

function tingodb.tdb.prototype.dropDatabase (cb)

function tingodb.tdb.prototype.open (options, cb)

function tingodb.tdb.prototype.renameCollection (on, nn, opts, cb)

module tingodb.tindex

function tingodb.tindex (key, tcoll, options, name)

module tingodb.tindex.prototype

function tingodb.tindex.prototype._del (k, v, o)

function tingodb.tindex.prototype._set (k, v, o)

function tingodb.tindex.prototype.all (order, shallow)

function tingodb.tindex.prototype.clear ()

function tingodb.tindex.prototype.count ()

function tingodb.tindex.prototype.del (k_, v)

function tingodb.tindex.prototype.depth ()

function tingodb.tindex.prototype.fields ()

function tingodb.tindex.prototype.inspect (depth)

function tingodb.tindex.prototype.match (k)

function tingodb.tindex.prototype.nuls ()

function tingodb.tindex.prototype.range (s, e, si, ei)

function tingodb.tindex.prototype.set (k_, v, check)

function tingodb.tindex.prototype.values ()

module tingodb.tstream

function tingodb.tstream (cursor, options)

module tingodb.tstream.prototype

function tingodb.tstream.prototype._init ()

function tingodb.tstream.prototype._next ()

function tingodb.tstream.prototype._onNextObject (err, doc)

function tingodb.tstream.prototype.destroy (err)

function tingodb.tstream.prototype.pause ()

function tingodb.tstream.prototype.resume ()

module tingodb.utils

function tingodb.utils.intersectIndexes (indexes, base)

module tingodb.wqueue

function tingodb.wqueue (limit, first)

module tingodb.wqueue.prototype

function tingodb.wqueue.prototype._exec (task, block, cb)

function tingodb.wqueue.prototype._ping ()

function tingodb.wqueue.prototype.add (task, block, cb)

[ this document was created with utility2 ]