Skip to content

jet2tlf/mongodb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

30 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MongoDB Wrapper

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

Installation

  1. Download the latest release.
  2. Add the following lines to your server config:
set mongoCredentials "mongodb:https://yourhost:27017/yourdb"
start mongodb
  1. Set your host and db

Usage

Every callback accepts result<object> as it's first argument. If the execution is successful, a table with some information will be removed, if it is not successful, it will return null

Example (Lua):

exports["mongodb"]:findOne({ collection = "products" }, function(result)
    if not result then return

    print("The first product is: "..result.name)
end)

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 insertOne in docs
  • callback(result<Array>) - callback (optional)

Inserts a single document into MongoDB.

exports["mongodb"]:insertMany(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 insertMany in docs
  • callback(result<Array>) - callback (optional)

Inserts an array of documents into MongoDB.

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 findOne in docs
  • callback(result<Array>) - callback (optional)

Performns a find query with limit = 1.

exports["mongodb"]:findMany(params, callback)

  • params<Object> - params object
  • params.collection<string> - collection name
  • params.query<Object> - filter query object
  • params.options<Object> - optional settings object. See findMany in docs
  • callback(result<Array>) - callback (optional)

Performs a find query.

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 updateOne in docs
  • callback(result<Array>) - callback (optional)

Update a single document on MongoDB.

exports["mongodb"]:updateMany(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 updateMany in docs
  • callback(result<Array>) - callback (optional)

Update 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 deleteOne in docs
  • callback(result<Array>) - callback (optional)

Delete a single document on MongoDB.

exports["mongodb"]:deleteMany(params, callback)

  • params<Object> - params object
  • params.collection<string> - collection name
  • params.query<Object> - filter query object
  • params.options<Object> - optional settings object. See deleteMany in docs
  • callback(result<Array>) - callback (optional)

Delete multiple documents on MongoDB.

More documentation coming soon