@serve.zone/dcrouter-migrations

Migration runner package for dcrouter's smartdata-backed persistence layer. 🧱

This package provides the startup migration chain that upgrades dcrouter data across releases before the application reads from the database.

Issue Reporting and Security

For reporting bugs, issues, or security vulnerabilities, please visit community.foss.global/. This is the central community hub for all issue reporting. Developers who sign and comply with our contribution agreement and go through identification can also get a code.foss.global/ account to submit Pull Requests directly.

What It Exports

Export	Purpose
`createMigrationRunner(db, targetVersion)`	Builds the dcrouter SmartMigration runner for the current application version
`IMigrationRunner`	Small interface describing the runner's `run()` method
`IMigrationRunResult`	Logged result shape used after execution

Usage

import { createMigrationRunner } from '@serve.zone/dcrouter-migrations';

const migration = await createMigrationRunner(db, '13.18.0');
const result = await migration.run();

console.log(result.currentVersionBefore, result.currentVersionAfter);

What These Migrations Handle

The migration chain currently covers dcrouter-specific storage transitions such as:

target profile target field renames
domain and DNS record source renames
route collection unification into RouteDoc
persisted route metadata backfills such as origin and systemKey

Important Behavior

fresh installs are stamped directly to the current target version
migration steps are registered in strict version order
migrations run before services load DB-backed state
route-related migrations use smartdata collection names exactly as declared in code

If you are embedding dcrouter's DB layer outside the main runtime, run this package before any feature code assumes the latest schema.

License and Legal Information

This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the license file.

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 or third parties, 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 or the guidelines of the respective third-party owners, and any usage must be approved in writing. Third-party trademarks used herein are the property of their respective owners and used only in a descriptive manner, e.g. for an implementation of an API or similar.

3.5 KiB Raw Blame History