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

@springworks/mongoose-connection

v5.2.1

Published

Manages a named connection to a mongoose database.

Downloads

15

Readme

@springworks/mongoose-connection

Module that creates and manages a named mongoose connection to a MongoDB database.

The module exports a single function used to create a named wrapper around a mongoose connection.

Example:

const connection_name = 'my connection'; // Used to retrieve connection
const mongo_uri = 'mongodb://...';
const logger = null; // Optional Bunyan logger
const mongoose_connection = require('@springworks/mongoose-connection');
const wrapped_connection = mongoose_connection.getWrapper(connection_name, mongo_uri, logger);

// The connection:
wrapped_connection.connection();

// Connect to the DB. The connect method can be called multiple times.
// Callbacks will be queued until the connection is established (or it failes).
wrapped_connection.connect(function(err) {
  if (!err) {
    // Connected
  }
});

// Disconnect from the DB. Like the connect method, disconnect can be called
// multiple times and will queue callbacks until disconnected.
wrapped_connection.disconnect(function(err) {
  if (!err) {
    // Disconnected
  }
});

// Ping the db server (using the db command "ping")
wrapped_connection.ping(function(err) {
  console.log('Ping %s', err ? 'failed' : 'succeeded');
});

Mongoose

This module will export its own version of mongoose. Please use that export instead of having mongoose as a dependency in the project using this module. The motivation behind this is that we ran into errors when using different versions of mongoose in the project using this module.

const mongoose_connection = require('@springworks/mongoose-connection');
const mongoose = mongoose_connection.mongoose;

databaseUriFromConfig

Can be used to generate a connection string based on a config object.

const mongoose_connection = require('@springworks/mongoose-connection');
const uri = mongoose_connection.databaseUriFromConfig({
  primary_db,
  secondary_dbs,
  db_user,
  db_pass,
  db_name,
});

API

getWrapper(connection_name, mongo_uri, logger)

Create or retrieve a shared connection wrapper by name and uri.

Returns an object with the methods connection, connect and disconnect.

connection()

Get the connection object used by mongoose.

connect(callback)

Connect to the DB. The connect method can be called multiple times while connecting. Callbacks will be queued until the connection is established (or it failes).

The callback function will be invoked with a single err param.

disconnect(callback)

Disconnect from the DB. Like the connect method, disconnect can be called multiple times and will queue callbacks until disconnected.

The callback function will be invoked with a single err param.

ping(callback)

Ping db server using the ping command. The ping command is a no-op used to test whether a server is responding to commands. This command will return immediately even if the server is write-locked.

The callback function will be invoked with a single err param if ping fails.