CosmicClone 项目教程

CosmicClone 项目教程

CosmicClone Cosmic Clone is a utility that can backup\clone\restore a azure Cosmos database Collection. It can also anonymize cosmos documents and helps hide personally identifiable data. 项目地址: https://gitcode.com/gh_mirrors/co/CosmicClone

1. 项目的目录结构及介绍

CosmicClone 项目的目录结构如下：

CosmicClone/
├── docs/
│   └── gitignore
├── .gitignore
├── CODE_OF_CONDUCT.md
├── LICENSE
├── README.md
├── SECURITY.md
└── CosmicClone/
    └── (项目源代码)

目录结构介绍

• docs/: 存放项目的文档文件，如 gitignore 文件。
• .gitignore: Git 忽略文件，指定哪些文件或目录不需要被 Git 跟踪。
• CODE_OF_CONDUCT.md: 项目的行为准则文件。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍和使用说明文件。
• SECURITY.md: 项目的安全相关说明文件。
• CosmicClone/: 项目的源代码目录，包含主要的代码文件。

2. 项目的启动文件介绍

CosmicClone 项目的启动文件是 CosmicCloneUI.exe，该文件位于项目的发布版本中。启动文件的主要功能是启动 CosmicClone 工具的用户界面，用户可以通过该界面进行 Azure Cosmos 数据库的备份、克隆、恢复以及数据匿名化操作。

启动步骤

1. 下载项目的发布版本，找到 CosmicCloneUI.exe 文件。
2. 双击 CosmicCloneUI.exe 文件，启动 CosmicClone 工具。
3. 在用户界面中输入源和目标连接的详细信息，进行验证。
4. 根据需要选择克隆选项，启动克隆过程。

3. 项目的配置文件介绍

CosmicClone 项目的主要配置文件是 CosmicCloneUI.exe 运行时所需的配置文件。配置文件中包含以下关键配置项：

• 源 Cosmos 数据库连接信息: 包括数据库的 URL、密钥等。
• 目标 Cosmos 数据库连接信息: 包括数据库的 URL、密钥等。
• 克隆选项: 包括是否复制索引策略、分区键、文档等。
• 匿名化规则: 定义需要匿名化的字段及其匿名化方式。

配置文件示例

{
  "SourceConnection": {
    "Url": "https://source-cosmos-db.documents.azure.com:443/",
    "Key": "your-source-key"
  },
  "TargetConnection": {
    "Url": "https://target-cosmos-db.documents.azure.com:443/",
    "Key": "your-target-key"
  },
  "CloneOptions": {
    "CopyIndexes": true,
    "CopyPartitionKeys": true,
    "CopyDocuments": true
  },
  "AnonymizationRules": [
    {
      "AttributeToScrub": "FullName",
      "FilterQuery": "",
      "ScrubType": "Shuffle"
    },
    {
      "AttributeToScrub": "Email",
      "FilterQuery": "EntityType = 'Individual'",
      "ScrubType": "PartialMaskFromLeft"
    }
  ]
}

配置文件说明

• SourceConnection: 源 Cosmos 数据库的连接信息。
• TargetConnection: 目标 Cosmos 数据库的连接信息。
• CloneOptions: 克隆选项，控制是否复制索引、分区键和文档。
• AnonymizationRules: 匿名化规则，定义需要匿名化的字段及其匿名化方式。

通过以上配置文件，用户可以自定义 CosmicClone 工具的行为，以满足不同的需求。

CosmicClone Cosmic Clone is a utility that can backup\clone\restore a azure Cosmos database Collection. It can also anonymize cosmos documents and helps hide personally identifiable data. 项目地址: https://gitcode.com/gh_mirrors/co/CosmicClone