# gudsi-mongodb-plugin > This plugin provides a mongodb local storage option to Cordova based applications. Latest version **0.1.0** (published 2019-02-26) · Apache-2.0 license · 0 weekly downloads ## Install ```sh npm install gudsi-mongodb-plugin pnpm add gudsi-mongodb-plugin yarn add gudsi-mongodb-plugin bun add gudsi-mongodb-plugin ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.1.0 | | Published | 2019-02-26 | | First published | 2019-02-08 | | Weekly downloads | 0 | | License | Apache-2.0 | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 0 | | Unpacked size | 54.6 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 0 | | Author | Luis Bobadilla | | Maintainers | luisbobadilla | | Keywords | mongodb, plugin, stitchSDK, Mongodb mobile, cordova, phonegap, ecosystem:cordova, cordova-android | ## Links - npm: https://www.npmjs.com/package/gudsi-mongodb-plugin - Repository: https://github.com/luisbobadilla/gudsi-mongodb-plugin - Homepage: https://github.com/luisbobadilla/gudsi-mongodb-plugin.git - Issues: https://github.com/luisbobadilla/gudsi-mongodb-plugin/issues - npm.io page: https://npm.io/package/gudsi-mongodb-plugin ## Alternatives - [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads - [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads - [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads - [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads - [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads ## Recent versions - 0.1.0 (latest) — 2019-02-26 - 0.0.11 — 2019-02-13 - 0.0.10 — 2019-02-11 - 0.0.9 — 2019-02-08 - 0.0.8 — 2019-02-08 - 0.0.7 — 2019-02-08 - 0.0.6 — 2019-02-08 ## README # gudsi-mongodb-plugin This is a Cordova plugin that exposes the functionality of MongoDB Mobile to a Cordova Android app for local storage. ### Install To install this plugin run `cordova plugin add gudsi-mongodb-plugin` in your projects root folder. ### Ionic integration To use the plugin in ionic project run `npm install ionic-native-mongodb` in your projects root folder.
[Ionic Native MongoDB](https://github.com/luisbobadilla/ionic-native-mongodb) ### Functions Below are the functions that are exposed in the plugin. --- #### initiate(`appId: string`) This function has to be called before doing anything else, this is a mongodb mobile requirement
`appId` the id of this app, this is more usefull when you are using stitch but mongo does it need the initialization.
--- #### dropDatabase(`databaseName: string`) [API reference for dropDatabase](https://docs.mongodb.com/manual/reference/method/db.dropDatabase/)
`databaseName` the name of the database to delete. --- #### createCollection(`databaseName: string`,`collectionName: string`,`schema?: JSONObject`) [API reference for createCollection](https://docs.mongodb.com/manual/reference/method/db.createCollection/)
`databaseName` the name of the database.
`collectionName` the name of the new collection.
`schema` the schema with JSON Schema validation $jsonSchema.
--- #### dropCollection(`databaseName: string`,`collectionName: string`) [API reference for dropCollection](https://docs.mongodb.com/manual/reference/method/db.collection.drop/)
`databaseName` the name of the database that contains the database to delete. `collectionName` the name of the collection to delete. --- #### listCollectionNames(`databaseName: string`) [API reference for getCollectionNames](https://docs.mongodb.com/manual/reference/method/db.getCollectionNames/)
`databaseName` the name of the database to explore. --- #### createIndex(`databaseName: string`, `collectionName: string`, `keys: JSONObject`, `indexOptions: JSONObject`) [API reference for createIndex](https://docs.mongodb.com/manual/reference/method/db.collection.createIndex/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`keys` a document that contains the field and value pairs where the field is the index key and the value describes the type of index for that field.
`indexOptions` a document that contains a set of options that controls the creation of the index.
--- #### dropIndex(`databaseName: string`, `collectionName: string`, `indexName: string`) [API reference for dropIndex](https://docs.mongodb.com/manual/reference/method/db.collection.dropIndex/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`indexName` Specifies the name of the index to drop.
--- #### aggregate(`databaseName: string`, `collectionName: string`, `pipeline: JSONArray`) [API reference for aggregate](https://docs.mongodb.com/manual/reference/method/db.collection.aggregate/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`pipeline` A sequence of data aggregation operations or stages.
[API reference for aggregation pipeline stages](https://docs.mongodb.com/manual/reference/operator/aggregation-pipeline/)
--- #### count(`databaseName: string`, `collectionName: string`, `query?: JSONObject`) [API reference for count](https://docs.mongodb.com/manual/reference/method/db.collection.count/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`query` the query selection criteria.
--- #### find(`databaseName: string`, `collectionName: string`, `query?: JSONObject`) [API reference for find](https://docs.mongodb.com/manual/reference/method/db.collection.find/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`query` (optional) Specifies selection filter using query operators. To return all documents in a collection, omit this parameter or pass an empty document
--- #### findOne(`databaseName: string`, `collectionName: string`, `query?: JSONObject`) [API reference for findOne](https://docs.mongodb.com/manual/reference/method/db.collection.findOne/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`query` (optional) Specifies query selection criteria using query operators.
--- #### findById(`databaseName: string`, `collectionName: string`, `id: string | {$oid:string}`) `databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`id` the id of the element to find.
--- #### findOneAndUpdate(`databaseName: string`, `collectionName: string`, `query: JSONObject`,`update: JSONObject`) [API reference for findOneAndUpdate](https://docs.mongodb.com/manual/reference/method/db.collection.findOneAndUpdate/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`query` the selection criteria for the update. The same query selectors as in the find() method are available.
`update` the update document.
--- #### findOneAndReplace(`databaseName: string`, `collectionName: string`, `query: JSONObject`,`replacement: JSONObject`) [API reference for findOneAndReplace](https://docs.mongodb.com/manual/reference/method/db.collection.findOneAndReplace/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`query` the selection criteria for the update. The same query selectors as in the find() method are available.
`replacement` the replacement document.
--- #### findOneAndDelete(`databaseName: string`, `collectionName: string`, `query: JSONObject`) [API reference for findOneAndDelete](https://docs.mongodb.com/manual/reference/method/db.collection.findOneAndDelete/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`query` the selection criteria for the delete. The same query selectors as in the find() method are available.
--- #### insertOne(`databaseName: string`, `collectionName: string`, `document: JSONObject`) [API reference for insertOne](https://docs.mongodb.com/manual/reference/method/db.collection.insertOne/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`document` a document to insert into the collection.
--- #### insertMany(`databaseName: string`, `collectionName: string`, `documents: JSONArray`) [API reference for insertMany](https://docs.mongodb.com/manual/reference/method/db.collection.insertMany/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`documents` an array of documents to insert into the collection.
--- #### replaceOne(`databaseName: string`, `collectionName: string`, `query: JSONObject` , `replacement: JSONObject`) [API reference for replaceOne](https://docs.mongodb.com/manual/reference/method/db.collection.replaceOne/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`query` the selection criteria for the update. The same query selectors as in the find() method are available.
`replacement` the replacement document.
--- #### updateOne(`databaseName: string`, `collectionName: string`, `query: JSONObject` , `update: JSONObject`) [API reference for updateOne](https://docs.mongodb.com/manual/reference/method/db.collection.updateOne/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`query` the selection criteria for the update. The same query selectors as in the find() method are available.
`update` the modifications to apply.
--- #### updateMany(`databaseName: string`, `collectionName: string`, `query: JSONObject` , `update: JSONObject`) [API reference for updateMany](https://docs.mongodb.com/manual/reference/method/db.collection.updateMany/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`query` the selection criteria for the update. The same query selectors as in the find() method are available.
`update` the modifications to apply.
--- #### deleteOne(`databaseName: string`, `collectionName: string`, `query: JSONObject`) [API reference for deleteOne](https://docs.mongodb.com/manual/reference/method/db.collection.deleteOne/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`query` specifies deletion criteria using query operators.
--- #### deleteMany(`databaseName: string`, `collectionName: string`, `query: JSONObject`) [API reference for deleteMany](https://docs.mongodb.com/manual/reference/method/db.collection.deleteMany/)
`databaseName` the name of the database that is to be used.
`collectionName` the name of the collection that is to be used.
`query` specifies deletion criteria using query operators.
--- --- _Source: https://npm.io/package/gudsi-mongodb-plugin · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._