getMembers(mongoDBInstance: Db instance, index: String, fieldObject: Field Object, page: Object)
[starting from version: 2.8]
This API call allows getting all members of the field from a MongoDB database. Used in the handler of the Flexmonster /members
request. The getMembers
method is a part of the Flexmonster MongoDB Connector API.
Parameters:
mongoDBInstance
– Db instance. The instance of the needed MongoDB database.index
– String. The collection’s name. index
is sent in the body of the Flexmonster request.fieldObject
– Field Object. Represents a field with its properties. fieldObject
is sent in the body of the Flexmonster request.page
– Object. Has the following properties:pageNumber
– Number. Page number. Used to load members by parts. Starts from 0
. pageNumber
is sent in the body of the Flexmonster request.pageToken
– String. A key calculated on the server that defines which part of the data should be loaded next. pageToken
is sent in the body of the Flexmonster request. Returns
Array of objects, which contains all the members. The response format is the same as in the /members request.
Example
mongo.post("/members", async (req, res) => {
try {
const result = await MongoDataAPI.getMembers(mongoDBInstance, req.body.index, req.body.field, {pageNumber: req.body.page, pageToken: req.body.pageToken });
res.json(result);
} catch (err) { }
});
See also