Module mongorover.luaBSONObjects

Lua representations of BSON objects.

luaBSONObjects.BSONNull Functions

BSONNull.new (db_uri) Creates a MongoClient instance.
BSONNull.isBSONNull (object) Checks whether the object is a BSONNull object or not.

luaBSONObjects.ObjectId Functions

ObjectId.new (key) Creates an ObjectId object with the corresponding key.
ObjectId.isObjectId (object) Checks whether the object is a ObjectId object or not.
ObjectId:getKey () Returns hexidecimal string representation of the ObjectId.


luaBSONObjects.BSONNull Functions

BSONNull.new (db_uri)
Creates a MongoClient instance. uses MongoDB connection URI (http://docs.mongodb.org/manual/reference/connection-string/).

Parameters:

  • db_uri The MongoDB connection URI.
BSONNull.isBSONNull (object)
Checks whether the object is a BSONNull object or not.

Parameters:

  • object The object to be checked whether it is an BSONNull.

Returns:

    bool Whether the object is an BSONNull or not.

luaBSONObjects.ObjectId Functions

ObjectId.new (key)
Creates an ObjectId object with the corresponding key.

Parameters:

  • key string A hexadecimal string representation of the ObjectId of length 24.
ObjectId.isObjectId (object)
Checks whether the object is a ObjectId object or not.

Parameters:

  • object The object to be checked whether it is an ObjectId.

Returns:

    bool Whether the object is an ObjectId or not.
ObjectId:getKey ()
Returns hexidecimal string representation of the ObjectId.

Returns:

    String hexidecimal string representation of the ObjectId.
generated by LDoc 1.4.3 Last updated 2015-09-16 03:55:02