Bitwarden 贡献文档
⮐ Bitwarden Contributing Documentation我的博客联系我
  • 关于
  • 入门
    • 概述
    • 工具
    • 服务器
      • 设置指南
      • 高级服务器设置
      • 数据库
        • MSSQL
        • 实体框架
      • 事件日志
      • Ingress 隧道
      • SCIM
      • 自托管指南
      • 系统管理门户
      • 单点登录 (SSO)
        • 本地 IdP
        • Okta
      • 故障排除
      • 用户机密
      • 公共 API
    • 网页客户端
      • 网页密码库
        • WebAuthn
      • 浏览器端
        • 生物识别解锁
        • Firefox 隐私模式
      • 桌面端
        • Mac App Store Dev
        • Microsoft Store
        • Native Messaging Test Runner
        • 更新测试
      • CLI
      • 故障排除
    • 移动端
      • Android
        • F-Droid
      • iOS
      • .NET MAUI (legacy)
        • Android
        • iOS
        • watchOS
    • SDK
      • 内部 SDK
      • Secrets Manager
        • Integrations
          • Kubernetes
    • 业务 App
      • 目录连接器
        • JumpCloud
        • OpenLDAP Docker 服务器
      • Key Connector
      • Splunk App
  • 贡献
    • 贡献
    • 代码样式
      • =Android & Kotlin
      • Angular & TypeScript
      • C#
      • =Rust
      • T-SQL
      • =Swift
      • Tailwind
    • 数据库迁移
      • 进化数据库设计
    • 提交签名
    • 拉取请求
      • =贡献审查程序
      • 分支
      • 代码审查
      • UI 审查 - Chromatic
    • 无障碍
    • 依赖管理
    • 功能标记
    • 模板存储库
    • 测试
      • =数据库集成测试
      • 负载测试
      • 单元测试
        • 命名约定
        • 测试结构
    • 修改用户机密
  • 架构
    • 架构
    • 架构决策记录 (ADR)
      • 0001 - Angular Reactive Forms
      • 0002 - Public API for modules
      • 0003 - Adopt Observable Data Services for Angular
      • 0004 - Refactor State Service
      • 0005 - Refactor Api Service
      • 0006 - Clients: Use Jest Mocks
      • 0007 - Manifest V3 sync Observables
      • 0008 - Server: Adopt CQRS
      • 0009 - Composition over inheritance
      • 0010 - Angular Modules
      • 0011 - Scalable Angular Clients folder structure
      • 0012 - Angular Filename convention
      • 0013 - Avoid layered folder structure for request/response models
      • 0014 - Adopt Typescript Strict flag
      • 0015 - Short Lived Browser Services
      • 0016 - Move Decryption and Encryption to Views
      • 0017 - Use Swift to build watchOS app
      • 0018 - Feature management
      • 0019 - Adoption of Web Push
      • 0020 - Observability with OpenTelemetry
      • 0021 - Logging to Standard Output
      • =0022 - Authorization
      • =0023 - Identifying Integrated Clients
    • 移动客户端架构
      • =Android
      • =iOS
        • =推送通知故障排除提示
      • =.NET MAUI (legacy)
        • =概述
        • watchOS
    • =SDK 架构
      • =数据模型
      • =依赖
      • Password Manager
        • Web
          • =互操作性
      • =Secrets Manager
      • =服务器绑定
      • =版本控制和破坏性更改
    • 网络客户端架构
      • 概述
      • 数据模型
      • 表示层
        • Angular
        • CLI
      • =依赖注入
      • 服务层
        • Vision
        • 实现
    • 服务器架构
    • 深度剖析
      • 身份验证
        • 双重身份验证
      • =授权
      • =浏览器自动填充
        • 收集页面详细信息
        • 生成并执行填充脚本
        • 表单提交检测
        • Shadow DOM
        • =内联自动填充菜单
      • Captcha
      • =只读数据库副本
      • 事件日志
      • =FIDO2 和通行密钥
        • =凭据
        • =操作
        • =命名惯例
        • =实现
          • =提供程序
            • =浏览器扩展
          • =依赖方
            • =用于解密的通行密钥
        • =术语表
      • 推送通知
        • 移动端推送通知
        • 其他客户端推送通知
      • =SSH 密钥和代理
        • =SSH 代理
      • =状态提供程序框架
        • =派生状态
    • =安全
      • =定义
      • =原则
        • =P01 - 锁定的密码库是安全的
        • =P02 - 半受损设备密码库的有限安全性
        • =P03 - 完全损坏的系统没有安全性
        • =P04 - 控制密码库数据的访问权限
        • =P05 - 将安全漏洞的影响降至最低
      • =要求
由 GitBook 提供支持
在本页
  • 应用迁移
  • 为新的更改创建迁移
  • MSSQL 迁移
  • EF 迁移
  • [未实现] 手动 MSSQL 迁移
  1. 贡献

数据库迁移

上一页Tailwind下一页进化数据库设计

最后更新于3个月前

对应的

应用迁移

我们使用 migrate.ps1 PowerShell 脚本将迁移应用到本地开发数据库。此脚本可以处理我们支持的不同数据库提供程序。

有关如何使用 migrate.ps1 的说明,请参阅 和的入门部分。

为新的更改创建迁移

任何数据库的更改都必须编写为我们的主 DBMS - MSSQL 以及实体框架的迁移脚本。针对每个提供商,请按照以下说明进行操作。

MSSQL 迁移

我们建议首先阅读和 ,因为它们对我们如何编写迁移的有很大的影响。

根据的原则,每个更改都需要考虑分为两部分:

  1. 向后兼容的过渡迁移

  2. 非向后兼容的最终迁移

更改可能无需非向后兼容的结束阶段(即所有更改的最终形式可能是向后兼容的)。在这种情况下,只需要进行一个阶段的更改即可。

向后兼容迁移

  1. 修改 src/Sql/dbo 中的源 .sql 文件。

  2. 编写迁移脚本,并将其放在 util/Migrator/DbScripts 中。每个脚本必须以当前日期为前缀。

非向后兼容迁移

  1. 将相关的 .sql 文件从 src/Sql/dbo 复制到 src/Sql/dbo_finalization。

  2. 移除不再需要的向后兼容性。

  3. 编写一个新的 Migration 并将其放置在 src/Migrator/DbScripts_finalization 中。将其命名为 YYYY-0M-FinalizationMigration.sql。

    • 通常情况下,迁移是被设计为按顺序运行的。然而,由于 DbScripts_finalization中 的迁移可以不按顺序运行,因此必须注意确保它们与 DbScripts 的变更保持兼容。为了做到这一点,我们只保留了一个迁移,用于执行所有向后不兼容的架构变更。

EF 迁移

如果要更改数据库架构,则必须创建 EF 迁移脚本,以确保 EF 数据库与这些更改保持同步。开发人员必须这样做,并将迁移包含在他们的 PR 中。

要创建这些脚本,您必须首先根据需要更新 Core/Entities 中的数据模型。这将用于为我们的每个 EF 目标生成迁移。

模型更新后,导航到 server 存储库中的 dev 目录并执行 ef_migrate.ps1 PowerShell 命令。您应该提供迁移的名称,将其作为唯一的参数:

pwsh ef_migrate.ps1 [NAME_OF_MIGRATION]

这将生成迁移,然后应将其包含在您的 PR 中。

[未实现] 手动 MSSQL 迁移

可能需要在正常更新过程之外运行迁移。这些类型的迁移应该出于非常特殊的目的而保留。其中一个原因可能是索引重建。

  1. 编写一个带有当前日期前缀的新迁移并将其放置在 src/Migrator/DbScripts_manual 中

  2. 在我们的云环境中运行它并且我们对结果感到满意后,创建一个 PR 将其移动到 DbScripts。这将使其能够由我们的迁移器进程在全新安装的云和自托管环境,以及自托管中运行

官方页面地址
进化的数据库设计
T-SQL 代码样式
进化数据库设计
实体框架
MSSQL