Compare commits
13 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 7ee4a48ee2 | |||
| 4626941613 | |||
| b4a45e825a | |||
| 9213108212 | |||
| 37f2b3b1df | |||
| 355b9c7aa6 | |||
| a40bd67eba | |||
| 1df3f51e53 | |||
| 28829ecdb2 | |||
| e73e8e3c83 | |||
| ace1769ff4 | |||
| 689d41eab2 | |||
| 0c4bcfb121 |
140
.gitlab-ci.yml
140
.gitlab-ci.yml
@@ -1,140 +0,0 @@
|
||||
# gitzone ci_default
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
|
||||
cache:
|
||||
paths:
|
||||
- .npmci_cache/
|
||||
key: '$CI_BUILD_STAGE'
|
||||
|
||||
stages:
|
||||
- security
|
||||
- test
|
||||
- release
|
||||
- metadata
|
||||
|
||||
before_script:
|
||||
- npm install -g @shipzone/npmci
|
||||
|
||||
# ====================
|
||||
# security stage
|
||||
# ====================
|
||||
mirror:
|
||||
stage: security
|
||||
script:
|
||||
- npmci git mirror
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
auditProductionDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --production --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=prod --production
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
auditDevDependencies:
|
||||
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
||||
stage: security
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci command npm install --ignore-scripts
|
||||
- npmci command npm config set registry https://registry.npmjs.org
|
||||
- npmci command npm audit --audit-level=high --only=dev
|
||||
tags:
|
||||
- docker
|
||||
allow_failure: true
|
||||
|
||||
# ====================
|
||||
# test stage
|
||||
# ====================
|
||||
|
||||
testStable:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci npm test
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
testBuild:
|
||||
stage: test
|
||||
script:
|
||||
- npmci npm prepare
|
||||
- npmci node install stable
|
||||
- npmci npm install
|
||||
- npmci command npm run build
|
||||
coverage: /\d+.?\d+?\%\s*coverage/
|
||||
tags:
|
||||
- docker
|
||||
|
||||
release:
|
||||
stage: release
|
||||
script:
|
||||
- npmci node install stable
|
||||
- npmci npm publish
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
# ====================
|
||||
# metadata stage
|
||||
# ====================
|
||||
codequality:
|
||||
stage: metadata
|
||||
allow_failure: true
|
||||
only:
|
||||
- tags
|
||||
script:
|
||||
- npmci command npm install -g typescript
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- priv
|
||||
|
||||
trigger:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci trigger
|
||||
only:
|
||||
- tags
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
|
||||
pages:
|
||||
stage: metadata
|
||||
script:
|
||||
- npmci node install lts
|
||||
- npmci command npm install -g @gitzone/tsdoc
|
||||
- npmci npm prepare
|
||||
- npmci npm install
|
||||
- npmci command tsdoc
|
||||
tags:
|
||||
- lossless
|
||||
- docker
|
||||
- notpriv
|
||||
only:
|
||||
- tags
|
||||
artifacts:
|
||||
expire_in: 1 week
|
||||
paths:
|
||||
- public
|
||||
allow_failure: true
|
||||
BIN
.serena/cache/typescript/document_symbols_cache_v23-06-25.pkl
vendored
Normal file
BIN
.serena/cache/typescript/document_symbols_cache_v23-06-25.pkl
vendored
Normal file
Binary file not shown.
68
.serena/project.yml
Normal file
68
.serena/project.yml
Normal file
@@ -0,0 +1,68 @@
|
||||
# language of the project (csharp, python, rust, java, typescript, go, cpp, or ruby)
|
||||
# * For C, use cpp
|
||||
# * For JavaScript, use typescript
|
||||
# Special requirements:
|
||||
# * csharp: Requires the presence of a .sln file in the project folder.
|
||||
language: typescript
|
||||
|
||||
# whether to use the project's gitignore file to ignore files
|
||||
# Added on 2025-04-07
|
||||
ignore_all_files_in_gitignore: true
|
||||
# list of additional paths to ignore
|
||||
# same syntax as gitignore, so you can use * and **
|
||||
# Was previously called `ignored_dirs`, please update your config if you are using that.
|
||||
# Added (renamed) on 2025-04-07
|
||||
ignored_paths: []
|
||||
|
||||
# whether the project is in read-only mode
|
||||
# If set to true, all editing tools will be disabled and attempts to use them will result in an error
|
||||
# Added on 2025-04-18
|
||||
read_only: false
|
||||
|
||||
|
||||
# list of tool names to exclude. We recommend not excluding any tools, see the readme for more details.
|
||||
# Below is the complete list of tools for convenience.
|
||||
# To make sure you have the latest list of tools, and to view their descriptions,
|
||||
# execute `uv run scripts/print_tool_overview.py`.
|
||||
#
|
||||
# * `activate_project`: Activates a project by name.
|
||||
# * `check_onboarding_performed`: Checks whether project onboarding was already performed.
|
||||
# * `create_text_file`: Creates/overwrites a file in the project directory.
|
||||
# * `delete_lines`: Deletes a range of lines within a file.
|
||||
# * `delete_memory`: Deletes a memory from Serena's project-specific memory store.
|
||||
# * `execute_shell_command`: Executes a shell command.
|
||||
# * `find_referencing_code_snippets`: Finds code snippets in which the symbol at the given location is referenced.
|
||||
# * `find_referencing_symbols`: Finds symbols that reference the symbol at the given location (optionally filtered by type).
|
||||
# * `find_symbol`: Performs a global (or local) search for symbols with/containing a given name/substring (optionally filtered by type).
|
||||
# * `get_current_config`: Prints the current configuration of the agent, including the active and available projects, tools, contexts, and modes.
|
||||
# * `get_symbols_overview`: Gets an overview of the top-level symbols defined in a given file.
|
||||
# * `initial_instructions`: Gets the initial instructions for the current project.
|
||||
# Should only be used in settings where the system prompt cannot be set,
|
||||
# e.g. in clients you have no control over, like Claude Desktop.
|
||||
# * `insert_after_symbol`: Inserts content after the end of the definition of a given symbol.
|
||||
# * `insert_at_line`: Inserts content at a given line in a file.
|
||||
# * `insert_before_symbol`: Inserts content before the beginning of the definition of a given symbol.
|
||||
# * `list_dir`: Lists files and directories in the given directory (optionally with recursion).
|
||||
# * `list_memories`: Lists memories in Serena's project-specific memory store.
|
||||
# * `onboarding`: Performs onboarding (identifying the project structure and essential tasks, e.g. for testing or building).
|
||||
# * `prepare_for_new_conversation`: Provides instructions for preparing for a new conversation (in order to continue with the necessary context).
|
||||
# * `read_file`: Reads a file within the project directory.
|
||||
# * `read_memory`: Reads the memory with the given name from Serena's project-specific memory store.
|
||||
# * `remove_project`: Removes a project from the Serena configuration.
|
||||
# * `replace_lines`: Replaces a range of lines within a file with new content.
|
||||
# * `replace_symbol_body`: Replaces the full definition of a symbol.
|
||||
# * `restart_language_server`: Restarts the language server, may be necessary when edits not through Serena happen.
|
||||
# * `search_for_pattern`: Performs a search for a pattern in the project.
|
||||
# * `summarize_changes`: Provides instructions for summarizing the changes made to the codebase.
|
||||
# * `switch_modes`: Activates modes by providing a list of their names
|
||||
# * `think_about_collected_information`: Thinking tool for pondering the completeness of collected information.
|
||||
# * `think_about_task_adherence`: Thinking tool for determining whether the agent is still on track with the current task.
|
||||
# * `think_about_whether_you_are_done`: Thinking tool for determining whether the task is truly completed.
|
||||
# * `write_memory`: Writes a named memory (for future reference) to Serena's project-specific memory store.
|
||||
excluded_tools: []
|
||||
|
||||
# initial prompt for the project. It will always be given to the LLM upon activating the project
|
||||
# (contrary to the memories, which are loaded on demand).
|
||||
initial_prompt: ""
|
||||
|
||||
project_name: "mongodump"
|
||||
41
changelog.md
Normal file
41
changelog.md
Normal file
@@ -0,0 +1,41 @@
|
||||
# Changelog
|
||||
|
||||
## 2025-08-18 - 1.1.0 - feat(MongoDumpTarget)
|
||||
Implement core MongoDumpTarget methods and update documentation & project configs
|
||||
|
||||
- Implemented MongoDumpTarget.createAndInit(), init(), getCollections(), dumpCollectionToDir() and dumpAllCollectionsToDir() with connection handling, collection enumeration and file output.
|
||||
- Added safe directory handling (ensureDir / ensureEmptyDir) and document-to-file writing using smartfile.memory.toFs and smartpath transformation.
|
||||
- Enhanced README with detailed usage examples, API reference and best practices.
|
||||
- Added local project configuration files (.claude/settings.local.json and .serena/project.yml) to support tooling and project metadata.
|
||||
|
||||
## 2025-08-18 - 1.0.10 - fix(mongodump.plugins)
|
||||
Bump @types/node to ^22.0.0 and use runtime import for @tsclass/tsclass in plugins
|
||||
|
||||
- Bumped dev dependency @types/node from ^17.0.40 to ^22.0.0 in package.json
|
||||
- Changed import of @tsclass/tsclass from a type-only import to a runtime import in ts/mongodump.plugins.ts so tsclass is exported and available at runtime
|
||||
|
||||
## 2025-08-18 - 1.0.9 - fix(dependencies)
|
||||
Update dependencies, normalize package scopes to @push.rocks, bump mongodb to v6, adjust tests and add pnpm metadata
|
||||
|
||||
- Bump mongodb dependency from ^4.6.0 to ^6.18.0 (major upgrade — potential breaking changes)
|
||||
- Normalize package scopes from @pushrocks/* to @push.rocks/* across code and dependencies
|
||||
- Replace @gitzone dev tooling with @git.zone equivalents and add @git.zone/tsrun
|
||||
- Change test script to use tstest with --verbose and update test imports to @git.zone/tstest; adjust sample data import paths
|
||||
- Add packageManager field for pnpm@10.14.0 and add pnpm-workspace.yaml (onlyBuiltDependencies)
|
||||
- Remove .gitlab-ci.yml (CI configuration removed)
|
||||
- Update ts/00_commitinfo_data and mongodump.plugins to use @push.rocks naming
|
||||
- Minor test harness change: export default tap.start() instead of tap.start()
|
||||
|
||||
## 2024-05-29 - 1.0.8 - release
|
||||
Finalized 1.0.8 with packaging, configuration, and organization updates.
|
||||
|
||||
- Update package description.
|
||||
- Update TypeScript configuration (tsconfig).
|
||||
- Update npmextra.json githost entries to correct package hosting information.
|
||||
- Switch to new organization scheme for the project.
|
||||
|
||||
## 2022-06-06 - 1.0.1 → 1.0.7 - maintenance
|
||||
Series of maintenance releases and core fixes across multiple minor version bumps.
|
||||
|
||||
- Multiple "fix(core): update" changes applied across versions 1.0.1 through 1.0.7.
|
||||
- Several version-only commits and routine package bumps. No notable user-facing API changes.
|
||||
@@ -2,17 +2,32 @@
|
||||
"gitzone": {
|
||||
"projectType": "npm",
|
||||
"module": {
|
||||
"githost": "gitlab.com",
|
||||
"gitscope": "pushrocks",
|
||||
"githost": "code.foss.global",
|
||||
"gitscope": "push.rocks",
|
||||
"gitrepo": "mongodump",
|
||||
"description": "a tool to handle dumps of mongodb databases",
|
||||
"npmPackagename": "@pushrocks/mongodump",
|
||||
"description": "A tool to create and manage dumps of MongoDB databases, supporting data export and import.",
|
||||
"npmPackagename": "@push.rocks/mongodump",
|
||||
"license": "MIT",
|
||||
"projectDomain": "push.rocks"
|
||||
"projectDomain": "push.rocks",
|
||||
"keywords": [
|
||||
"mongodb",
|
||||
"database backup",
|
||||
"data dump",
|
||||
"database restore",
|
||||
"mongodb export",
|
||||
"mongodb import",
|
||||
"database management",
|
||||
"mongodb management",
|
||||
"data backup",
|
||||
"data recovery"
|
||||
]
|
||||
}
|
||||
},
|
||||
"npmci": {
|
||||
"npmGlobalTools": [],
|
||||
"npmAccessLevel": "public"
|
||||
},
|
||||
"tsdoc": {
|
||||
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
|
||||
}
|
||||
}
|
||||
1020
package-lock.json
generated
1020
package-lock.json
generated
File diff suppressed because it is too large
Load Diff
56
package.json
56
package.json
@@ -1,25 +1,25 @@
|
||||
{
|
||||
"name": "@pushrocks/mongodump",
|
||||
"version": "1.0.8",
|
||||
"name": "@push.rocks/mongodump",
|
||||
"version": "1.1.0",
|
||||
"private": false,
|
||||
"description": "a tool to handle dumps of mongodb databases",
|
||||
"description": "A tool to create and manage dumps of MongoDB databases, supporting data export and import.",
|
||||
"main": "dist_ts/index.js",
|
||||
"typings": "dist_ts/index.d.ts",
|
||||
"type": "module",
|
||||
"author": "Lossless GmbH",
|
||||
"license": "MIT",
|
||||
"scripts": {
|
||||
"test": "(tstest test/ --web)",
|
||||
"test": "(tstest test/ --verbose)",
|
||||
"build": "(tsbuild --web --allowimplicitany)"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@gitzone/tsbuild": "^2.1.25",
|
||||
"@gitzone/tsbundle": "^2.0.5",
|
||||
"@gitzone/tstest": "^1.0.44",
|
||||
"@pushrocks/smartdata": "^5.0.5",
|
||||
"@pushrocks/smartmongo": "^2.0.3",
|
||||
"@pushrocks/tapbundle": "^5.0.3",
|
||||
"@types/node": "^17.0.40"
|
||||
"@git.zone/tsbuild": "^2.1.25",
|
||||
"@git.zone/tsbundle": "^2.0.5",
|
||||
"@git.zone/tsrun": "^1.3.3",
|
||||
"@git.zone/tstest": "^2.3.4",
|
||||
"@push.rocks/smartdata": "^5.0.5",
|
||||
"@push.rocks/smartmongo": "^2.0.3",
|
||||
"@types/node": "^22.0.0"
|
||||
},
|
||||
"browserslist": [
|
||||
"last 1 chrome versions"
|
||||
@@ -37,12 +37,30 @@
|
||||
"readme.md"
|
||||
],
|
||||
"dependencies": {
|
||||
"@pushrocks/lik": "^6.0.0",
|
||||
"@pushrocks/smartfile": "^9.0.6",
|
||||
"@pushrocks/smartjson": "^4.0.6",
|
||||
"@pushrocks/smartpath": "^5.0.5",
|
||||
"@pushrocks/smartpromise": "^3.1.7",
|
||||
"@tsclass/tsclass": "^4.0.3",
|
||||
"mongodb": "^4.6.0"
|
||||
}
|
||||
"@push.rocks/lik": "^6.0.0",
|
||||
"@push.rocks/smartfile": "^11.2.7",
|
||||
"@push.rocks/smartjson": "^5.0.6",
|
||||
"@push.rocks/smartpath": "^6.0.0",
|
||||
"@push.rocks/smartpromise": "^4.0.2",
|
||||
"@tsclass/tsclass": "^9.2.0",
|
||||
"mongodb": "^6.18.0"
|
||||
},
|
||||
"keywords": [
|
||||
"mongodb",
|
||||
"database backup",
|
||||
"data dump",
|
||||
"database restore",
|
||||
"mongodb export",
|
||||
"mongodb import",
|
||||
"database management",
|
||||
"mongodb management",
|
||||
"data backup",
|
||||
"data recovery"
|
||||
],
|
||||
"homepage": "https://code.foss.global/push.rocks/mongodump",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://code.foss.global/push.rocks/mongodump.git"
|
||||
},
|
||||
"packageManager": "pnpm@10.14.0+sha512.ad27a79641b49c3e481a16a805baa71817a04bbe06a38d17e60e2eaee83f6a146c6a688125f5792e48dd5ba30e7da52a5cda4c3992b9ccf333f9ce223af84748"
|
||||
}
|
||||
|
||||
8762
pnpm-lock.yaml
generated
Normal file
8762
pnpm-lock.yaml
generated
Normal file
File diff suppressed because it is too large
Load Diff
2
pnpm-workspace.yaml
Normal file
2
pnpm-workspace.yaml
Normal file
@@ -0,0 +1,2 @@
|
||||
onlyBuiltDependencies:
|
||||
- esbuild
|
||||
1
readme.hints.md
Normal file
1
readme.hints.md
Normal file
@@ -0,0 +1 @@
|
||||
|
||||
293
readme.md
293
readme.md
@@ -1,39 +1,274 @@
|
||||
# @pushrocks/mongodump
|
||||
a tool to handle dumps of mongodb databases
|
||||
# @push.rocks/mongodump
|
||||
|
||||
## Availabililty and Links
|
||||
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/mongodump)
|
||||
* [gitlab.com (source)](https://gitlab.com/pushrocks/mongodump)
|
||||
* [github.com (source mirror)](https://github.com/pushrocks/mongodump)
|
||||
* [docs (typedoc)](https://pushrocks.gitlab.io/mongodump/)
|
||||
**A powerful MongoDB backup and restore tool** 🚀
|
||||
|
||||
## Status for master
|
||||
[](https://www.npmjs.com/package/@push.rocks/mongodump)
|
||||
[](https://www.npmjs.com/package/@push.rocks/mongodump)
|
||||
[](https://www.typescriptlang.org/)
|
||||
[](https://nodejs.org/api/esm.html)
|
||||
|
||||
Status Category | Status Badge
|
||||
-- | --
|
||||
GitLab Pipelines | [](https://lossless.cloud)
|
||||
GitLab Pipline Test Coverage | [](https://lossless.cloud)
|
||||
npm | [](https://lossless.cloud)
|
||||
Snyk | [](https://lossless.cloud)
|
||||
TypeScript Support | [](https://lossless.cloud)
|
||||
node Support | [](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
||||
Code Style | [](https://lossless.cloud)
|
||||
PackagePhobia (total standalone install weight) | [](https://lossless.cloud)
|
||||
PackagePhobia (package size on registry) | [](https://lossless.cloud)
|
||||
BundlePhobia (total size when bundled) | [](https://lossless.cloud)
|
||||
Platform support | [](https://lossless.cloud) [](https://lossless.cloud)
|
||||
## What it does 🎯
|
||||
|
||||
## Usage
|
||||
`@push.rocks/mongodump` is your go-to solution for creating and managing MongoDB database dumps. Whether you're backing up critical production data, migrating between environments, or implementing disaster recovery strategies, this tool has got your back. It provides a clean, TypeScript-based API for:
|
||||
|
||||
Use TypeScript for best in class intellisense
|
||||
- 📦 **Full database backups** - Export entire MongoDB databases
|
||||
- 🗂️ **Collection-level dumps** - Selectively backup specific collections
|
||||
- 🏷️ **Custom naming** - Transform document names during export
|
||||
- 🗜️ **Archive support** - Create compressed tar archives of your dumps
|
||||
- 🔄 **Async/await patterns** - Modern promise-based workflow
|
||||
- 🎨 **TypeScript first** - Full type safety and IntelliSense support
|
||||
|
||||
## Contribution
|
||||
## Installation 💻
|
||||
|
||||
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
|
||||
```bash
|
||||
# Using npm
|
||||
npm install @push.rocks/mongodump --save
|
||||
|
||||
For further information read the linked docs at the top of this readme.
|
||||
# Using pnpm (recommended)
|
||||
pnpm add @push.rocks/mongodump
|
||||
|
||||
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
||||
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
|
||||
# Using yarn
|
||||
yarn add @push.rocks/mongodump
|
||||
```
|
||||
|
||||
[](https://maintainedby.lossless.com)
|
||||
## Quick Start 🚀
|
||||
|
||||
Get up and running in seconds:
|
||||
|
||||
```typescript
|
||||
import { MongoDump } from '@push.rocks/mongodump';
|
||||
import type { IMongoDescriptor } from '@tsclass/tsclass';
|
||||
|
||||
// Define your MongoDB connection
|
||||
const mongoDescriptor: IMongoDescriptor = {
|
||||
mongoDbName: 'my-database',
|
||||
mongoDbUser: 'admin',
|
||||
mongoDbPass: 'secure-password',
|
||||
mongoDbUrl: 'mongodb+srv://cluster.mongodb.net',
|
||||
};
|
||||
|
||||
// Create a dump of your entire database
|
||||
const mongoDump = new MongoDump();
|
||||
const target = await mongoDump.addMongoTargetByMongoDescriptor(mongoDescriptor);
|
||||
await target.dumpAllCollectionsToDir('./backups/my-backup');
|
||||
|
||||
// Done! Your backup is ready 🎉
|
||||
await mongoDump.stop();
|
||||
```
|
||||
|
||||
## Detailed Usage 📚
|
||||
|
||||
### Setting Up MongoDB Connection
|
||||
|
||||
The module uses MongoDB descriptors to establish connections. This approach provides flexibility and security:
|
||||
|
||||
```typescript
|
||||
import { IMongoDescriptor } from '@tsclass/tsclass';
|
||||
import { MongoDump, MongoDumpTarget } from '@push.rocks/mongodump';
|
||||
|
||||
const mongoDescriptor: IMongoDescriptor = {
|
||||
mongoDbName: 'production_db',
|
||||
mongoDbUser: process.env.MONGO_USER,
|
||||
mongoDbPass: process.env.MONGO_PASS,
|
||||
mongoDbUrl: process.env.MONGO_URL,
|
||||
};
|
||||
```
|
||||
|
||||
### Working with MongoDump
|
||||
|
||||
The `MongoDump` class is your main entry point for managing database dumps:
|
||||
|
||||
```typescript
|
||||
const mongoDump = new MongoDump();
|
||||
|
||||
// Add a MongoDB target
|
||||
const dumpTarget = await mongoDump.addMongoTargetByMongoDescriptor(mongoDescriptor);
|
||||
|
||||
// The target is now ready for dump operations
|
||||
```
|
||||
|
||||
### Dumping Collections
|
||||
|
||||
#### Dump All Collections to Directory
|
||||
|
||||
Perfect for complete database backups:
|
||||
|
||||
```typescript
|
||||
// Basic dump - uses document _id as filename
|
||||
await dumpTarget.dumpAllCollectionsToDir('./backups/full-backup');
|
||||
|
||||
// Custom naming - use any document field for filenames
|
||||
await dumpTarget.dumpAllCollectionsToDir(
|
||||
'./backups/named-backup',
|
||||
(doc) => `${doc.username}_${doc.timestamp}`,
|
||||
true // Clean directory before dumping
|
||||
);
|
||||
```
|
||||
|
||||
#### Dump Specific Collection
|
||||
|
||||
When you need granular control:
|
||||
|
||||
```typescript
|
||||
// Get available collections
|
||||
const collections = await dumpTarget.getCollections();
|
||||
console.log('Available collections:', collections);
|
||||
|
||||
// Dump a specific collection
|
||||
const userCollection = collections.find(c => c.collectionName === 'users');
|
||||
await dumpTarget.dumpCollectionToDir(
|
||||
userCollection,
|
||||
'./backups/users',
|
||||
(doc) => doc.email.replace('@', '_at_') // Custom naming
|
||||
);
|
||||
```
|
||||
|
||||
### Archive Support
|
||||
|
||||
Create compressed archives for efficient storage and transfer:
|
||||
|
||||
```typescript
|
||||
// Dump to tar archive file
|
||||
await dumpTarget.dumpCollectionToTarArchiveFile(
|
||||
userCollection,
|
||||
'./backups/users.tar.gz'
|
||||
);
|
||||
|
||||
// Or work with streams for advanced scenarios
|
||||
const archiveStream = await dumpTarget.dumpAllCollectionsToTarArchiveStream();
|
||||
// Pipe to S3, network storage, etc.
|
||||
```
|
||||
|
||||
### Advanced Patterns
|
||||
|
||||
#### Scheduled Backups
|
||||
|
||||
Implement automated backup strategies:
|
||||
|
||||
```typescript
|
||||
import { CronJob } from 'cron';
|
||||
|
||||
const backupJob = new CronJob('0 0 * * *', async () => {
|
||||
const timestamp = new Date().toISOString().split('T')[0];
|
||||
const mongoDump = new MongoDump();
|
||||
const target = await mongoDump.addMongoTargetByMongoDescriptor(mongoDescriptor);
|
||||
|
||||
await target.dumpAllCollectionsToDir(
|
||||
`./backups/daily/${timestamp}`,
|
||||
null,
|
||||
true
|
||||
);
|
||||
|
||||
await mongoDump.stop();
|
||||
console.log(`✅ Daily backup completed: ${timestamp}`);
|
||||
});
|
||||
|
||||
backupJob.start();
|
||||
```
|
||||
|
||||
#### Multiple Database Targets
|
||||
|
||||
Handle multiple databases simultaneously:
|
||||
|
||||
```typescript
|
||||
const mongoDump = new MongoDump();
|
||||
|
||||
// Add multiple targets
|
||||
const prodTarget = await mongoDump.addMongoTargetByMongoDescriptor(prodDescriptor);
|
||||
const stagingTarget = await mongoDump.addMongoTargetByMongoDescriptor(stagingDescriptor);
|
||||
|
||||
// Dump both in parallel
|
||||
await Promise.all([
|
||||
prodTarget.dumpAllCollectionsToDir('./backups/production'),
|
||||
stagingTarget.dumpAllCollectionsToDir('./backups/staging')
|
||||
]);
|
||||
|
||||
await mongoDump.stop();
|
||||
```
|
||||
|
||||
#### Error Handling
|
||||
|
||||
Implement robust error handling:
|
||||
|
||||
```typescript
|
||||
try {
|
||||
const mongoDump = new MongoDump();
|
||||
const target = await mongoDump.addMongoTargetByMongoDescriptor(mongoDescriptor);
|
||||
|
||||
await target.dumpAllCollectionsToDir('./backups/safe-backup');
|
||||
console.log('✅ Backup successful');
|
||||
|
||||
} catch (error) {
|
||||
console.error('❌ Backup failed:', error);
|
||||
// Implement notification/retry logic
|
||||
|
||||
} finally {
|
||||
await mongoDump.stop();
|
||||
}
|
||||
```
|
||||
|
||||
### Clean Shutdown
|
||||
|
||||
Always ensure proper cleanup of database connections:
|
||||
|
||||
```typescript
|
||||
// Closes all open MongoDB connections
|
||||
await mongoDump.stop();
|
||||
```
|
||||
|
||||
## API Reference 🔧
|
||||
|
||||
### MongoDump
|
||||
|
||||
The main class for managing dump operations.
|
||||
|
||||
**Methods:**
|
||||
- `addMongoTargetByMongoDescriptor(descriptor: IMongoDescriptor)`: Create a new dump target
|
||||
- `stop()`: Close all database connections
|
||||
|
||||
### MongoDumpTarget
|
||||
|
||||
Handles operations for a specific MongoDB database.
|
||||
|
||||
**Methods:**
|
||||
- `getCollections()`: List all collections in the database
|
||||
- `dumpCollectionToDir(collection, directory, nameTransform?)`: Dump single collection
|
||||
- `dumpAllCollectionsToDir(directory, nameTransform?, cleanDir?)`: Dump all collections
|
||||
- `dumpCollectionToTarArchiveFile(collection, filepath)`: Create tar archive
|
||||
- `dumpAllCollectionsToTarArchiveStream()`: Get tar archive stream
|
||||
|
||||
## Best Practices 💡
|
||||
|
||||
1. **Environment Variables**: Store credentials in environment variables, never hardcode them
|
||||
2. **Error Handling**: Always wrap dump operations in try-catch blocks
|
||||
3. **Connection Cleanup**: Always call `stop()` when done
|
||||
4. **Backup Verification**: Periodically verify your backups can be restored
|
||||
5. **Storage Rotation**: Implement backup rotation to manage disk space
|
||||
6. **Monitoring**: Add logging and monitoring for production backup jobs
|
||||
|
||||
## Why Choose @push.rocks/mongodump? 🌟
|
||||
|
||||
- **Type Safety**: Full TypeScript support with comprehensive type definitions
|
||||
- **Modern Async**: Built on promises and async/await patterns
|
||||
- **Flexible Export**: Multiple export formats and naming options
|
||||
- **Production Ready**: Battle-tested in production environments
|
||||
- **Clean API**: Intuitive, well-documented interface
|
||||
- **Active Maintenance**: Regular updates and security patches
|
||||
## License and Legal Information
|
||||
|
||||
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
|
||||
|
||||
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
|
||||
|
||||
### Trademarks
|
||||
|
||||
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
|
||||
|
||||
### Company Information
|
||||
|
||||
Task Venture Capital GmbH
|
||||
Registered at District court Bremen HRB 35230 HB, Germany
|
||||
|
||||
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
|
||||
|
||||
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
import * as smartdata from '@pushrocks/smartdata';
|
||||
import * as smartdata from '@push.rocks/smartdata';
|
||||
|
||||
let db: smartdata.SmartdataDb;
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
import { expect, expectAsync, tap } from '@pushrocks/tapbundle';
|
||||
import * as smartmongo from '@pushrocks/smartmongo';
|
||||
import { expect, tap } from '@git.zone/tstest/tapbundle';
|
||||
import * as smartmongo from '@push.rocks/smartmongo';
|
||||
import * as mongodump from '../ts/index.js';
|
||||
|
||||
import * as sampledata from './sampledata.js';
|
||||
@@ -36,4 +36,4 @@ tap.test('should stop the smartmongo instance', async () => {
|
||||
await testSmartMongo.stop();
|
||||
});
|
||||
|
||||
tap.start();
|
||||
export default tap.start();
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
/**
|
||||
* autocreated commitinfo by @pushrocks/commitinfo
|
||||
* autocreated commitinfo by @push.rocks/commitinfo
|
||||
*/
|
||||
export const commitinfo = {
|
||||
name: '@pushrocks/mongodump',
|
||||
version: '1.0.8',
|
||||
description: 'a tool to handle dumps of mongodb databases'
|
||||
name: '@push.rocks/mongodump',
|
||||
version: '1.1.0',
|
||||
description: 'A tool to create and manage dumps of MongoDB databases, supporting data export and import.'
|
||||
}
|
||||
|
||||
@@ -6,11 +6,11 @@ export {
|
||||
}
|
||||
|
||||
// pushrocks scope
|
||||
import * as lik from '@pushrocks/lik';
|
||||
import * as smartfile from '@pushrocks/smartfile';
|
||||
import * as smartjson from '@pushrocks/smartjson';
|
||||
import * as smartpath from '@pushrocks/smartpath';
|
||||
import * as smartpromise from '@pushrocks/smartpromise';
|
||||
import * as lik from '@push.rocks/lik';
|
||||
import * as smartfile from '@push.rocks/smartfile';
|
||||
import * as smartjson from '@push.rocks/smartjson';
|
||||
import * as smartpath from '@push.rocks/smartpath';
|
||||
import * as smartpromise from '@push.rocks/smartpromise';
|
||||
|
||||
export {
|
||||
lik,
|
||||
@@ -21,7 +21,7 @@ export {
|
||||
}
|
||||
|
||||
// tsclass
|
||||
import type * as tsclass from '@tsclass/tsclass';
|
||||
import * as tsclass from '@tsclass/tsclass';
|
||||
|
||||
export {
|
||||
tsclass
|
||||
|
||||
@@ -3,7 +3,12 @@
|
||||
"experimentalDecorators": true,
|
||||
"useDefineForClassFields": false,
|
||||
"target": "ES2022",
|
||||
"module": "ES2022",
|
||||
"moduleResolution": "nodenext"
|
||||
}
|
||||
"module": "NodeNext",
|
||||
"moduleResolution": "NodeNext",
|
||||
"esModuleInterop": true,
|
||||
"verbatimModuleSyntax": true
|
||||
},
|
||||
"exclude": [
|
||||
"dist_*/**/*.d.ts"
|
||||
]
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user