Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aheckmann/m
mongodb version management
https://github.com/aheckmann/m
Last synced: 24 days ago
JSON representation
mongodb version management
- Host: GitHub
- URL: https://github.com/aheckmann/m
- Owner: aheckmann
- License: mit
- Created: 2012-08-25T18:40:26.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2024-07-10T01:50:41.000Z (4 months ago)
- Last Synced: 2024-10-05T01:13:56.924Z (about 1 month ago)
- Language: Shell
- Homepage:
- Size: 228 KB
- Stars: 266
- Watchers: 20
- Forks: 55
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- License: LICENSE
Awesome Lists containing this project
- awesome - aheckmann/m - mongodb version management (Shell)
README
# m - MongoDB Version Manager
`m` helps you download, use, and manage multiple versions of the MongoDB server
and command-line tools.
This can be useful for development & testing environments. For example, testing
release upgrades/downgrades or potential behavior differences between versions.
Where possible `m` will try to download the distro-specific binaries for your
O/S and version. If a binary appears to be unavailable, `m` will ask if you want
to try building from source.
NOTE: [Building MongoDB from source](https://github.com/mongodb/mongo/wiki/Build-Mongodb-From-Source)
requires you to preinstall all of the relevant dependencies & toolchain to build
the desired version of MongoDB. Installing those is outside the scope of what
`m` does.
## Prerequisites
To install binary packages `m` requires a 64-bit O/S which:
- is a [Supported Platform for the version of MongoDB you are trying to install](https://docs.mongodb.com/manual/administration/production-notes/#supported-platforms)
- includes the `bash` shell
Environments that should work include:
- Linux (RHEL/CentOS, Debian/Ubuntu, Amazon Linux)
- macOS 10.14 (Mojave) and later
- Windows 10 with [Ubuntu on Windows](https://www.microsoft.com/en-us/p/ubuntu/9nblggh4msv6?activetab=pivot%3Aoverviewtab)
- Docker using a supported Linux distro
## Installation
`m` is a `bash` script which can be installed & updated via `npm` for convenience:
npm install -g m
or installed by cloning the GitHub repo and running `make install`:
git clone https://github.com/aheckmann/m.git && cd m && make install
or fetched via `wget` and copied to a location of your choice:
wget https://raw.githubusercontent.com/aheckmann/m/master/bin/m && chmod +x ./m
### Downloading MongoDB Binaries
Specify a MongoDB server version to try download a binary package (if available for your current O/S) or switch to a previously downloaded copy. After `m` successfully downloads or switches to a specified version of MongoDB, those binaries will become the default in the install path (typically `$HOME/.local/bin/`; see _Details_ below for more information).
$ m 6.0.14
$ m 7.0.6
You can also specify a release series to download the latest available revision:
$ m 6.0
$ m 7.0
List installed binaries:
$ m
6.0.14
* 7.0.6
Use or download the latest official release:
$ m latest
Use or download the stable official release:
$ m stable
Check what the latest available release is:
$ m --latest
$ m --latest 7.0
Check what the current stable release is:
$ m --stable
$ m --stable 7.0
Download an Enterprise release:
$ m 7.0-ent
Select a MongoDB version without prompting for confirmation if a download is required:
$ yes | m 7.0
### Downloading MongoDB Database Tools
The Database Tools (mongodump, mongorestore, etc.) are now released separately from the server. You can use `m` to manage your MongoDB Database Tools version independently of your MongoDB server and shell versions.
List available Database Tools versions:
$ m tools ls
List installed Database Tools versions:
$ m tools installed
Use or download the latest stable release of the Database Tools:
$ m tools stable
Use or download a specific version of the Database Tools:
$ m tools 100.9.4
### Removing Binaries
Remove some previously installed versions:
$ m rm 6.0.13 7.0.5
### Binary Usage
Multiple versions of MongoDB can be downloaded and targeted directly.
Ask `m` for the binary path for a specific version that has already been downloaded:
$ m bin 7.0.6
/Users/bobbytables/.local/m/versions/7.0.6/bin
Start up `mongod` 6.0.13 regardless of the active version:
$ m use 6.0.13 --port 29000 --dbpath ./data/
When installing or changing the active version you might want to run custom scripts:
$ m pre install /path/to/my/script
$ m post install /path/to/script
$ m pre change /path/to/my/script
$ m post change /path/to/script
Multiple scripts may be added for any event. To add two `pre change` scripts:
$ m pre change /path/to/script1
$ m pre change /path/to/script2
Scripts are executed in the order they were added.
List all pre change hooks:
$ m pre change
/path/to/script1
/path/to/script2
List all post install hooks:
$ m post install
/path/to/scriptA
/path/to/scriptB
/path/to/scriptC
To remove a post install hook:
$ m post install rm /path/to/scriptB
To remove all post install hooks:
$ m post install rm
## Usage
Output from `m --help`:
```
Usage: m [options] [COMMAND] [config]
Commands:
m Output versions installed
m stable [config ...] Install or activate the latest stable MongoDB release
m latest [config ...] Install or activate the latest MongoDB release (including dev & RCs)
m X.Y Install or activate the latest patch release for MongoDB X.Y (eg. 7.0)
m [config ...] Install and/or use MongoDB
m --legacy Install generic Linux version (does not include SSL)
m use [args ...] Execute mongod with [args ...]
m shard [args ...] Execute mongos with [args ...]
m shell [args ...] Open a mongo shell with [args ...]
m bin Output bin path for
m rm Remove the given version(s)
m --stable Output the latest stable MongoDB version available
m --stable X.Y .. for release series X.Y (eg. 7.0)
m --latest Output the latest MongoDB version available (including dev & RCs)
m --latest X.Y .. for release series X.Y (eg. 7.0)
m ls Output the versions of MongoDB available
m installed [--json] Output installed versions available (optionally, in JSON format)
m src Output the url for source used for the given
(useful if installed from source)
m pre [script] Declare one or list scripts to execute before
(scripts must use absolute paths)
m post [script] Declare one or list scripts to execute after
(scripts must use absolute paths)
m pre rm [script] Remove pre script
m post rm [script] Remove post script
m tools stable Install or activate the latest stable Database Tools release
m tools X.Y.Z Install or activate the Database Tools X.Y.Z
m tools ls Output the versions of the Database Tools available
m tools installed [--json] Output installed versions of the Database Tools available
Events:
change Occurs when switching MongoDB versions
install Occurs when installing a previously uninstalled MongoDB version
Options:
-V, --version Output current version of m
-h, --help Display help information
Aliases:
installed lls
shard sd, mongos
shell s, sh, mongo
list ls, available, avail
use as, mongod
which bin
```
## Details
By default `m` downloads MongoDB binaries to _~/.local/m/versions_ in subdirectories named after the release version (6.0.14, 7.0.6, ...). MongoDB Database Tools binaries are downloaded to _~/.local/m/tools/versions_ in subdirectories named after the release version (100.0.0, 100.0.1, ...). Activated MongoDB binaries are symlinked into the `bin` directory in _~/.local/bin_. To alter where `m` operates, export the __M_PREFIX__ environment variable with your preferred path prefix.
Previously downloaded versions of MongoDB can be activated using `m ` or
selected using of the variations in the _Binary Usage_ section above.
## License
[MIT](https://github.com/aheckmann/m/blob/master/LICENSE)
## Inspiration
Yes tj, this is nearly identical to [n](https://github.com/tj/n). Huge thanks!
## Disclaimer
This software is not supported by MongoDB, Inc. under any of their commercial support subscriptions or otherwise. Any usage of `m` is at your own risk. Bug reports, feature suggestions, and questions can be posted in the [Issues](https://github.com/aheckmann/m/issues) section on GitHub.