Skip to content

Commit cbf7df8

Browse files
committed
chore: clarify core directory.
1 parent 79efc01 commit cbf7df8

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

migration/core/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# `core`
2+
`core` contains the `-core` APIs for which migration. It contains the following subdirectories.
3+
4+
1. [`node`](./node/): refers to the parts of the migration which run with privileged access to the node itself--including file-based state and
5+
2. [`migrator`](./migrator/): refers to parts of the migration which run with all other units. Currently, `migrator` includes access to `node` via `.node()` methods on the migrators as well as access to REST clients via `.wait_for_rest_client()` methods on the migrators. Thus, `migrators` can also be where migrations are run which require transaction API usage.
6+
3. [`mtma`](./mtma/): refers to what is ultimately exported as the correct migration. Currently, this is basically empty. It is the end-target for `mtma` migration development.

0 commit comments

Comments
 (0)