Class Collection<ColT>

Adaptively insert a selected item to the index.

Adaptively remove a selected item from the index.

Adaptively update a selected item within an index.

Add object to collection

Add a dynamic view to the collection

Returns

reference to the dynamic view added

Example

var pview = users.addDynamicView('progeny');
pview.applyFind({'age': {'$lte': 40}});
pview.applySimpleSort('name');

var results = pview.data();

Adds a named collection transform to the collection

Example

users.addTransform('progeny', [
  {
    type: 'find',
    value: {
      'age': {'$lte': 40}
    }
  }
]);

var results = users.chain('progeny').data();

Calculates the average numerical value of a property

Returns

average of property in all docs in the collection

Retrieve doc by Unique index

Returns

document matching the value passed

calculateRange() - Binary Search utility method to find range/segment of values matching criteria. this is used for collection.find() and first find filter of resultset/dynview slightly different than get() binary search in that get() hones in on 1 value, but we have to hone in on many (range)

Returns

[start, end] index array positions

Internal method used for indexed $between. Given a prop (index name), and a value (which may or may not yet exist) this will find the final position of that upper range value.

Internal method used for index maintenance and indexed searching. Calculates the beginning of an index range for a given value. For index maintainance (adaptive:true), we will return a valid index position to insert to. For querying (adaptive:false/undefined), we will : return lower bound/index of range of that value (if found) return next lower index position if not found (hole) If index is empty it is assumed to be handled at higher level, so this method assumes there is at least 1 document in index.

Chain method, used for beginning a series of chained find() and/or view() operations on a collection.

Returns

(this) resultset, or data array if any map or join functions where called

Perform checks to determine validity/consistency of all binary indices

Returns

array of index names where problems were found.

Example

// check all indices on a collection, returns array of invalid index names
var result = coll.checkAllIndexes({ repair: true, randomSampling: true, randomSamplingFactor: 0.15 });
if (result.length > 0) {
  results.forEach(function(name) {
    console.log('problem encountered with index : ' + name);
  });
}

Perform checks to determine validity/consistency of a binary index

Returns

whether the index was found to be valid (before optional correcting).

Example

// full test
var valid = coll.checkIndex('name');
// full test with repair (if issues found)
valid = coll.checkIndex('name', { repair: true });
// random sampling (default is 10% of total document count)
valid = coll.checkIndex('name', { randomSampling: true });
// random sampling (sample 20% of total document count)
valid = coll.checkIndex('name', { randomSampling: true, randomSamplingFactor: 0.20 });
// random sampling (implied boolean)
valid = coll.checkIndex('name', { randomSamplingFactor: 0.20 });
// random sampling with repair (if issues found)
valid = coll.checkIndex('name', { repair: true, randomSampling: true });

Empties the collection of all data but leaves indexes and options intact by default.

commit the transation

(Staging API) re-attach all objects to the original collection, so indexes and views can be rebuilt then create a message to be inserted in the commitlog

Will allow reconfiguring certain collection options.

Quickly determine number of documents in collection (or query)

Returns

number of documents in the collection

Ensure all binary indices

Rebuild idIndex

Rebuild idIndex async with callback - useful for background syncing with a remote server

Ensure binary index on a certain field

Join two collections on specified properties

Returns

Result of the mapping operation

Find method, api is similar to mongodb. for more complex queries use [chain()]chain or [where()]where.

Example

{@tutorial Query Examples}

Returns

Array of matching documents

Applies a 'mongo-like' find query object removes all documents which match that filter.

Applies a 'mongo-like' find query object and passes all results to an update function. For filter function querying you should migrate to [updateWhere()]updateWhere.

Find one object by index property, by property equal to value

Returns

First matching document, or null if none

Find object by unindexed field by property equal to value, simply iterates and returns the first element matching the query

Internal method used to flag a lazy index as dirty

Internal method used to flag all lazy index as dirty

Get by Id - faster than other methods because of the searching algorithm

Returns

Object reference if document was found, null if not, or an array if 'returnPosition' was passed.

Perform binary range lookup for the data[dataPosition][binaryIndexName] property value Since multiple documents may contain the same value (which the index is sorted on), we hone in on range and then linear scan range to find exact index array position.

Look up dynamic view reference from within the collection

Returns

A reference to the dynamic view with that name

(Staging API) create a stage and/or retrieve it

Retrieves a named transform from the collection.

Returns a named unique index

Adds object(s) to collection, ensure object(s) have meta properties, clone it if necessary, etc.

Returns

document or documents inserted

Example

users.insert({
    name: 'Odin',
    age: 50,
    address: 'Asgard'
});

// alternatively, insert array of documents
users.insert([{ name: 'Thor', age: 35}, { name: 'Loki', age: 30}]);

Adds a single object, ensures it has meta properties, clone it if necessary, etc.

Returns

document or 'undefined' if there was a problem inserting it

Map Reduce operation

Returns

The result of your mapReduce operation

create a row filter that covers all documents in the collection

Remove a document from the collection

Returns

CollectionDocument | null - null if document not found, otherwise removed document. Array of new documents is not returned

Internal method called by remove()

Internal method to remove a batch of documents from the collection.

Remove a dynamic view from the collection

Removes a named collection transform from the collection

Remove all documents matching supplied filter function. For 'mongo-like' querying you should migrate to [findAndRemove()]findAndRemove.

roll back the transation

Updates or applies collection TTL settings.

Updates a named collection transform to the collection

(Staging API) create a copy of an object and insert it into a stage

start the transation

Calculate standard deviation of a field

Updates an object and notifies collection that the document has changed.

Returns

the document that was updated

Applies a filter function and passes all results to an update function.

Query the collection by supplying a javascript filter function.

Example

var results = coll.where(function(obj) {
  return obj.legs === 8;
});

Returns

all documents which pass your filter function