Mongo Utilities

Peerdependency: @krknet/profiler

Model

ToDo

Connection

const { Connection } = require('@krknet/mongo')
global.__db = new Connection(global.__config.mongo, { doLog: true, initiators: [] })

await global.__db.connect()
await global.__db.disconnect()

Options

{
  initiators: [],
  doLog: true
}

Functions

async connect ()

async disconnect ()

get (collectionName) // Returns Collection

Collection

ToDo

CLI

const path = require('path')

global.rootRequire = dep => require(path.join(__dirname, '../app/', dep))
global.__environment = process.env.NODE_ENV || 'development'
global.__basePath = path.join(__dirname, '../app/')
global.__dataFolder = path.join(process.cwd(), 'data/')
global.__config = rootRequire('config/')

const { Connection, CLIservice } = require('@krknet/mongo')
global.__db = new Connection(global.__config.mongo, { doLog: false })

const service = new CLIservice({
  dbConnection: global.__db,
  models: [
    rootRequire('models/access'),
    rootRequire('models/accounts')
  ]
})

service.query(process.argv)

Schema Additions: resolver

resolver allows for easier value lookup and selection.

Example:

async function instanceResolver ({ results, eq, initial }) {
  const instances = await rootRequire('models/instances').get()
  const { id } = await eq.prompt({
    type: 'select',
    name: 'instance',
    message: 'Instanz',
    initial,
    choices: instances.map(d => ({ name: d.data._id, message: `${d.title}` }))
  })

  return id
}

Schema Additions: options

options allows for ENUM style value selection.

Example:

{
  mode: {
    type: String,
    title: 'Zugangs-Modus',
    require: false,
    default: 'closed',
    options: ['open', 'account', 'admin', 'closed']
  }
}

Schema Additions: setter

setter model function name to set field.

Example:

{
  password: {
    type: String,
    title: 'Passwort',
    required: false,
    setter: 'setPassword'
  }
}