ionic-native-mongodb
TypeScript icon, indicating that this package has built-in type declarations

5.0.0 • Public • Published

Android Full Screen

This plugin enables developers create a local mongodb using the new mongodb mobile sdk. MongoDB Mobile

Repo: https://github.com/luisbobadilla/ionic-native-mongodb

Installation

Install the Cordova and Ionic Wrapper plugins:

$ ionic cordova plugin add gudsi-mongodb-plugin
$ npm install --save ionic-native-mongodb

Supported platforms

Android


Usage

import { Mongodb } from 'ionic-native-mongodb';

constructor(private mongodb: Mongodb) { }

...

try {
  await mongodb.initiate('gudsi-debug');
  await mongodb.createCollection('gudsi-debug', 'example',{
          $jsonSchema: {
            bsonType: "object",
            required: ["name"],
            properties: {
              name: {
                bsonType: "string",
                description: "must be a string and is required"
              },
              year: {
                bsonType: "int",
                minimum: 2017,
                maximum: 3017,
                exclusiveMaximum: false,
                description: "must be an integer in [ 2017, 3017 ] and is required"
              },
              major: {
                enum: ["Math", "English", "Computer Science", "History", null],
                description: "can only be one of the enum values and is required"
              }
            }
          }
        })
  const _document = await mongodb.insertOne('gudsi-debug', 'example', { 
    name:"hello",
    year:2017,
    major:"History"
  });
} catch (error) {
  console.log(error);
}

Instance Members

initiate(appId: string)

This function has to be called before doing anything else, this is a mongodb mobile requirement.

Returns: Promise<boolean>

dropDatabase(databaseName: string)

API reference for dropDatabase

Returns: Promise<boolean>

createCollection(databaseName: string, collectionName: string, schema?: MongodbSchema)

API reference for createCollection

Returns: Promise<boolean>

dropCollection(databaseName: string, collectionName: string)

API reference for dropCollection

Returns: Promise<boolean>

listCollectionNames(databaseName: string)

API reference for getCollectionNames

Returns: Promise<string>

createIndex(databaseName: string, collectionName: string, keys: IndexKeys, options: IndexOptions)

API reference for createIndex

Returns: Promise<boolean>

dropIndex(databaseName: string, collectionName: string, indexName: string)

API reference for dropIndex

Returns: Promise<boolean>

aggregate(databaseName: string,collectionName: string,pipeline: PipelineStage [])

API reference for aggregate

Returns: Promise<MongodbDocument[]>

count(databaseName: string, collectionName: string, query?: MongodbQuery)

API reference for count

Returns: Promise<number>

find(databaseName: string, collectionName: string, query?: MongodbQuery)

API reference for find

Returns: Promise<MongodbDocument[]>

findOne(databaseName: string, collectionName: string, query?: MongodbQuery)

API reference for findOne

Returns: Promise<MongodbDocument>

findOne(databaseName: string, collectionName: string, id?: string | number)

API reference for findOne

Returns: Promise<MongodbDocument>

findOneAndUpdate(databaseName: string, collectionName: string, query: MongodbQuery, update: MongodbDocument)

API reference for findOneAndUpdate

Returns: Promise<MongodbDocument>

findOneAndReplace(databaseName: string, collectionName: string, query: MongodbQuery, replacement: MongodbDocument)

API reference for findOneAndReplace

Returns: Promise<MongodbDocument>

findOneAndDelete(databaseName: string, collectionName: string, query: MongodbQuery)

API reference for findOneAndDelete

Returns: Promise<MongodbDocument>

insertOne(databaseName: string, collectionName: string, document: MongodbDocument)

API reference for insertOne

Returns: Promise<MongodbDocument>

insertMany(databaseName: string, collectionName: string, documents: MongodbDocument [])

API reference for insertMany

Returns: Promise<MongodbDocument []>

replaceOne(databaseName: string, collectionName: string, query: MongodbQuery, replacement: MongodbDocument)

API reference for replaceOne

Returns: Promise<UpdateResult>

updateOne(databaseName: string, collectionName: string, query: MongodbQuery, update: MongodbDocument)

API reference for updateOne

Returns: Promise<UpdateResult>

updateMany(databaseName: string, collectionName: string, query: MongodbQuery, update: MongodbDocument)

API reference for updateMany

Returns: Promise<UpdateResult>

deleteOne(databaseName: string, collectionName: string, query: MongodbQuery)

API reference for deleteOne

Returns: Promise<UpdateResult>

deleteMany(databaseName: string, collectionName: string, query: MongodbQuery)

API reference for deleteMany

Returns: Promise<UpdateResult>

Package Sidebar

Install

npm i ionic-native-mongodb

Weekly Downloads

5

Version

5.0.0

License

MIT

Unpacked Size

84.1 kB

Total Files

7

Last publish

Collaborators

  • luisbobadilla