npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

commons-mongodb-crud

v1.0.11

Published

1. [Connection](#connection) 2. [CRUD Operations](#crud-operations)

Downloads

176

Readme

Commons - MongoDB

Contents

  1. Connection
  2. CRUD Operations

Connection

To connect to the mongo database call connectToServer method and pass in uri and custom database options.

This will return 2 parameters status and message. If status is true that means you are connected.

const { connections: mongoConn } = require('commons-mongodb-crud')

const res = await mongoConn.connectToServer("mongodb://localhost", {})

console.log(res)
// { status: true, message: 'Connected MongoDB: my_db' }

Re-use same connection elsewhere

Once connected you get status flag. Now you can utilize the same connection anywhere in your node.js application.

To do so use getDb() function to get the connection.

const { connections: mongoConn } = require('commons-mongodb-crud')

const connectionObj = mongoConn.getDb()
// further use connectionObj to run any query

Close database connection on app shutdown

This is important part of the connection. Use closeConnections() method if there is no requirement of using mysql connection or during graceful shutdown

const { connections: mongoConn } = require('commons-mongodb-crud')

mongoConn.closeConnections()

Crud Operations

Running Simple query

To run a query against the given database use runQuery() method of mysqlCrud

  • collection: This can be your collection name which can be passed in the form of string
  • query: This is an object which is used to narrow down the collection data
  • projection: In order to get only the required fields in response the projection object can be passed
const { crud } = require('commons-mongodb-crud')

const findRes = await crud.find(collection, query, projection, options)
// options: To customize the documents options is used. Currently the below options are supported
// const options = { limit: 10, page: 1, sort: "firstName", order: "asc" | "desc" }
const findOneRes = await crud.findOne(collection, query, projection)
const insertOneRes = await crud.insertOne(collection, data)
// data: The data is a document you want to store in the given collection
const updateOneRes = await crud.updateOne(collection, query, set)
// set: pass in set object that you want to update in the existing document
// The parameters that are passed in the set value will be updated
const deleteOneRes = await crud.deleteOne(collection, query)