> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Migrations コレクション

`migrations` は、どのデータベースマイグレーションが実行済みかを記録します。1 つのドキュメントは `tools/migrations/` の 1 つのマイグレーションです。実行中のサービスではなく、マイグレーションツール [east](https://github.com/okv/east) のアダプター `tools/migrations/lib/adapter.mjs` が書き込みます。

#### フィールド

| フィールド | 型 | 意味 | 出典 |
| - | - | - | - |
| `_id` | ObjectId | ドキュメント id。 | `adapter.mjs:103` |
| `name` | String | 拡張子を除いたマイグレーションのファイル名。例: `20190912145029_create_tags_indexes`。 | `adapter.mjs:104` |
| `migratedAt` | Date | マイグレーションが完了した日時。 | `adapter.mjs:105` |

#### 書き込むコード

| コード | 動作 |
| - | - |
| `adapter.mjs:101-107` (`markExecuted`) | マイグレーションの実行後にドキュメントを挿入します。 |
| `adapter.mjs:109-114` (`unmarkExecuted`) | マイグレーションがロールバックされたときに、それを再び削除します。 |

CE はコンテナの起動のたびに `yarn run migrations migrate -t server-ce` を実行します（`server-ce/init_scripts/900_run_web_migrations.sh:4-12`。`OVERLEAF_IS_SERVER_PRO=true` の場合は `-t server-pro`）。`tags` にその環境を含むマイグレーションだけが実行されるため、それらだけがここにドキュメントを持ちます。

#### 読み取るコード

| コード | 動作 |
| - | - |
| `adapter.mjs:72-99` (`getExecutedMigrationNames`) | east は、名前が既にここにあるマイグレーションをすべてスキップします。 |
| `tools/migrations/lib/helpers.mjs:67-75` (`assertDependency`) | 別のマイグレーションの事前実行を必要とするマイグレーションは、その名前がない場合に例外を投げます。 |

#### インデックス

| 名前 | キー | オプション | マイグレーション |
| - | - | - | - |
| `name_1` | `{ name: 1 }` | unique | `tools/migrations/20190720165251_create_migrations.mjs` |

#### 補足

* ドキュメントを削除すると、タグが一致する場合、そのマイグレーションは次回のコンテナ起動時に再実行されます。
* 補助 Mongo クラスター（`mongo.auxUrl`）がある場合、`auxiliary` タグの付いたマイグレーションは代わりにそのクラスターの `migrations` コレクションに記録されます（`adapter.mjs:8-15`、`:64-70`）。`mongo.auxUrl` は `MONGO_AUX_CONNECTION_STRING`（`tools/migrations/config/settings.defaults.js:19`）から取得され、デフォルトでは未設定です。


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.