ionic-native-mongodb
v5.0.0
Published
Ionic Native - Native plugins for ionic apps
Downloads
30
Maintainers
Readme
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
)
Returns: Promise<boolean>
dropIndex(databaseName: string, collectionName: string, indexName: string
)
Returns: Promise<boolean>
aggregate(databaseName: string,collectionName: string,pipeline: PipelineStage []
)
Returns: Promise<MongodbDocument[]>
count(databaseName: string, collectionName: string, query?: MongodbQuery
)
Returns: Promise<number>
find(databaseName: string, collectionName: string, query?: MongodbQuery
)
Returns: Promise<MongodbDocument[]>
findOne(databaseName: string, collectionName: string, query?: MongodbQuery
)
Returns: Promise<MongodbDocument>
findOne(databaseName: string, collectionName: string, id?: string | number
)
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
)
Returns: Promise<MongodbDocument>
insertMany(databaseName: string, collectionName: string, documents: MongodbDocument []
)
Returns: Promise<MongodbDocument []>
replaceOne(databaseName: string, collectionName: string, query: MongodbQuery, replacement: MongodbDocument
)
Returns: Promise<UpdateResult>
updateOne(databaseName: string, collectionName: string, query: MongodbQuery, update: MongodbDocument
)
Returns: Promise<UpdateResult>
updateMany(databaseName: string, collectionName: string, query: MongodbQuery, update: MongodbDocument
)
Returns: Promise<UpdateResult>
deleteOne(databaseName: string, collectionName: string, query: MongodbQuery
)
Returns: Promise<UpdateResult>
deleteMany(databaseName: string, collectionName: string, query: MongodbQuery
)
Returns: Promise<UpdateResult>