README.md

FiveM MongoDB wrapper

Description

This resource is a simple MongoDB wrapper for FiveM. It's running on top of MongoDB Node Driver.

Installation

1. Clone this repository to resources/mongodb folder.
2. Copy mongodb/database.cfg to your server root directory.
3. Add the following lines to your server config:

exec "database.cfg"
start mongodb

4. Change mongodb_url and mongodb_database in database.cfg.
5. Run npm install in resources/mongodb directory.

Usage

Every callback accepts success<boolean> as its first argument. If success is false, second argument contains error message.

Example (Lua):

exports.mongodb:findOne({ collection = "users", query = { _id = id } }, function (success, result)
    if not success then
        print("Error message: "..tostring(result))
        return
    end

    print("User name is "..tostring(result[1].name))
end)

exports.mongodb.isConnected

• Returns boolean

Returns true if database connection is established.

exports.mongodb.insert(params, callback);

• params<Object> - params object
• params.collection<string> - collection name
• params.documents<Object> - an array of documents to insert
• params.options<Object> - optional settings object. See collection.insertMany in docs
• callback(success<boolean>, insertedCount<number>, insertedIds<Array>) - callback (optional) Inserts an array of documents into MongoDB.

exports.mongodb.insertOne(params, callback);

• params<Object> - params object
• params.collection<string> - collection name
• params.document<Object> - document object
• params.options<Object> - optional settings object. See collection.insertMany in docs
• callback(success<boolean>, insertedCount<number>, insertedIds<Array>) - callback (optional)

Inserts a single document into MongoDB.

exports.mongodb.find(params, callback);

• params<Object> - params object
• params.collection<string> - collection name
• params.query<Object> - filter query object
• params.options<Object> - optional settings object. See collection.find in docs
• params.limit<number> - limit documents count
• callback(success<boolean>, documents<Array>) - callback (optional)

Performs a find query.

exports.mongodb.findOne(params, callback);

• params<Object> - params object
• params.collection<string> - collection name
• params.query<Object> - filter query object
• params.options<Object> - optional settings object. See collection.find in docs
• callback(success<boolean>, documents<Array>) - callback (optional)

Performns a find query with limit = 1.

exports.mongodb.update(params, callback);

• params<Object> - params object
• params.collection<string> - collection name
• params.query<Object> - filter query object
• params.update<Object> - update query object
• params.options<Object> - optional settings object. See collection.updateMany in docs
• callback(success<boolean>, updatedCount<number>) - callback (optional)

Update multiple documents on MongoDB.

exports.mongodb.updateOne(params, callback);

• params<Object> - params object
• params.collection<string> - collection name
• params.query<Object> - filter query object
• params.update<Object> - update query object
• params.options<Object> - optional settings object. See collection.updateMany in docs
• callback(success<boolean>, updatedCount<number>) - callback (optional)

Update a single document on MongoDB.

exports.mongodb.count(params, callback);

• params<Object> - params object
• params.collection<string> - collection name
• params.query<Object> - filter query object
• params.options<Object> - optional settings object. See collection.countDocuments in docs
• callback(success<boolean>, count<number>) - callback (optional)

Gets the number of documents matching the filter.

exports.mongodb.delete(params, callback);

• params<Object> - params object
• params.collection<string> - collection name
• params.query<Object> - filter query object
• params.options<Object> - optional settings object. See collection.deleteMany in docs
• callback(success<boolean>, deletedCount<number>) - callback (optional)

Delete multiple documents on MongoDB.

exports.mongodb.deleteOne(params, callback);

• params<Object> - params object
• params.collection<string> - collection name
• params.query<Object> - filter query object
• params.options<Object> - optional settings object. See collection.deleteMany in docs
• callback(success<boolean>, deletedCount<number>) - callback (optional)

Delete a document on MongoDB.