Skip to content

fluentmigrator/fluentmigrator.github.io

Repository files navigation

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
  <head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width,initial-scale=1">
    <title>FluentMigrator Documentation Website | FluentMigrator</title>
    <meta name="description" content="A .NET migration framework for database schema management">
    <meta name="generator" content="VitePress v1.6.4">
    <link rel="preload stylesheet" href="/assets/style.Cs1QHm9W.css" as="style">
    <link rel="preload stylesheet" href="/vp-icons.css" as="style">
    
    <script type="module" src="/assets/app.DuRicayD.js"></script>
    <link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
    <link rel="modulepreload" href="/assets/chunks/theme.CFA23FMy.js">
    <link rel="modulepreload" href="/assets/chunks/framework.PyOy_Pvu.js">
    <link rel="modulepreload" href="/assets/README.md.tZhmTXOk.lean.js">
    <link rel="icon" href="logo-favicon.svg">
    <script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
    <script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
  </head>
  <body>
    <div id="app"><div class="Layout" data-v-d8b57b2d><!--[--><!--]--><!--[--><span tabindex="-1" data-v-fcbfc0e0></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-fcbfc0e0>Skip to content</a><!--]--><!----><header class="VPNav" data-v-d8b57b2d data-v-7ad780c2><div class="VPNavBar" data-v-7ad780c2 data-v-9fd4d1dd><div class="wrapper" data-v-9fd4d1dd><div class="container" data-v-9fd4d1dd><div class="title" data-v-9fd4d1dd><div class="VPNavBarTitle has-sidebar" data-v-9fd4d1dd data-v-9f43907a><a class="title" href="/" data-v-9f43907a><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/logo-white.svg" alt data-v-ab19afbb><!--]--><!--[--><img class="VPImage light logo" src="/logo.svg" alt data-v-ab19afbb><!--]--><!--]--><!--]--><span data-v-9f43907a>FluentMigrator</span><!--[--><!--]--></a></div></div><div class="content" data-v-9fd4d1dd><div class="content-body" data-v-9fd4d1dd><!--[--><!--]--><div class="VPNavBarSearch search" data-v-9fd4d1dd><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-9fd4d1dd data-v-afb2845e><span id="main-nav-aria-label" class="visually-hidden" data-v-afb2845e> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/" tabindex="0" data-v-afb2845e data-v-815115f5><!--[--><span data-v-815115f5>Home</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/intro/quick-start.html" tabindex="0" data-v-afb2845e data-v-815115f5><!--[--><span data-v-815115f5>Documentation</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://github.com/fluentmigrator/fluentmigrator/releases" target="_blank" rel="noreferrer" tabindex="0" data-v-afb2845e data-v-815115f5><!--[--><span data-v-815115f5>Release notes</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://github.com/fluentmigrator/fluentmigrator" target="_blank" rel="noreferrer" tabindex="0" data-v-afb2845e data-v-815115f5><!--[--><span data-v-815115f5>GitHub</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-9fd4d1dd data-v-3f90c1a5><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-3f90c1a5 data-v-be9742d9 data-v-b4ccac88><span class="check" data-v-b4ccac88><span class="icon" data-v-b4ccac88><!--[--><span class="vpi-sun sun" data-v-be9742d9></span><span class="vpi-moon moon" data-v-be9742d9></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-9fd4d1dd data-v-ef6192dc data-v-e71e869c><!--[--><a class="VPSocialLink no-icon" href="https://github.com/fluentmigrator/fluentmigrator" aria-label="github" target="_blank" rel="noopener" data-v-e71e869c data-v-60a9a2d3><span class="vpi-social-github"></span></a><!--]--></div><div class="VPFlyout VPNavBarExtra extra" data-v-9fd4d1dd data-v-f953d92f data-v-bfe7971f><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-bfe7971f><span class="vpi-more-horizontal icon" data-v-bfe7971f></span></button><div class="menu" data-v-bfe7971f><div class="VPMenu" data-v-bfe7971f data-v-20ed86d6><!----><!--[--><!--[--><!----><div class="group" data-v-f953d92f><div class="item appearance" data-v-f953d92f><p class="label" data-v-f953d92f>Appearance</p><div class="appearance-action" data-v-f953d92f><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-f953d92f data-v-be9742d9 data-v-b4ccac88><span class="check" data-v-b4ccac88><span class="icon" data-v-b4ccac88><!--[--><span class="vpi-sun sun" data-v-be9742d9></span><span class="vpi-moon moon" data-v-be9742d9></span><!--]--></span></span></button></div></div></div><div class="group" data-v-f953d92f><div class="item social-links" data-v-f953d92f><div class="VPSocialLinks social-links-list" data-v-f953d92f data-v-e71e869c><!--[--><a class="VPSocialLink no-icon" href="https://github.com/fluentmigrator/fluentmigrator" aria-label="github" target="_blank" rel="noopener" data-v-e71e869c data-v-60a9a2d3><span class="vpi-social-github"></span></a><!--]--></div></div></div><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-9fd4d1dd data-v-6bee1efd><span class="container" data-v-6bee1efd><span class="top" data-v-6bee1efd></span><span class="middle" data-v-6bee1efd></span><span class="bottom" data-v-6bee1efd></span></span></button></div></div></div></div><div class="divider" data-v-9fd4d1dd><div class="divider-line" data-v-9fd4d1dd></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-d8b57b2d data-v-2488c25a><div class="container" data-v-2488c25a><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-2488c25a><span class="vpi-align-left menu-icon" data-v-2488c25a></span><span class="menu-text" data-v-2488c25a>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-2488c25a data-v-6b867909><button data-v-6b867909>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-d8b57b2d data-v-42c4c606><div class="curtain" data-v-42c4c606></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-42c4c606><span class="visually-hidden" id="sidebar-aria-label" data-v-42c4c606> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-51288d80><section class="VPSidebarItem level-0" data-v-51288d80 data-v-0009425e><div class="item" role="button" tabindex="0" data-v-0009425e><div class="indicator" data-v-0009425e></div><h2 class="text" data-v-0009425e>Introduction</h2><!----></div><div class="items" data-v-0009425e><!--[--><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/intro/quick-start.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Quick Start</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/intro/installation.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Installation</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/intro/configuration.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Configuration</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/intro/faq.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>FAQ</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-51288d80><section class="VPSidebarItem level-0" data-v-51288d80 data-v-0009425e><div class="item" role="button" tabindex="0" data-v-0009425e><div class="indicator" data-v-0009425e></div><h2 class="text" data-v-0009425e>Operations</h2><!----></div><div class="items" data-v-0009425e><!--[--><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/operations/create-tables.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Creating Tables</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/operations/alter-tables.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Altering Tables</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/operations/columns.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Managing Columns</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/operations/data.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Data Operations</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/operations/schema.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Schema Operations</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/operations/execute-sql.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Execute SQL</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/operations/with-connection.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Run code on connection</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-51288d80><section class="VPSidebarItem level-0" data-v-51288d80 data-v-0009425e><div class="item" role="button" tabindex="0" data-v-0009425e><div class="indicator" data-v-0009425e></div><h2 class="text" data-v-0009425e>Basics</h2><!----></div><div class="items" data-v-0009425e><!--[--><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/basics/columns.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Columns</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/basics/indexes.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Indexes</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/basics/constraints.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Constraints</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/basics/foreign-keys.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Foreign Keys</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/basics/raw-sql.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Raw SQL Helper</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-51288d80><section class="VPSidebarItem level-0" data-v-51288d80 data-v-0009425e><div class="item" role="button" tabindex="0" data-v-0009425e><div class="indicator" data-v-0009425e></div><h2 class="text" data-v-0009425e>Migration Runners</h2><!----></div><div class="items" data-v-0009425e><!--[--><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/runners/index.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Choosing a runner</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/runners/in-process.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>In-Process Runner</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/runners/console.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Console Tool (Migrate.exe)</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/runners/dotnet-fm.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>dotnet-fm CLI</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-51288d80><section class="VPSidebarItem level-0" data-v-51288d80 data-v-0009425e><div class="item" role="button" tabindex="0" data-v-0009425e><div class="indicator" data-v-0009425e></div><h2 class="text" data-v-0009425e>Database Providers</h2><!----></div><div class="items" data-v-0009425e><!--[--><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/providers/sql-server.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>SQL Server</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/providers/postgresql.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>PostgreSQL</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/providers/mysql.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>MySQL</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/providers/sqlite.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>SQLite</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/providers/oracle.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Oracle</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/providers/others.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Other Providers</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-51288d80><section class="VPSidebarItem level-0" data-v-51288d80 data-v-0009425e><div class="item" role="button" tabindex="0" data-v-0009425e><div class="indicator" data-v-0009425e></div><h2 class="text" data-v-0009425e>Migration Types</h2><!----></div><div class="items" data-v-0009425e><!--[--><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/migration-types/maintenance.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Maintenance Migrations</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/migration-types/auto-reversing.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Auto-Reversing Migrations</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/migration-types/tags.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Tags</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/migration-types/profiles.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Profiles</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-51288d80><section class="VPSidebarItem level-0" data-v-51288d80 data-v-0009425e><div class="item" role="button" tabindex="0" data-v-0009425e><div class="indicator" data-v-0009425e></div><h2 class="text" data-v-0009425e>Advanced Topics</h2><!----></div><div class="items" data-v-0009425e><!--[--><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/advanced/best-practices.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Best Practices</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/advanced/versioning.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Migration Versioning</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/advanced/conditional-logic.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Conditional Logic</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-0009425e data-v-0009425e><div class="item" data-v-0009425e><div class="indicator" data-v-0009425e></div><a class="VPLink link link" href="/advanced/custom-extensions.html" data-v-0009425e><!--[--><p class="text" data-v-0009425e>Custom Extensions</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-d8b57b2d data-v-9a6c75ad><div class="VPDoc has-sidebar has-aside" data-v-9a6c75ad data-v-e6f2a212><!--[--><!--]--><div class="container" data-v-e6f2a212><div class="aside" data-v-e6f2a212><div class="aside-curtain" data-v-e6f2a212></div><div class="aside-container" data-v-e6f2a212><div class="aside-content" data-v-e6f2a212><div class="VPDocAside" data-v-e6f2a212 data-v-cb998dce><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-cb998dce data-v-f610f197><div class="content" data-v-f610f197><div class="outline-marker" data-v-f610f197></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-f610f197>On this page</div><ul class="VPDocOutlineItem root" data-v-f610f197 data-v-53c99d69><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-cb998dce></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-e6f2a212><div class="content-container" data-v-e6f2a212><!--[--><!--]--><main class="main" data-v-e6f2a212><div style="position:relative;" class="vp-doc _README external-link-icon-enabled" data-v-e6f2a212><div><h1 id="fluentmigrator-documentation-website" tabindex="-1">FluentMigrator Documentation Website <a class="header-anchor" href="#fluentmigrator-documentation-website" aria-label="Permalink to &quot;FluentMigrator Documentation Website&quot;">​</a></h1><p>This directory contains the VitePress documentation website for FluentMigrator.</p><h2 id="development" tabindex="-1">Development <a class="header-anchor" href="#development" aria-label="Permalink to &quot;Development&quot;">​</a></h2><h3 id="prerequisites" tabindex="-1">Prerequisites <a class="header-anchor" href="#prerequisites" aria-label="Permalink to &quot;Prerequisites&quot;">​</a></h3><ul><li>Node.js 20+</li><li>npm</li></ul><h3 id="setup" tabindex="-1">Setup <a class="header-anchor" href="#setup" aria-label="Permalink to &quot;Setup&quot;">​</a></h3><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">cd</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> docs-website</span></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">npm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> install</span></span></code></pre></div><h3 id="development-server" tabindex="-1">Development Server <a class="header-anchor" href="#development-server" aria-label="Permalink to &quot;Development Server&quot;">​</a></h3><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">npm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> run</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> docs:dev</span></span></code></pre></div><p>The site will be available at <code>http://localhost:5173</code></p><h3 id="build" tabindex="-1">Build <a class="header-anchor" href="#build" aria-label="Permalink to &quot;Build&quot;">​</a></h3><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">npm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> run</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> docs:build</span></span></code></pre></div><p>The built site will be in <code>.vitepress/dist/</code></p><h3 id="preview-built-site" tabindex="-1">Preview Built Site <a class="header-anchor" href="#preview-built-site" aria-label="Permalink to &quot;Preview Built Site&quot;">​</a></h3><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">npm</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> run</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> docs:preview</span></span></code></pre></div><h2 id="contributing" tabindex="-1">Contributing <a class="header-anchor" href="#contributing" aria-label="Permalink to &quot;Contributing&quot;">​</a></h2><p>To contribute to the documentation:</p><ol><li>Make your changes to the markdown files</li><li>Test locally with <code>npm run docs:dev</code></li><li>Build to verify: <code>npm run docs:build</code></li><li>Submit your changes</li></ol></div></div></main><footer class="VPDocFooter" data-v-e6f2a212 data-v-1bcd8184><!--[--><!--]--><div class="edit-info" data-v-1bcd8184><div class="edit-link" data-v-1bcd8184><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://github.com/fluentmigrator/fluentmigrator/edit/main/docs-website/README.md" target="_blank" rel="noreferrer" data-v-1bcd8184><!--[--><span class="vpi-square-pen edit-link-icon" data-v-1bcd8184></span> Edit this page on GitHub<!--]--></a></div><div class="last-updated" data-v-1bcd8184><p class="VPLastUpdated" data-v-1bcd8184 data-v-1bb0c8a8>Updated at: <time datetime="2025-11-19T22:03:23.000Z" data-v-1bb0c8a8></time></p></div></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-1bcd8184><span class="visually-hidden" id="doc-footer-aria-label" data-v-1bcd8184>Pager</span><div class="pager" data-v-1bcd8184><!----></div><div class="pager" data-v-1bcd8184><a class="VPLink link pager-link next" href="/intro/quick-start.html" data-v-1bcd8184><!--[--><span class="desc" data-v-1bcd8184>Next page</span><span class="title" data-v-1bcd8184>Quick Start</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-d8b57b2d data-v-566314d4><div class="container" data-v-566314d4><p class="message" data-v-566314d4>Released under the Apache-2.0 License.</p><p class="copyright" data-v-566314d4>Copyright © 2008-present FluentMigrator Project</p></div></footer><!--[--><!--]--></div></div>
    <script>window.__VP_HASH_MAP__=JSON.parse("{\"advanced_best-practices.md\":\"DoQYK-Wr\",\"advanced_conditional-logic.md\":\"DO5aeaGM\",\"advanced_custom-extensions.md\":\"BzVR0EH7\",\"advanced_versioning.md\":\"BQCRfSGr\",\"basics_columns.md\":\"DZ5lsjuI\",\"basics_constraints.md\":\"Cb6wm8os\",\"basics_foreign-keys.md\":\"YAniR7NC\",\"basics_indexes.md\":\"rV0m2ObU\",\"basics_raw-sql.md\":\"ZsMs3Iqh\",\"index.md\":\"DxDE31Pk\",\"intro_configuration.md\":\"Dpk8xiA9\",\"intro_faq.md\":\"7ZhI4SG4\",\"intro_installation.md\":\"4oxT1zKZ\",\"intro_quick-start.md\":\"Dcp5eQzl\",\"migration-types_auto-reversing.md\":\"BS5spOJ1\",\"migration-types_maintenance.md\":\"CRZ0a1sB\",\"migration-types_profiles.md\":\"BhbapE8m\",\"migration-types_tags.md\":\"BUOuJdo2\",\"operations_alter-tables.md\":\"CnqAWRI0\",\"operations_columns.md\":\"ChxJ5gI0\",\"operations_create-tables.md\":\"CPk8dyDq\",\"operations_data.md\":\"Cxioy10d\",\"operations_execute-sql.md\":\"DAGtQ6yd\",\"operations_schema.md\":\"lK6WoQE7\",\"operations_with-connection.md\":\"CRejvP--\",\"providers_mysql.md\":\"Dk1HgNNz\",\"providers_oracle.md\":\"82VmIfSK\",\"providers_others.md\":\"DhPo3OV7\",\"providers_postgresql.md\":\"CXuN0q8w\",\"providers_sql-server.md\":\"B3jm4zBi\",\"providers_sqlite.md\":\"shrom88Y\",\"readme.md\":\"tZhmTXOk\",\"runners_console.md\":\"Ci2ZzJkG\",\"runners_dotnet-fm.md\":\"DHCUoNsp\",\"runners_in-process.md\":\"DbxDGHOG\",\"runners_index.md\":\"5E2VU3vz\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"FluentMigrator\",\"description\":\"A .NET migration framework for database schema management\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"outline\":2,\"logo\":{\"dark\":\"/logo-white.svg\",\"light\":\"/logo.svg\"},\"externalLinkIcon\":true,\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Documentation\",\"link\":\"/intro/quick-start\"},{\"text\":\"Release notes\",\"link\":\"https://github.com/fluentmigrator/fluentmigrator/releases\"},{\"text\":\"GitHub\",\"link\":\"https://github.com/fluentmigrator/fluentmigrator\"}],\"sidebar\":{\"/\":[{\"text\":\"Introduction\",\"items\":[{\"text\":\"Quick Start\",\"link\":\"/intro/quick-start\"},{\"text\":\"Installation\",\"link\":\"/intro/installation\"},{\"text\":\"Configuration\",\"link\":\"/intro/configuration\"},{\"text\":\"FAQ\",\"link\":\"/intro/faq\"}]},{\"text\":\"Operations\",\"items\":[{\"text\":\"Creating Tables\",\"link\":\"/operations/create-tables\"},{\"text\":\"Altering Tables\",\"link\":\"/operations/alter-tables\"},{\"text\":\"Managing Columns\",\"link\":\"/operations/columns\"},{\"text\":\"Data Operations\",\"link\":\"/operations/data\"},{\"text\":\"Schema Operations\",\"link\":\"/operations/schema\"},{\"text\":\"Execute SQL\",\"link\":\"/operations/execute-sql\"},{\"text\":\"Run code on connection\",\"link\":\"/operations/with-connection\"}]},{\"text\":\"Basics\",\"items\":[{\"text\":\"Columns\",\"link\":\"/basics/columns\"},{\"text\":\"Indexes\",\"link\":\"/basics/indexes\"},{\"text\":\"Constraints\",\"link\":\"/basics/constraints\"},{\"text\":\"Foreign Keys\",\"link\":\"/basics/foreign-keys\"},{\"text\":\"Raw SQL Helper\",\"link\":\"/basics/raw-sql\"}]},{\"text\":\"Migration Runners\",\"items\":[{\"text\":\"Choosing a runner\",\"link\":\"/runners/index\"},{\"text\":\"In-Process Runner\",\"link\":\"/runners/in-process\"},{\"text\":\"Console Tool (Migrate.exe)\",\"link\":\"/runners/console\"},{\"text\":\"dotnet-fm CLI\",\"link\":\"/runners/dotnet-fm\"}]},{\"text\":\"Database Providers\",\"items\":[{\"text\":\"SQL Server\",\"link\":\"/providers/sql-server\"},{\"text\":\"PostgreSQL\",\"link\":\"/providers/postgresql\"},{\"text\":\"MySQL\",\"link\":\"/providers/mysql\"},{\"text\":\"SQLite\",\"link\":\"/providers/sqlite\"},{\"text\":\"Oracle\",\"link\":\"/providers/oracle\"},{\"text\":\"Other Providers\",\"link\":\"/providers/others\"}]},{\"text\":\"Migration Types\",\"items\":[{\"text\":\"Maintenance Migrations\",\"link\":\"/migration-types/maintenance\"},{\"text\":\"Auto-Reversing Migrations\",\"link\":\"/migration-types/auto-reversing\"},{\"text\":\"Tags\",\"link\":\"/migration-types/tags\"},{\"text\":\"Profiles\",\"link\":\"/migration-types/profiles\"}]},{\"text\":\"Advanced Topics\",\"items\":[{\"text\":\"Best Practices\",\"link\":\"/advanced/best-practices\"},{\"text\":\"Migration Versioning\",\"link\":\"/advanced/versioning\"},{\"text\":\"Conditional Logic\",\"link\":\"/advanced/conditional-logic\"},{\"text\":\"Custom Extensions\",\"link\":\"/advanced/custom-extensions\"}]}]},\"socialLinks\":[{\"icon\":\"github\",\"link\":\"https://github.com/fluentmigrator/fluentmigrator\"}],\"footer\":{\"message\":\"Released under the Apache-2.0 License.\",\"copyright\":\"Copyright © 2008-present FluentMigrator Project\"},\"search\":{\"provider\":\"local\"},\"editLink\":{\"pattern\":\"https://github.com/fluentmigrator/fluentmigrator/edit/main/docs-website/:path\",\"text\":\"Edit this page on GitHub\"},\"lastUpdated\":{\"text\":\"Updated at\",\"formatOptions\":{\"dateStyle\":\"full\",\"timeStyle\":\"medium\"}}},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
    
  </body>
</html>

About

FluentMigrator documentation

Resources

Stars

Watchers

Forks

Languages