README
¶
migration-tools
A library of reusable components for use in MongoDB migration tooling. You may find some of them useful in your own projects.
IMPORTANT: This Repository is NOT an officially supported MongoDB product. No support guarantees are made. Use at your own risk.
Guidelines for contributing
- Prioritize separation of concerns. In particular, avoid references to specific downstream tools except to give examples.
- Document thoroughly, preferably with example code.
Installing dev tools
This repo uses mise for managing dev tools. After you install mise, run
the following commands:
mise trust
mise install
Pre-commit hooks
If you'd like linting checks to run as a git pre-commit hook, run git/setup to install the hook.
Do not add …
Some things should not be in this library because upstream tooling already provides them.
- generic
syncmap; use xsync instead - safe numeric conversion; use github.com/ccoveille/go-safecast/v2 instead
- sets; use golang-set instead
Directories
¶
| Path | Synopsis |
|---|---|
|
Package bsontools exposes various BSON-related tools.
|
Package bsontools exposes various BSON-related tools. |
|
cmd
|
|
|
third-party-notices
command
|
|
|
Package contextplus provides wrappers around the standard library’s context cancellation & expiry functions.
|
Package contextplus provides wrappers around the standard library’s context cancellation & expiry functions. |
|
Package history exposes a time-bounded queue.
|
Package history exposes a time-bounded queue. |
|
Package humantools exports various functions that are useful in “humanizing” numbers in various contexts.
|
Package humantools exports various functions that are useful in “humanizing” numbers in various contexts. |
|
Package mongotools contains tools for use with MongoDB servers.
|
Package mongotools contains tools for use with MongoDB servers. |
|
expr
Package expr provides convenience types and functions for building aggregation expressions.
|
Package expr provides convenience types and functions for building aggregation expressions. |
|
expr/accum
Package accum exposes helper types for accumulation operators.
|
Package accum exposes helper types for accumulation operators. |
|
expr/helpers
Package helpers exposes higher-level helpers that don’t map to a single aggregation operator, unlike the primitive operator wrappers in the expr package.
|
Package helpers exposes higher-level helpers that don’t map to a single aggregation operator, unlike the primitive operator wrappers in the expr package. |
|
index
Package index exports index-related functions.
|
Package index exports index-related functions. |
|
Package option implements [option types] in Go.
|
Package option implements [option types] in Go. |
|
Package ringbuf provides a generic, fixed-capacity, array-backed ring buffer.
|
Package ringbuf provides a generic, fixed-capacity, array-backed ring buffer. |
|
Package synctools exposes concurrency-related tools.
|
Package synctools exposes concurrency-related tools. |
|
Package sysinfo exports tools to query & report system information.
|
Package sysinfo exports tools to query & report system information. |
Click to show internal directories.
Click to hide internal directories.