Underbase

Underbase

  • Docs
  • Guides
  • API
  • GitHub

›API

Get started

  • Introduction
  • Installation
  • Configuration
  • Writting migrations
  • Module usage
  • Logging
  • Troubleshooting

Guides

  • Organizing migrations
  • Babel usage
  • Working with backups
  • Typescript usage

API

  • Module
  • Configuration API
  • Query Interface
  • Module for development
Edit

Configuration API

Those configuration options are both used by the CLI app and the module.

Reference

config

Configuration file path.

  • Default : 'underbase.config.js'
  • Type : string
underbase --config underbase.config.js

db

MongoDB connection URL.

  • Default : ''
  • Type : string
underbase --db mongodb://localhost:27017/underbase_example

migrationsDir

Migrations versions directory. Should be used with an absolute path.

  • Default : './migrations'
  • Type : string
underbase --migrationsDir ./migrations

collectionName

Migrations state collection.

  • Default : 'migrations'
  • Type : string
underbase --collectionName migrations

logs

Enable logs.

  • Default : true
  • Type : boolean
underbase --logs true

logIfLatest

Log in the terminal if you are already at the specified version.

  • Default : true
  • Type : boolean
underbase --logIfLatest true

supportFile

Support file path.

  • Default : undefined
  • Type : string
underbase --supportFile ./support.js
← ModuleQuery Interface →
  • Reference
    • config
    • db
    • migrationsDir
    • collectionName
    • logs
    • logIfLatest
    • supportFile
Underbase
Guides
Working with backupsWorking with continuous deploymentAPI Reference
Community
Stack OverflowIssues tracker
More
Release notesGitHub